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

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

(daemon) #1047: man page inconsistencies

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