release/src/router/transmission/daemon/transmission-daemon.1

   1 .Dd July 21, 2008
   2 .Dt TRANSMISSION-DAEMON 1
   3 .Sh NAME
   4 .Nm transmission-daemon
   5 .Nd a bittorrent client
   6 .Sh SYNOPSIS
   7 .Bk -words
   8 .Nm transmission-daemon
   9 .Fl h
  10 .Nm
  11 .Op Fl a Ar x.x.x.x,...
  12 .Op Fl b | B
  13 .Op Fl c Ar directory
  14 .Op Fl C
  15 .Op Fl f
  16 .Op Fl g Ar directory
  17 .Op Fl h
  18 .Op Fl p Ar port
  19 .Op Fl t | T
  20 .Op Fl u Ar username
  21 .Op Fl v Ar password
  22 .Op Fl P Ar port
  23 .Op Fl m | M
  24 .Op Fl l Ar limit
  25 .Op Fl L Ar limit
  26 .Op Fl er | ep | et
  27 .Op Fl V
  28 .Op Fl w Ar download-dir
  29 .Op Fl e Ar logfile
  30 .Op Fl log-error | log-info | log-debug
  31 .Ek
  32 .Sh DESCRIPTION
  33 .Nm
  34 is a daemon-based Transmission session that can be controlled
  35 via RPC commands from transmission's web interface or
  36 .Xr transmission-remote 1 .
  37 .Sh OPTIONS
  38 .Bl -tag -width Ds
  39 .It Fl a Fl -allowed Ar x.x.x.x,...
  40 Allow RPC access to a comma-delimited whitelist of IP addresses.
  41 Wildcards can be specified in an address by using '*'.
  42 Default: "127.0.0.1"
  43 Example: "127.0.0.*,192.168.1.*"
  44 .It Fl b Fl -blocklist
  45 Enable peer blocklists. Transmission understands the bluetack blocklist file format.
  46 New blocklists can be added by copying them into the config-dir's "blocklists" subdirectory.
  47 .It Fl c Ar directory
  48 Directory to watch for new .torrent files to be added. As they are added to this directory,
  49 the daemon will load them into Transmission.
  50 .It Fl C
  51 Do not watch for new .torrent files.
  52 .It Fl B Fl -no-blocklist
  53 Disble blocklists.
  54 .It Fl f Fl -foreground
  55 Run in the foreground and print errors to stderr.
  56 .It Fl g Fl -config-dir Ar directory
  57 Where to look for configuration files. This can be used to swap between using the cli, daemon, gtk, and qt clients.
  58 See http://trac.transmissionbt.com/wiki/ConfigFiles for more information.
  59 .It Fl er Fl -encryption-required
  60 Encrypt all peer connections.
  61 .It Fl ep Fl -encryption-preferred
  62 Prefer encrypted peer connections.
  63 .It Fl et Fl -encryption-tolerated
  64 Prefer unencrypted peer connections.
  65 .It Fl gsr Fl -global-seedratio Ar ratio
  66 All torrents, unless overridden by a per-torrent setting, should seed until a specific
  67 .Ar ratio
  68 .It Fl GSR Fl -no-global-seedratio
  69 All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio
  70 .It Fl h Fl -help
  71 Print command-line option descriptions.
  72 .It Fl -incomplete-dir Ar dir
  73 When adding new torrents, store their contents in
  74 .Ar directory
  75 until the torrent is done.
  76 .It Fl -no-incomplete-dir
  77 Don't store incomplete torrents in a different directory.
  78 .It Fl i Fl -bind-address-ipv4
  79 Listen for IPv4 BitTorrent connections on a specific address. Only one IPv4 listening address is allowed. Default: 0.0.0.0 (All addresses)
  80 .It Fl I Fl -bind-address-ipv6
  81 Listen for IPv6 BitTorrent connections on a specific address. Only one IPv6 listening address is allowed. Default: :: (All addresses)
  82 .It Fl r Fl -rpc-bind-address
  83 Listen for RPC connections on a specific address. This must be an IPv4 address. Only one RPC listening address is allowed. Default: 0.0.0.0 (All addresses)
  84 .It Fl -paused
  85 Pause all torrents on startup
  86 .It Fl L Fl -peerlimit-global Ar limit
  87 Overall peer limit. Useful on embedded systems where the default might be unsuitable. Default: 240
  88 .It Fl l Fl -peerlimit-torrent Ar limit
  89 Peer limit per torrent. Useful on embedded systems where the default might be unsuitable. Default: 60
  90 .It Fl m Fl -portmap
  91 Enable portmapping via NAT-PMP or UPnP
  92 .It Fl M Fl -no-portmap
  93 Disable portmapping
  94 .It Fl o Fl -dht
  95 Enable distributed hash table (DHT).
  96 .It Fl O Fl -no-dht
  97 Disable distribued hash table (DHT).
  98 .It Fl p Fl -port Ar port
  99 Port to open and listen for RPC requests on. Default: 9091
 100 .It Fl P, -peerport Ar port
 101 Port to listen for incoming peers on. Default: 51413
 102 .It Fl t Fl -auth
 103 Require clients to authenticate themselves.
 104 This doesn't do much good unless
 105 .Ar username
 106 and
 107 .Ar password
 108 are also set.
 109 .It Fl T Fl -no-auth
 110 Don't require authentication from clients.
 111 .It Fl u Fl -username Ar username
 112 Used for client authentication.
 113 .It Fl v Fl -password Ar password
 114 Used for client authentication.
 115 .It Fl V Fl -version
 116 Show version number and exit
 117 .It Fl w Fl -download-dir
 118 Where to store downloaded data.
 119 .It Fl e Fl -logfile
 120 Where to store transmission's log messages.
 121 .It Fl -log-error
 122 Show error messages
 123 .It Fl -log-info
 124 Show error and info messages
 125 .It Fl -log-debug
 126 Show error, info, and debug messages
 127 .El
 128 .Sh ENVIRONMENT
 129 .Bl -tag -width Fl
 130 .It Ev http_proxy
 131 libcurl uses this environment variable when performing tracker announces.
 132 .It Ev TRANSMISSION_HOME
 133 Sets the default config-dir.
 134 .El
 135 .Sh FILES
 136 .Bl -tag -width Ds -compact
 137 .It ~/.config/transmission-daemon
 138 The config-dir used when neither
 139 .Op Ev TRANSMISSION_HOME
 140 nor
 141 .Op Fl g
 142 is specified.
 143 See http://trac.transmissionbt.com/wiki/ConfigFiles for more information.
 144 .El
 145 .Sh AUTHORS
 146 .An -nosplit
 147 .An Jordan Lee ,
 148 .An Josh Elsasser ,
 149 .An Eric Petit ,
 150 and
 151 .An Mitchell Livingston .
 152 .Sh SEE ALSO
 153 .Xr transmission-create 1 ,
 154 .Xr transmission-daemon 1 ,
 155 .Xr transmission-edit 1 ,
 156 .Xr transmission-gtk 1 ,
 157 .Xr transmission-qt 1 ,
 158 .Xr transmission-remote 1 ,
 159 .Xr transmission-show 1
 160 .Pp
 161 http://www.transmissionbt.com/