source: trunk/cli/transmissioncli.1 @ 6299

Last change on this file since 6299 was 6299, checked in by charles, 14 years ago

sync the man pages with the cli/daemon/remote changes

  • Property svn:keywords set to Date Rev Author Id
File size: 3.2 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 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 number
38.Op Fl u Ar number
39.Op Fl f Ar script
40.Op Fl n
41.Ar torrent-file
42.Op Ar output-dir
43.Nm
44.Fl n Ar path
45.Op Fl a Ar url
46.Op Fl c Ar comment
47.Op Fl r
48.Ar output-file
49.Ek
50.Sh DESCRIPTION
51The
52.Nm
53program is a lightweight, command-line BitTorrent client with
54scripting capabilities.
55.Pp
56The options are as follows:
57.Bl -tag -width Ds
58
59.It Fl a, Fl -announce Ar announce-url
60When creating a new torrent, set its announce URL
61
62.It Fl c, Fl -comment Ar comment-text
63When creating a new torrent, set its comment field
64
65.It Fl d, -downlimit Ar number
66Set the maximum download speed in KB/s
67
68.It Fl D, -no-downlimit
69Don't limit the download speed
70
71.It Fl f, -finish Ar script
72Set a script to run when the torrent finishes
73
74.It Fl g, Fl -config-dir Ar directory
75Where to look for configuration files
76
77.It Fl h, Fl -help
78Prints a short usage summary.
79
80.It Fl i, Fl -info
81Shows torrent details and exit
82
83.It Fl m, Fl -portmap
84Enable portmapping via NAT-PMP or UPnP
85
86.It Fl M, Fl -no-portmap
87Disable portmapping
88
89.It Fl n, Fl -new Ar path
90Create torrent from the specified file or directory
91
92.It Fl p, -port Ar port
93Set the port to listen for incoming peers. (Default: 51413)
94
95.It Fl r, Fl -private
96When creating a new torrent, set its 'private' flag
97
98.It Fl s, -scrape
99Print the current number of seeders and leechers for the specified torrent
100
101.It Fl t, -tos
102Set the peer socket TOS for local router-based traffic shaping.
103
104.It Fl u, -uplimit Ar number
105Set the maximum upload speed in KB/s
106
107.It Fl U, -no-uplimit
108Don't limit the upload speed
109
110.It Fl v, Fl -verify
111Verify the torrent's downloaded data.
112
113.It Fl w, Fl -download-dir Ar directory
114Where to save downloaded data.
115
116ccc
117
118.Sh SIGNALS
119In addition to these options, sending
120.Nm
121a SIGHUP signal will contact the tracker for more peers.
122.El
123.Sh FILES
124.Bl -tag -width Ds -compact
125.It ~/.config/transmission
126Directory where
127.Nm
128keeps torrent information for future seeding and resume operations.
129.El
130.Sh AUTHORS
131The
132.Nm
133program was written by
134.An -nosplit
135.An Eric Petit ,
136.An Josh Elsasser ,
137.An Charles Kerr ,
138and
139.An Mitchell Livingston .
140.Sh SEE ALSO
141.Xr transmission 1 ,
142.Xr transmission-daemon 1 ,
143.Xr transmission-remote 1
144.Pp
145http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.