~ubuntu-branches/ubuntu/maverick/transmission/maverick

« back to all changes in this revision

Viewing changes to cli/transmissioncli.1

  • Committer: Bazaar Package Importer
  • Author(s): Philipp Benner
  • Date: 2006-08-29 20:50:41 UTC
  • Revision ID: james.westby@ubuntu.com-20060829205041-mzhpiqksdf7pbk17
Tags: upstream-0.6.1.dfsg
ImportĀ upstreamĀ versionĀ 0.6.1.dfsg

Show diffs side-by-side

added added

removed removed

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