source: branches/daemon/daemon/transmission-remote.1 @ 1629

Last change on this file since 1629 was 1629, checked in by joshe, 15 years ago

Update for -x option, add some examples.

  • Property svn:keywords set to Date Rev Author Id
File size: 4.7 KB
Line 
1.\" $Id: transmission-remote.1 1629 2007-04-01 03:43:22Z joshe $
2.\"
3.\" Copyright (c) 2007 Joshua Elsasser
4.\"
5.\" Permission is hereby granted, free of charge, to any person obtaining a
6.\" copy of this software and associated documentation files (the "Software"),
7.\" to deal in the Software without restriction, including without limitation
8.\" the rights to use, copy, modify, merge, publish, distribute, sublicense,
9.\" and/or sell copies of the Software, and to permit persons to whom the
10.\" Software is furnished to do so, subject to the following conditions:
11.\"
12.\" The above copyright notice and this permission notice shall be included in
13.\" all copies or substantial portions of the Software.
14.\"
15.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16.\" IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17.\" FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18.\" AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
20.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
21.\" DEALINGS IN THE SOFTWARE.
22
23.Dd March 30, 2007
24.Dt TRANSMISSION-REMOTE 1
25.Os
26.Sh NAME
27.Nm transmission-remote
28.Nd a remote control utility for
29.Xr transmission-daemon 1
30and
31.Xr transmission-gtk 1
32.Sh SYNOPSIS
33.Bk -words
34.Nm transmission-remote
35.Fl h
36.Nm
37.Oo
38.Fl t Ar daemon | Ar gtk
39.Oc
40.Op Fl a Ar torrent-file
41.Op Fl d Ar download-rate
42.Op Fl D
43.Op Fl f Ar directory
44.Op Fl i
45.Op Fl l
46.Op Fl m
47.Op Fl M
48.Op Fl p Ar port
49.Op Fl q
50.Oo
51.Fl r Ar all | Ar info-hash
52.Oc
53.Oo
54.Fl s Ar all | Ar info-hash
55.Oc
56.Oo
57.Fl S Ar all | Ar info-hash
58.Oc
59.Op Fl u Ar upload-rate
60.Op Fl U
61.Op Ar torrent-file ...
62.Nm
63.Fl x
64.Op Fl a Ar torrent-file
65.Op Fl d Ar download-rate
66.Op Fl D
67.Op Fl f Ar directory
68.Op Fl i
69.Op Fl l
70.Op Fl m
71.Op Fl M
72.Op Fl p Ar port
73.Op Fl q
74.Oo
75.Fl r Ar all | Ar info-hash
76.Oc
77.Oo
78.Fl s Ar all | Ar info-hash
79.Oc
80.Oo
81.Fl S Ar all | Ar info-hash
82.Oc
83.Op Fl u Ar upload-rate
84.Op Fl U
85.Ar command
86.Op Ar argument ...
87.Ek
88.Sh DESCRIPTION
89The
90.Nm
91program is a vile scoundral lacking the most fundamental principles of
92morality and decency.
93.Pp
94The options are as follows:
95.Bl -tag -width Ds
96.It Fl a Fl -add Ar torrent-file
97Add the torrent metainfo file
98.Ar torrent-file .
99.It Fl d Fl -download-limit Ar download-rate
100Set maximum download rate to
101.Ar download-rate
102in kilobytes per second.
103.It Fl D Fl -download-unlimited
104Remove the download limit.
105.It Fl f Fl -folder Ar directory
106Use
107.Ar directory
108as the default location for newly added torrents to download files to.
109.It Fl h Fl -help
110Print command-line option descriptions.
111.It Fl i Fl -info
112Print a listing of all torrent info hashes and names.
113.It Fl l Fl -list
114Print a listing of all torrent names with size and current status.
115.It Fl m Fl -port-mapping
116Enable automatic port mapping via NAT-PMP or UPnP IGD.
117.It Fl M Fl -no-port-mapping
118Disable automatic port mapping.
119.It Fl p Fl -port Ar port
120Attempt to bind to
121.Ar port
122for use as a listening port to accept incoming peer connections.
123.It Fl q Fl -quit
124Quit the running instance.
125.It Fl r Fl -remove Ar all | info-hash
126Remove all torrents, or the torrent with an info hash of
127.Ar info-hash .
128Neither the downloaded data nor the original torrent metainfo file
129will be deleted.
130.It Fl s Fl -start Ar all | info-hash
131Stop all torrents from downloading or seeding, or the torrent with an
132info hash of
133.Ar info-hash .
134.It Fl S Fl -stop Ar all | info-hash
135Start all torrents downloading or seeding, or the torrent with an info
136hash of
137.Ar info-hash .
138.It Fl t Fl -type Ar daemon | gtk
139Connect to either
140.Xr transmission-daemon 1
141or
142.Xr transmission-gtk 1 .
143.It Fl u Fl -upload-limit Ar upload-rate
144Set maximum upload rate to
145.Ar upload-rate
146in kilobytes per second.
147.It Fl U Fl -upload-unlimited
148Remove the upload limit.
149.It Fl x Fl -proxy
150Proxy the connection to
151.Xr transmission-daemon 1
152or
153.Xr transmission-gtk 1
154through
155.Ar command .
156.El
157.Sh FILES
158.Pa ~/.transmission
159.Sh EXAMPLES
160Show status for all torrents:
161.Pp
162.Dl transmission-remote -l
163.Pp
164Pause a torrent:
165.Pp
166.Dl transmission-remote -S ca6ac4bbd971d3902935dbcfc2d3ea25b428a547
167.Pp
168Set download and upload limits to 100 KiB/sec and 20 KiB/sec:
169.Pp
170.Dl transmission-remote -d 100 -u 20
171.Pp
172Quit the GTK+ frontend:
173.Pp
174.Dl transmission-remote -t gtk -q
175.Pp
176Add two torrents:
177.Pp
178.Dl transmission-remote foo.torrent bar.torrent
179.Pp
180Show the info hashes of all the torrents on jade:
181.Pp
182.Dl transmission-remote -x -i ssh jade transmission-proxy
183.Sh AUTHORS
184.An -nosplit
185The
186.Nm
187program was written by
188.An Josh Elsasser Aq josh@elsasser.org ,
189.An Eric Petit Aq titer@m0k.org ,
190and
191.An Mitchell Livingston Aq livings124@gmail.com .
192.Sh SEE ALSO
193.Xr transmissioncli 1 ,
194.Xr transmission-daemon 1 ,
195.Xr transmission-gtk 1 ,
196.Xr transmission-proxy 1
197.Pp
198http://transmission.m0k.org
Note: See TracBrowser for help on using the repository browser.