User Commands transmission-remote(1)
NAME
transmission-remote - control Transmission remotely
SYNOPSIS
transmission-remote [--help]
transmission-remote [host:porthostport] [--add torrent-
files] [--debug] [--downlimit speed--no-downlimit ] [--
encryption-required--encryption-preferred--encryption-
tolerated] [--files] [--get allfile-indexfiles] [--no-get
allfile-indexfiles] [--help] [--info idtorrent-hash] [--
list] [--portmap--no-portmap] [--auth username:password]
[--port port] [--priority-normal allfile-indexfiles] [--
priority-high allfile-indexfiles] [--priority-low
allfile-indexfiles] [--remove] [--start--stop] [--torrent
allidtorrent-hash] [--uplimit speed--no-limit] [--verify]
[--download-dir directory] [--pex--no-pex]
DESCRIPTION
transmission-remote is a remote control utility for
transmission-daemon(1) and transmission(1).
By default, transmission-remote connects to the transmission
session at localhost:9091. Other sessions can be controlled
by specifying a different host and/or port.
OPTIONS
The following options are supported:
-a, --add torrent-files
Add single or multiple torrent-files, separated by a
space, into transmission.
-b, --debug
Enable debugging mode.
-d, --downlimit speed
Set the maximum download speed in KB/s, which defaults
to no limit.
-D, --no-downlimit
Do not limit the download speed.
SunOS 5.11 Last change: 17 Jul 2008 1
User Commands transmission-remote(1)
-er, --encryption-required
Encrypt all peer connections.
-ep, --encryption-preferred
Prefer encrypted peer connections.
-et, --encryption-tolerated
Prefer unencrypted peer connections.
-f, --files
Get a file list for the current torrents.
-g, --get allfile-indexfiles
Mark files for downloading. all marks all of the
torrent's files for downloading, file-index adds a sin-
gle file to the download list, and files adds multiple
files to the download list, such as "-g 1,3-5" to add
files #1, #3, #4, and #5 to the download list.
-G, --no-get allfile-indexfiles
Mark files for not downloading.
-h, --help
Print command-line option descriptions.
-i, --info idtorrent-hash
Show details of the current torrents.
SunOS 5.11 Last change: 17 Jul 2008 2
User Commands transmission-remote(1)
-l, --list
List all the torrents.
-m, --portmap
Enable portmapping via NAT-PMP or UPnP.
-M, --no-portmap
Disable portmapping.
-n, --auth username:password
Set the username and password for authentication.
-p, --port
Set the port for user when listening for incoming peer
connections.
-pn, --priority-normal allfile-indexfiles
Mark files as normal priority. all marks all of the
torrent's files as normal priority, file-index sets a
single file's priority as normal, and files sets multi-
ple files' priorities as normal, such as "-pn 1,3-5" to
normalize files #1, #3, #4, and #5.
-ph, --priority-high allfile-indexfiles
Mark files as high priority.
-pl, --priority-low allfile-indexfiles
Mark files as low priority.
SunOS 5.11 Last change: 17 Jul 2008 3
User Commands transmission-remote(1)
-r, --remove
Remove the current torrents. This does not delete the
downloaded data.
-s, --start
Start the current torrents.
-S, --stop
Stop the current torrents from downloading or seeding.
-t, --torrent allidtorrent-hash
Set the current torrents for use by subsequent options.
all will apply the following requests to all torrents,
while specific torrents can be chosen by id or torrent-
hash. To set more than one current torrent, join their
ids or hashes together in a list, such as "-t 2,4,6-8"
to operate on the torrents whose IDs are 2, 4, 6, 7, and
8.
-u, --uplimit speed
Set the maximum upload speed, Which defaults to 20KB/s.
-U, --no-uplimit
Do not limit the upload speed.
-v, --verify
Verify the torrent's downloaded data.
-w, --download-dir directory
Where to save download data.
SunOS 5.11 Last change: 17 Jul 2008 4
User Commands transmission-remote(1)
-x, --pex
Enable peer exchange(PEX). Peer exchange is a feature of
the BitTorrent peer-to-peer protocol, which can be util-
ized to gather peers. Using peer exchange, an existing
peer is used to trade the information required to find
and connect to additional peers.
-X, --no-pex
disable peer exchange(PEX).
FILES
The following files are used by this application:
/usr/bin/transmission-remote
The executable for transmission-remote
EXAMPLES
Example 1: Set download and upload limits to 100 KB/s and 20
KB/s:
example% transmission-remote -d 100 -u 20
example% transmission-remote -downlimit 100 -uplimit 20
Example 2: List all torrents' IDs and states:
example% transmission-remote --list
Example 3: List all torrents from a remote session that
requires authentication:
example% transmission-remote host:9091 --auth=username:password -l
Example 4: Start all the torrents
example% transmission-remote -t all --start
Example 5: Add two torrents
example% transmission-remote -a one.torrent two.torrent
Example 6: Add all torrents in $HOME/Desktop:
SunOS 5.11 Last change: 17 Jul 2008 5
User Commands transmission-remote(1)
example% transmission-remote -a ~/Desktop/*torrent
Example 7: Get detailed information on the torrent whose ID
is "1":
example% transmission-remote -t 1 -i
Example 8: Get a list of a torrent's files:
example% transmission-remote -t 1 -l
Example 9: Download only its second and fourth files:
example% transmission-remote -t 1 -G all -g 2,4"
Example 10: Set all torrents' first two files' priorities to
high:
example% transmission-remote -t all -ph 1,2
Example 11: Set all torrents' files' priorities to normal:
example% transmission-remote -t all -pn all
EXIT STATUS
The following exit values are returned:
0 Application exited successfully.
>0 Application exited with failure.
ATRIBUTES
See attributes(5) for descriptions of the following attri-
butes:
ATRIBUTE TYPE ATRIBUTE VALUE
Availability SUNWtransmission
Interface stability Volatile
SEE ALSO
transmission(1), transmissioncli(1), transmission-daemon(1),
attributes(5)
SunOS 5.11 Last change: 17 Jul 2008 6
User Commands transmission-remote(1)
Transmission community site - http:/www.transmissionbt.org/
NOTES
transmission-remote program was written by Charles Kerr
|