source: branches/1.7x/daemon/transmission-remote.1 @ 9355

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

(1.7x) backports for 1.76: #2447 (manpage errors)

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