1
.\" $Id: transmission-remote.1 6180 2008-06-13 21:01:31Z charles $
3
.\" Copyright (c) 2007 Joshua Elsasser
5
.\" Permission is hereby granted, free of charge, to any person obtaining a
6
.\" copy of this software and associated documentation files (the "Software"),
7
.\" to deal in the Software without restriction, including without limitation
8
.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
9
.\" and/or sell copies of the Software, and to permit persons to whom the
10
.\" Software is furnished to do so, subject to the following conditions:
12
.\" The above copyright notice and this permission notice shall be included in
13
.\" all copies or substantial portions of the Software.
15
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
.\" AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21
.\" DEALINGS IN THE SOFTWARE.
24
2
.Dt TRANSMISSION-REMOTE 1
34
.Nm transmission-remote
38
.Fl t Ar daemon | Ar gtk
40
.Op Fl a Ar torrent-file
41
.Op Fl d Ar download-rate
53
.Fl r Ar all | Ar info-hash
56
.Fl s Ar all | Ar info-hash
59
.Fl S Ar all | Ar info-hash
61
.Op Fl u Ar upload-rate
63
.Op Ar torrent-file ...
66
.Op Fl a Ar torrent-file
67
.Op Fl d Ar download-rate
79
.Fl r Ar all | Ar info-hash
82
.Fl s Ar all | Ar info-hash
85
.Fl S Ar all | Ar info-hash
87
.Op Fl u Ar upload-rate
13
.Op Ar host:port | host | port
14
.Op Fl a Ar torrent-files
16
.Op Fl d Ar number | Fl D
32
.Op Fl t Ar all | Ar id | Ar hash
33
.Op Fl u Ar number | Fl U
35
.Op Fl w Ar download-dir
95
program is a remote control utility for
96
.Xr transmission-daemon 1
40
is a remote control utility for
43
.Xr transmission-daemon 1 .
100
The options are as follows:
47
connects to the transmission session at localhost:9091.
48
Other sessions can be controlled by specifying a different host and/or port.
101
51
.Bl -tag -width Ds
102
.It Fl a Fl -add Ar torrent-file
103
Add the torrent metainfo file
105
.It Fl d Fl -download-limit Ar download-rate
106
Set maximum download rate to
108
in kilobytes per second.
109
.It Fl D Fl -download-unlimited
52
.It Fl a Fl -add Ar torrent-file(s)
58
Enable debugging mode.
60
.It Fl d Fl -downlimit Ar limit
61
Limit the download speed to
65
.It Fl D Fl -no-downlimit
110
66
Remove the download limit.
112
Enable peer exchange.
114
Disable peer exchange.
115
.It Fl f Fl -folder Ar directory
118
as the default location for newly added torrents to download files to.
119
.It Fl g, Fl -config-dir Ar directory
120
Where to look for configuration files.
68
.It Fl er Fl -encryption-required
69
Encrypt all peer connections.
70
.It Fl ep Fl -encryption-preferred
71
Prefer encrypted peer connections.
72
.It Fl et Fl -encryption-tolerated
73
Prefer unencrypted peer connections.
76
Get a file list for the current torrent(s)
78
.It Fl g Fl -get Ar all | file-index | files
79
Mark file(s) for download.
81
marks all all of the torrent's files for downloading,
83
adds a single file to the download list, and
85
adds multiple files to the download list,
86
such as "-g1,3-5" to add files #1, #3, #4, and #5 to the download list.
88
.It Fl G Fl -no-get Ar all | file-index | files
89
Mark file(s) for not downloading.
122
92
Print command-line option descriptions.
124
Print a listing of all torrent info hashes and names.
94
.It Fl i Fl -info Ar id | torrent-hash
95
Show details of the current torrent(s)
126
Print a listing of all torrent names with size and current status.
127
.It Fl m Fl -port-mapping
128
Enable automatic port mapping via NAT-PMP or UPnP IGD.
129
.It Fl M Fl -no-port-mapping
130
Disable automatic port mapping.
101
Enable portmapping via NAT-PMP or UPnP
102
.It Fl M Fl -no-portmap
105
.It Fl n Fl -auth Ar username:password
131
112
.It Fl p Fl -port Ar port
134
for use as a listening port to accept incoming peer connections.
136
Quit the running instance.
137
.It Fl r Fl -remove Ar all | info-hash
138
Remove all torrents, or the torrent with an info hash of
140
Neither the downloaded data nor the original torrent metainfo file
142
.It Fl S Fl -stop Ar all | info-hash
143
Stop all torrents from downloading or seeding, or the torrent with an
146
.It Fl s Fl -start Ar all | info-hash
147
Start all torrents downloading or seeding, or the torrent with an info
150
.It Fl t Fl -type Ar daemon | gtk
152
.Xr transmission-daemon 1
115
for use when listening for incoming peer connections
117
.It Fl pn Fl -priority-normal Ar all | file-index | files
118
Mark file(s) as normal priority.
120
marks all of the torrent's files as normal priority,
122
sets a single file's priority as normal, and
124
sets multiple files' priorities as normal,
125
such as "-pn1,3-5" to normalize files #1, #3, #4, and #5.
127
.It Fl ph Fl -priority-high Ar all | file-index | files
128
Mark file(s) as high priority.
130
.It Fl pl Fl -priority-low Ar all | file-index | files
131
Mark file(s) as low priority.
134
Remove the current torrent(s). This does not delete the downloaded data.
137
Start the current torrent(s)
140
Stop the current torrent(s) from downloading or seeding
142
.It Fl t Fl -torrent Ar all | id | torrent-hash
143
Set the current torrent(s) for use by subsequent options.
145
will apply following requests to all torrents, while specific torrents can be chosen by
155
.It Fl u Fl -upload-limit Ar upload-rate
156
Set maximum upload rate to
158
in kilobytes per second.
159
.It Fl U Fl -upload-unlimited
149
To set more than one current torrent, join their ids or hashes together in a list,
150
such as "-t2,4,6-8" to operate on the torrents whose IDs are 2, 4, 6, 7, and 8.
152
.It Fl u Fl -uplimit Ar limit
153
Limit the upload speed to
155
kilobytes per second.
156
.It Fl U Fl -no-uplimit
160
157
Remove the upload limit.
162
Proxy the connection to
163
.Xr transmission-daemon 1
160
Verify the current torrent(s)
162
.It Fl w Fl -download-dir Ar directory
165
as the default location for newly added torrents to download files to.
168
Enable peer exchange (PEX).
170
Disable peer exchange (PEX).
170
.Pa ~/.config/transmission
172
Show status for all torrents:
174
.Dl transmission-remote -l
178
.Dl transmission-remote -S ca6ac4bbd971d3902935dbcfc2d3ea25b428a547
180
175
Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
182
.Dl transmission-remote -d 100 -u 20
184
Quit the GTK+ frontend:
186
.Dl transmission-remote -t gtk -q
176
.Bd -literal -offset indent
177
$ transmission-remote -d100 -u20
178
$ transmission-remote --downlimit=100 --uplimit=20
181
List all torrents' IDs and states:
182
.Bd -literal -offset indent
183
$ transmission-remote -l
186
List all torrents from a remote session that requires authentication:
187
.Bd -literal -offset indent
188
$ transmission-remote host:9091 --auth=username:password -l
192
.Bd -literal -offset indent
193
$ transmission-remote -tall --start
188
196
Add two torrents:
190
.Dl transmission-remote foo.torrent bar.torrent
192
Show the info hashes of all the torrents on jade:
194
.Dl transmission-remote -x -i ssh jade transmission-proxy
197
.Bd -literal -offset indent
198
$ transmission-remote -a one.torrent two.torrent
201
Add all torrents in ~/Desktop:
202
.Bd -literal -offset indent
203
$ transmission-remote -a ~/Desktop/*torrent
206
Get detailed information on the torrent whose ID is '1':
207
.Bd -literal -offset indent
208
$ transmission-remote -t1 -i"
211
Get a list of a torrent's files:
212
.Bd -literal -offset indent
213
$ transmission-remote -t1 -l"
216
Download only its second and fourth files:
217
.Bd -literal -offset indent
218
$ transmission-remote -t1 -Gall -g2,4"
221
Set all torrents' first two files' priorities to high:
222
.Bd -literal -offset indent
223
$ transmission-remote -tall -ph1,2"
226
Set all torrents' files' priorities to normal:
227
.Bd -literal -offset indent
228
$ transmission-remote -tall -pnall"
199
program was written by
200
.An Josh Elsasser Aq josh@elsasser.org ,
201
.An Eric Petit Aq titer@m0k.org ,
202
.An Charles Kerr Aq charles@rebelbase.com ,
204
.An Mitchell Livingston Aq livings124@gmail.com .
237
.An Mitchell Livingston .
206
240
.Xr transmissioncli 1 ,
207
241
.Xr transmission-daemon 1 ,
209
.Xr transmission-proxy 1
211
245
http://www.transmissionbt.com/
added
removed
daemon/transmission-remote.1
