source: trunk/daemon/transmission-daemon.1 @ 8710

Last change on this file since 8710 was 8710, checked in by charles, 13 years ago

(trunk) document the -g arg a little better

  • Property svn:keywords set to Date Rev Author Id
File size: 3.9 KB
Line 
1.Dd July 21, 2008
2.Dt TRANSMISSION-DAEMON 1
3
4.Sh NAME
5.Nm transmission-daemon
6.Nd a bittorrent client
7.Sh SYNOPSIS
8.Bk -words
9.Nm transmission-daemon
10.Fl h
11.Nm
12.Op Fl a Ar x.x.x.x,...
13.Op Fl b | B
14.Op Fl c Ar directory
15.Op Fl C
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 V
29.Op Fl w Ar download-dir
30.Ek
31
32.Sh DESCRIPTION
33.Nm
34is a daemon-based Transmission session that can be controlled
35via RPC commands from transmission's web interface or
36.Xr transmission-remote 1 .
37
38.Sh OPTIONS
39.Bl -tag -width Ds
40
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
47.It Fl b Fl -blocklist
48Enable peer blocklists.  Transmission understands the bluetack blocklist file format.
49New blocklists can be added by copying them into the config-dir's "blocklists" subdirectory.
50
51.It Fl c Ar directory
52Directory to watch for new .torrent files to be added.  As they are added to this directory,
53the daemon will load them into Transmission.
54
55.It Fl C
56Do not watch for new .torrent files.
57
58.It Fl B Fl -no-blocklist
59Disble blocklists.
60
61.It Fl f Fl -foreground
62Run in the foreground and print errors to stderr.
63
64.It Fl g Fl -config-dir Ar directory
65Where to look for configuration files.  This can be used to swap between using the cli, daemon, gtk, and qt clients.
66See http://trac.transmissionbt.com/wiki/ConfigFiles for more information.
67
68
69.It Fl er Fl -encryption-required
70Encrypt all peer connections.
71.It Fl ep Fl -encryption-preferred
72Prefer encrypted peer connections.
73.It Fl et Fl -encryption-tolerated
74Prefer unencrypted peer connections.
75
76.It Fl h Fl -help
77Print command-line option descriptions.
78
79.It Fl i Fl -bind-address-ipv4
80Listen for IPv4 BitTorrent connections on a specific address. Only one IPv4 listening address is allowed. Default: 0.0.0.0 (All addresses)
81.It Fl I Fl -bind-address-ipv6
82Listen for IPv6 BitTorrent connections on a specific address. Only one IPv6 listening address is allowed. Default: :: (All addresses)
83.It Fl r Fl -rpc-bind-address
84Listen 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)
85
86.It Fl -paused
87Pause all torrents on startup
88
89.It Fl L Fl -peerlimit-global Ar limit
90Overall peer limit. Useful on embedded systems where the default might be unsuitable. Default: 240
91.It Fl l Fl -peerlimit-torrent Ar limit
92Peer limit per torrent. Useful on embedded systems where the default might be unsuitable. Default: 60
93
94.It Fl m Fl -portmap
95Enable portmapping via NAT-PMP or UPnP
96.It Fl M Fl -no-portmap
97Disable portmapping
98
99.It Fl p Fl -port Ar port
100Port to open and listen for RPC requests on.  Default: 9091
101
102.It Fl P, -peerport Ar port
103Port to listen for incoming peers on. Default: 51413
104
105.It Fl t Fl -auth
106Require clients to authenticate themselves.
107This doesn't do much good unless
108.Ar username
109and
110.Ar password
111are also set.
112
113.It Fl T Fl -no-auth
114Don't require authentication from clients.
115
116.It Fl u Fl -username Ar username
117Used for client authentication.
118
119.It Fl v Fl -password Ar password
120Used for client authentication.
121
122.It Fl V Fl -version
123Show version number and exit
124
125.It Fl w Fl -download-dir
126Where to store downloaded data.
127
128.El
129
130.Sh ENVIRONMENT
131.Bl -tag -width Fl
132.It Ev TRANSMISSION_HOME
133Sets the default config-dir.
134.El
135
136
137.Sh FILES
138.Bl -tag -width Ds -compact
139.It ~/.config/transmission-daemon
140The config-dir used when neither
141.Op Ev TRANSMISSION_HOME
142nor
143.Op Fl g
144is specified.
145See http://trac.transmissionbt.com/wiki/ConfigFiles for more information.
146.El
147
148
149.Sh AUTHORS
150.An -nosplit
151.An Charles Kerr ,
152.An Josh Elsasser ,
153.An Eric Petit ,
154and
155.An Mitchell Livingston .
156
157.Sh SEE ALSO
158.Xr transmissioncli 1 ,
159.Xr transmission 1 ,
160.Xr transmission-remote 1
161.Pp
162http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.