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

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

(daemon) let file download flags and priorities be set by transmission-remote. Add examples to the man page and --help.
(libT) minor tweaks to tr-getopt
(gtk) tweak the preference dialog's "port forwarding" text for clarity as suggested in the forums

  • Property svn:keywords set to Date Rev Author Id
File size: 4.3 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 e Ar mode
19.Op Fl f
20.Op Fl g Ar files
21.Op Fl G Ar files
22.Op Fl h
23.Op Fl i
24.Op Fl l
25.Op Fl m
26.Op Fl M
27.Op Fl n Ar user:pass
28.Op Fl p Ar port
29.Op Fl ph Ar files
30.Op Fl pl Ar files
31.Op Fl pn Ar files
32.Op Fl r
33.Op Fl s
34.Op Fl S
35.Op Fl t Ar all | Ar id | Ar hash
36.Op Fl u Ar number
37.Op Fl U
38.Op Fl v
39.Op Fl w Ar download-dir
40.Op Fl x
41.Op Fl X
42.Ek
43.Sh DESCRIPTION
44.Nm
45is a remote control utility for
46.Xr transmission 1
47and
48.Xr transmission-daemon 1 .
49.Pp
50By default,
51.Nm
52connects to the transmission session at localhost:9091.
53Other sessions can be controlled by specifying a different host and/or port.
54.Pp
55The options are as follows:
56.Bl -tag -width Ds
57.It Fl a Fl -add Ar torrent-file
58Add metainfo
59.Ar torrent-file(s) .
60
61.It Fl b Fl -debug
62Enable debugging mode.
63
64.It Fl d Fl -downlimit Ar limit
65Limit the download speed to
66.Ar limit
67kilobytes per second.
68
69.It Fl D Fl -no-downlimit
70Remove the download limit.
71
72.It Fl e Fl -encryption Ar required
73Require all peer connections to be encrypted.
74.It Fl e Fl -encryption Ar preferred
75Prefer encrypted peer connections.
76.It Fl e Fl -encryption Ar tolerated
77Prefer unencrypted peer connections.
78
79.It Fl f Fl -files
80Get a file list for the current torrent(s)
81
82.It Fl g Fl -get Ar files
83Mark file(s) for download.
84.Ar files
85can be a file index, or a comma-separated list of file indices, or the literal
86.Ar all
87for all files in the torrent.
88
89.It Fl g Fl -no-get Ar 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 user:pass
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 ph Fl -priority-high Ar files
118Mark
119.Ar files
120as high priority.
121.Ar files
122can be a file index, or a comma-separated list of file indices, or the literal
123.Ar all
124for all files in the torrent.
125
126.It Fl pl Fl -priority-low Ar files
127Mark
128.Ar files
129as low priority
130
131.It Fl pn Fl -priority-normal Ar files
132Mark
133.Ar files
134as normal priority
135
136.It Fl r Fl -remove
137Remove the current torrent(s).  This does not delete the downloaded data.
138
139.It Fl s Fl -start
140Start the current torrent(s)
141
142.It Fl S Fl -stop
143Stop the current torrent(s) from downloading or seeding
144
145.It Fl t Fl -torrent Ar all | id | torrent-hash
146Set the current torrent(s) for use by subsequent options.
147.Ar all
148will apply following requests to all torrents, while specific torrents can be chosen by
149.Ar id
150or
151.Ar hash .
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
169Enable peer exchange (PEX).
170.It Fl X
171Disable peer exchange (PEX).
172
173.El
174.Sh EXAMPLES
175
176List all torrents:
177.Pp
178.Dl $ transmission-remote -l
179.Pp
180
181Start all torrents:
182.Pp
183.Dl $ transmission-remote -tall --start
184.Pp
185
186Get detailed information on the torrent whose ID is '1':
187.Pp
188.Dl $ transmission-remote -t1 -i
189.Pp
190
191Only download the second, fourth, and sixth files of the torrent whose ID is '1':
192.Pp
193.Dl $ transmission-remote -t1 -Gall -g2,4,6
194.Pp
195
196Set all torrents' first two files' priorities to high:
197.Pp
198.Dl $ transmission-remote -t1 -ph1,2
199.Pp
200
201Set all torrents' files' priorities to normal:
202.Pp
203.Dl $ transmission-remote -tall -pnall
204.Pp
205
206Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
207.Pp
208.Dl $ transmission-remote -d 100 -u 20
209.Dl $ transmission-remote -d=100 -u=20
210.Pp
211
212Add two torrents:
213.Pp
214.Dl $ transmission-remote -a one.torrent two.torrent
215.Pp
216
217.Sh AUTHORS
218.An -nosplit
219.An Charles Kerr ,
220.An Josh Elsasser ,
221.An Eric Petit ,
222and
223.An Mitchell Livingston .
224
225.Sh SEE ALSO
226.Xr transmissioncli 1 ,
227.Xr transmission-daemon 1 ,
228.Xr transmission 1
229
230.Pp
231http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.