source: trunk/cli/transmissioncli.1 @ 1125

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

Merge nat-traversal branch to trunk.

  • Property svn:keywords set to Date Rev Author Id
File size: 2.9 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 lightweight bittorrent client
22.Sh SYNOPSIS
23.Nm transmissioncli
24.Bk -words
25.Op Fl h
26.Op Fl i Ar torrent-file
27.Op Fl s Ar torrent-file
28.Op Fl v Ar level
29.Op Fl n
30.Op Fl p Ar port
31.Op Fl u Ar upload-rate
32.Op Fl u Ar download-rate
33.Op Fl f Ar script
34.Ek
35.Sh DESCRIPTION
36The
37.Nm
38program is a lightweight, command-line BitTorrent client with
39scripting capabilities.  The options are as follows:
40.Pp
41.Bl -tag -width Ds
42.It Fl h, Fl -help
43Prints a short usage summary.
44.It Fl i, Fl -info Ar torrent-file
45Shows information from the specified torrent file, such as the
46cryptographic hash, the tracker, announcement, file size and file
47name.
48.It Fl s, -scrape Ar torrent-file
49Prints the number of seeders and leechers for the specified torrent
50file, and exits.
51.It Fl v, -verbose Ar level
52Sets debugging options.  The current range is 0-2, with the highest
53level producing the most output.  The default is 0.
54.It Fl n, Fl -nat-traversal
55Attempt to use the NAT-PMP and UPnP IGD protocols to establish a port
56mapping for allowing incoming peer connections.
57.It Fl p, -port Ar port
58Specifies an alternate port for the client to listen on.  The default is
599090.
60.It Fl u, -upload Ar upload-rate
61Specifies the maximum upload rate in kB/s, which defaults to 20. The
62level -1 may be used for unlimited uploads.
63.It Fl d, -download Ar download-rate
64Specifies the maximum download rate in kB/s, which defaults to -1 for
65no download limit.
66.It Fl f, -finish Ar script
67Specifies a shell script to be executed upon successful download.
68.El
69.Sh FILES
70.Pa ~/.transmission
71.Pp
72Directory where
73.Nm
74keeps torrent information for future seeding and resume operations.
75.Sh AUTHORS
76The
77.Nm
78program was written by
79.An -nosplit
80.An Eric Petit Aq titer@m0k.org
81.An Josh Elsasser Aq josh@elsasser.org
82.An Bryan Varner Aq bryan@varnernet.com
83and
84.An Michael Demars Aq keul@m0k.org .
85.Sh SEE ALSO
86http://transmission.m0k.org
87.Sh CAVEATS
88.Nm
89currently saves its downloads into the directory from which it was
90called.  If this directory is not writeable by the user, the program
91will terminate unexpectedly.
Note: See TracBrowser for help on using the repository browser.