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

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

(trunk daemon) #2158: transmission-remote should support "turtle mode"

  • Property svn:keywords set to Date Rev Author Id
File size: 8.8 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 as
16.Op Fl AS
17.Op Fl asd Ar number
18.Op Fl asu Ar number
19.Op Fl asc
20.Op Fl ASC
21.Op Fl b
22.Op Fl d Ar number | Fl D
23.Op Fl er | ep | et
24.Op Fl f
25.Op Fl g Ar files
26.Op Fl gpr Ar peers
27.Op Fl G Ar files
28.Op Fl gsr Ar ratio
29.Op Fl GSR
30.Op Fl h
31.Op Fl i
32.Op Fl l
33.Op Fl m | M
34.Op Fl n Ar user:pass
35.Op Fl N Ar netrc
36.Op Fl o | O
37.Op Fl p Ar port
38.Op Fl ph Ar files
39.Op Fl pl Ar files
40.Op Fl pn Ar files
41.Op Fl pr Ar peers
42.Op Fl r
43.Op Fl R
44.Op Fl s | S
45.Op Fl sr Ar ratio
46.Op Fl SR
47.Op Fl srd
48.Op Fl si
49.Op Fl st
50.Op Fl t Ar all | Ar id | Ar hash
51.Op Fl u Ar number | Fl U
52.Op Fl v
53.Op Fl V
54.Op Fl w Ar download-dir
55.Op Fl x | X
56.Op Fl pi
57.Ek
58.Sh DESCRIPTION
59.Nm
60is a remote control utility for
61.Xr transmission 1
62and
63.Xr transmission-daemon 1 .
64.Pp
65By default,
66.Nm
67connects to the transmission session at localhost:9091.
68Other sessions can be controlled by specifying a different host and/or port.
69
70.Sh OPTIONS
71.Bl -tag -width Ds
72.It Fl a Fl -add Ar filenames-or-URLs
73Add torrents to transmission.
74
75.It Fl b Fl -debug
76Enable debugging mode.
77
78.It Fl as Fl -alt-speed
79Use the alternate Limits.
80
81.It Fl AS Fl -no-alt-speed
82Don't use the alternate Limits.
83
84.It Fl asd Fl -alt-speed-downlimit Ar limit
85Limit the alternate download speed to
86.Ar limit
87kilobytes per second.
88
89.It Fl asu Fl -alt-speed-uplimit Ar limit
90Limit the alternate upload speed to
91.Ar limit
92kilobytes per second.
93
94.It Fl asc Fl -alt-speed-scheduler
95Use the scheduled on/off times.
96
97.It Fl ASC Fl -no-alt-speed-scheduler
98Don't use the scheduled on/off days and times.
99
100.It Fl -alt-speed-time-begin Ar time
101.Ar Time
102to start using the alt speed limits (in hhmm).
103
104.It Fl -alt-speed-time-end Ar time
105.Ar Time
106to stop using the alt speed limits (in hhmm).
107
108.It Fl -alt-speed-days Ar days
109Set the number of
110.Ar days
111on which to enable the speed scheduler, using a list such as "2,4-6".
112
113.It Fl d Fl -downlimit Ar limit
114Limit the global download speed to
115.Ar limit
116kilobytes per second.
117
118.It Fl D Fl -no-downlimit
119Remove the global download limit.
120
121.It Fl er Fl -encryption-required
122Encrypt all peer connections.
123.It Fl ep Fl -encryption-preferred
124Prefer encrypted peer connections.
125.It Fl et Fl -encryption-tolerated
126Prefer unencrypted peer connections.
127
128.It Fl f Fl -files
129Get a file list for the current torrent(s)
130
131.It Fl g Fl -get Ar all | file-index | files
132Mark file(s) for download.
133.Ar all
134marks all all of the torrent's files for downloading,
135.Ar file-index
136adds a single file to the download list, and
137.Ar files
138adds multiple files to the download list,
139such as "-g1,3-5" to add files #1, #3, #4, and #5 to the download list.
140
141.It Fl G Fl -no-get Ar all | file-index | files
142Mark file(s) for not downloading.
143
144.It Fl gsr Fl -global-seedratio Ar ratio
145All torrents, unless overridden by a per-torrent setting, should seed until a specific
146.Ar ratio
147
148.It Fl GSR Fl -no-global-seedratio
149All torrents, unless overridden by a per-torrent setting, should seed regardless of ratio
150
151.It Fl h Fl -help
152Print command-line option descriptions.
153
154.It Fl i Fl -info Ar id | torrent-hash
155Show details of the current torrent(s)
156
157.It Fl si Fl -session-info
158List session information from the server
159
160.It Fl st Fl -session-stats
161List statistical information from the server
162
163.It Fl l Fl -list
164List all torrents
165
166.It Fl m Fl -portmap
167Enable portmapping via NAT-PMP or UPnP
168.It Fl M Fl -no-portmap
169Disable portmapping
170
171.It Fl n Fl -auth Ar username:password
172Set the
173.Ar username
174and
175.Ar password
176for authentication
177
178.It Fl N Fl -netrc Ar filename
179Set the authentication information from a
180.Ar netrc file.
181See netrc(5) for more information.
182
183.It Fl o Fl -dht
184Enable distributed hash table (DHT).
185.It Fl O Fl -no-dht
186Disable distribued hash table (DHT).
187
188.It Fl p Fl -port Ar port
189Set the
190.Ar port
191for use when listening for incoming peer connections
192
193.It Fl pn Fl -priority-normal Ar all | file-index | files
194Mark file(s) as normal priority.
195.Ar all
196marks all of the torrent's files as normal priority,
197.Ar file-index
198sets a single file's priority as normal, and
199.Ar files
200sets multiple files' priorities as normal,
201such as "-pn1,3-5" to normalize files #1, #3, #4, and #5.
202
203.It Fl ph Fl -priority-high Ar all | file-index | files
204Mark file(s) as high priority.
205
206.It Fl pl Fl -priority-low Ar all | file-index | files
207Mark file(s) as low priority.
208
209.It Fl pr Fl -peers Ar number
210Set the current torrent(s)' maximum number of peers
211
212.It Fl gpr Fl -global-peers Ar number
213Set the maximum number of peers allowed globally
214
215.It Fl r Fl -remove
216Remove the current torrent(s).  This does not delete the downloaded data.
217
218.It Fl -remove-and-delete
219Remove the current torrent(s) and delete their downloaded data.
220
221.It Fl -move
222Move the current torrents' data from their current locations to the specified directory.
223
224.It Fl -find
225Tell Transmission where to look for the current torrents' data.
226
227.It Fl sr Fl -seedratio Ar ratio
228Let the current torrent(s) seed until a specific
229.Ar ratio
230
231.It Fl SR Fl -no-seedratio
232Let the current torrent(s) seed regardless of ratio
233
234.It Fl srd Fl -seedratio-default
235Let the current torrent(s) use the global seedratio settings
236
237.It Fl s Fl -start
238Start the current torrent(s)
239
240.It Fl S Fl -stop
241Stop the current torrent(s) from downloading or seeding
242
243.It Fl t Fl -torrent Ar all | id | torrent-hash
244Set the current torrent(s) for use by subsequent options.
245.Ar all
246will apply following requests to all torrents, while specific torrents can be chosen by
247.Ar id
248or
249.Ar hash .
250To set more than one current torrent, join their ids or hashes together in a list,
251such as "-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8.
252
253.It Fl u Fl -uplimit Ar limit
254Limit the global upload speed to
255.Ar limit
256kilobytes per second.
257.It Fl U Fl -no-uplimit
258Remove the global upload limit.
259
260.It Fl v Fl -verify
261Verify the current torrent(s)
262
263.It Fl V Fl -version
264Show version number and exit
265
266.It Fl w Fl -download-dir Ar directory
267Use
268.Ar directory
269as the default location for newly added torrents to download files to.
270
271.It Fl x Fl -pex
272Enable peer exchange (PEX).
273.It Fl X Fl -no-pex
274Disable peer exchange (PEX).
275
276.It Fl pi Fl -peer-info
277List the current torrent's connected peers.
278In the `status' section of the list, the following shorthand is used:
279.D1 D: Downloading from this peer
280.D1 d: We would download from this peer if they would let us
281.D1 E: Encrypted connection
282.D1 I: Peer is an incoming connection
283.D1 K: Peer has unchoked us, but we're not interested
284.D1 O: Optimistic unchoked
285.D1 U: Uploading to peer
286.D1 u: We would upload to this peer if they asked
287.D1 X: Peer was discovered through Peer Exchange (PEX)
288.D1 ?: We unchoked this peer, but they're not interested
289
290.El
291.Sh EXAMPLES
292
293Set download and upload limits to 400 KiB/sec and 60 KiB/sec:
294.Bd -literal -offset indent
295$ transmission-remote -d400 -u60
296$ transmission-remote --downlimit=400 --uplimit=60
297.Ed
298
299Set alternate download and upload limits to 100 KiB/sec and 20 KiB/sec:
300.Bd -literal -offset indent
301$ transmission-remote -asd100 -asu20
302$ transmission-remote --alt-speed-downlimit=100 --alt-speed-uplimit=20
303.Ed
304
305Set the scheduler to use the alternate speed limits on weekdays between 10AM and 11PM
306.Bd -literal -offset indent
307$ transmission-remote --alt-speed-time-begin=1000
308$ transmission-remote --alt-speed-time-end=2300
309$ transmission-remote --alt-speed-days=1-5
310$ transmission-remote --alt-speed-scheduler
311.Ed
312
313List all torrents' IDs and states:
314.Bd -literal -offset indent
315$ transmission-remote -l
316.Ed
317
318List all torrents from a remote session that requires authentication:
319.Bd -literal -offset indent
320$ transmission-remote host:9091 --auth=username:password -l
321.Ed
322
323Start all torrents:
324.Bd -literal -offset indent
325$ transmission-remote -tall --start
326.Ed
327
328Add two torrents:
329.Bd -literal -offset indent
330$ transmission-remote -a one.torrent two.torrent
331.Ed
332
333Add all torrents in ~/Desktop:
334.Bd -literal -offset indent
335$ transmission-remote -a ~/Desktop/*torrent
336.Ed
337
338Get detailed information on the torrent whose ID is '1':
339.Bd -literal -offset indent
340$ transmission-remote -t1 -i
341.Ed
342
343Get a list of a torrent's files:
344.Bd -literal -offset indent
345$ transmission-remote -t1 -l
346.Ed
347
348Download only its second and fourth files:
349.Bd -literal -offset indent
350$ transmission-remote -t1 -Gall -g2,4
351.Ed
352
353Set all torrents' first two files' priorities to high:
354.Bd -literal -offset indent
355$ transmission-remote -tall -ph1,2
356.Ed
357
358Set all torrents' files' priorities to normal:
359.Bd -literal -offset indent
360$ transmission-remote -tall -pnall
361.Ed
362
363.Sh AUTHORS
364.An -nosplit
365.An Charles Kerr ,
366.An Josh Elsasser ,
367.An Eric Petit ,
368and
369.An Mitchell Livingston .
370
371.Sh SEE ALSO
372.Xr transmissioncli 1 ,
373.Xr transmission-daemon 1 ,
374.Xr transmission 1
375
376.Pp
377http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.