source: trunk/cli/transmissioncli.1 @ 6300

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

steal some blocklist/encryption options from remote & reuse them in cli

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