| 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 22, 2006 |
|---|
| 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 | .Ek |
|---|
| 43 | .Sh DESCRIPTION |
|---|
| 44 | The |
|---|
| 45 | .Nm |
|---|
| 46 | program is a lightweight, command-line BitTorrent client with |
|---|
| 47 | scripting capabilities. |
|---|
| 48 | .Pp |
|---|
| 49 | The options are as follows: |
|---|
| 50 | .Bl -tag -width Ds |
|---|
| 51 | .It Fl h, Fl -help |
|---|
| 52 | Prints a short usage summary. |
|---|
| 53 | .It Fl i, Fl -info |
|---|
| 54 | Shows information from the specified torrent file, such as the |
|---|
| 55 | cryptographic hash, the tracker, announcement, file size and file |
|---|
| 56 | name. |
|---|
| 57 | .It Fl s, -scrape |
|---|
| 58 | Prints the number of seeders and leechers for the specified torrent |
|---|
| 59 | file, and exits. |
|---|
| 60 | .It Fl v, -verbose Ar level |
|---|
| 61 | Sets debugging options. The current range is 0-2, with the highest |
|---|
| 62 | level producing the most output. The default is 0. |
|---|
| 63 | .It Fl n, Fl -nat-traversal |
|---|
| 64 | Attempt to use the NAT-PMP and UPnP IGD protocols to establish a port |
|---|
| 65 | mapping for allowing incoming peer connections. |
|---|
| 66 | .It Fl p, -port Ar port |
|---|
| 67 | Specifies an alternate port for the client to listen on. The default is |
|---|
| 68 | 9090. |
|---|
| 69 | .It Fl u, -upload Ar upload-rate |
|---|
| 70 | Specifies the maximum upload rate in kB/s, which defaults to 20. The |
|---|
| 71 | level -1 may be used for unlimited uploads. |
|---|
| 72 | .It Fl d, -download Ar download-rate |
|---|
| 73 | Specifies the maximum download rate in kB/s, which defaults to -1 for |
|---|
| 74 | no download limit. |
|---|
| 75 | .It Fl f, -finish Ar script |
|---|
| 76 | Specifies a shell script to be executed upon successful download. |
|---|
| 77 | .El |
|---|
| 78 | .Sh FILES |
|---|
| 79 | .Pa ~/.transmission |
|---|
| 80 | .Pp |
|---|
| 81 | Directory where |
|---|
| 82 | .Nm |
|---|
| 83 | keeps torrent information for future seeding and resume operations. |
|---|
| 84 | .Sh AUTHORS |
|---|
| 85 | The |
|---|
| 86 | .Nm |
|---|
| 87 | program was written by |
|---|
| 88 | .An -nosplit |
|---|
| 89 | .An Eric Petit Aq titer@m0k.org , |
|---|
| 90 | .An Josh Elsasser Aq josh@elsasser.org , |
|---|
| 91 | and |
|---|
| 92 | .An Mitchell Livingston Aq livings124@gmail.com . |
|---|
| 93 | .Sh SEE ALSO |
|---|
| 94 | .Xr transmission-daemon 1 , |
|---|
| 95 | .Xr transmission-gtk 1 , |
|---|
| 96 | .Xr transmission-remote 1 |
|---|
| 97 | .Pp |
|---|
| 98 | http://transmission.m0k.org |
|---|
| 99 | .Sh CAVEATS |
|---|
| 100 | .Nm |
|---|
| 101 | currently saves its downloads into the directory from which it was |
|---|
| 102 | called. If this directory is not writable by the user, the program |
|---|
| 103 | will terminate unexpectedly. |
|---|
