transmission-cli(1)

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

NAME

4     transmission-cli — a bittorrent client
5

SYNOPSIS

7     transmission-cli -h
8     transmission-cli [-b | -B] [-d number | -D] [-er | -ep | -et] [-f script]
9                      [-g directory] [-h] [-m | -M] [-p port] [--tos tos]
10                      [-u number | -U] [-v] [-w directory] torrent-file
11

DESCRIPTION

13     The transmission-cli program is a lightweight, command-line BitTorrent
14     client with scripting capabilities.
15
16     The options are as follows:
17
18     -b --blocklist
19             Enable peer blocklists. Transmission understands the bluetack
20             blocklist file format.  New blocklists can be added by copying
21             them into the config-dir's "blocklists" subdirectory.
22
23     -B --no-blocklist
24             Disable blocklists.
25
26     -d --downlimit number
27             Set the maximum download speed in KB/s
28
29     -D --no-downlimit
30             Don't limit the download speed
31
32     -er --encryption-required
33             Encrypt all peer connections.
34
35     -ep --encryption-preferred
36             Prefer encrypted peer connections.
37
38     -et --encryption-tolerated
39             Prefer unencrypted peer connections.
40
41     -f --finish script
42             Set a script to run when the torrent finishes
43
44     -g --config-dir directory
45             Where to look for configuration files. This can be used to swap
46             between using the cli, daemon, gtk, and qt clients.  See
47             https://github.com/transmission/transmission/blob/main/docs/Con‐
48             figuration-Files.md for more information.
49
50     -h --help
51             Prints a short usage summary.
52
53     -m --portmap
54             Enable portmapping via NAT-PMP or UPnP
55
56     -M --no-portmap
57             Disable portmapping
58
59     -p --port port
60             Set the port to listen for incoming peers. (Default: 51413)
61
62     --tos tos
63             Use a ToS or DSCP name to set the peer socket service type for
64             local router-based traffic shaping. Valid values are a decimal
65             value 0-255, or any of these DSCP strings:
66
67             “af11”, “af12”, “af13”, “af21”, “af22”, “af23”, “af31”, “af32”,
68             “af33”, “af41”, “af42”, “af43”, “cs0”, “cs1”, “cs2”, “cs3”,
69             “cs4”, “cs5”, “cs6”, “cs7”, “ef”, “le” These ToS keys are depre‐
70             cated and will be removed in the future: “default”, “lowcost”,
71             “lowdelay,” “reliability”, “throughput”
72
73     -u --uplimit number
74             Set the maximum upload speed in KB/s
75
76     -U --no-uplimit
77             Don't limit the upload speed
78
79     -v --verify
80             Verify the torrent's downloaded data.
81
82     -w --download-dir directory
83             Where to save downloaded data.
84

SIGNALS

86     In addition to these options, sending transmission-cli a SIGHUP signal
87     will contact the tracker for more peers.
88

ENVIRONMENT

90     TRANSMISSION_HOME
91                 Sets the default config-dir.
92
93     http_proxy  libcurl uses this environment variable when performing
94                 tracker announces.
95

FILES

97     ~/.config/transmission
98             Directory where transmission-cli keeps torrent information for
99             future seeding and resume operations.
100

AUTHORS

102     The transmission-cli program was written by Eric Petit, Josh Elsasser,
103     Charles Kerr, Mitchell Livingston, and Mike Gelfand.
104