source: branches/daemon/cli/transmissioncli.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.0 KB
Line 
1.\"
2.\"  Copyright (c) Deanna Phillips <deanna@sdf.lonestar.org>
3.\"
4.\"  Permission to use, copy, modify, and distribute this software for any
5.\"  purpose with or without fee is hereby granted, provided that the above
6.\"  copyright notice and this permission notice appear in all copies.
7.\"
8.\"  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
9.\"  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
10.\"  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
11.\"  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
12.\"  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
13.\"  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
14.\"  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
15.\"
16.Dd April 22, 2006
17.Dt TRANSMISSIONCLI 1
18.Os
19.Sh NAME
20.Nm transmissioncli
21.Nd a bittorrent client
22.Sh SYNOPSIS
23.Nm transmissioncli
24.Bk -words
25.Fl h
26.Nm
27.Op Fl v Ar level
28.Fl i
29.Ar torrent-file
30.Nm
31.Op Fl v Ar level
32.Fl s
33.Ar torrent-file
34.Nm
35.Op Fl v Ar level
36.Op Fl p Ar port
37.Op Fl d Ar download-rate
38.Op Fl u Ar upload-rate
39.Op Fl f Ar script
40.Op Fl n
41.Ar torrent-file
42.Ek
43.Sh DESCRIPTION
44The
45.Nm
46program is a lightweight, command-line BitTorrent client with
47scripting capabilities.
48.Pp
49The options are as follows:
50.Bl -tag -width Ds
51.It Fl h, Fl -help
52Prints a short usage summary.
53.It Fl i, Fl -info
54Shows information from the specified torrent file, such as the
55cryptographic hash, the tracker, announcement, file size and file
56name.
57.It Fl s, -scrape
58Prints the number of seeders and leechers for the specified torrent
59file, and exits.
60.It Fl v, -verbose Ar level
61Sets debugging options.  The current range is 0-2, with the highest
62level producing the most output.  The default is 0.
63.It Fl n, Fl -nat-traversal
64Attempt to use the NAT-PMP and UPnP IGD protocols to establish a port
65mapping for allowing incoming peer connections.
66.It Fl p, -port Ar port
67Specifies an alternate port for the client to listen on.  The default is
689090.
69.It Fl u, -upload Ar upload-rate
70Specifies the maximum upload rate in kB/s, which defaults to 20.  The
71level -1 may be used for unlimited uploads.
72.It Fl d, -download Ar download-rate
73Specifies the maximum download rate in kB/s, which defaults to -1 for
74no download limit.
75.It Fl f, -finish Ar script
76Specifies a shell script to be executed upon successful download.
77.El
78.Sh FILES
79.Pa ~/.transmission
80.Pp
81Directory where
82.Nm
83keeps torrent information for future seeding and resume operations.
84.Sh AUTHORS
85The
86.Nm
87program was written by
88.An -nosplit
89.An Eric Petit Aq titer@m0k.org ,
90.An Josh Elsasser Aq josh@elsasser.org ,
91and
92.An Mitchell Livingston Aq livings124@gmail.com .
93.Sh SEE ALSO
94.Xr transmission-daemon 1 ,
95.Xr transmission-gtk 1 ,
96.Xr transmission-proxy 1 ,
97.Xr transmission-remote 1
98.Pp
99http://transmission.m0k.org
100.Sh CAVEATS
101.Nm
102currently saves its downloads into the directory from which it was
103called.  If this directory is not writable by the user, the program
104will terminate unexpectedly.
Note: See TracBrowser for help on using the repository browser.