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

Last change on this file since 6376 was 6376, checked in by charles, 14 years ago

add more rpc unit tests. man page cleanups.

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