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

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

(daemon) add file-listing capabilities to transmission-remote

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