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

Last change on this file since 10719 was 10719, checked in by charles, 12 years ago

(trunk daemon) sync the manpage with the --help page wrt file & priority args

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