source: trunk/cli/transmissioncli.1 @ 6096

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

#1004: update man pages FILES section

  • Property svn:keywords set to Date Rev Author Id
File size: 3.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 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.Op Ar output-dir
43.Nm
44.Op Fl v Ar level
45.Fl c Ar source-file
46.Fl a Ar announce-url
47.Op Fl p Ar port
48.Op Fl m Ar comment
49.Ar output-file
50.Ek
51.Sh DESCRIPTION
52The
53.Nm
54program is a lightweight, command-line BitTorrent client with
55scripting capabilities.
56.Pp
57The options are as follows:
58.Bl -tag -width Ds
59.It Fl g, Fl -config-dir Ar directory
60Where to look for configuration files.
61.It Fl o, Fl -output-dir Ar directory
62Where to save downloaded data.
63.It Fl c, Fl -create-from Ar source-file
64Create torrent from the specified source file.
65.It Fl a, Fl -announce Ar announce-url
66Specifies the announce-url the new torrent will use. Can only be
67used in conjunction with -c or --create-from.
68.It Fl r, Fl -private
69Sets the private flag for the new torrent. Can only be used in
70conjunction with -c or --create-from.
71.It Fl m, Fl -comment Ar comment-text
72This optional parameter adds a comment to the new torrent. Can only
73be used in conjunction with -c or --create-from.
74.It Fl h, Fl -help
75Prints a short usage summary.
76.It Fl i, Fl -info
77Shows information from the specified torrent file, such as the
78cryptographic hash, the tracker, announcement, file size and file
79name.
80.It Fl s, -scrape
81Prints the number of seeders and leechers for the specified torrent
82file, and exits.
83.It Fl v, -verbose Ar level
84Sets debugging options. You can use both many -v flags, or a -v level. The current available levels are 0-2, with the highest
85level producing the most output.  The default is 0.
86.It Fl n, Fl -nat-traversal
87Attempt to use the NAT-PMP and UPnP IGD protocols to establish a port
88mapping for allowing incoming peer connections.
89.It Fl p, -port Ar port
90Specifies an alternate port for the client to listen on.  The default is
9151413.
92.It Fl u, -upload Ar upload-rate
93Specifies the maximum upload rate in kB/s, which defaults to 20.  The
94level -1 may be used for unlimited uploads.
95.It Fl d, -download Ar download-rate
96Specifies the maximum download rate in kB/s, which defaults to -1 for
97no download limit.
98.It Fl f, -finish Ar script
99Specifies a shell script to be executed upon successful download.
100.It Fl y, Fl -recheck
101Force a recheck of the torrent data.
102.Sh SIGNALS
103In addition to these options, sending
104.Nm
105a SIGHUP signal will contact the tracker for more peers.
106.El
107.Sh FILES
108.Bl -tag -width Ds -compact
109.It ~/.config/transmission
110Directory where
111.Nm
112keeps torrent information for future seeding and resume operations.
113.El
114.Sh AUTHORS
115The
116.Nm
117program was written by
118.An -nosplit
119.An Eric Petit ,
120.An Josh Elsasser ,
121.An Charles Kerr ,
122and
123.An Mitchell Livingston .
124.Sh SEE ALSO
125.Xr transmission 1 ,
126.Xr transmission-daemon 1 ,
127.Xr transmission-remote 1
128.Pp
129http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.