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

Last change on this file since 10132 was 9511, checked in by charles, 13 years ago

(trunk daemon) #2155: typo fix: honnor -> honor

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