sys/man/1/torrent

   1 .TH TORRENT 1
   2 .SH NAME
   3 torrent \- bittorrent client
   4 .SH SYNOPSIS
   5 .B ip/torrent
   6 [
   7 .B -d
   8 ]
   9 [
  10 .B -v
  11 ]
  12 [
  13 .B -p
  14 ]
  15 [
  16 .B -m
  17 .I mtpt
  18 ]
  19 [
  20 .B -s
  21 ]
  22 [
  23 .I file
  24 ]
  25 .SH DESCRIPTION
  26 BitTorrent is a protocol for efficient file distribution
  27 over the internet. Files are split into small pieces
  28 that are then downloaded by clients in random order.
  29 As soon as a client completes a piece, it makes the piece
  30 available for others to download.
  31 .PP
  32 To find find other clients (peers), a tracker-server is
  33 contacted.
  34 .PP
  35 Before files can be transmitted, a torrent-file needs
  36 to be created describing the pieces of the files and
  37 other meta-data like network addresses of the trackers.
  38 .PP
  39 .I Torrent
  40 downloads the files that are described in the torrent-file
  41 given by the
  42 .I file
  43 argument to the current working directory. If no
  44 .I file
  45 is given, the torrent is read from standard-input.
  46 .PP
  47 Normally, the program exits immediately after all pieces
  48 have been completed.
  49 The
  50 .B -s
  51 option causes it to keep running and serve the remaining
  52 clients (also known as seeding).
  53 .PP
  54 Trackers use a subset of the HTTP protocol, so an
  55 alternative
  56 .IR webfs (4)
  57 mountpoint can be given with the
  58 .B -m
  59 option (defaults to
  60 .BR /mnt/web ).
  61 .PP
  62 The
  63 .B -v
  64 option causes
  65 .I torrent
  66 to list the files in the torrent-file before downloading.
  67 .PP
  68 The
  69 .B -d
  70 option produces verbose debug output to standard-error.
  71 .PP
  72 To monitor the download progress, the
  73 .B -p
  74 option can be given to cause the completed and total number of
  75 pieces written as a line of text to standard-output in one
  76 second intervals.
  77 .SH EXAMPLE
  78 Download the latest iso file of the distribution
  79 .EX
  80 cd /tmp
  81 hget http://r-36.net/9front/9front.iso.bz2.torrent | \\
  82         ip/torrent -pv | \\
  83         aux/statusbar 'download...'
  84 .EE
  85 .SH SOURCE
  86 .B /sys/src/cmd/ip/torrent.c
  87 .SH "SEE ALSO"
  88 .IR hget (1),
  89 .IR webfs (4)