- updated to 4.0.1

[packages/BitTorrent.git] / BitTorrent-man_pages.patch

diff -urN BitTorrent-3.4.2.orig/debian/bittorrent-downloader.1 BitTorrent-3.4.2/debian/bittorrent-downloader.1
--- BitTorrent-3.4.2.orig/debian/bittorrent-downloader.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/bittorrent-downloader.1	2004-11-07 23:45:49.746092560 +0000
@@ -0,0 +1,136 @@
+.TH "BITTORRENT-DOWNLOADER" 1 "Sep 24 2003"
+.SH NAME
+bittorrent-downloader \- download files using a scatter-gather network
+.SH SYNOPSIS
+.nf
+.B btdownloadheadless [ option ... ] \fIURL\fB
+.B btdownloadheadless [ option ... ] \fIfilename\fB
+.B btdownloadcurses   [ option ... ] \fIURL\fB
+.B btdownloadcurses   [ option ... ] \fIfilename\fB
+.B btdownloadgui      [ option ... ] \fIURL\fB
+.B btdownloadgui      [ option ... ] \fIfilename\fB
+.fi
+.br
+.B 
+.SH DESCRIPTION
+This manual page documents briefly the \fBbtdownloadheadless\fP,
+\fBbtdownloadcurses\fP, and \fBbtdownloadgui\fP commands.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+These are all programs that allow a user to download files using
+bittorrent, a peer to peer, scatter-gather network protocol.
+They all have the same options.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-\-responsefile \fIfilename\fP
+treat \fIfilename\fP as a file which the server reponse was stored in. If this
+option is used, no filename or URL should be present on the command line.
+.TP
+.B \-\-url \fIurl\fP
+retrieve the torrent info file from \fIurl\fP.  If this option is used, no
+filename or URL should be present on the command line.
+.TP
+.B \-i \fIip\fP | \-\-ip \fIip\fP
+report \fIip\fP as your IP to the tracker
+.TP
+.B \-\-bind \fIip\fP
+bind to \fIip\fP instead of the default
+.TP
+.B \-\-minport \fIportnum\fP
+set \fIportnum\fP as the minimum port to listen on, counts up if unavailable (default 6881)
+.TP
+.B \-\-maxport \fIportnum\fP
+set \fIportnum\fP as the maximum port to listen on (default 6889)
+.TP
+.B \-\-saveas \fIfilename\fP
+store the downloaded file to \fIfilename\fP, instead of querying user (gui) or 
+using the filename stored in the torrent info file
+.TP
+.B \-\-max_uploads \fInum\fP
+Only allow \fInum\fP uploads at once (default 4)
+.TP 
+.B \-\-max_upload_rate \fIkbytes\fP
+maximum rate to upload at in kilobytes, 0 means no limit (default 0)
+.TP
+.B \-\-keepalive_interval \fIsecs\fP
+pause \fIsecs\fP seconds between sending keepalives (default 120.0)
+.TP
+.B \-\-download_slice_size \fIbytes\fP
+query for \fIbytes\fP bytes per request (default 32768)
+.TP
+.B \-\-request_backlog \fInum\fP
+keep \fInum\fP requests in a single pipe at once (default 5)
+.TP
+.B \-\-max_message_length \fIbytes\fP
+set \fIbytes\fP to the maximum length prefix encoding you'll accept over the wire - larger values get the connection dropped (default 8388608)
+.TP
+.B \-\-timeout \fIsecs\fP
+wait \fIsecs\fP before closing sockets which nothing has been recieved on (default 300.0)
+.TP
+.B \-\-timeout_check_interval \fIsecs\fP
+check whether connections have timed out every \fIsecs\fP seconds (default 60.0)
+.TP
+.B \-\-max_slice_length \fIbytes\fP
+requests from peers larger than \fIbytes\fP bytes are ignored (default 131072)
+.TP
+.B \-\-max_rate_recalculate_interval \fIsecs\fP
+connections that pause longer than \fIsecs\fP seconds are given reduced rate (default 15.0)
+.TP
+.B \-\-max_rate_period \fIsecs\fP
+set \fIsecs\fP to the maximum amount of time to guess the current rate estimate represents (default 20.0)
+.TP
+.B \-\-upload_rate_fudge \fIsecs\fP
+set the time equivalent of writing to kernel-level TCP buffer to \fIsecs\fP (default 5.0)
+.TP
+.B \-\-display_interval \fIsecs\fP
+update displayed information every \fIsecs\fP seconds (default 0.1)
+.TP
+.B \-\-rerequest_interval \fIsecs\fP
+request more peers every \fIsecs\fP seconds (default 300)
+.TP
+.B \-\-min_peers \fInum\fP
+do not rerequest if we have \fInum\fP peers already (default 20)
+.TP
+.B \-\-http_timeout \fIsecs\fP
+wait \fIsecs\fP seconds before assuming a http connection has timed out (default 60)
+.TP
+.B \-\-snub_time \fIsecs\fP
+wait \fIsecs\fP seconds for data to come in over a connection before assuming it's semi-permanently choked (default 30.0)
+.TP
+.B \-\-spew \fI 1 | 0 \fP
+whether to display diagnostic info to stdout.  This option is not useful when
+using btdownloadcurses or btdownloadgui. (default 0)
+.B \-\-max_initiate \fInum\fP
+stop initiating new connections when we have \fInum\fP peers (default 40)
+.TP
+.B \-\-check_hashes \fI 1 | 0 \fP
+whether to check hashes on disk (defaults to 1)
+.TP
+.B \-\-report_hash_failures \fI 1 | 0 \fP
+whether to report to the user that hash failuers occur (non-fatal, common error) (default 0)
+.TP 
+.B \-\-rarest_first_priority_cutoff \fInum\fP
+the number of peers which need to have a piece before other partials take
+priority over rarest first (default 3)
+
+.SH SEE ALSO
+.BR bttrack (1),
+.BR btmakemetafile (1),
+.BR btlaunchmany (1).
+
+More information on the \fBBitTorrent\fR protocol used for distributing files is available
+at
+.B http://bitconjurer.org/BitTorrent/protocol.html
+
+You will also find a full description on the advantages of the protocol in the academic paper
+.B "Incentives Build Robustness in BitTorrent"
+available at
+.B http://bitconjurer.org/BitTorrent/bittorrentecon.pdf
+.br
+.SH AUTHOR
+This manual page was written by Michael Janssen <jamuraa@debian.org>,
+for the Debian GNU/Linux system (but may be used by others).
diff -urN BitTorrent-3.4.2.orig/debian/bittorrent-multi-downloader.1 BitTorrent-3.4.2/debian/bittorrent-multi-downloader.1
--- BitTorrent-3.4.2.orig/debian/bittorrent-multi-downloader.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/bittorrent-multi-downloader.1	2004-11-07 23:45:49.746092560 +0000
@@ -0,0 +1,31 @@
+.TH "BITTORRENT-MULTI-DOWNLOADER" 1 "Jan 18 2003"
+.SH NAME
+bittorrent-multi-downloader \- multiple file clients for bittorrent
+.SH SYNOPSIS
+.nf
+.B btlaunchmany \fIdirname\fP [ option ... ]
+.B btlaunchmanycurses \fIdirname\fP [ option ... ]
+.fi
+.SH DESCRIPTION
+This manual page documents briefly the \fBbtlaunchmany\fP and 
+\fBbtlaunchmanycurses\fP commands.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+\fBbtlaunchmany\fP is a program that eases the use of 
+bittorrent in multiple-downloader situations.  The program checks
+a directory for torrent files.  When it finds any, it starts a 
+separate downloader thread for each file.
+.SH OPTIONS
+
+These programs have the exact same options as the normal 
+downloaders, which are documented in \fBbittorrent-downloader\fP(1).
+
+.SH SEE ALSO
+.BR bittorrent-downloader (1),
+.BR btmakemetafile (1),
+.BR bttrack (1).
+.br
+.SH AUTHOR
+This manual page was written by Michael Janssen <jamuraa@debian.org>,
+for the Debian GNU/Linux system (but may be used by others).
diff -urN BitTorrent-3.4.2.orig/debian/btdownloadcurses.1 BitTorrent-3.4.2/debian/btdownloadcurses.1
--- BitTorrent-3.4.2.orig/debian/btdownloadcurses.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btdownloadcurses.1	2004-11-07 23:46:40.901315784 +0000
@@ -0,0 +1,2 @@
+.so bittorrent-downloader.1
+
diff -urN BitTorrent-3.4.2.orig/debian/btdownloadgui.1 BitTorrent-3.4.2/debian/btdownloadgui.1
--- BitTorrent-3.4.2.orig/debian/btdownloadgui.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btdownloadgui.1	2004-11-07 23:45:49.754091344 +0000
@@ -0,0 +1 @@
+.so bittorrent-downloader.1
diff -urN BitTorrent-3.4.2.orig/debian/btdownloadheadless.1 BitTorrent-3.4.2/debian/btdownloadheadless.1
--- BitTorrent-3.4.2.orig/debian/btdownloadheadless.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btdownloadheadless.1	2004-11-07 23:45:49.755091192 +0000
@@ -0,0 +1 @@
+.so bittorrent-downloader.1
diff -urN BitTorrent-3.4.2.orig/debian/btlaunchmany.1 BitTorrent-3.4.2/debian/btlaunchmany.1
--- BitTorrent-3.4.2.orig/debian/btlaunchmany.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btlaunchmany.1	2004-11-07 23:45:49.755091192 +0000
@@ -0,0 +1 @@
+.so bittorrent-multi-downloader.1
diff -urN BitTorrent-3.4.2.orig/debian/btlaunchmanycurses.1 BitTorrent-3.4.2/debian/btlaunchmanycurses.1
--- BitTorrent-3.4.2.orig/debian/btlaunchmanycurses.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btlaunchmanycurses.1	2004-11-07 23:45:49.755091192 +0000
@@ -0,0 +1,2 @@
+.so bittorrent-multi-downloader.1
+
diff -urN BitTorrent-3.4.2.orig/debian/btmakemetafile.1 BitTorrent-3.4.2/debian/btmakemetafile.1
--- BitTorrent-3.4.2.orig/debian/btmakemetafile.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btmakemetafile.1	2004-11-07 23:45:49.756091040 +0000
@@ -0,0 +1,52 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH "BTMAKEMETAFILE" 1 "Jan 18 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+btmakemetafile \- program to generate torrent info files for bittorrent
+.SH SYNOPSIS
+.B btmakemetafile \fIfile\fP \fItracker_announce_address\fP [ option ... ] 
+.SH DESCRIPTION
+This manual page documents briefly the \fBbtmakemetafile\fP
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
+.\" respectively.
+\fBbtmakemetafile\fP is a program that generates the torrent info files
+which are distributed to bittorrent clients (usually via the WWW) in order
+to inform them where the designated tracker for the torrent is located, and 
+to allow them to verify the file's contents.
+.PP
+\fBbtmakemetafile\fP takes two arguments.  Both are required.  The first
+is the file that the torrent info file will be generated for.  The second is 
+the "announce" address of a tracker (ex. http://127.0.0.1:6969/announce).
+.SH OPTIONS
+.TP
+.B \-\-piece_size_pow2 \fIarg\fP
+which power of 2 to set the piece size to (default: 18)
+
+.SH SEE ALSO
+.BR bittorrent-downloader (1),
+.BR btrename (1),
+.BR btreannounce (1),
+.BR bttrack (1).
+.br
+.SH AUTHOR
+This manual page was written by Michael Janssen <jamuraa@debian.org>,
+for the Debian GNU/Linux system (but may be used by others).
diff -urN BitTorrent-3.4.2.orig/debian/btreannounce.1 BitTorrent-3.4.2/debian/btreannounce.1
--- BitTorrent-3.4.2.orig/debian/btreannounce.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btreannounce.1	2004-11-07 23:45:49.756091040 +0000
@@ -0,0 +1,43 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH "BTREANNOUNCE" 1 "Jan 18 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+btreannounce \- change the announce address of a torrent file.
+.SH SYNOPSIS
+\fBbtreannounce\fP \fIurl\fP \fItorrent\fP [ \fItorrent\fP ... ]
+.SH DESCRIPTION
+This manual page documents briefly the \fBbtreannounce\fP
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
+.\" respectively.
+\fBbtreannounce\fP is a program which will change the announce 
+address of one or more existing torrent files.  
+The torrent files will be modified to use the new 
+announce url given by the \fIurl\fP argument.
+
+.SH SEE ALSO
+.BR bittorrent-downloader (1),
+.BR btmakemetafile (1),
+.BR btrename (1).
+.br
+.SH AUTHOR
+This manual page was written by Michael Janssen <jamuraa@debian.org>,
+for the Debian GNU/Linux system (but may be used by others).
diff -urN BitTorrent-3.4.2.orig/debian/btrename.1 BitTorrent-3.4.2/debian/btrename.1
--- BitTorrent-3.4.2.orig/debian/btrename.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btrename.1	2004-11-07 23:45:49.757090888 +0000
@@ -0,0 +1,44 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH "BTRENAME" 1 "Jan 18 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+btrename \- change the suggested filename inside a bittorrent file
+.SH SYNOPSIS
+\fBbttrack\fP \fItorrent\fP \fInewfilename\fP
+.SH DESCRIPTION
+This manual page documents briefly the \fBbtrename\fP
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
+.\" respectively.
+\fBbtrename\fP is a program which will change the suggested 
+filename presented to the user for a bittorrent file. This 
+will make the downloader save it as a different name by default.
+The torrent specified by the \fItorrent\fP option is modified 
+in-place, changing the suggested filename to \fInewfilename\fP.
+
+.SH SEE ALSO
+.BR bittorrent-downloader (1),
+.BR btmakemetafile (1),
+.BR btreannounce (1).
+.br
+.SH AUTHOR
+This manual page was written by Michael Janssen <jamuraa@debian.org>,
+for the Debian GNU/Linux system (but may be used by others).
diff -urN BitTorrent-3.4.2.orig/debian/btshowmetainfo.1 BitTorrent-3.4.2/debian/btshowmetainfo.1
--- BitTorrent-3.4.2.orig/debian/btshowmetainfo.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/btshowmetainfo.1	2004-11-07 23:45:49.757090888 +0000
@@ -0,0 +1,40 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH "BTSHOWMETAINFO" 1 "Jan 18 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+btshowmetainfo \- display information in bittorrent files
+.SH SYNOPSIS
+\fBbtshowmetainfo\fP \fIfile\fP [ file ... ] 
+.SH DESCRIPTION
+This manual page documents briefly the \fBbtshowmetainfo\fP
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
+.\" respectively.
+\fBbtshowmetainfo\fP is a program which will display the information
+stored in a bittorrent file. 
+
+.SH SEE ALSO
+.BR bittorrent-downloader (1),
+.BR btmakemetafile (1).
+.br
+.SH AUTHOR
+This manual page was written by Michael Janssen <jamuraa@debian.org>,
+for the Debian GNU/Linux system (but may be used by others).
diff -urN BitTorrent-3.4.2.orig/debian/bttrack.1 BitTorrent-3.4.2/debian/bttrack.1
--- BitTorrent-3.4.2.orig/debian/bttrack.1	1970-01-01 00:00:00.000000000 +0000
+++ BitTorrent-3.4.2/debian/bttrack.1	2004-11-07 23:45:49.758090736 +0000
@@ -0,0 +1,88 @@
+.\"                                      Hey, EMACS: -*- nroff -*-
+.\" First parameter, NAME, should be all caps
+.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
+.\" other parameters are allowed: see man(7), man(1)
+.TH "BTTRACK" 1 "Jan 18 2003"
+.\" Please adjust this date whenever revising the manpage.
+.\"
+.\" Some roff macros, for reference:
+.\" .nh        disable hyphenation
+.\" .hy        enable hyphenation
+.\" .ad l      left justify
+.\" .ad b      justify to both left and right margins
+.\" .nf        disable filling
+.\" .fi        enable filling
+.\" .br        insert line break
+.\" .sp <n>    insert n+1 empty lines
+.\" for manpage-specific macros, see man(7)
+.SH NAME
+bttrack \- tracker for bittorrent
+.SH SYNOPSIS
+.B bttrack \fI [ option ... ]
+.SH DESCRIPTION
+This manual page documents briefly the \fIbttrack\fP
+command.
+This manual page was written for the Debian distribution
+because the original program does not have a manual page.
+.PP
+.\" TeX users may be more comfortable with the \fB<whatever>\fP and
+.\" \fI<whatever>\fP escape sequences to invode bold face and italics, 
+.\" respectively.
+\fBbttrack\fP is a program that serves as a "tracker" for 
+bittorrent clients.  This program keeps track of the completion
+of each client, and communcates that information when requested
+to other clients.
+.SH OPTIONS
+These programs follow the usual GNU command line syntax, with long
+options starting with two dashes (`-').
+A summary of options is included below.
+.TP
+.B \-\-port \fIportnum\fP
+listen on port \fIportnum\fP (default 80)
+.TP
+.B \-\-dfile \fIfilename\fP
+store recent downloader info in \fIfilename\fP
+.TP
+.B \-\-bind \fIip\fP
+bind to \fIip\fP instead of the default
+.TP
+.B \-\-socket_timeout \fIsecs\fP
+timeout for closing connections (default 15)
+.TP
+.B \-\-save_dfile_interval \fIsecs\fP
+seconds between saving dfile (default 300)
+.TP
+.B \-\-timeout_downloaders_interval \fIsecs\fP
+seconds between expiring downloaders (default 2700)
+.TP
+.B \-\-reannounce_interval \fIsecs\fP
+seconds downloaders should wait between reannouncements (default 1800)
+.TP
+.B \-\-response_size \fInum\fP
+number of peers to send in an info message (default 50)
+.TP
+.B \-\-timeout_check_interval \fIsecs\fP
+time to wait between checking if any connections have timed out (default 5)
+.TP
+.B \-\-nat_check \fI[ 1 | 0 ]\fP
+whether to check back and ban downloaders behind NAT (default 1)
+.TP
+.B \-\-min_time_between_log_flushes \fIsecs\fP
+minimum time it must have been since the last flush to do another one (default 3.0)
+.TP
+.B \-\-allowed_dir \fIpath\fP
+only allow downloads for .torrents in this directory (default '')
+.TP
+.B \-\-parse_allowed_interval \fImins\fP
+minutes between reloading of allowed_dir (default 15)
+.TP
+.B \-\-show_names \fI[ 1 | 0 ]\fP
+whether to display names from alowed dir (default 1)
+
+.SH SEE ALSO
+.BR bittorrent-downloader (1),
+.BR btmakemetafile (1).
+.br
+.SH AUTHOR
+This manual page was written by Michael Janssen <jamuraa@debian.org>,
+for the Debian GNU/Linux system (but may be used by others).