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

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

(trunk libT) #1392: changing per-torrent peer limits via transmission-remote

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