source: trunk/daemon/transmission-remote.1 @ 7865

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

(trunk libT) #1784: add .netrc support to transmission-remote

  • Property svn:keywords set to Date Rev Author Id
File size: 6.4 KB
Line 
1.Dd July 21, 2008
2.Dt TRANSMISSION-REMOTE 1
3.Os
4.Sh NAME
5.Nm transmission-remote
6.Nd a remote control utility for
7.Xr transmission-daemon 1
8and
9.Xr transmission 1
10.Sh SYNOPSIS
11.Bk -words
12.Nm
13.Op Ar host:port | host | port
14.Op Fl a Ar filenames-or-URLs
15.Op Fl b
16.Op Fl d Ar number | Fl D
17.Op Fl er | ep | et
18.Op Fl f
19.Op Fl g Ar files
20.Op Fl gpr Ar peers
21.Op Fl G Ar files
22.Op Fl h
23.Op Fl i
24.Op Fl l
25.Op Fl m | M
26.Op Fl n Ar user:pass
27.Op Fl N Ar netrc
28.Op Fl p Ar port
29.Op Fl ph Ar files
30.Op Fl pl Ar files
31.Op Fl pn Ar files
32.Op Fl pr Ar peers
33.Op Fl r
34.Op Fl R
35.Op Fl s | S
36.Op Fl si
37.Op Fl t Ar all | Ar id | Ar hash
38.Op Fl u Ar number | Fl U
39.Op Fl v
40.Op Fl V
41.Op Fl w Ar download-dir
42.Op Fl x | X
43.Op Fl pi
44.Ek
45.Sh DESCRIPTION
46.Nm
47is a remote control utility for
48.Xr transmission 1
49and
50.Xr transmission-daemon 1 .
51.Pp
52By default,
53.Nm
54connects to the transmission session at localhost:9091.
55Other sessions can be controlled by specifying a different host and/or port.
56
57.Sh OPTIONS
58.Bl -tag -width Ds
59.It Fl a Fl -add Ar filenames-or-URLs
60Add torrents to transmission.
61
62.It Fl b Fl -debug
63Enable debugging mode.
64
65.It Fl d Fl -downlimit Ar limit
66Limit the global download speed to
67.Ar limit
68kilobytes per second.
69
70.It Fl D Fl -no-downlimit
71Remove the global download limit.
72
73.It Fl er Fl -encryption-required
74Encrypt all peer connections.
75.It Fl ep Fl -encryption-preferred
76Prefer encrypted peer connections.
77.It Fl et Fl -encryption-tolerated
78Prefer unencrypted peer connections.
79
80.It Fl f Fl -files
81Get a file list for the current torrent(s)
82
83.It Fl g Fl -get Ar all | file-index | files
84Mark file(s) for download.
85.Ar all
86marks all all of the torrent's files for downloading,
87.Ar file-index
88adds a single file to the download list, and
89.Ar files
90adds multiple files to the download list,
91such as "-g1,3-5" to add files #1, #3, #4, and #5 to the download list.
92
93.It Fl G Fl -no-get Ar all | file-index | files
94Mark file(s) for not downloading.
95
96.It Fl h Fl -help
97Print command-line option descriptions.
98
99.It Fl i Fl -info Ar id | torrent-hash
100Show details of the current torrent(s)
101
102.It Fl si Fl -session-info
103List session information from the server
104
105.It Fl l Fl -list
106List all torrents
107
108.It Fl m Fl -portmap
109Enable portmapping via NAT-PMP or UPnP
110.It Fl M Fl -no-portmap
111Disable portmapping
112
113.It Fl n Fl -auth Ar username:password
114Set the
115.Ar username
116and
117.Ar password
118for authentication
119
120.It Fl N Fl -netrc Ar filename
121Set the authentication information from a
122.Ar netrc file.
123See netrc(5) for more information.
124
125.It Fl p Fl -port Ar port
126Set the
127.Ar port
128for use when listening for incoming peer connections
129
130.It Fl pn Fl -priority-normal Ar all | file-index | files
131Mark file(s) as normal priority.
132.Ar all
133marks all of the torrent's files as normal priority,
134.Ar file-index
135sets a single file's priority as normal, and
136.Ar files
137sets multiple files' priorities as normal,
138such as "-pn1,3-5" to normalize files #1, #3, #4, and #5.
139
140.It Fl ph Fl -priority-high Ar all | file-index | files
141Mark file(s) as high priority.
142
143.It Fl pl Fl -priority-low Ar all | file-index | files
144Mark file(s) as low priority.
145
146.It Fl pr Fl -peers Ar number
147Set the current torrent(s)' maximum number of peers
148
149.It Fl gpr Fl -global-peers Ar number
150Set the maximum number of peers allowed globally
151
152.It Fl r Fl -remove
153Remove the current torrent(s).  This does not delete the downloaded data.
154
155.It Fl -remove-and-delete
156Remove the current torrent(s) and delete their downloaded data.
157
158.It Fl s Fl -start
159Start the current torrent(s)
160
161.It Fl S Fl -stop
162Stop the current torrent(s) from downloading or seeding
163
164.It Fl t Fl -torrent Ar all | id | torrent-hash
165Set the current torrent(s) for use by subsequent options.
166.Ar all
167will apply following requests to all torrents, while specific torrents can be chosen by
168.Ar id
169or
170.Ar hash .
171To set more than one current torrent, join their ids or hashes together in a list,
172such as "-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8.
173
174.It Fl u Fl -uplimit Ar limit
175Limit the global upload speed to
176.Ar limit
177kilobytes per second.
178.It Fl U Fl -no-uplimit
179Remove the global upload limit.
180
181.It Fl v Fl -verify
182Verify the current torrent(s)
183
184.It Fl V Fl -version
185Show version number and exit
186
187.It Fl w Fl -download-dir Ar directory
188Use
189.Ar directory
190as the default location for newly added torrents to download files to.
191
192.It Fl x Fl -pex
193Enable peer exchange (PEX).
194.It Fl X Fl -no-pex
195Disable peer exchange (PEX).
196
197.It Fl pi Fl -peer-info
198List the current torrent's connected peers.
199In the `status' section of the list, the following shorthand is used:
200.D1 D: Downloading from this peer
201.D1 d: We would download from this peer if they would let us
202.D1 E: Encrypted connection
203.D1 I: Peer is an incoming connection
204.D1 K: Peer has unchoked us, but we're not interested
205.D1 O: Optimistic unchoked
206.D1 U: Uploading to peer
207.D1 u: We would upload to this peer if they asked
208.D1 X: Peer was discovered through Peer Exchange (PEX)
209.D1 ?: We unchoked this peer, but they're not interested
210
211.El
212.Sh EXAMPLES
213
214Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
215.Bd -literal -offset indent
216$ transmission-remote -d100 -u20
217$ transmission-remote --downlimit=100 --uplimit=20
218.Ed
219
220List all torrents' IDs and states:
221.Bd -literal -offset indent
222$ transmission-remote -l
223.Ed
224
225List all torrents from a remote session that requires authentication:
226.Bd -literal -offset indent
227$ transmission-remote host:9091 --auth=username:password -l
228.Ed
229
230Start all torrents:
231.Bd -literal -offset indent
232$ transmission-remote -tall --start
233.Ed
234
235Add two torrents:
236.Bd -literal -offset indent
237$ transmission-remote -a one.torrent two.torrent
238.Ed
239
240Add all torrents in ~/Desktop:
241.Bd -literal -offset indent
242$ transmission-remote -a ~/Desktop/*torrent
243.Ed
244
245Get detailed information on the torrent whose ID is '1':
246.Bd -literal -offset indent
247$ transmission-remote -t1 -i
248.Ed
249
250Get a list of a torrent's files:
251.Bd -literal -offset indent
252$ transmission-remote -t1 -l
253.Ed
254
255Download only its second and fourth files:
256.Bd -literal -offset indent
257$ transmission-remote -t1 -Gall -g2,4
258.Ed
259
260Set all torrents' first two files' priorities to high:
261.Bd -literal -offset indent
262$ transmission-remote -tall -ph1,2
263.Ed
264
265Set all torrents' files' priorities to normal:
266.Bd -literal -offset indent
267$ transmission-remote -tall -pnall
268.Ed
269
270.Sh AUTHORS
271.An -nosplit
272.An Charles Kerr ,
273.An Josh Elsasser ,
274.An Eric Petit ,
275and
276.An Mitchell Livingston .
277
278.Sh SEE ALSO
279.Xr transmissioncli 1 ,
280.Xr transmission-daemon 1 ,
281.Xr transmission 1
282
283.Pp
284http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.