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

Last change on this file since 12163 was 12163, checked in by jordan, 12 years ago

(trunk daemon) #4118 "transmission-remote, document peer status for H and T in its man page" -- done.

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