source: trunk/daemon/transmission-daemon.1

Last change on this file was 14082, checked in by jordan, 9 years ago

add transmission-daemon's --dump option to the manpage.

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