source: trunk/daemon/transmission-remote.1 @ 6295

Last change on this file since 6295 was 6295, checked in by charles, 14 years ago

cleanup the new getopt code a bit. sync remote's manpage.

  • Property svn:keywords set to Date Rev Author Id
File size: 3.3 KB
Line 
1.Dd May 20, 2008
2.Dt TRANSMISSION-REMOTE 1
3.Os
4.Sh NAME
5.Nm transmission-remote
6.Nd a remote control utility for
7.Xr transmission-daemon 1
8and
9.Xr transmission 1
10.Sh SYNOPSIS
11.Bk -words
12.Nm
13.Op Ar host:port | host | port
14.Op Fl a Ar torrent-files
15.Op Fl d Ar number
16.Op Fl D
17.Op Fl e Ar mode
18.Op Fl f
19.Op Fl g
20.Op Fl h
21.Op Fl i
22.Op Fl l
23.Op Fl m
24.Op Fl M
25.Op Fl n Ar user:pass
26.Op Fl p Ar port
27.Op Fl r
28.Op Fl s
29.Op Fl S
30.Op Fl t Ar all | Ar id | Ar hash
31.Op Fl u Ar number
32.Op Fl U
33.Op Fl v
34.Op Fl w Ar download-dir
35.Op Fl x
36.Op Fl X
37.Ek
38.Sh DESCRIPTION
39.Nm
40is a remote control utility for
41.Xr transmission 1
42and
43.Xr transmission-daemon 1 .
44.Pp
45By default,
46.Nm
47connects to the transmission session at localhost:9091.
48Other sessions can be controlled by specifying a different host and/or port.
49.Pp
50The options are as follows:
51.Bl -tag -width Ds
52.It Fl a Fl -add Ar torrent-file
53Add metainfo
54.Ar torrent-file(s) .
55
56.It Fl d Fl -downlimit Ar limit
57Limit the download speed to
58.Ar limit
59kilobytes per second.
60
61.It Fl D Fl -no-downlimit
62Remove the download limit.
63
64.It Fl e Fl -encryption Ar required
65Require all peer connections to be encrypted.
66.It Fl e Fl -encryption Ar preferred
67Prefer encrypted peer connections.
68.It Fl e Fl -encryption Ar tolerated
69Prefer unencrypted peer connections.
70
71.It Fl f Fl -files
72Get a file list for the current torrent(s)
73
74.It Fl h Fl -help
75Print command-line option descriptions.
76
77.It Fl i Fl -info Ar id | torrent-hash
78Show details of the current torrent(s)
79
80.It Fl l Fl -list
81List all torrents
82
83.It Fl m Fl -portmap
84Enable portmapping via NAT-PMP or UPnP
85.It Fl M Fl -no-portmap
86Disable portmapping
87
88.It Fl n Fl -auth Ar user:pass
89.Ar Username
90and
91.Ar password
92for authentication
93
94.It Fl p Fl -port Ar port
95Set the
96.Ar port
97for use when listening for incoming peer connections
98
99.It Fl r Fl -remove
100Remove the current torrent(s).  This does not delete the downloaded data.
101
102.It Fl s Fl -start
103Start the current torrent(s)
104
105.It Fl S Fl -stop
106Stop the current torrent(s) from downloading or seeding
107
108.It Fl t Fl -torrent Ar all | id | torrent-hash
109Set the current torrent(s) for use by subsequent options.
110.Ar all
111will apply following requests to all torrents, while specific torrents can be chosen by
112.Ar id
113or
114.Ar hash .
115
116.It Fl u Fl -uplimit Ar limit
117Limit the upload speed to
118.Ar limit
119kilobytes per second.
120.It Fl U Fl -no-uplimit
121Remove the upload limit.
122
123.It Fl v Fl -verify
124Verify the current torrent(s)
125
126.It Fl w Fl -download-dir Ar directory
127Use
128.Ar directory
129as the default location for newly added torrents to download files to.
130
131.It Fl x
132Enable peer exchange (PEX).
133.It Fl X
134Disable peer exchange (PEX).
135
136.El
137.Sh EXAMPLES
138Show all torrents, their ID numbers, and their status:
139.Pp
140.Dl transmission-remote -l
141.Pp
142Pause torrent #12:
143.Pp
144.Dl transmission-remote -t 12 -S
145.Dl transmission-remote --torrent=12 --stop
146.Pp
147Start all torrents:
148.Pp
149.Dl transmission-remote -t all -s
150.Dl transmission-remote --torrent=all --start
151.Pp
152Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
153.Pp
154.Dl transmission-remote -d 100 -u 20
155.Dl transmission-remote -d=100 -u=20
156.Pp
157Add two torrents:
158.Pp
159.Dl transmission-remote -a one.torrent two.torrent
160
161.Sh AUTHORS
162.An -nosplit
163.An Charles Kerr ,
164.An Josh Elsasser ,
165.An Eric Petit ,
166and
167.An Mitchell Livingston .
168
169.Sh SEE ALSO
170.Xr transmissioncli 1 ,
171.Xr transmission-daemon 1 ,
172.Xr transmission 1
173
174.Pp
175http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.