transmission-remote(1)

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] [--exit] [-f] [-g files] [-G files]
12                         [-gsr ratio] [-GSR] [-h] [-i] [-ic] [-if] [-ip] [-it]
13                         [-l] [-m | -M] [-n user:pass] [-ne] [-N netrc]
14                         [-o | -O] [-p port] [-Bh] [-Bn] [-Bl] [-ph files]
15                         [-pl files] [-pn files] [-pr peers] [-r] [-rad]
16                         [-s | -S] [-sr ratio] [-SR] [-srd] [-si] [-st]
17                         [-t all | active | id | hash] [-hl] [-HL]
18                         [-u number | -U] [-utp | -no-utp] [-v] [-V]
19                         [-w download-dir] [-x | -X] [-y | -Y] [-pi]
20

DESCRIPTION

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

OPTIONS

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

EXAMPLES

327     List all torrents:
328
329           $ transmission-remote -l
330     List all active torrents:
331
332           $ transmission-remote -tactive -l
333     Set download and upload limits to 400 kB/sec and 60 kB/sec:
334
335           $ transmission-remote -d400 -u60
336           $ transmission-remote --downlimit=400 --uplimit=60
337     Set alternate download and upload limits to 100 kB/sec and 20 kB/sec:
338
339           $ transmission-remote -asd100 -asu20
340           $ transmission-remote --alt-speed-downlimit=100 --alt-speed-uplimit=20
341     Set the scheduler to use the alternate speed limits on weekdays between
342     10AM and 11PM
343
344           $ transmission-remote --alt-speed-time-begin=1000
345           $ transmission-remote --alt-speed-time-end=2300
346           $ transmission-remote --alt-speed-days=1-5
347           $ transmission-remote --alt-speed-scheduler
348     List all torrents' IDs and states:
349
350           $ transmission-remote -l
351     List all torrents from a remote session that requires authentication:
352
353           $ transmission-remote host:9091 --auth=username:password -l
354     Start all torrents:
355
356           $ transmission-remote -tall --start
357     Add two torrents:
358
359           $ transmission-remote -a one.torrent two.torrent
360     Add all torrents in ~/Desktop:
361
362           $ transmission-remote -a ~/Desktop/*torrent
363     Get detailed information on the torrent whose ID is '1':
364
365           $ transmission-remote -t1 -i
366     Get a list of a torrent's files:
367
368           $ transmission-remote -t1 -f
369     Download only its second and fourth files:
370
371           $ transmission-remote -t1 -Gall -g2,4
372     Set all torrents' first two files' priorities to high:
373
374           $ transmission-remote -tall -ph1,2
375     Set all torrents' files' priorities to normal:
376
377           $ transmission-remote -tall -pnall
378

ENVIRONMENT

380     http_proxy  Sets the proxy to use for http tracker announces.
381

AUTHORS

383     Jordan Lee, Josh Elsasser, Eric Petit, and Mitchell Livingston.
384