Revert [619]

cli/transmissioncli.1

@@ -0,0 +1,87 @@
+.\"
+.\"  Copyright (c) Deanna Phillips <deanna@sdf.lonestar.org>
+.\" 
+.\"  Permission to use, copy, modify, and distribute this software for any
+.\"  purpose with or without fee is hereby granted, provided that the above
+.\"  copyright notice and this permission notice appear in all copies.
+.\" 
+.\"  THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\"  WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\"  MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\"  ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\"  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\"  ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\"  OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd April 22, 2006
+.Dt TRANSMISSIONCLI 1
+.Os
+.Sh NAME
+.Nm transmissioncli
+.Nd a lightweight bittorrent client
+.Sh SYNOPSIS
+.Nm transmissioncli
+.Bk -words
+.Op Fl h
+.Op Fl i Ar torrent-file
+.Op Fl s Ar torrent-file
+.Op Fl v Ar level
+.Op Fl p Ar port
+.Op Fl u Ar upload-rate
+.Op Fl u Ar download-rate
+.Op Fl f Ar script
+.Ek
+.Sh DESCRIPTION
+The
+.Nm
+program is a lightweight, command-line BitTorrent client with
+scripting capabilities.  The options are as follows:
+.Pp
+.Bl -tag -width Ds
+.It Fl h, Fl -help
+Prints a short usage summary.
+.It Fl i, Fl -info Ar torrent-file
+Shows information from the specified torrent file, such as the
+cryptographic hash, the tracker, announcement, file size and file
+name.
+.It Fl s, -scrape Ar torrent-file
+Prints the number of seeders and leechers for the specified torrent
+file, and exits.
+.It Fl v, -verbose Ar level
+Sets debugging options.  The current range is 0-2, with the highest
+level producing the most output.  The default is 0.
+.It Fl p, -port Ar port
+Specifies an alternate port for the client to listen on.  The default is
+9090.
+.It Fl u, -upload Ar upload-rate
+Specifies the maximum upload rate in kB/s, which defaults to 20. The
+level -1 may be used for unlimited uploads.
+.It Fl d, -download Ar download-rate
+Specifies the maximum download rate in kB/s, which defaults to -1 for
+no download limit.
+.It Fl f, -finish Ar script
+Specifies a shell script to be executed upon successful download.
+.El
+.Sh FILES
+.Pa ~/.transmission
+.Pp
+Directory where
+.Nm
+keeps torrent information for future seeding and resume operations.
+.Sh AUTHORS
+The
+.Nm
+program was written by 
+.An -nosplit
+.An Eric Petit Aq titer@m0k.org
+.An Josh Elsasser Aq josh@elsasser.org
+.An Bryan Varner Aq bryan@varnernet.com
+and
+.An Michael Demars Aq keul@m0k.org .
+.Sh SEE ALSO
+http://transmission.m0k.org
+.Sh CAVEATS 
+.Nm
+currently saves its downloads into the directory from which it was
+called.  If this directory is not writeable by the user, the program
+will terminate unexpectedly.