.TH "bittorrent-downloader.bittornado" "1" .SH "NAME" bittorrent-downloader \(em download files using a scatter-gather network .SH "SYNOPSIS" .PP \fBbtdownloadheadless\fR [\fBoptions\fP \&...] \fIURL\fR .PP \fBbtdownloadheadless\fR [\fBoptions\fP \&...] \fIfilename\fR .PP \fBbtdownloadcurses\fR [\fBoptions\fP \&...] \fIURL\fR .PP \fBbtdownloadcurses\fR [\fBoptions\fP \&...] \fIfilename\fR .PP \fBbtdownloadgui\fR [\fBoptions\fP \&...] \fIURL\fR .PP \fBbtdownloadgui\fR [\fBoptions\fP \&...] \fIfilename\fR .PP \fBbtlaunchmany\fR [\fBoptions\fP \&...] \fIdirectory\fR .PP \fBbtlaunchmanycurses\fR [\fBoptions\fP \&...] \fIdirectory\fR .SH "DESCRIPTION" .PP This manual page documents briefly the options available to the bittorrent-downloader commands. .PP This manual page was written for the \fBDebian\fP distribution because the original program does not have a manual page. .PP \fBbtdownloadheadless\fR, \fBbtdownloadcurses\fR, \fBbtdownloadgui\fR, \fBbtlaunchmany\fR, and \fBbtlaunchmanycurses\fR are all programs that allow a user to download files using bittorrent, a peer to peer, scatter-gather network protocol. They all share a common set of options, shown below. For more information on how to run them, and their program-specific options, see their individual man pages. .SH "OPTIONS" .PP These programs follow the usual GNU command line syntax, with long options starting with two dashes (`\-\-'). A summary of options is included below. .IP "\fB\-\-max_uploads \fInumber\fR\fP" 10 the maximum \fInumber\fR of uploads to allow at once (defaults to 7) .IP "\fB\-\-keepalive_interval \fIseconds\fR\fP" 10 the number of \fIseconds\fR to pause between sending keepalives (defaults to 120.0) .IP "\fB\-\-download_slice_size \fIbytes\fR\fP" 10 the number of \fIbytes\fR to query for per request (defaults to 16384) .IP "\fB\-\-upload_unit_size \fIbytes\fR\fP" 10 when limiting the upload rate, the number of \fIbytes\fR to send at a time (defaults to 1460) .IP "\fB\-\-request_backlog \fInumber\fR\fP" 10 the maximum \fInumber\fR of requests to keep in a single pipe at once (defaults to 10) .IP "\fB\-\-max_message_length \fIlength\fR\fP" 10 the maximum \fIlength\fR prefix encoding you'll accept over the wire. Larger values will get the connection dropped. (defaults to 8388608) .IP "\fB\-\-ip \fIip\fR\fP" 10 the \fIip\fR to report you have to the tracker (defaults to '') .IP "\fB\-\-minport \fIport\fR\fP" 10 the minimum \fIport\fR to listen on (defaults to 10000) .IP "\fB\-\-maxport \fIport\fR\fP" 10 the maximum \fIport\fR to listen on (defaults to 60000) .IP "\fB\-\-random_port\fP 0|1" 10 whether to choose randomly inside the port range (instead of counting up linearly from min to max) (defaults to 1) .IP "\fB\-\-responsefile \fIfile\fR\fP" 10 the \fIfile\fR the server response was stored in, as an alternative to \-\-url. If this option is used, no filename or URL should be present on the command line. (defaults to '') .IP "\fB\-\-url \fIURL\fR\fP" 10 the \fIURL\fR to get the torrent file from, as an alternative to \-\-responsefile. If this option is used, no filename or URL should be present on the command line. (defaults to '') .IP "\fB\-\-crypto_allowed\fP 0|1" 10 whether to allow the client to accept encrypted connections. (defaults to 1 if python-crypto is installed, 0 otherwise) .IP "\fB\-\-crypto_only\fP 0|1" 10 whether to only create or allow encrypted connections. (defaults to 0) .IP "\fB\-\-crypto_stealth\fP 0|1" 10 whether to prevent all non-encrypted connection attempts; will result in an effectively firewalled state on older trackers. (defaults to 0) .IP "\fB\-\-selector_enabled\fP 0|1" 10 whether to enable the file selector and fast resume function (defaults to 1) .IP "\fB\-\-expire_cache_data \fIdays\fR\fP" 10 the number of \fIdays\fR after which you wish to expire old cache data (0 = disabled) (defaults to 10) .IP "\fB\-\-priority\fP \-1|0|1|2[,\-1|0|1|2 ...]" 10 a list of file priorities, separated by commas. There must be one per file. 0 = highest, 1 = normal, 2 = lowest, \-1 = download disabled. Order is based on the file/torrent order as shown by btshowmetainfo. For example, to download only the third of four files use: \-\-priority \-1,\-1,2,\-1 (defaults to '') .IP "\fB\-\-saveas \fIfilename\fR\fP" 10 the local \fIfilename\fR to save the file as, null indicates query user (defaults to '') .IP "\fB\-\-timeout \fIseconds\fR\fP" 10 the number of \fIseconds\fR to wait between closing sockets which nothing has been received on (defaults to 300.0) .IP "\fB\-\-timeout_check_interval \fIseconds\fR\fP" 10 the number of \fIseconds\fR to wait between checking if any connections have timed out (defaults to 60.0) .IP "\fB\-\-max_slice_length \fIlength\fR\fP" 10 the maximum \fIlength\fR slice to send to peers, larger requests are ignored (defaults to 131072) .IP "\fB\-\-max_rate_period \fIseconds\fR\fP" 10 the maximum number of \fIseconds\fR to use in guessing what the current rate estimate represents (defaults to 20.0) .IP "\fB\-\-bind \fIip\fR|\fIhostname\fR[,\fIip\fR|\fIhostname\fR ...]\fP" 10 a comma-separated list of \fIips\fR and \fIhostnames\fR to bind to locally (defaults to '') .IP "\fB\-\-ipv6_enabled\fP 0|1" 10 whether to allow the client to connect to peers via IPv6 (defaults to 0) .IP "\fB\-\-ipv6_binds_v4\fP 0|1" 10 set if an IPv6 server socket won't also field IPv4 connections (defaults to 0) .IP "\fB\-\-upload_rate_fudge \fIseconds\fR\fP" 10 the time equivalent in \fIseconds\fR of writing to kernel-level TCP buffer, for rate adjustment (defaults to 5.0) .IP "\fB\-\-tcp_ack_fudge \fIoverhead\fR\fP" 10 how much TCP ACK download \fIoverhead\fR to add to upload rate calculations (0 = disabled) (defaults to 0.029999999999999999) .IP "\fB\-\-display_interval \fIseconds\fR\fP" 10 the number of \fIseconds\fR between updates of displayed information (defaults to 0.5) .IP "\fB\-\-rerequest_interval \fIseconds\fR\fP" 10 the number of \fIseconds\fR between requesting more peers (defaults to 300) .IP "\fB\-\-min_peers \fInumber\fR\fP" 10 make tracker requests every \-\-rerequest_interval until this \fInumber\fR has been reached, then switch to the standard longer interval (defaults to 20) .IP "\fB\-\-http_timeout \fIseconds\fR\fP" 10 the number of \fIseconds\fR to wait before assuming that an http connection has timed out (defaults to 60) .IP "\fB\-\-max_initiate \fInumber\fR\fP" 10 the \fInumber\fR of peers at which to stop initiating new connections (defaults to 40) .IP "\fB\-\-check_hashes\fP 0|1" 10 whether to check hashes on disk (defaults to 1) .IP "\fB\-\-max_upload_rate \fIkB/s\fR\fP" 10 the maximum \fIkB/s\fR to upload at (0 = no limit, \-1 = automatic) (defaults to 0) .IP "\fB\-\-max_download_rate \fIkB/s\fR\fP" 10 the maximum \fIkB/s\fR to download at (0 = no limit) (defaults to 0) .IP "\fB\-\-alloc_type\fP normal|background|pre-allocate|sparse" 10 the allocation type (may be 'normal', 'background', 'pre-allocate' or 'sparse') (defaults to 'normal') .IP "\fB\-\-alloc_rate \fIMiB/s\fR\fP" 10 the rate (in \fIMiB/s\fR) to allocate space at using background allocation (defaults to 2.0) .IP "\fB\-\-buffer_reads\fP 0|1" 10 whether to buffer disk reads (defaults to 1) .IP "\fB\-\-write_buffer_size \fIspace\fR\fP" 10 the maximum amount of \fIspace\fR to use for buffering disk writes (in megabytes, 0 = disabled) (defaults to 4) .IP "\fB\-\-breakup_seed_bitfield\fP 0|1" 10 whether to send an incomplete bitfield and then 'have' messages, in order to get around stupid ISP manipulation (defaults to 1) .IP "\fB\-\-snub_time \fIseconds\fR\fP" 10 the number of \fIseconds\fR to wait for data to come in over a connection before assuming it's semi-permanently choked (defaults to 30.0) .IP "\fB\-\-spew\fP 0|1" 10 whether to display diagnostic info to stdout. This option is not very useful when using the curses or gui interfaces. (defaults to 0) .IP "\fB\-\-rarest_first_cutoff \fInumber\fR\fP" 10 the \fInumber\fR of downloads at which to switch from random to rarest first (defaults to 2) .IP "\fB\-\-rarest_first_priority_cutoff \fInumber\fR\fP" 10 the \fInumber\fR of peers which need to have a piece before other partials take priority over rarest first (defaults to 5) .IP "\fB\-\-min_uploads \fInumber\fR\fP" 10 the \fInumber\fR of uploads to fill out to with extra optimistic unchokes (defaults to 4) .IP "\fB\-\-max_files_open \fInumber\fR\fP" 10 the maximum \fInumber\fR of files to keep open at a time, 0 means no limit (defaults to 50) .IP "\fB\-\-round_robin_period \fIseconds\fR\fP" 10 the number of \fIseconds\fR between the client switching upload targets (defaults to 30) .IP "\fB\-\-super_seeder\fP 0|1" 10 whether to use special upload-efficiency-maximizing routines (only for dedicated seeds) (defaults to 0) .IP "\fB\-\-security\fP 0|1" 10 whether to enable extra security features intended to prevent abuse (defaults to 1) .IP "\fB\-\-max_connections \fInumber\fR\fP" 10 the absolute maximum \fInumber\fR of peers to connect with (0 = no limit) (defaults to 0) .IP "\fB\-\-auto_kick\fP 0|1" 10 whether to allow the client to automatically kick/ban peers that send bad data (defaults to 1) .IP "\fB\-\-double_check\fP 0|1" 10 whether to double-check data being written to the disk for errors (may increase CPU load) (defaults to 1) .IP "\fB\-\-triple_check\fP 0|1" 10 whether to thoroughly check data being written to the disk (may slow disk access) (defaults to 0) .IP "\fB\-\-lock_files\fP 0|1" 10 whether to lock files the client is working with (defaults to 1) .IP "\fB\-\-lock_while_reading\fP 0|1" 10 whether to lock access to files being read (defaults to 0) .IP "\fB\-\-auto_flush \fIminutes\fR\fP" 10 the number of \fIminutes\fR between automatic flushes to disk (0 = disabled) (defaults to 0) .IP "\fB\-\-dedicated_seed_id \fIcode\fR\fP" 10 the \fIcode\fR to send to a tracker, identifying as a dedicated seed (defaults to '') .IP "\fB\-\-save_options\fP 0|1" 10 whether to save the current options as the new default configuration for the current program (defaults to 0) .SH "SEE ALSO" .PP The single torrent downloaders: \fBbtdownloadheadless\fP\fB(1)\fP, \fBbtdownloadcurses\fP\fB(1)\fP, \fBbtdownloadgui\fP\fB(1)\fP. .PP The multiple torrent downloaders: \fBbittorrent-multi-downloader\fP\fB(1)\fP, \fBbtlaunchmany\fP\fB(1)\fP, \fBbtlaunchmanycurses\fP\fB(1)\fP. .PP The bittorrent tracker: \fBbttrack\fP\fB(1)\fP. .PP The torrent file creators: \fBbtmakemetafile\fP\fB(1)\fP, \fBbtmaketorrentgui\fP\fB(1)\fP, \fBbtcompletedir\fP\fB(1)\fP, \fBbtcompletedirgui\fP\fB(1)\fP. .PP The torrent file modifiers: \fBbtcopyannounce\fP\fB(1)\fP, \fBbtreannounce\fP\fB(1)\fP, \fBbtrename\fP\fB(1)\fP, \fBbtsethttpseeds\fP\fB(1)\fP. .PP The torrent file displayer: \fBbtshowmetainfo\fP\fB(1)\fP. .SH "AUTHOR" .PP This manual page was written by Cameron Dale (based on the original man pages written by Micah Anderson ) for the \fBDebian\fP system (but may be used by others). Permission is granted to copy, distribute and/or modify this document under the terms of the GNU General Public License, Version 2 or any later version published by the Free Software Foundation. .PP On Debian systems, the complete text of the GNU General Public License can be found in /usr/share/common-licenses/GPL. .\" created by instant / docbook-to-man