1TRANSMISSION-REMOTE(1) BSD General Commands Manual TRANSMISSION-REMOTE(1)
2
4 transmission-remote — a remote control utility for transmission-daemon(1)
5 and transmission(1)
6
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] [-F filter]
12 [-g files] [-G files] [-gsr ratio] [-GSR] [-h] [-i]
13 [-ic] [-ids] [-if] [-ip] [-it] [-j] [-l] [-m | -M]
14 [-n user:pass] [-ne] [-N netrc] [-o | -O] [-p port]
15 [-Bh] [-Bn] [-Bl] [-ph files] [-pl files] [-pn files]
16 [-pr peers] [-r] [-rad] [-s | -S] [-sr ratio] [-SR]
17 [-srd] [-si] [-st] [-t all | active | id | hash]
18 [-hl] [-HL] [-u number | -U] [-utp | -no-utp] [-v]
19 [-V] [-w download-dir] [-x | -X] [-y | -Y] [-pi]
20
22 transmission-remote is a remote control utility for transmission(1) and
23 transmission-daemon(1).
24 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
30 -a --add filenames-or-URLs
31 Add torrents to transmission.
32 -b --debug
34 Enable debugging mode.
35 -as --alt-speed
37 Use the alternate Limits.
38 -AS --no-alt-speed
40 Don't use the alternate Limits.
41 -asd --alt-speed-downlimit limit
43 Limit the alternate download speed to limit kilobytes per second.
44 -asu --alt-speed-uplimit limit
46 Limit the alternate upload speed to limit kilobytes per second.
47 -asc --alt-speed-scheduler
49 Use the scheduled on/off times.
50 -ASC --no-alt-speed-scheduler
52 Don't use the scheduled on/off days and times.
53 --alt-speed-time-begin time
55 Time to start using the alt speed limits (in hhmm).
56 --alt-speed-time-end time
58 Time to stop using the alt speed limits (in hhmm).
59 --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 --torrent-done-script filename
65 Specify a file to run each time a torrent finishes
66 --no-torrent-done-script
68 Don't run any script when a torrent finishes
69 -c --incomplete-dir dir
71 When adding new torrents, store their contents in directory until
72 the torrent is done.
73 -C --no-incomplete-dir
75 Don't store incomplete torrents in a different directory.
76 -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 -D --no-downlimit
83 Disable download speed limits. If current torrent(s) are se‐
84 lected this operates on them. Otherwise, it changes the global
85 setting.
86 -e --cache size
88 Set the session's maximum memory cache size in MiB. This cache is
89 used to reduce disk IO.
90 -er --encryption-required
92 Encrypt all peer connections.
93 -ep --encryption-preferred
95 Prefer encrypted peer connections.
96 -et --encryption-tolerated
98 Prefer unencrypted peer connections.
99 --exit Tell the Transmission to initiate a shutdown.
101 -f --files
103 Get a file list for the current torrent(s)
104 -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 -F --filter filter
113 Filter selected torrents. Further commands will use only torrents
114 that satisfy the filter condition.
115 i - currently idle
116 u - currently uploading
117 d - currently downloading
118 n:str - torrent name includes str
119 l:label - has label
120 r:ratio - Minimum upload ratio
121 w - Have some unwanted files
122 Prefixing the filter by "~" negates the filter. -F may be speci‐
123 fied more than once, and may be preceded by -t. Only torrents
124 that satisfy all the conditions are selected.
125 -G --no-get all | file-index | files
127 Mark file(s) for not downloading.
128 -gsr --global-seedratio ratio
130 All torrents, unless overridden by a per-torrent setting, should
131 seed until a specific ratio
132 -GSR --no-global-seedratio
134 All torrents, unless overridden by a per-torrent setting, should
135 seed regardless of ratio
136 -h --help
138 Print command-line option descriptions.
139 -i --info
141 Show details of the current torrent(s)
142 -if --info-files
144 List the specified torrent's files
145 -ip --info-peers
147 List the specified torrent's peers
148 -ic --info-pieces
150 List the specified torrent's pieces
151 -it --info-trackers
153 List the specified torrent's trackers
154 -j --json
156 Return the RPC response as JSON
157 -si --session-info
159 List session information from the server
160 -st --session-stats
162 List statistical information from the server
163 -l --list
165 List all torrents
166 -ids --print-ids
168 Print a list of the specified torrent's ids in a format suitable
169 as a parameter for -t
170 -L --labels label1[,label2[,...]]
172 Set the specified torrent's labels
173 -m --portmap
175 Enable portmapping via NAT-PMP or UPnP
176 -M --no-portmap
178 Disable portmapping
179 -n --auth username:password
181 Set the username and password for authentication
182 -ne --authenv
184 Set the authentication information from the TR_AUTH environment
185 variable which must be formatted as username:password.
186 -N --netrc filename
188 Set the authentication information from a netrc file. See
189 netrc(5) for more information.
190 -o --dht
192 Enable distributed hash table (DHT).
193 -O --no-dht
195 Disable distributed hash table (DHT).
196 -p --port port
198 Set the port for use when listening for incoming peer connections
199 -Bh --bandwidth-high
201 Give this torrent first chance at available bandwidth
202 -Bn --bandwidth-normal
204 Give this torrent the bandwidth left over by high priority tor‐
205 rents
206 -Bl --bandwidth-low
208 Give this torrent the bandwidth left over by high and normal pri‐
209 ority torrents
210 -ph --priority-high all | file-index | files
212 Try to download the specified file(s) first. all marks all of
213 the torrent's files as normal priority, file-index sets a single
214 file's priority as normal, and files sets multiple files' priori‐
215 ties as normal, such as "-pn1,3-5" to normalize files #1, #3, #4,
216 and #5.
217 -pn --priority-normal all | file-index | files
219 Try to download the specified files normally.
220 -pl --priority-low all | file-index | files
222 Try to download the specified files last
223 -pr --peers number
225 Set the maximum number of peers. If current torrent(s) are se‐
226 lected this operates on them. Otherwise, it changes the global
227 setting.
228 -r --remove
230 Remove the current torrent(s). This does not delete the down‐
231 loaded data.
232 -rad --remove-and-delete
234 Remove the current torrent(s) and delete their downloaded data.
235 --reannounce
237 Reannounce the current torrent(s). This is the same as the GUI's
238 "ask tracker for more peers" button.
239 --move Move the current torrents' data from their current locations to
241 the specified directory.
242 --rename newname
244 Rename files or root folder of a torrent
245 --path oldname
247 Provide original path for the rename command
248 --unix-socket
250 Connect using a Unix domain socket.
251 --find Tell Transmission where to look for the current torrents' data.
253 -sr --seedratio ratio
255 Let the current torrent(s) seed until a specific ratio
256 -SR --no-seedratio
258 Let the current torrent(s) seed regardless of ratio
259 -srd --seedratio-default
261 Let the current torrent(s) use the global seedratio settings
262 -td --tracker-add tracker
264 Add a tracker to a torrent
265 -tr --tracker-remove trackerId
267 Remove a tracker from a torrent
268 -s --start
270 Start the current torrent(s)
271 -S --stop
273 Stop the current torrent(s) from downloading or seeding
274 --start-paused
276 Start added torrents paused
277 --no-start-paused
279 Start added torrents unpaused
280 -t --torrent all | active | id | torrent-hash
282 Set the current torrent(s) for use by subsequent options. The
283 literal all will apply following requests to all torrents; the
284 literal active will apply following requests to recently-active
285 torrents; and specific torrents can be chosen by id or hash. To
286 set more than one current torrent, join their ids together in a
287 list, such as "-t2,4,6-8" to operate on the torrents whose IDs
288 are 2, 4, 6, 7, and 8.
289 --trash-torrent
291 Delete torrents after adding
292 --no-trash-torrent
294 Do not delete torrents after adding
295 -hl --honor-session
297 Make the current torrent(s) honor the session limits.
298 -HL --no-honor-session
300 Make the current torrent(s) not honor the session limits.
301 -u --uplimit limit
303 Limit the maximum upload speed to limit kB/s. If current tor‐
304 rent(s) are selected this operates on them. Otherwise, it changes
305 the global setting.
306 -U --no-uplimit
308 Disable upload speed limits.
309 --utp Enable uTP for peer connections.
311 --no-utp
313 Disable uTP for peer connections. If current torrent(s) are se‐
314 lected this operates on them. Otherwise, it changes the global
315 setting.
316 -v --verify
318 Verify the current torrent(s)
319 -V --version
321 Show version number and exit
322 -w --download-dir directory
324 When used in conjunction with --add, set the new torrent's down‐
325 load folder. Otherwise, set the default download folder.
326 -x --pex
328 Enable peer exchange (PEX).
329 -X --no-pex
331 Disable peer exchange (PEX).
332 -y --lds
334 Enable local peer discovery (LPD).
335 -Y --no-lds
337 Disable local peer discovery (LPD).
338 -pi --peer-info
340 List the current torrent's connected peers. In the `status' sec‐
341 tion of the list, the following shorthand is used:
342 D: Downloading from this peer
343 d: We would download from this peer if they would let us
344 E: Encrypted connection
345 H: Peer was found through DHT
346 I: Peer is an incoming connection
347 K: Peer has unchoked us, but we're not interested
348 O: Optimistic unchoked
349 T: Peer is connected over uTP
350 U: Uploading to peer
351 u: We would upload to this peer if they asked
352 X: Peer was discovered through Peer Exchange (PEX)
353 ?: We unchoked this peer, but they're not interested
354 --blocklist-update
356 Update blocklist from URL specified in remote client's settings
357 with blocklist-url key.
358
360 List all torrents:
361 $ transmission-remote -l
363 List all active torrents:
364 $ transmission-remote -tactive -l
366 List all torrents with label "abc":
367 $ transmission-remote -F l:abc -l
369 List all torrents with name containing "def" or with label "abc":
370 $ transmission-remote -t $( transmission-remote -F n:def -ids )$( transmission-remote -F l:abc -ids ) -l
372 Rename torrent root folder from "test1/examplefile.txt" to "test2/exam‐
373 plefile.txt"
374 $ transmission-remote -t1 --path test1 --rename test2
376 Set download and upload limits to 400 kB/sec and 60 kB/sec:
377 $ transmission-remote -d400 -u60
379 $ transmission-remote --downlimit=400 --uplimit=60
380 Set alternate download and upload limits to 100 kB/sec and 20 kB/sec:
381 $ transmission-remote -asd100 -asu20
383 $ transmission-remote --alt-speed-downlimit=100 --alt-speed-uplimit=20
384 Set the scheduler to use the alternate speed limits on weekdays between
385 10AM and 11PM
386 $ transmission-remote --alt-speed-time-begin=1000
388 $ transmission-remote --alt-speed-time-end=2300
389 $ transmission-remote --alt-speed-days=1-5
390 $ transmission-remote --alt-speed-scheduler
391 List all torrents' IDs and states:
392 $ transmission-remote -l
394 List all torrents from a remote session that requires authentication:
395 $ transmission-remote host:9091 --auth=username:password -l
397 Start all torrents:
398 $ transmission-remote -tall --start
400 Add two torrents:
401 $ transmission-remote -a one.torrent two.torrent
403 Add all torrents in ~/Desktop:
404 $ transmission-remote -a ~/Desktop/*torrent
406 Get detailed information on the torrent whose ID is '1':
407 $ transmission-remote -t1 -i
409 Get a list of a torrent's files:
410 $ transmission-remote -t1 -f
412 Download only its second and fourth files:
413 $ transmission-remote -t1 -Gall -g2,4
415 Set all torrents' first two files' priorities to high:
416 $ transmission-remote -tall -ph1,2
418 Set all torrents' files' priorities to normal:
419 $ transmission-remote -tall -pnall
421
423 http_proxy Sets the proxy to use for http tracker announces.
424
426 Charles Kerr, Josh Elsasser, Eric Petit, Mitchell Livingston, and Mike
427 Gelfand.
428
430 transmission-create(1), transmission-daemon(1), transmission-edit(1),
431 transmission-gtk(1), transmission-qt(1), transmission-remote(1),
432 transmission-show(1)
433 https://transmissionbt.com/
435BSD July 21, 2008 BSD