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

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

(trunk daemon) #3060 "local peer discovery" -- fix bugs reported by Eszet (thanks Eszet :)

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