1TRANSMISSION-REMOTE(1)    BSD General Commands Manual   TRANSMISSION-REMOTE(1)
2

NAME

4     transmission-remote — a remote control utility for transmission-daemon(1)
5     and transmission(1)
6

SYNOPSIS

8     transmission-remote [host:port | host | port] [-a filenames-or-URLs]
9                         [-as] [-AS] [-asd number] [-asu number] [-asc] [-ASC]
10                         [-b] [-c path | -C] [-d number | -D] [-e size]
11                         [-er | -ep | -et] [-f] [-g files] [-G files]
12                         [-gsr ratio] [-GSR] [-h] [-i] [-l] [-m | -M]
13                         [-n user:pass] [-N netrc] [-o | -O] [-p port] [-Bh]
14                         [-Bn] [-Bl] [-ph files] [-pl files] [-pn files]
15                         [-pr peers] [-r] [-R] [-s | -S] [-sr ratio] [-SR]
16                         [-srd] [-si] [-st] [-t all | id | hash] [-hl] [-HL]
17                         [-u number | -U] [-v] [-V] [-w download-dir]
18                         [-x | -X] [-y | -Y] [-pi]
19

DESCRIPTION

21     transmission-remote is a remote control utility for transmission(1) and
22     transmission-daemon(1).
23
24     By default, transmission-remote connects to the transmission session at
25     localhost:9091.  Other sessions can be controlled by specifying a differ‐
26     ent host and/or port.
27

OPTIONS

29     -a --add filenames-or-URLs
30             Add torrents to transmission.
31
32     -b --debug
33             Enable debugging mode.
34
35     -as --alt-speed
36             Use the alternate Limits.
37
38     -AS --no-alt-speed
39             Don't use the alternate Limits.
40
41     -asd --alt-speed-downlimit limit
42             Limit the alternate download speed to limit kilobytes per second.
43
44     -asu --alt-speed-uplimit limit
45             Limit the alternate upload speed to limit kilobytes per second.
46
47     -asc --alt-speed-scheduler
48             Use the scheduled on/off times.
49
50     -ASC --no-alt-speed-scheduler
51             Don't use the scheduled on/off days and times.
52
53     --alt-speed-time-begin time
54             Time to start using the alt speed limits (in hhmm).
55
56     --alt-speed-time-end time
57             Time to stop using the alt speed limits (in hhmm).
58
59     --alt-speed-days days
60             Set the number of days on which to enable the speed scheduler,
61             using a list such as "2,4-6".
62
63     --torrent-done-script filename
64             Specify a file to run each time a torrent finishes
65
66     --no-torrent-done-script
67             Don't run any script when a torrent finishes
68
69     -c --incomplete-dir dir
70             When adding new torrents, store their contents in directory until
71             the torrent is done.
72
73     -C --no-incomplete-dir
74             Don't store incomplete torrents in a different directory.
75
76     -d --downlimit limit
77             Limit the maximum download speed to limit KiB/s.  If current tor‐
78             rent(s) are selected this operates on them.  Otherwise, it
79             changes the global setting.
80
81     -D --no-downlimit
82             Disable download speed limits.  If current torrent(s) are
83             selected this operates on them.  Otherwise, it changes the global
84             setting.
85
86     -e --cache size
87             Set the session's maximum memory cache size in MiB.  This cache
88             is used to reduce disk IO.
89
90     -er --encryption-required
91             Encrypt all peer connections.
92
93     -ep --encryption-preferred
94             Prefer encrypted peer connections.
95
96     -et --encryption-tolerated
97             Prefer unencrypted peer connections.
98
99     -f --files
100             Get a file list for the current torrent(s)
101
102     -g --get all | file-index | files
103             Mark file(s) for download.  all marks all all of the torrent's
104             files for downloading, file-index adds a single file to the down‐
105             load list, and files adds multiple files to the download list,
106             such as "-g1,3-5" to add files #1, #3, #4, and #5 to the download
107             list.
108
109     -G --no-get all | file-index | files
110             Mark file(s) for not downloading.
111
112     -gsr --global-seedratio ratio
113             All torrents, unless overridden by a per-torrent setting, should
114             seed until a specific ratio
115
116     -GSR --no-global-seedratio
117             All torrents, unless overridden by a per-torrent setting, should
118             seed regardless of ratio
119
120     -h --help
121             Print command-line option descriptions.
122
123     -i --info id | torrent-hash
124             Show details of the current torrent(s)
125
126     -si --session-info
127             List session information from the server
128
129     -st --session-stats
130             List statistical information from the server
131
132     -l --list
133             List all torrents
134
135     -m --portmap
136             Enable portmapping via NAT-PMP or UPnP
137
138     -M --no-portmap
139             Disable portmapping
140
141     -n --auth username:password
142             Set the username and password for authentication
143
144     -N --netrc filename
145             Set the authentication information from a netrc file. See
146             netrc(5) for more information.
147
148     -o --dht
149             Enable distributed hash table (DHT).
150
151     -O --no-dht
152             Disable distribued hash table (DHT).
153
154     -p --port port
155             Set the port for use when listening for incoming peer connections
156
157     -Bh --bandwidth-high
158             Give this torrent first chance at available bandwidth
159
160     -Bn --bandwidth-normal
161             Give this torrent the bandwidth left over by high priority tor‐
162             rents
163
164     -Bl --bandwidth-low
165             Give this torrent the bandwidth left over by high and normal pri‐
166             ority torrents
167
168     -ph --priority-high all | file-index | files
169             Try to download the specified file(s) first.  all marks all of
170             the torrent's files as normal priority, file-index sets a single
171             file's priority as normal, and files sets multiple files' priori‐
172             ties as normal, such as "-pn1,3-5" to normalize files #1, #3, #4,
173             and #5.
174
175     -pn --priority-normal all | file-index | files
176             Try to download the specified files normally.
177
178     -pl --priority-low all | file-index | files
179             Try to download the specified files last
180
181     -pr --peers number
182             Set the maximum number of peers.  If current torrent(s) are
183             selected this operates on them.  Otherwise, it changes the global
184             setting.
185
186     -r --remove
187             Remove the current torrent(s).  This does not delete the down‐
188             loaded data.
189
190     --remove-and-delete
191             Remove the current torrent(s) and delete their downloaded data.
192
193     --move  Move the current torrents' data from their current locations to
194             the specified directory.
195
196     --find  Tell Transmission where to look for the current torrents' data.
197
198     -sr --seedratio ratio
199             Let the current torrent(s) seed until a specific ratio
200
201     -SR --no-seedratio
202             Let the current torrent(s) seed regardless of ratio
203
204     -srd --seedratio-default
205             Let the current torrent(s) use the global seedratio settings
206
207     -ta --tracker-add tracker
208             Add a tracker to a torrent
209
210     -ta --tracker-remove trackerId
211             Remove a tracker from a torrent
212
213     -s --start
214             Start the current torrent(s)
215
216     -S --stop
217             Stop the current torrent(s) from downloading or seeding
218
219     --start-paused
220             Start added torrents paused
221
222     --no-start-paused
223             Start added torrents unpaused
224
225     -t --torrent all | id | torrent-hash
226             Set the current torrent(s) for use by subsequent options.  all
227             will apply following requests to all torrents, while specific
228             torrents can be chosen by id or hash.  To set more than one cur‐
229             rent torrent, join their ids together in a list, such as
230             "-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7,
231             and 8.
232
233     --trash-torrent
234             Delete torrents after adding
235
236     --no-trash-torrent
237             Do not delete torrents after adding
238
239     -hl --honor-session
240             Make the current torrent(s) honor the session limits.
241
242     -HL --no-honor-session
243             Make the current torrent(s) not honor the session limits.
244
245     -u --uplimit limit
246             Limit the maximum upload speed to limit KiB/s.  If current tor‐
247             rent(s) are selected this operates on them.  Otherwise, it
248             changes the global setting.
249
250     -U --no-uplimit
251             Disable upload speed limits.  If current torrent(s) are selected
252             this operates on them.  Otherwise, it changes the global setting.
253
254     -v --verify
255             Verify the current torrent(s)
256
257     -V --version
258             Show version number and exit
259
260     -w --download-dir directory
261             Use directory as the default location for newly added torrents to
262             download files to.
263
264     -x --pex
265             Enable peer exchange (PEX).
266
267     -X --no-pex
268             Disable peer exchange (PEX).
269
270     -y --lds
271             Enable local peer discovery (LPD).
272
273     -Y --no-lds
274             Disable local peer discovery (LPD).
275
276     -pi --peer-info
277             List the current torrent's connected peers.  In the `status' sec‐
278             tion of the list, the following shorthand is used:
279                   D: Downloading from this peer
280                   d: We would download from this peer if they would let us
281                   E: Encrypted connection
282                   I: Peer is an incoming connection
283                   K: Peer has unchoked us, but we're not interested
284                   O: Optimistic unchoked
285                   U: Uploading to peer
286                   u: We would upload to this peer if they asked
287                   X: Peer was discovered through Peer Exchange (PEX)
288                   ?: We unchoked this peer, but they're not interested
289

EXAMPLES

291     Set download and upload limits to 400 KiB/sec and 60 KiB/sec:
292
293           $ transmission-remote -d400 -u60
294           $ transmission-remote --downlimit=400 --uplimit=60
295     Set alternate download and upload limits to 100 KiB/sec and 20 KiB/sec:
296
297           $ transmission-remote -asd100 -asu20
298           $ transmission-remote --alt-speed-downlimit=100 --alt-speed-uplimit=20
299     Set the scheduler to use the alternate speed limits on weekdays between
300     10AM and 11PM
301
302           $ transmission-remote --alt-speed-time-begin=1000
303           $ transmission-remote --alt-speed-time-end=2300
304           $ transmission-remote --alt-speed-days=1-5
305           $ transmission-remote --alt-speed-scheduler
306     List all torrents' IDs and states:
307
308           $ transmission-remote -l
309     List all torrents from a remote session that requires authentication:
310
311           $ transmission-remote host:9091 --auth=username:password -l
312     Start all torrents:
313
314           $ transmission-remote -tall --start
315     Add two torrents:
316
317           $ transmission-remote -a one.torrent two.torrent
318     Add all torrents in ~/Desktop:
319
320           $ transmission-remote -a ~/Desktop/*torrent
321     Get detailed information on the torrent whose ID is '1':
322
323           $ transmission-remote -t1 -i
324     Get a list of a torrent's files:
325
326           $ transmission-remote -t1 -f
327     Download only its second and fourth files:
328
329           $ transmission-remote -t1 -Gall -g2,4
330     Set all torrents' first two files' priorities to high:
331
332           $ transmission-remote -tall -ph1,2
333     Set all torrents' files' priorities to normal:
334
335           $ transmission-remote -tall -pnall
336

AUTHORS

338     Charles Kerr, Josh Elsasser, Eric Petit, and Mitchell Livingston.
339

SEE ALSO

341     transmission-create(1), transmission-daemon(1), transmission-edit(1),
342     transmission-gtk(1), transmission-qt(1), transmission-remote(1),
343     transmission-show(1)
344
345     http://www.transmissionbt.com/
346
347BSD                              July 21, 2008                             BSD
Impressum