source: trunk/cli/transmission-cli.1 @ 11521

Last change on this file since 11521 was 11521, checked in by charles, 11 years ago

(trunk) extremely minor manpage copyediting

  • Property svn:keywords set to Date Rev Author Id
File size: 3.6 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 July 21, 2008
17.Dt TRANSMISSION-CLI 1
18.Os
19.Sh NAME
20.Nm transmission-cli
21.Nd a bittorrent client
22.Sh SYNOPSIS
23.Nm transmission-cli
24.Bk -words
25.Fl h
26.Nm
27.Op Fl b | B
28.Op Fl d Ar number | Fl D
29.Op Fl er | ep | et
30.Op Fl f Ar script
31.Op Fl g Ar directory
32.Op Fl h
33.Op Fl m | M
34.Op Fl p Ar port
35.Op Fl t
36.Op Fl u Ar number | Fl U
37.Op Fl v
38.Op Fl w Ar directory
39.Ar torrent-file
40.Ek
41.Sh DESCRIPTION
42The
43.Nm
44program is a lightweight, command-line BitTorrent client with
45scripting capabilities.
46.Pp
47The options are as follows:
48.Bl -tag -width Ds
49.It Fl b Fl -blocklist
50Enable peer blocklists. Transmission understands the bluetack blocklist file format.
51New blocklists can be added by copying them into the config-dir's "blocklists" subdirectory.
52.It Fl B Fl -no-blocklist
53Disble blocklists.
54.It Fl d, -downlimit Ar number
55Set the maximum download speed in KB/s
56.It Fl D, -no-downlimit
57Don't limit the download speed
58.It Fl er Fl -encryption-required
59Encrypt all peer connections.
60.It Fl ep Fl -encryption-preferred
61Prefer encrypted peer connections.
62.It Fl et Fl -encryption-tolerated
63Prefer unencrypted peer connections.
64.It Fl f, -finish Ar script
65Set a script to run when the torrent finishes
66.It Fl g, Fl -config-dir Ar directory
67Where to look for configuration files. This can be used to swap between using the cli, daemon, gtk, and qt clients.
68See http://trac.transmissionbt.com/wiki/ConfigFiles for more information.
69.It Fl h, Fl -help
70Prints a short usage summary.
71.It Fl m, Fl -portmap
72Enable portmapping via NAT-PMP or UPnP
73.It Fl M, Fl -no-portmap
74Disable portmapping
75.It Fl n, Fl -new Ar sourcefile
76Create torrent from the specified file or directory
77.It Fl p, -port Ar port
78Set the port to listen for incoming peers. (Default: 51413)
79.It Fl t, -tos
80Set the peer socket TOS for local router-based traffic shaping.
81.It Fl u, -uplimit Ar number
82Set the maximum upload speed in KB/s
83.It Fl U, -no-uplimit
84Don't limit the upload speed
85.It Fl v, Fl -verify
86Verify the torrent's downloaded data.
87.It Fl w, Fl -download-dir Ar directory
88Where to save downloaded data.
89.El
90.Sh SIGNALS
91In addition to these options, sending
92.Nm
93a SIGHUP signal will contact the tracker for more peers.
94.Sh ENVIRONMENT
95.Bl -tag -width Fl
96.It Ev TRANSMISSION_HOME
97Sets the default config-dir.
98.It Ev http_proxy
99Sets the proxy to use for http tracker announces.
100.El
101.Sh FILES
102.Bl -tag -width Ds -compact
103.It ~/.config/transmission
104Directory where
105.Nm
106keeps torrent information for future seeding and resume operations.
107.El
108.Sh AUTHORS
109The
110.Nm
111program was written by
112.An -nosplit
113.An Eric Petit ,
114.An Josh Elsasser ,
115.An Charles Kerr ,
116and
117.An Mitchell Livingston .
118.Sh SEE ALSO
119.Xr transmission-create 1 ,
120.Xr transmission-daemon 1 ,
121.Xr transmission-edit 1 ,
122.Xr transmission-gtk 1 ,
123.Xr transmission-qt 1 ,
124.Xr transmission-remote 1 ,
125.Xr transmission-show 1
126.Pp
127http://www.transmissionbt.com/
Note: See TracBrowser for help on using the repository browser.