btplay(1)

📦 version 3.2, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble, ubuntu questing, ubuntu resolute, ubuntu stonking

💖 btplay(1) — the general commands manual, but make it cute 💖

okay bestie, welcome to the btplay page. yes it's a man page, no it does not have to be boring. it's filed under the general commands manual and honestly? it's giving "tiny script that changes your whole afternoon". 💅

✨ NAME ✨

btplay — directly play video torrents using btfs. no middleman, no mount point drama, just vibes. 🎀

🌸 SYNOPSIS 🌸

btplay [OPTIONS]... torrentlink

🦋 DESCRIPTION 🦋

so btfs uses fuse (filesystem in user space) to expose a bittorrent source as a normal directory on your filesystem. lowkey iconic. ✨

btplay is a wrapper for btfs that mounts and plays the video directly, so you never have to specify a mount point yourself. main character energy fr fr. 🫶

you can pass either a .torrent link or a magnet link — and the magnet link has to be contained in single quotation marks. do not forget the quotes bestie, I am begging. 😭

👑 OPTIONS 👑

Usage, one more time for the people in the back:

btplay [OPTIONS...] torrentlink

💜 BTFS Options 💜

  • -v, --version — show version information. tiny, useful, slay.
  • -h, --help — displays usage for the tool. when in doubt, ask for help. periodt.
  • -b, --browse-only — download metadata only. no video, just the receipts.
  • -k, --keep — keep files after unmount. it's giving "I'm not letting go". 🥺

🌈 FUSE Options 🌈

  • -d, -o debug — enable debug output (and yes, this implies -f). turn it on when you want to see everything. 🙈
  • -f — foreground operation. it stays right there in front of you.
  • -s — disable multi-threaded operation.
  • -o allow_other — allow access to other users.
  • -o allow_root — allow access to root.
  • -o auto_unmount — auto unmount on process termination.
  • -o nonempty — allow mounts over non-empty file/dir.
  • -o default_permissions — enable permission checking by kernel.
  • -o fsname=NAME — set filesystem name.
  • -o suptype=NAME — set filesystem type.
  • -o large_read — issue large read requests.
  • -o max_read=N — set maximum size of read requests.
  • -o hard_remove — immediate removal (don't hide files). no hiding, no games.
  • -o use_ino — let filesystem set inode numbers.
  • -o readdir_ino — try to fill in d_ino in readdir.
  • -o direct_io — use direct I/O.
  • -o kernel_cache — cache files in kernel.
  • -o [no]auto_cache — enable caching based on modification times (off). default is off, fyi.
  • -o umask=M — set file permissions (octal).
  • -o uid=N — set file owner.
  • -o gid=N — set file group.
  • -o entry_timeout=T — cache timeout for names (1.0s).
  • -o negative_timeout=T — cache timeout for deleted names (0.0s).
  • -o attr_timeout=T — cache timeout for attributes (1.0s).
  • -o ac_attr_timeout=T — auto cache timeout for attributes (attr_timeout).
  • -o noforget — never forget cached inodes. it remembers. always. 🧠
  • -o remember=T — remember cached inodes for T seconds (0s).
  • -o nopath — don't supply path if not necessary.
  • -o intr — allow requests to be interrupted.
  • -o intr_signal=NUM — signal to send on interrupt (10).
  • -o modules=M1[:M2...] — names of modules to push onto filesystem stack.

🎀 Module Options 🎀

[iconv]

  • -o from_code=CHARSET — original encoding of file names (default: UTF-8).
  • -o to_code=CHARSET — new encoding of the file names (default: UTF-8).

[subdir]

  • -o subdir=DIR — prepend this directory to all paths (mandatory — like, actually required, not a suggestion 💀).
  • -o [no]rellinks — transform absolute symlinks to relative.

🍓 REPORTING BUGS 🍓

found something cursed? please file issues on the GitHub bug tracker, that's the whole move:

https://github.com/johang/btfs/issues
not me telling you to actually report the bug instead of just complaining in the group chat. do both, honestly. 🫶

💀 SEE ALSO 💀

fuse(1), btfs(1)

⭐ AUTHORS ⭐

this manual page was written by Jonathan Carter <jonathan@ubuntu.com> 💖

btplay was written by Johan Gunnarsson <johan.gunnarsson@gmail.com> 👑

okay that's the whole page, you ate that. this was btplay, from the general commands manual, dated 2016-01-05 — shoutout to everyone who made it, we're obsessed. now go play a video torrent and be iconic about it. 🌈✨💅

📦 where this page comes from