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

Last change on this file since 13364 was 13364, checked in by jordan, 9 years ago

(trunk daemon) #4947 "Expanded info not in transmission-remote manpage, only in --help" -- fixed.

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