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

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

(daemon) #1420: transmission-remote --peers doesn't work right

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