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

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

(daemon) more cleanup work on remote's help and manpage

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