source: trunk/cli/transmissioncli.1 @ 5646

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

gtk/cli/daemon/remote/proxy: add command-line argument --config-dir / -g to override the default config dir

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