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

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

(trunk daemon) mention --session in the transmission-remote manpage

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