source: trunk/cli/transmissioncli.1 @ 261

Last change on this file since 261 was 261, checked in by titer, 16 years ago

Updated svn:keywords

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