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

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

(trunk) #1521 "memory cache to reduce disk IO" -- commit block-cache-rc1.diff to trunk for the nightlies.

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