source: branches/1.5x/daemon/transmission-remote.1 @ 7813

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

(trunk libT) backport latest changes to 1.5x -- (1) all of libT (2) more stats in daemon (3) compiler warning in gtk

  • 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 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 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 V
37.Op Fl w Ar download-dir
38.Op Fl x | X
39.Op Fl z | peers
40.Ek
41.Sh DESCRIPTION
42.Nm
43is a remote control utility for
44.Xr transmission 1
45and
46.Xr transmission-daemon 1 .
47.Pp
48By default,
49.Nm
50connects to the transmission session at localhost:9091.
51Other sessions can be controlled by specifying a different host and/or port.
52
53.Sh OPTIONS
54.Bl -tag -width Ds
55.It Fl a Fl -add Ar filenames-or-URLs
56Add torrents to transmission.
57
58.It Fl b Fl -debug
59Enable debugging mode.
60
61.It Fl d Fl -downlimit Ar limit
62Limit the global download speed to
63.Ar limit
64kilobytes per second.
65
66.It Fl D Fl -no-downlimit
67Remove the global 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 -remove-and-delete
138Remove the current torrent(s) and delete their downloaded data.
139
140.It Fl s Fl -start
141Start the current torrent(s)
142
143.It Fl S Fl -stop
144Stop the current torrent(s) from downloading or seeding
145
146.It Fl t Fl -torrent Ar all | id | torrent-hash
147Set the current torrent(s) for use by subsequent options.
148.Ar all
149will apply following requests to all torrents, while specific torrents can be chosen by
150.Ar id
151or
152.Ar hash .
153To set more than one current torrent, join their ids or hashes together in a list,
154such as "-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8.
155
156.It Fl u Fl -uplimit Ar limit
157Limit the global upload speed to
158.Ar limit
159kilobytes per second.
160.It Fl U Fl -no-uplimit
161Remove the global upload limit.
162
163.It Fl v Fl -verify
164Verify the current torrent(s)
165
166.It Fl V Fl -version
167Show version number and exit
168
169.It Fl w Fl -download-dir Ar directory
170Use
171.Ar directory
172as the default location for newly added torrents to download files to.
173
174.It Fl x Fl -pex
175Enable peer exchange (PEX).
176.It Fl X Fl -no-pex
177Disable peer exchange (PEX).
178
179.It Fl z Fl -peers
180List the current torrent's connected peers.
181In the `status' section of the list, the following shorthand is used:
182.D1 D: Downloading from this peer
183.D1 d: We would download from this peer if they would let us
184.D1 E: Encrypted connection
185.D1 I: Peer is an incoming connection
186.D1 K: Peer has unchoked us, but we're not interested
187.D1 O: Optimistic unchoked
188.D1 U: Uploading to peer
189.D1 u: We would upload to this peer if they asked
190.D1 X: Peer was discovered through Peer Exchange (PEX)
191.D1 ?: We unchoked this peer, but they're not interested
192
193.El
194.Sh EXAMPLES
195
196Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
197.Bd -literal -offset indent
198$ transmission-remote -d100 -u20
199$ transmission-remote --downlimit=100 --uplimit=20
200.Ed
201
202List all torrents' IDs and states:
203.Bd -literal -offset indent
204$ transmission-remote -l
205.Ed
206
207List all torrents from a remote session that requires authentication:
208.Bd -literal -offset indent
209$ transmission-remote host:9091 --auth=username:password -l
210.Ed
211
212Start all torrents:
213.Bd -literal -offset indent
214$ transmission-remote -tall --start
215.Ed
216
217Add two torrents:
218.Bd -literal -offset indent
219$ transmission-remote -a one.torrent two.torrent
220.Ed
221
222Add all torrents in ~/Desktop:
223.Bd -literal -offset indent
224$ transmission-remote -a ~/Desktop/*torrent
225.Ed
226
227Get detailed information on the torrent whose ID is '1':
228.Bd -literal -offset indent
229$ transmission-remote -t1 -i
230.Ed
231
232Get a list of a torrent's files:
233.Bd -literal -offset indent
234$ transmission-remote -t1 -l
235.Ed
236
237Download only its second and fourth files:
238.Bd -literal -offset indent
239$ transmission-remote -t1 -Gall -g2,4
240.Ed
241
242Set all torrents' first two files' priorities to high:
243.Bd -literal -offset indent
244$ transmission-remote -tall -ph1,2
245.Ed
246
247Set all torrents' files' priorities to normal:
248.Bd -literal -offset indent
249$ transmission-remote -tall -pnall
250.Ed
251
252.Sh AUTHORS
253.An -nosplit
254.An Charles Kerr ,
255.An Josh Elsasser ,
256.An Eric Petit ,
257and
258.An Mitchell Livingston .
259
260.Sh SEE ALSO
261.Xr transmissioncli 1 ,
262.Xr transmission-daemon 1 ,
263.Xr transmission 1
264
265.Pp
266http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.