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

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

(daemon) #1510: kysucix's patch to give an option to delete local data via RPC when removing a torrent.

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