source: trunk/cli/transmissioncli.1 @ 9122

Last change on this file since 9122 was 9122, checked in by charles, 13 years ago

(trunk) silence manpage warnings reported by lintian and recorded at http://lintian.debian.org/full/costela@debian.org.html#transmission

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