Rename project to apt-p2p.

[quix0rs-apt-p2p.git] / debian / apt-dht.conf.sgml

diff --git a/debian/apt-dht.conf.sgml b/debian/apt-dht.conf.sgml
index 6b7762ddd4c8f27a565f50bc3576425dd7c41f3c..301ccb1a5d7b7ec11a9e049b61600a9c2a6f1f1f 100644 (file)
--- a/debian/apt-dht.conf.sgml
+++ b/debian/apt-dht.conf.sgml
@@ -10,8 +10,8 @@
   <!ENTITY dhsection   "<manvolnum>5</manvolnum>">
   <!ENTITY dhemail     "<email>camrdale@gmail.com</email>">
   <!ENTITY dhusername  "Cameron Dale">
-  <!ENTITY dhucpackage "<refentrytitle>apt-dht.conf</refentrytitle>">
-  <!ENTITY dhpackage   "apt-dht">
+  <!ENTITY dhucpackage "<refentrytitle>apt-p2p.conf</refentrytitle>">
+  <!ENTITY dhpackage   "apt-p2p">
 
   <!ENTITY debian      "<productname>Debian</productname>">
   <!ENTITY gnu         "<acronym>GNU</acronym>">
@@ -51,8 +51,8 @@
     <para>Configuration information for &dhpackage; is searched for in the following order, with later
       entries overriding former ones:
       <OrderedList>
-        <ListItem><para>/etc/apt-dht/apt-dht.conf</para></ListItem>
-        <ListItem><para>${HOME}/.apt-dht/apt-dht.conf</para></ListItem>
+        <ListItem><para>/etc/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>
@@ -97,7 +97,7 @@
            <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-dht/cache.)</para>
+               (Default is ${HOME}/.apt-p2p/cache.)</para>
            </listitem>
          </varlistentry>
          <varlistentry>
@@ -123,13 +123,21 @@
                  to reload when a new request arrives. (Default is 5 minutes.)</para>
            </listitem>
          </varlistentry>
+         <varlistentry>
+           <term><option>KEY_REFRESH = <replaceable>time</replaceable></option></term>
+            <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>
+           </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 &lt;DHT&gt;.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_dht_Khashmir')</para>
+               (Default is `apt_p2p_Khashmir')</para>
            </listitem>
          </varlistentry>
          <varlistentry>
@@ -142,7 +150,7 @@
        </variablelist>
       </refsect2>
       <refsect2>
-       <title>apt_dht_Khashmir</title>
+       <title>apt_p2p_Khashmir</title>
 
         <variablelist>
          <varlistentry>
@@ -204,6 +212,17 @@
                  (Default is 3.)</para>
            </listitem>
          </varlistentry>
+         <varlistentry>
+           <term><option>RETRIEVE_VALUES = <replaceable>number</replaceable></option></term>
+            <listitem>
+             <para>The <replaceable>number</replaceable> of values to attempt to retrieve from the DHT.
+                 Setting this to 0 will try and get all values (which could take a while if
+                 a lot of nodes have values). Setting it negative will try to get that
+                 number of results from only the closest STORE_REDUNDANCY nodes to the hash.
+                 (Default is -10000, which is a large negative number so all values from the closest
+                 STORE_REDUNDANCY nodes will be retrieved.)</para>
+           </listitem>
+         </varlistentry>
          <varlistentry>
            <term><option>MAX_FAILURES = <replaceable>number</replaceable></option></term>
             <listitem>
@@ -227,21 +246,7 @@
            </listitem>
          </varlistentry>
          <varlistentry>
-           <term><option>KEINITIAL_DELAY = <replaceable>time</replaceable></option></term>
-            <listitem>
-             <para>The <replaceable>time</replaceable> to wait after startup before starting the key expirer.
-                 (Default is 15 seconds.)</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><option>KE_DELAY = <replaceable>time</replaceable></option></term>
-            <listitem>
-             <para>The <replaceable>time</replaceable> to wait between runs of the key expirer.
-                 (Default is 20 minutes.)</para>
-           </listitem>
-         </varlistentry>
-         <varlistentry>
-           <term><option>KE_AGE = <replaceable>time</replaceable></option></term>
+           <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>
@@ -262,7 +267,7 @@
     <title>SEE ALSO</title>
 
     <para>
-      <citerefentry><refentrytitle>apt-dht</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+      <citerefentry><refentrytitle>apt-p2p</refentrytitle><manvolnum>8</manvolnum></citerefentry>
     </para>
   </refsect1>
   <refsect1>