summaryrefslogtreecommitdiff
path: root/net/bittorrent/files/BitTorrent.1
diff options
context:
space:
mode:
Diffstat (limited to 'net/bittorrent/files/BitTorrent.1')
-rw-r--r--net/bittorrent/files/BitTorrent.190
1 files changed, 90 insertions, 0 deletions
diff --git a/net/bittorrent/files/BitTorrent.1 b/net/bittorrent/files/BitTorrent.1
new file mode 100644
index 000000000000..686552fdc135
--- /dev/null
+++ b/net/bittorrent/files/BitTorrent.1
@@ -0,0 +1,90 @@
+.Dd April 12, 2003
+.Dt BITTORRENT 1
+.Sh NAME
+.Nm BitTorrent
+.Nd Peer to Peer Distributed download client/server.
+.Sh SYNOPSIS
+.Nm
+.Op Ar args ...
+.Sh DESCRIPTION
+The
+.Nm
+client/server may be invoked with the following options:
+.Pp
+.Bl -tag -width indent
+.It Fl -max_uploads Ar num
+the maximum number of uploads to allow at once. (defaults to 4)
+.It Fl -keepalive_interval Ar seconds
+number of seconds to pause between sending keepalives (defaults to
+120.0)
+.It Fl -download_slice_size Ar bytes
+How many bytes to query for per request. (defaults to 16384)
+.It Fl -request_backlog Ar num
+how many requests to keep in a single pipe at once. (defaults to 5)
+.It Fl -max_message_length Ar bytes
+maximum length prefix encoding you'll accept over the wire - larger
+values get the connection dropped. (defaults to 8388608)
+.It Fl -ip Ar address
+.It Fl i Ar address
+IP to report you have to the tracker. (defaults to '')
+.It Fl -minport Ar port
+minimum port to listen on, counts up if unavailable (defaults to 6881)
+.It Fl -maxport Ar port
+maximum port to listen on (defaults to 6999)
+.It Fl -responsefile Ar filename
+file the server response was stored in, alternative
+to url (defaults to '')
+.It Fl -url Ar filename
+url to get file from, alternative to responsefile (defaults to '')
+.It Fl -saveas Ar filename
+local file name to save the file as, null indicates
+query user (defaults to '')
+.It Fl -timeout Ar seconds
+time to wait between closing sockets which nothing
+has been received on (defaults to 300.0)
+.It Fl -timeout_check_interval Ar seconds
+time to wait between checking if any connections
+have timed out (defaults to 60.0)
+.It Fl -max_slice_length Ar bytes
+maximum length slice to send to peers, larger
+requests are ignored (defaults to 131072)
+.It Fl -max_rate_period Ar seconds
+maximum amount of time to guess the current
+rate estimate represents (defaults to 20.0)
+.It Fl -bind Ar address
+IP to bind to locally (defaults to '')
+.It Fl -upload_rate_fudge Ar num
+time equivalent of writing to kernel-level TCP buffer, for rate
+adjustment (defaults to 5.0)
+.It Fl -display_interval Ar seconds
+time between updates of displayed information (defaults to 0.5)
+.It Fl -rerequest_interval Ar seconds
+time to wait between requesting more peers (defaults to 300)
+.It Fl -min_peers Ar num
+minimum number of peers to not do rerequesting (defaults to 20)
+.It Fl -http_timeout Ar seconds
+number of seconds to wait before assuming that an http connection has
+timed out (defaults to 60)
+.It Fl -max_initiate Ar num
+number of peers at which to stop initiating new connections (defaults to 40)
+.It Fl -check_hashes Ar boolean
+whether to check hashes on disk (defaults to 1)
+.It Fl -max_upload_rate Ar kB/s
+maximum kB/s to upload at, 0 means no limit (defaults to 0)
+.It Fl -alloc_pause Ar seconds
+seconds to wait before displaying allocation feedback (defaults to 3.0)
+.It Fl -snub_time Ar seconds
+seconds to wait for data to come in over a connection before assuming
+it's semi-permanently choked (defaults to 60.0)
+.It Fl -spew Ar boolean
+whether to display diagnostic info to stdout (defaults to 0)
+.El
+.Sh SEE ALSO
+.Rs
+.%T BitTorrent
+.%O "http://bitconjurer.org/BitTorrent/index.html"
+.Re
+.Sh AUTHORS
+.Nm
+was written by
+.An Bram Cohen Aq bram@bitconjurer.org .