sync man page with the transmission-remote rewrite

This commit is contained in:
Charles Kerr 2008-05-19 18:53:11 +00:00
parent d7f0e0fa1e
commit 8ea0437bcf
1 changed files with 28 additions and 80 deletions

View File

@ -34,9 +34,7 @@ and
.Nm transmission-remote
.Fl h
.Nm
.Oo
.Fl t Ar daemon | Ar gtk
.Oc
.Op Ar host:port | host | port
.Op Fl a Ar torrent-file
.Op Fl d Ar download-rate
.Op Fl D
@ -50,52 +48,31 @@ and
.Op Fl p Ar port
.Op Fl q
.Oo
.Fl r Ar all | Ar info-hash
.Fl r Ar all | Ar torrent-id
.Oc
.Oo
.Fl s Ar all | Ar info-hash
.Fl s Ar all | Ar torrent-id
.Oc
.Oo
.Fl S Ar all | Ar info-hash
.Fl S Ar all | Ar torrent-id
.Oc
.Op Fl u Ar upload-rate
.Op Fl U
.Op Ar torrent-file ...
.Nm
.Fl x
.Op Fl a Ar torrent-file
.Op Fl d Ar download-rate
.Op Fl D
.Op Fl e
.Op Fl E
.Op Fl f Ar directory
.Op Fl i
.Op Fl l
.Op Fl m
.Op Fl M
.Op Fl p Ar port
.Op Fl q
.Oo
.Fl r Ar all | Ar info-hash
.Fl V Ar all | Ar torrent-id
.Oc
.Oo
.Fl s Ar all | Ar info-hash
.Oc
.Oo
.Fl S Ar all | Ar info-hash
.Oc
.Op Fl u Ar upload-rate
.Op Fl U
.Ar command
.Op Ar argument ...
.Ek
.Sh DESCRIPTION
The
.Nm
program is a remote control utility for
.Xr transmission-daemon 1
is a remote control utility for
.Xr transmission 1
and
.Xr transmission 1
.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
@ -116,14 +93,10 @@ Disable peer exchange.
Use
.Ar directory
as the default location for newly added torrents to download files to.
.It Fl g, Fl -config-dir Ar directory
Where to look for configuration files.
.It Fl h Fl -help
Print command-line option descriptions.
.It Fl i Fl -info
Print a listing of all torrent info hashes and names.
.It Fl l Fl -list
Print a listing of all torrent names with size and current status.
Print a listing of all torrents, their Id numbers, and current status.
.It Fl m Fl -port-mapping
Enable automatic port mapping via NAT-PMP or UPnP IGD.
.It Fl M Fl -no-port-mapping
@ -132,66 +105,41 @@ Disable automatic port mapping.
Attempt to bind to
.Ar port
for use as a listening port to accept incoming peer connections.
.It Fl q Fl -quit
Quit the running instance.
.It Fl r Fl -remove Ar all | info-hash
Remove all torrents, or the torrent with an info hash of
.Ar info-hash .
.It Fl r Fl -remove Ar all | torrent-id
Remove all torrents, or the torrent with the unique id
.Ar torrent-id .
Neither the downloaded data nor the original torrent metainfo file
will be deleted.
.It Fl S Fl -stop Ar all | info-hash
Stop all torrents from downloading or seeding, or the torrent with an
info hash of
.Ar info-hash .
.It Fl s Fl -start Ar all | info-hash
Start all torrents downloading or seeding, or the torrent with an info
hash of
.Ar info-hash .
.It Fl t Fl -type Ar daemon | gtk
Connect to either
.Xr transmission-daemon 1
or
.Xr transmission 1 .
.It Fl S Fl -stop Ar all | torrent-id
Stop all torrents from downloading or seeding, or the torrent with the unique id
.Ar torrent-id .
.It Fl s Fl -start Ar all | torrent-id
Start all torrents downloading or seeding, or the torrent with the unique id
.Ar torrent-id .
.It Fl u Fl -upload-limit Ar upload-rate
Set maximum upload rate to
.Ar upload-rate
in kilobytes per second.
.It Fl U Fl -upload-unlimited
Remove the upload limit.
.It Fl x Fl -proxy
Proxy the connection to
.Xr transmission-daemon 1
or
.Xr transmission 1
through
.Ar command .
.El
.Sh FILES
.Pa ~/.transmission
.Sh EXAMPLES
Show status for all torrents:
Show all torrents, their ID numbers, and their status:
.Pp
.Dl transmission-remote -l
.Pp
Pause a torrent:
Pause torrent #12:
.Pp
.Dl transmission-remote -S ca6ac4bbd971d3902935dbcfc2d3ea25b428a547
.Dl transmission-remote -S 12
.Pp
Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
.Pp
.Dl transmission-remote -d 100 -u 20
.Pp
Quit the GTK+ frontend:
.Pp
.Dl transmission-remote -t gtk -q
.Pp
Add two torrents:
.Pp
.Dl transmission-remote foo.torrent bar.torrent
.Pp
Show the info hashes of all the torrents on jade:
.Pp
.Dl transmission-remote -x -i ssh jade transmission-proxy
.Dl transmission-remote -a foo.torrent -a bar.torrent
.Sh AUTHORS
.An -nosplit