<!ENTITY dhfirstname "<firstname>Cameron</firstname>">
<!ENTITY dhsurname "<surname>Dale</surname>">
<!-- Please adjust the date whenever revising the manpage. -->
- <!ENTITY dhdate "<date>February 17, 2008</date>">
+ <!ENTITY dhdate "<date>April 25, 2008</date>">
<!-- SECTION should be 1-8, maybe w/ subsection other parameters are
allowed: see man(7), man(1). -->
<!ENTITY dhsection "<manvolnum>5</manvolnum>">
<!ENTITY dhemail "<email>camrdale@gmail.com</email>">
<!ENTITY dhusername "Cameron Dale">
<!ENTITY dhucpackage "<refentrytitle>apt-p2p.conf</refentrytitle>">
- <!ENTITY dhpackage "apt-p2p">
+ <!ENTITY dhpackage "apt-p2p.conf">
<!ENTITY debian "<productname>Debian</productname>">
<!ENTITY gnu "<acronym>GNU</acronym>">
entries overriding former ones:
<OrderedList>
<ListItem><para>/etc/apt-p2p/apt-p2p.conf</para></ListItem>
- <ListItem><para>${HOME}/.apt-p2p/apt-p2p.conf</para></ListItem>
+ <ListItem><para>$HOME/.apt-p2p/apt-p2p.conf</para></ListItem>
<ListItem><para>the location specified by the config-file parameter</para></ListItem>
</OrderedList>
</para>
<title>FORMAT</title>
<para>&dhpackage; has a structure similar to Microsoft Windows INI files.
- The configuration file consists of sections, led by a ``[section]'' header and followed
- by ``name = value'' or ``name: value'' entries, with continuations in the style of RFC 822
+ The configuration file consists of sections, led by a '[section]' header and followed
+ by 'name = value' or 'name: value' entries, with continuations in the style of RFC 822
(values can span multiple lines by starting the subsequent lines with one or more spaces).
Some values indicate times, in which case a suffix of 'd' for
days, 'h' for hours, 'm' for minutes, and 's' for seconds can be used.
Boolean values can be '1', 'yes', 'true', and 'on' to evaluate to True,
or '0', 'no', 'false', and 'off' to evaluate to false.
Note that leading whitespace is removed from values, and case is not important.
- Lines beginning with "#" or ";" are ignored and may be used to provide comments.</para>
+ Lines beginning with '#' or ';' are ignored and may be used to provide comments.</para>
</refsect1>
<refsect1>
<term><option>CACHE_DIR = <replaceable>directory</replaceable></option></term>
<listitem>
<para>The <replaceable>directory</replaceable> to store the downloaded files in.
- (Default is ${HOME}/.apt-p2p/cache.)</para>
+ (Default is $HOME/.apt-p2p/cache.)</para>
</listitem>
</varlistentry>
<varlistentry>
<varlistentry>
<term><option>LOCAL_OK = <replaceable>boolean</replaceable></option></term>
<listitem>
- <para>Whether it's OK to use an IP addres from a known local or private range.
+ <para>Whether it's OK for the application to use for sharing files an IP address from a
+ known local or private range (RFC 1918). This should only be set true if you are running
+ your own private apt-p2p network that no one else will be connecting to.
(Default is false)</para>
</listitem>
</varlistentry>
<listitem>
<para>The <replaceable>time</replaceable> after which to refresh DHT keys.
This should be a time slightly less than the DHT's KEY_EXPIRE value.
- (Default is 57 minutes.)</para>
+ (Default is 2.5 hours.)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>USERNAME = <replaceable>user</replaceable></option></term>
+ <listitem>
+ <para>The <replaceable>user</replaceable> name to try and run as.
+ Leaving this blank will try to run as current user.
+ (Default is 'apt-p2p'.)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>DHT = <replaceable>string</replaceable></option></term>
<listitem>
- <para>The DHT implementation to use. It must be possile to do (in python)
- ``from <DHT>.DHT import DHT'' to get a class that implements the IDHT interface.
- There should also be a similarly named section below to specify the options for the DHT.
- (Default is `apt_p2p_Khashmir')</para>
+ <para>The DHT implementation to use. It must be possile to do (in python) 'from
+ <DHT>.DHT import DHT' to get a class that implements the IDHT interface.
+ There should also be a similarly named section in the config file to specify
+ the options for the DHT. (Default is 'apt_p2p_Khashmir')</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>CONCURRENT_REQS = <replaceable>number</replaceable></option></term>
<listitem>
<para>The concurrent <replaceable>number</replaceable> of calls per find node/value request.
- (Default is 4.)</para>
+ (Default is 8.)</para>
</listitem>
</varlistentry>
<varlistentry>
<term><option>STORE_REDUNDANCY = <replaceable>number</replaceable></option></term>
<listitem>
<para>The <replaceable>number</replaceable> of redundant copies of a value to store in the DHT.
- (Default is 3.)</para>
+ (Default is 6.)</para>
</listitem>
</varlistentry>
<varlistentry>
(Default is 1 hour.)</para>
</listitem>
</varlistentry>
+ <varlistentry>
+ <term><option>LOCAL_OK = <replaceable>boolean</replaceable></option></term>
+ <listitem>
+ <para>Whether it's OK to add nodes to the routing table that use an IP address from a
+ known local or private range (RFC 1918). This should only be set true if you are running
+ your own private apt-p2p network that no one else will be connecting to.
+ (Default is to use the value specified in the DEFAULT section.)</para>
+ </listitem>
+ </varlistentry>
<varlistentry>
<term><option>KEY_EXPIRE = <replaceable>time</replaceable></option></term>
<listitem>
<para>The <replaceable>time</replaceable> to wait before expiring unrefreshed keys.
- (Default is 1 hour.)</para>
+ (Default is 3 hours.)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>KRPC_TIMEOUT = <replaceable>time</replaceable></option></term>
+ <listitem>
+ <para>The <replaceable>time</replaceable> to wait before KRPC requests timeout.
+ (Default is 9 seconds.)</para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><option>KRPC_INITIAL_DELAY = <replaceable>time</replaceable></option></term>
+ <listitem>
+ <para>The <replaceable>time</replaceable> to start with when resending KRPC requests using exponential backoff.
+ The request will first be resent after the delay set here.
+ The request will be resent again after twice the delay set here, and so on.
+ e.g. if TIMEOUT is 9 sec., and INITIAL_DELAY is 2 sec., then requests will
+ be resent at times 0, 2 (2 sec. later), and 6 (4 sec. later), and then will
+ timeout at 9. (Default is 2 seconds.)</para>
</listitem>
</varlistentry>
<varlistentry>
projects / quix0rs-apt-p2p.git / blobdiff