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

Last change on this file since 11686 was 11686, checked in by jordan, 11 years ago

#3686 "add rpc command to cleanly shutdown daemon" -- added for libT, tr-daemon, tr-gtk, tr-remote, and the rpc spec

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