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