transmission/daemon/transmission-remote.1

.Dd May 20, 2008
.Dt TRANSMISSION-REMOTE 1
.Os
.Sh NAME
.Nm transmission-remote
.Nd a remote control utility for
.Xr transmission-daemon 1
and
.Xr transmission 1
.Sh SYNOPSIS
.Bk -words
.Nm
.Op Ar host:port | host | port
.Op Fl a Ar torrent-files
.Op Fl b
.Op Fl d Ar number
.Op Fl D
.Op Fl er
.Op Fl ep
.Op Fl et
.Op Fl f
.Op Fl g Ar files
.Op Fl G Ar files
.Op Fl h
.Op Fl i
.Op Fl l
.Op Fl m
.Op Fl M
.Op Fl n Ar user:pass
.Op Fl p Ar port
.Op Fl ph Ar files
.Op Fl pl Ar files
.Op Fl pn Ar files
.Op Fl r
.Op Fl s
.Op Fl S
.Op Fl t Ar all | Ar id | Ar hash
.Op Fl u Ar number
.Op Fl U
.Op Fl v
.Op Fl w Ar download-dir
.Op Fl x
.Op Fl X
.Ek
.Sh DESCRIPTION
.Nm
is a remote control utility for
.Xr transmission 1 
and
.Xr transmission-daemon 1 .
.Pp
By default,
.Nm
connects to the transmission session at localhost:9091.
Other sessions can be controlled by specifying a different host and/or port.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl a Fl -add Ar torrent-file
Add metainfo
.Ar torrent-file(s) .

.It Fl b Fl -debug
Enable debugging mode.

.It Fl d Fl -downlimit Ar limit
Limit the download speed to
.Ar limit
kilobytes per second.

.It Fl D Fl -no-downlimit
Remove the download limit.

.It Fl er Fl -encryption-required
Encrypt all peer connections.
.It Fl ep Fl -encryption-preferred
Prefer encrypted peer connections.
.It Fl et Fl -encryption-tolerated
Prefer unencrypted peer connections.

.It Fl f Fl -files
Get a file list for the current torrent(s)

.It Fl g Fl -get Ar files
Mark file(s) for download.
.Ar files
can be a file index, or a comma-separated list of file indices, or the literal
.Ar all
for all files in the torrent.

.It Fl g Fl -no-get Ar files
Mark file(s) for not downloading

.It Fl h Fl -help
Print command-line option descriptions.

.It Fl i Fl -info Ar id | torrent-hash
Show details of the current torrent(s)

.It Fl l Fl -list
List all torrents

.It Fl m Fl -portmap
Enable portmapping via NAT-PMP or UPnP
.It Fl M Fl -no-portmap
Disable portmapping

.It Fl n Fl -auth Ar username:password
Set the
.Ar username
and
.Ar password
for authentication

.It Fl p Fl -port Ar port
Set the
.Ar port
for use when listening for incoming peer connections

.It Fl ph Fl -priority-high Ar files
Mark 
.Ar files
as high priority.
.Ar files
can be a file index, or a comma-separated list of file indices, or the literal
.Ar all
for all files in the torrent.

.It Fl pl Fl -priority-low Ar files
Mark 
.Ar files
as low priority

.It Fl pn Fl -priority-normal Ar files
Mark 
.Ar files
as normal priority

.It Fl r Fl -remove
Remove the current torrent(s).  This does not delete the downloaded data.

.It Fl s Fl -start
Start the current torrent(s)

.It Fl S Fl -stop
Stop the current torrent(s) from downloading or seeding

.It Fl t Fl -torrent Ar all | id | torrent-hash
Set the current torrent(s) for use by subsequent options.
.Ar all
will apply following requests to all torrents, while specific torrents can be chosen by
.Ar id
or
.Ar hash .
To set more than one current torrent, joined their ids or hashes together in a comma-delimited list,
such as "-t1,2,3"

.It Fl u Fl -uplimit Ar limit
Limit the upload speed to
.Ar limit
kilobytes per second.
.It Fl U Fl -no-uplimit
Remove the upload limit.

.It Fl v Fl -verify
Verify the current torrent(s)

.It Fl w Fl -download-dir Ar directory
Use
.Ar directory
as the default location for newly added torrents to download files to.

.It Fl x Fl -pex
Enable peer exchange (PEX).
.It Fl X Fl -no-pex
Disable peer exchange (PEX).

.El
.Sh EXAMPLES

List all torrents' IDs and states:
.Bd -literal -offset indent
$ transmission-remote -l
.Ed

List all torrents from a remote session that requires authentication:
.Bd -literal -offset indent
$ transmission-remote host:9091 --auth=username:password -l
.Ed

Start all torrents:
.Bd -literal -offset indent
$ transmission-remote -tall --start
.Ed

Add two torrents:
.Bd -literal -offset indent
$ transmission-remote -a one.torrent two.torrent
.Ed

Add all torrents in ~/Desktop:
.Bd -literal -offset indent
$ transmission-remote -a ~/Desktop/*torrent
.Ed

Get detailed information on the torrent whose ID is '1':
.Bd -literal -offset indent
$ transmission-remote -t1 -i"
.Ed

Download only its second and fourth files:
.Bd -literal -offset indent
$ transmission-remote -t1 -Gall -g2,4"
.Ed

Set all torrents' first two files' priorities to high:
.Bd -literal -offset indent
$ transmission-remote -tall -ph1,2"
.Ed

Set all torrents' files' priorities to normal:
.Bd -literal -offset indent
$ transmission-remote -tall -pnall"
.Ed

Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
.Bd -literal -offset indent
$ transmission-remote -d100 -u20
$ transmission-remote --downlimit=100 --uplimit=20
.Bd -literal -offset indent

.Sh AUTHORS
.An -nosplit
.An Charles Kerr ,
.An Josh Elsasser ,
.An Eric Petit ,
and
.An Mitchell Livingston .

.Sh SEE ALSO
.Xr transmissioncli 1 ,
.Xr transmission-daemon 1 ,
.Xr transmission 1

.Pp
http://www.transmissionbt.com/