← Back to branch summary

~ubuntu-branches/ubuntu/hardy/transmission/hardy-updates

« back to all changes in this revision

Viewing changes to cli/transmissioncli.1

  • Committer: Bazaar Package Importer
  • Author(s): Philipp Benner
  • Date: 2007-10-26 16:02:39 UTC
  • mto: This revision was merged to the branch mainline in revision 6.
  • Revision ID: james.westby@ubuntu.com-20071026160239-2c0agn7q1ken0xsp
Tags: upstream-0.90.dfsg
Import upstream version 0.90.dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
cli/transmissioncli.1
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 18, 2007
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
 
.Nm
43
 
.Op Fl v Ar level
44
 
.Fl c Ar source-file
45
 
.Fl a Ar announce-url
46
 
.Op Fl p Ar 1
47
 
.Op Fl m Ar comment
48
 
.Ar output-file
49
 
.Ek
50
 
.Sh DESCRIPTION
51
 
The
52
 
.Nm
53
 
program is a lightweight, command-line BitTorrent client with
54
 
scripting capabilities.
55
 
.Pp
56
 
The options are as follows:
57
 
.Bl -tag -width Ds
58
 
.lt Fl c, Fl -create-from Ar source-file
59
 
Create torrent from the specified source file.
60
 
.lt Fl a, Fl -announce Ar announce-url
61
 
Specifies the Announceurl the new torrent will use. Can only be
62
 
used in conjunction with -c or --create-from.
63
 
.lt Fl r, Fl -private
64
 
Sets the private flag for the new torrent. Can only be used in
65
 
conjunction with -c or --create-from.
66
 
.lt Fl m, Fl -comment Ar comment-text
67
 
This optional parameter adds a comment to the new torrent. Can only
68
 
be used in conjunction with -c or --create-from.
69
 
.It Fl h, Fl -help
70
 
Prints a short usage summary.
71
 
.It Fl i, Fl -info
72
 
Shows information from the specified torrent file, such as the
73
 
cryptographic hash, the tracker, announcement, file size and file
74
 
name.
75
 
.It Fl s, -scrape
76
 
Prints the number of seeders and leechers for the specified torrent
77
 
file, and exits.
78
 
.It Fl v, -verbose Ar level
79
 
Sets debugging options.  The current range is 0-2, with the highest
80
 
level producing the most output.  The default is 0.
81
 
.It Fl n, Fl -nat-traversal
82
 
Attempt to use the NAT-PMP and UPnP IGD protocols to establish a port
83
 
mapping for allowing incoming peer connections.
84
 
.It Fl p, -port Ar port
85
 
Specifies an alternate port for the client to listen on.  The default is
86
 
9090.
87
 
.It Fl u, -upload Ar upload-rate
88
 
Specifies the maximum upload rate in kB/s, which defaults to 20.  The
89
 
level -1 may be used for unlimited uploads.
90
 
.It Fl d, -download Ar download-rate
91
 
Specifies the maximum download rate in kB/s, which defaults to -1 for
92
 
no download limit.
93
 
.It Fl f, -finish Ar script
94
 
Specifies a shell script to be executed upon successful download.
95
 
.El
96
 
.Sh FILES
97
 
.Bl -tag -width Ds -compact
98
 
.It ~/.transmission
99
 
Directory where
100
 
.Nm
101
 
keeps torrent information for future seeding and resume operations.
102
 
.El
103
 
.Sh AUTHORS
104
 
The
105
 
.Nm
106
 
program was written by 
107
 
.An -nosplit
108
 
.An Eric Petit Aq titer@m0k.org ,
109
 
.An Josh Elsasser Aq josh@elsasser.org ,
110
 
and
111
 
.An Mitchell Livingston Aq livings124@gmail.com .
112
 
.Sh SEE ALSO
113
 
.Xr transmission-daemon 1 ,
114
 
.Xr transmission-gtk 1 ,
115
 
.Xr transmission-proxy 1 ,
116
 
.Xr transmission-remote 1
117
 
.Pp
118
 
http://transmission.m0k.org