r180 - /debtorrent/trunk/debian/debtorrent-client.sgml
camrdale-guest at users.alioth.debian.org
camrdale-guest at users.alioth.debian.org
Tue Jul 17 01:04:08 UTC 2007
Author: camrdale-guest
Date: Tue Jul 17 01:04:08 2007
New Revision: 180
URL: http://svn.debian.org/wsvn/debtorrent/?sc=1&rev=180
Log:
Updated the man page.
Modified:
debtorrent/trunk/debian/debtorrent-client.sgml
Modified: debtorrent/trunk/debian/debtorrent-client.sgml
URL: http://svn.debian.org/wsvn/debtorrent/debtorrent/trunk/debian/debtorrent-client.sgml?rev=180&op=diff
==============================================================================
--- debtorrent/trunk/debian/debtorrent-client.sgml (original)
+++ debtorrent/trunk/debian/debtorrent-client.sgml Tue Jul 17 01:04:08 2007
@@ -46,18 +46,29 @@
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
- <command>debtorrent-client</command> <arg rep="Repeat"><option>options</option></arg>
+ <command>&dhpackage;</command> <arg rep="Repeat"><option>options</option></arg>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>DESCRIPTION</title>
- <para>This manual page documents briefly the options available to the &dhpackage; commands.</para>
-
- <para><command>btlaunchmany</command> is a program that allows 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.</para>
-
+ <para>This manual page documents briefly the options available to the &dhpackage; command.</para>
+
+ <para><command>&dhpackage;</command> is a daemon that listens for requests for packages from APT, and then downloads
+ them using bittorrent, a peer-to-peer, scatter-gather network protocol.</para>
+
+ <para>In order for APT to send it's requests to &dhpackage;, the source.list entries must be modified to point to the
+ &dhpackage; proxy address. If &dhpackage; is running on this machine, then adding "localhost:9988/" to the beginning
+ of each entry should be sufficient. For example, if your sources.list contains a line like this:</para>
+
+ <para>deb http://ftp.us.debian.org/debian etch main contrib non-free</para>
+
+ <para>then replace it with this:</para>
+
+ <para>deb http://localhost:9988/ftp.us.debian.org/debian etch main contrib non-free</para>
+
+ <para>The port can be changed in the &dhpackage; config file in /etc/debtorrent/&dhpackage;.conf, or using the "--port"
+ command-line option described below, but it defaults to 9988.</para>
</refsect1>
<refsect1>
<title>OPTIONS</title>
@@ -65,24 +76,96 @@
<para>These programs follow the usual &gnu; command line syntax,
with long options starting with two dashes (`--'). A summary of
options is included below.</para>
-
- <variablelist>
- <varlistentry>
- <term><option>--max_uploads <replaceable>number</replaceable></option></term>
- <listitem>
- <para>the maximum <replaceable>number</replaceable> of uploads to allow at once (defaults to 7)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--keepalive_interval <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>seconds</replaceable> to pause between sending keepalives (defaults to 120.0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--download_slice_size <replaceable>bytes</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>bytes</replaceable> to query for per request (defaults to 16384)</para>
+
+ <refsect2>
+ <title>CONFIG FILES</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--configfile <replaceable>filename</replaceable></option></term>
+ <listitem>
+ <para>the <replaceable>filename</replaceable> to use for the configuration file, if not specified then a file in
+ /etc/debtorrent will be used, followed by a file in the .DebTorrent directory in the user's home directory</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--save_options</option> 0|1</term>
+ <listitem>
+ <para>whether to save the current options as the new default configuration
+ for the current program (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>LOCATIONS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--download_dir <replaceable>directory</replaceable></option></term>
+ <listitem>
+ <para>the local <replaceable>directory</replaceable> to save the downloads in, if left blank the default of the user's home directory will be used</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--saveas_style</option> 1|2</term>
+ <listitem>
+ <para>how to name the torrent download directories, 1 = mirror_dists_suite_section_binary-arch, 2 = mirror (experimental)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--cache_dir <replaceable>directory</replaceable></option></term>
+ <listitem>
+ <para>the local <replaceable>directory</replaceable> to save cache data in, if left blank then a .DebTorrent directory in the user's home directory will be used</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--expire_cache_data <replaceable>days</replaceable></option></term>
+ <listitem>
+ <para>the number of <replaceable>days</replaceable> after which you wish to expire old cache data (0 = disabled) (defaults to 30)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--log_dir <replaceable>directory</replaceable></option></term>
+ <listitem>
+ <para>the local <replaceable>directory</replaceable> to save log files in, if left blank then the cache directory will be used</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>RATE LIMIITS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--max_upload_rate <replaceable>kB/s</replaceable></option></term>
+ <listitem>
+ <para>the maximum <replaceable>kB/s</replaceable> to upload at (0 = no limit, -1 = automatic) (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--max_download_rate <replaceable>kB/s</replaceable></option></term>
+ <listitem>
+ <para>the maximum <replaceable>kB/s</replaceable> to download at (0 = no limit) (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--upload_rate_fudge <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>the time equivalent in <replaceable>seconds</replaceable> of writing to kernel-level TCP buffer, for rate adjustment (defaults to
+ 5.0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--tcp_ack_fudge <replaceable>overhead</replaceable></option></term>
+ <listitem>
+ <para>how much TCP ACK download <replaceable>overhead</replaceable> to add to upload rate calculations (0 = disabled)
+ (defaults to 0.029999999999999999)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--max_rate_period <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>the maximum number of <replaceable>seconds</replaceable> to use in guessing what the current rate estimate represents (defaults to 20.0)</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -91,17 +174,16 @@
<para>when limiting the upload rate, the number of <replaceable>bytes</replaceable> to send at a time (defaults to 1460)</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><option>--request_backlog <replaceable>number</replaceable></option></term>
- <listitem>
- <para>the maximum <replaceable>number</replaceable> of requests to keep in a single pipe at once (defaults to 10)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--max_message_length <replaceable>length</replaceable></option></term>
- <listitem>
- <para>the maximum <replaceable>length</replaceable> prefix encoding you'll accept over the wire.
- Larger values will get the connection dropped. (defaults to 8388608)</para>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>CONNECTIONS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--bind <replaceable>ip</replaceable>|<replaceable>hostname</replaceable>[,<replaceable>ip</replaceable>|<replaceable>hostname</replaceable> ...]</option></term>
+ <listitem>
+ <para>a comma-separated list of <replaceable>ips</replaceable> and <replaceable>hostnames</replaceable> to bind to locally (defaults to '')</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -129,19 +211,36 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--responsefile <replaceable>file</replaceable></option></term>
- <listitem>
- <para>the <replaceable>file</replaceable> 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 '')</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--url <replaceable>URL</replaceable></option></term>
- <listitem>
- <para>the <replaceable>URL</replaceable> 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 '')</para>
- </listitem>
- </varlistentry>
+ <term><option>--ipv6_enabled</option> 0|1</term>
+ <listitem>
+ <para>whether to allow the client to connect to peers via IPv6 (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--ipv6_binds_v4</option> 0|1</term>
+ <listitem>
+ <para>set if an IPv6 server socket won't also field IPv4 connections (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--timeout <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>the number of <replaceable>seconds</replaceable> to wait between closing sockets which nothing has been received on
+ (defaults to 300.0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--timeout_check_interval <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>the number of <replaceable>seconds</replaceable> to wait between checking if any connections have timed out (defaults to 60.0)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>ENCRYPTION</title>
+ <variablelist>
<varlistentry>
<term><option>--crypto_allowed</option> 0|1</term>
<listitem>
@@ -161,44 +260,136 @@
in an effectively firewalled state on older trackers. (defaults to 0)</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><option>--selector_enabled</option> 0|1</term>
- <listitem>
- <para>whether to enable the file selector and fast resume function (defaults to 1)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--expire_cache_data <replaceable>days</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>days</replaceable> after which you wish to expire old cache data (0 = disabled) (defaults to 10)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--priority</option> -1|0|1|2[,-1|0|1|2 ...]</term>
- <listitem>
- <para>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 '')</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--saveas <replaceable>filename</replaceable></option></term>
- <listitem>
- <para>the local <replaceable>filename</replaceable> to save the file as, null indicates query user (defaults to '')</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--timeout <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>seconds</replaceable> to wait between closing sockets which nothing has been received on
- (defaults to 300.0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--timeout_check_interval <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>seconds</replaceable> to wait between checking if any connections have timed out (defaults to 60.0)</para>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>APT REQUESTS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--port <replaceable>port</replaceable></option></term>
+ <listitem>
+ <para>the <replaceable>port</replaceable> to listen on (defaults to 9988)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--show_infopage</option> 0|1</term>
+ <listitem>
+ <para>whether to display an info page when the tracker's root dir is loaded
+ (defaults to 1)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--infopage_redirect <replaceable>URL</replaceable></option></term>
+ <listitem>
+ <para>redirect the info page to this <replaceable>URL</replaceable> (defaults to '')</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--favicon <replaceable>filename</replaceable></option></term>
+ <listitem>
+ <para>the <replaceable>filename</replaceable> containing x-icon data to return when browser requests
+ favicon.ico (defaults to '')</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--display_path</option> 0|1</term>
+ <listitem>
+ <para>whether to display the full path or the torrent contents for each
+ torrent (defaults to 1 for <command>btlaunchmany</command>, 0 for <command>btlaunchmanycurses</command>)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--allow_get</option> 0|1</term>
+ <listitem>
+ <para>use with allowed_dir; adds a /file?hash=<replaceable>hash</replaceable> URL that allows users
+ to download the torrent file (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--min_time_between_log_flushes <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>the minimum number of <replaceable>seconds</replaceable> it must have been since the last flush to do another one
+ (defaults to 3.0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--hupmonitor</option> 0|1</term>
+ <listitem>
+ <para>whether to reopen the log file upon receipt of HUP signal (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--allowed_ips <replaceable>file</replaceable></option></term>
+ <listitem>
+ <para>only allow connections from IPs specified in the given <replaceable>file</replaceable>, which
+ contains subnet data in the format: aa.bb.cc.dd/len (defaults to '')</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--banned_ips <replaceable>file</replaceable></option></term>
+ <listitem>
+ <para>don't allow connections from IPs specified in the given <replaceable>file</replaceable>, which
+ contains IP range data in the format: xxx:xxx:ip1-ip2 (defaults to '')</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--parse_ip_files <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>number of <replaceable>seconds</replaceable> between reloading of allowed and banned IP lists (defaults to 60)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>BACKUP HTTP DOWNLOADER</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--disable_http_downloader</option> 0|1</term>
+ <listitem>
+ <para>whether to disable the backup HTTP downloader, WARNING: for testing purposes only (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>OTHER THINGS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--separate_all</option> 0|1|2|3</term>
+ <listitem>
+ <para>whether to separate the architecture:all packages into a separate torrent, 0 = don't separate, 1 = separate, run
+ architecture:all, 2 = separate, run non-architecture:all torrent, 3 = separate, run both</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+ </refsect1>
+ <refsect1>
+ <title>ADVANCED OPTIONS</title>
+
+ <para>WARNING: The options below control some of the inner
+ workings of the bittorrent client. You should not need to change
+ any of them, and it is NOT recommended that you change them unless
+ you are VERY familiar with bittorrent, as poor choices for some of
+ the variables can have bad results, such as other clients refusing
+ to connect to you.</para>
+
+ <refsect2>
+ <title>BITTORRENT OPTIONS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--keepalive_interval <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>the number of <replaceable>seconds</replaceable> to pause between sending keepalives (defaults to 120.0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--download_slice_size <replaceable>bytes</replaceable></option></term>
+ <listitem>
+ <para>the number of <replaceable>bytes</replaceable> to query for per request (defaults to 16384)</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -208,54 +399,85 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--max_rate_period <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the maximum number of <replaceable>seconds</replaceable> to use in guessing what the current rate estimate represents (defaults to 20.0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--bind <replaceable>ip</replaceable>|<replaceable>hostname</replaceable>[,<replaceable>ip</replaceable>|<replaceable>hostname</replaceable> ...]</option></term>
- <listitem>
- <para>a comma-separated list of <replaceable>ips</replaceable> and <replaceable>hostnames</replaceable> to bind to locally (defaults to '')</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--ipv6_enabled</option> 0|1</term>
- <listitem>
- <para>whether to allow the client to connect to peers via IPv6 (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--ipv6_binds_v4</option> 0|1</term>
- <listitem>
- <para>set if an IPv6 server socket won't also field IPv4 connections (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--upnp_nat_access</option> 0|1|2</term>
- <listitem>
- <para>attempt to autoconfigure a UPnP router to forward a server port (0 = disabled, 1 = mode 1
- [fast], 2 = mode 2 [slow]) (defaults to 1)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--upload_rate_fudge <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the time equivalent in <replaceable>seconds</replaceable> of writing to kernel-level TCP buffer, for rate adjustment (defaults to
- 5.0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--tcp_ack_fudge <replaceable>overhead</replaceable></option></term>
- <listitem>
- <para>how much TCP ACK download <replaceable>overhead</replaceable> to add to upload rate calculations (0 = disabled)
- (defaults to 0.029999999999999999)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--display_interval <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>seconds</replaceable> between updates of displayed information (defaults to 0.5)</para>
+ <term><option>--max_message_length <replaceable>length</replaceable></option></term>
+ <listitem>
+ <para>the maximum <replaceable>length</replaceable> prefix encoding you'll accept over the wire.
+ Larger values will get the connection dropped. (defaults to 8388608)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--rarest_first_cutoff <replaceable>number</replaceable></option></term>
+ <listitem>
+ <para>the <replaceable>number</replaceable> of downloads at which to switch from random to rarest first (defaults to 2)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--rarest_first_priority_cutoff <replaceable>number</replaceable></option></term>
+ <listitem>
+ <para>the <replaceable>number</replaceable> of peers which need to have a piece before other partials take priority over
+ rarest first (defaults to 5)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--breakup_seed_bitfield</option> 0|1</term>
+ <listitem>
+ <para>whether to send an incomplete bitfield and then 'have' messages, in
+ order to get around stupid ISP manipulation (defaults to 1)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--snub_time <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>the number of <replaceable>seconds</replaceable> to wait for data to come in over a connection before assuming it's
+ semi-permanently choked (defaults to 30.0)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>INCENTIVE MECHANISM</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--max_uploads <replaceable>number</replaceable></option></term>
+ <listitem>
+ <para>the maximum <replaceable>number</replaceable> of uploads to allow at once (defaults to 7)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--min_uploads <replaceable>number</replaceable></option></term>
+ <listitem>
+ <para>the <replaceable>number</replaceable> of uploads to fill out to with extra optimistic unchokes (defaults to 4)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--round_robin_period <replaceable>seconds</replaceable></option></term>
+ <listitem>
+ <para>the number of <replaceable>seconds</replaceable> between the client switching upload targets (defaults to 30)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--auto_kick</option> 0|1</term>
+ <listitem>
+ <para>whether to allow the client to automatically kick/ban peers that send bad data (defaults to 1)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--security</option> 0|1</term>
+ <listitem>
+ <para>whether to enable extra security features intended to prevent abuse (defaults to 1)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>TRACKER CONNECTIONS</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--default_tracker <replaceable>announce</replaceable></option></term>
+ <listitem>
+ <para>the default tracker <replaceable>announce</replaceable> address to use for new torrents that don't specify one (defaults to 'http://dttracker.debian.net:6969/announce')</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -271,16 +493,47 @@
</listitem>
</varlistentry>
<varlistentry>
+ <term><option>--max_initiate <replaceable>number</replaceable></option></term>
+ <listitem>
+ <para>the <replaceable>number</replaceable> of peers at which to stop initiating new connections (defaults to 40)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--max_connections <replaceable>number</replaceable></option></term>
+ <listitem>
+ <para>the absolute maximum <replaceable>number</replaceable> of peers to connect with (0 = no limit) (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
<term><option>--http_timeout <replaceable>seconds</replaceable></option></term>
<listitem>
<para>the number of <replaceable>seconds</replaceable> to wait before assuming that an http connection
- has timed out (defaults to 60)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--max_initiate <replaceable>number</replaceable></option></term>
- <listitem>
- <para>the <replaceable>number</replaceable> of peers at which to stop initiating new connections (defaults to 40)</para>
+ has timed out (defaults to 60)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>FILE SYSTEM</title>
+ <variablelist>
+ <varlistentry>
+ <term><option>--buffer_reads</option> 0|1</term>
+ <listitem>
+ <para>whether to buffer disk reads (defaults to 1)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--write_buffer_size <replaceable>space</replaceable></option></term>
+ <listitem>
+ <para>the maximum amount of <replaceable>space</replaceable> to use for buffering disk writes (in megabytes, 0 = disabled)
+ (defaults to 4)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--max_files_open <replaceable>number</replaceable></option></term>
+ <listitem>
+ <para>the maximum <replaceable>number</replaceable> of files to keep open at a time, 0 means no limit (defaults to 50)</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -290,148 +543,48 @@
</listitem>
</varlistentry>
<varlistentry>
- <term><option>--max_upload_rate <replaceable>kB/s</replaceable></option></term>
- <listitem>
- <para>the maximum <replaceable>kB/s</replaceable> to upload at (0 = no limit, -1 = automatic) (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--max_download_rate <replaceable>kB/s</replaceable></option></term>
- <listitem>
- <para>the maximum <replaceable>kB/s</replaceable> to download at (0 = no limit) (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--alloc_type</option> normal|background|pre-allocate|sparse</term>
- <listitem>
- <para>the allocation type (may be 'normal', 'background', 'pre-allocate' or 'sparse') (defaults to 'normal')</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--alloc_rate <replaceable>MiB/s</replaceable></option></term>
- <listitem>
- <para>the rate (in <replaceable>MiB/s</replaceable>) to allocate space at using background allocation (defaults to 2.0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--buffer_reads</option> 0|1</term>
- <listitem>
- <para>whether to buffer disk reads (defaults to 1)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--write_buffer_size <replaceable>space</replaceable></option></term>
- <listitem>
- <para>the maximum amount of <replaceable>space</replaceable> to use for buffering disk writes (in megabytes, 0 = disabled)
- (defaults to 4)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--breakup_seed_bitfield</option> 0|1</term>
- <listitem>
- <para>whether to send an incomplete bitfield and then 'have' messages, in
- order to get around stupid ISP manipulation (defaults to 1)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--snub_time <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>seconds</replaceable> to wait for data to come in over a connection before assuming it's
- semi-permanently choked (defaults to 30.0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--spew</option> 0|1</term>
- <listitem>
- <para>whether to display diagnostic info to stdout. This option is not very useful when using the curses or gui interfaces. (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--rarest_first_cutoff <replaceable>number</replaceable></option></term>
- <listitem>
- <para>the <replaceable>number</replaceable> of downloads at which to switch from random to rarest first (defaults to 2)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--rarest_first_priority_cutoff <replaceable>number</replaceable></option></term>
- <listitem>
- <para>the <replaceable>number</replaceable> of peers which need to have a piece before other partials take priority over
- rarest first (defaults to 5)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--min_uploads <replaceable>number</replaceable></option></term>
- <listitem>
- <para>the <replaceable>number</replaceable> of uploads to fill out to with extra optimistic unchokes (defaults to 4)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--max_files_open <replaceable>number</replaceable></option></term>
- <listitem>
- <para>the maximum <replaceable>number</replaceable> of files to keep open at a time, 0 means no limit (defaults to 50)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--round_robin_period <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>seconds</replaceable> between the client switching upload targets (defaults to 30)</para>
- </listitem>
- </varlistentry>
+ <term><option>--double_check</option> 0|1</term>
+ <listitem>
+ <para>whether to double-check data being written to the disk for errors (may increase CPU load)
+ (defaults to 1)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--triple_check</option> 0|1</term>
+ <listitem>
+ <para>whether to thoroughly check data being written to the disk (may slow disk access)
+ (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--lock_files</option> 0|1</term>
+ <listitem>
+ <para>whether to lock files the client is working with (defaults to 1)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--lock_while_reading</option> 0|1</term>
+ <listitem>
+ <para>whether to lock access to files being read (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>--auto_flush <replaceable>minutes</replaceable></option></term>
+ <listitem>
+ <para>the number of <replaceable>minutes</replaceable> between automatic flushes to disk (0 = disabled) (defaults to 0)</para>
+ </listitem>
+ </varlistentry>
+ </variablelist>
+ </refsect2>
+
+ <refsect2>
+ <title>ADVANCED FEATURES</title>
+ <variablelist>
<varlistentry>
<term><option>--super_seeder</option> 0|1</term>
<listitem>
<para>whether to use special upload-efficiency-maximizing routines (only for dedicated seeds)
- (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--security</option> 0|1</term>
- <listitem>
- <para>whether to enable extra security features intended to prevent abuse (defaults to 1)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--max_connections <replaceable>number</replaceable></option></term>
- <listitem>
- <para>the absolute maximum <replaceable>number</replaceable> of peers to connect with (0 = no limit) (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--auto_kick</option> 0|1</term>
- <listitem>
- <para>whether to allow the client to automatically kick/ban peers that send bad data (defaults to 1)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--double_check</option> 0|1</term>
- <listitem>
- <para>whether to double-check data being written to the disk for errors (may increase CPU load)
- (defaults to 1)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--triple_check</option> 0|1</term>
- <listitem>
- <para>whether to thoroughly check data being written to the disk (may slow disk access)
- (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--lock_files</option> 0|1</term>
- <listitem>
- <para>whether to lock files the client is working with (defaults to 1)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--lock_while_reading</option> 0|1</term>
- <listitem>
- <para>whether to lock access to files being read (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--auto_flush <replaceable>minutes</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>minutes</replaceable> between automatic flushes to disk (0 = disabled) (defaults to 0)</para>
+ (defaults to 0)</para>
</listitem>
</varlistentry>
<varlistentry>
@@ -440,35 +593,8 @@
<para>the <replaceable>code</replaceable> to send to a tracker, identifying as a dedicated seed (defaults to '')</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><option>--save_options</option> 0|1</term>
- <listitem>
- <para>whether to save the current options as the new default configuration
- for the current program (defaults to 0)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--parse_dir_interval <replaceable>seconds</replaceable></option></term>
- <listitem>
- <para>the number of <replaceable>seconds</replaceable> between re-scanning the provided directory (defaults to 60)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--saveas_style</option> 1|2|3</term>
- <listitem>
- <para>how to name torrent downloads (1 = rename to torrent name, 2 = save
- under name in torrent, 3 = save in directory under torrent name)
- (defaults to 1 for <command>btlaunchmany</command>, 2 for <command>btlaunchmanycurses</command>)</para>
- </listitem>
- </varlistentry>
- <varlistentry>
- <term><option>--display_path</option> 0|1</term>
- <listitem>
- <para>whether to display the full path or the torrent contents for each
- torrent (defaults to 1 for <command>btlaunchmany</command>, 0 for <command>btlaunchmanycurses</command>)</para>
- </listitem>
- </varlistentry>
- </variablelist>
+ </variablelist>
+ </refsect2>
</refsect1>
<refsect1>
More information about the Debtorrent-commits
mailing list