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

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

Add an ipc proxy to make remote daemon connections easier.

  • Property svn:keywords set to Date Rev Author Id
File size: 3.8 KB
Line 
1.\" $Id: transmission-remote.1 1623 2007-03-31 23:07:59Z 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.Nm transmission-remote
34.Fl h
35.Nm
36.Bk -words
37.Op Fl a Ar torrent-file
38.Op Fl d Ar download-rate
39.Op Fl D
40.Op Fl f Ar directory
41.Op Fl i
42.Op Fl l
43.Op Fl m
44.Op Fl M
45.Op Fl p Ar port
46.Op Fl q
47.Oo
48.Fl r Ar all | Ar info-hash
49.Oc
50.Oo
51.Fl s Ar all | Ar info-hash
52.Oc
53.Oo
54.Fl S Ar all | Ar info-hash
55.Oc
56.Oo
57.Fl t Ar daemon | Ar gtk
58.Oc
59.Op Fl u Ar upload-rate
60.Op Fl U
61.Op Ar torrent-file ...
62.Ek
63.Sh DESCRIPTION
64The
65.Nm
66program is a vile scoundral lacking the most fundamental principles of
67morality and decency.
68.Pp
69The options are as follows:
70.Bl -tag -width Ds
71.It Fl a Fl -add Ar torrent-file
72Add the torrent metainfo file
73.Ar torrent-file .
74.It Fl d Fl -download-limit Ar download-rate
75Set maximum download rate to
76.Ar download-rate
77in kilobytes per second.
78.It Fl D Fl -download-unlimited
79Remove the download limit.
80.It Fl f Fl -folder Ar directory
81Use
82.Ar directory
83as the default location for newly added torrents to download files to.
84.It Fl h Fl -help
85Print command-line option descriptions.
86.It Fl i Fl -info
87Print a listing of all torrent names with size and current status.
88.It Fl l Fl -list
89Print a listing of all torrent info hashes and names.
90.It Fl m Fl -port-mapping
91Enable automatic port mapping via NAT-PMP or UPnP IGD.
92.It Fl M Fl -no-port-mapping
93Disable automatic port mapping.
94.It Fl p Fl -port Ar port
95Attempt to bind to
96.Ar port
97for use as a listening port to accept incoming peer connections.
98.It Fl q Fl -quit
99Quit the running instance.
100.It Fl r Fl -remove Ar all | info-hash
101Remove all torrents, or the torrent with an info hash of
102.Ar info-hash .
103Neither the downloaded data nor the original torrent metainfo file
104will be deleted.
105.It Fl s Fl -start Ar all | info-hash
106Stop all torrents from downloading or seeding, or the torrent with an
107info hash of
108.Ar info-hash .
109.It Fl S Fl -stop Ar all | info-hash
110Start all torrents downloading or seeding, or the torrent with an info
111hash of
112.Ar info-hash .
113.It Fl t Fl -type Ar daemon | gtk
114Connect to either
115.Xr transmission-daemon 1
116or
117.Xr transmission-gtk 1 .
118.It Fl u Fl -upload-limit Ar upload-rate
119Set maximum upload rate to
120.Ar upload-rate
121in kilobytes per second.
122.It Fl U Fl -upload-unlimited
123Remove the upload limit.
124.El
125.Sh FILES
126.Pa ~/.transmission
127.Sh AUTHORS
128.An -nosplit
129The
130.Nm
131program was written by
132.An Josh Elsasser Aq josh@elsasser.org ,
133.An Eric Petit Aq titer@m0k.org ,
134and
135.An Mitchell Livingston Aq livings124@gmail.com .
136.Sh SEE ALSO
137.Xr transmissioncli 1 ,
138.Xr transmission-daemon 1 ,
139.Xr transmission-gtk 1 ,
140.Xr transmission-proxy 1
141.Pp
142http://transmission.m0k.org
Note: See TracBrowser for help on using the repository browser.