Fix various documentation issues (Closes: #518590, #518549, #518548, 518550)
authorCameron Dale <camrdale@gmail.com>
Sun, 21 Mar 2010 06:41:55 +0000 (23:41 -0700)
committerCameron Dale <camrdale@gmail.com>
Sun, 21 Mar 2010 06:41:55 +0000 (23:41 -0700)
apt-p2p.conf
debian/apt-p2p.conf.sgml
debian/apt-p2p.sgml
debian/changelog
debian/control

index 6d4a00f..0620979 100644 (file)
@@ -36,7 +36,10 @@ CACHE_DIR = /var/cache/apt-p2p
 #          for everybody to download
 # OTHER_DIRS = 
     
-# Whether it's OK to use an IP address from a known local/private range
+# 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.
 LOCAL_OK = no
 
 # Whether a remote peer can access the statistics page
@@ -106,7 +109,9 @@ MIN_PING_INTERVAL = 15m
 BUCKET_STALENESS = 1h
 
 # Whether it's OK to add nodes to the routing table that use an IP
-# address from a known local/private range.
+# 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.
 # If not specified here, the LOCAL_OK value in the DEFAULT section will be used.
 # LOCAL_OK = no
 
index 288864e..e8938d3 100644 (file)
@@ -52,7 +52,7 @@
       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>
            <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 address 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>
          <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.
+             <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>
index d8e9597..d8baf39 100644 (file)
@@ -47,7 +47,7 @@
   <refsynopsisdiv>
     <para>Normally &dhpackage; is run from init.d using <command>twistd</command>, in which case no &dhpackage;
         options can be specified on the command-line, and all configuration variables are
-        read from the default config file locations of ${HOME}/.apt-p2p/apt-p2p.conf and /etc/apt-p2p/apt-p2p.conf.
+        read from the default config file locations of $HOME/.apt-p2p/apt-p2p.conf and /etc/apt-p2p/apt-p2p.conf.
         The command is then:</para>
     <cmdsynopsis>
       <command>twistd</command> <arg choice="Req">-y /path/to/&dhpackage;</arg> <arg rep="Repeat"><option>twistd options</option></arg>
     <para><ulink url="http://portforward.com/"></ulink></para>
     
       </refsect2>
+      <refsect2>
+       <title>PRIVATE NETWORKS</title>
+
+    <para>Apt-P2P is not designed to function as a downloader for multiple
+        clients on a private network. Apt-P2P checks the source of incoming
+        requests and only responds to those from the localhost. For more
+        information:</para>
+
+    <para><ulink url="http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=481243"></ulink></para>
+    
+      </refsect2>
    </refsect1>
   <refsect1>
     <title>OPTIONS</title>
         <term><option>-c <replaceable>filename</replaceable>,</option> <option>--configfile=<replaceable>filename</replaceable></option></term>
          <listitem>
           <para>the <replaceable>filename</replaceable> to use for the configuration file, options found in this
-              file are combined with those in ${HOME}/.apt-p2p/apt-p2p.conf and /etc/apt-p2p/apt-p2p.conf
+              file are combined with those in $HOME/.apt-p2p/apt-p2p.conf and /etc/apt-p2p/apt-p2p.conf
               (see <citerefentry><refentrytitle>apt-p2p.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry> for the format of the file)</para>
         </listitem>
       </varlistentry>
index 98b7ea9..688617b 100644 (file)
@@ -2,8 +2,10 @@ apt-p2p (0.1.6) unstable; urgency=low
 
   * Fix a lot of lintian warnings and errors
     - Update standards version to 3.8.4 (no changes)
+  * Fix various documentation issues
+    (Closes: #518590, #518549, #518548, 518550)
 
- -- Cameron Dale <camrdale@gmail.com>  Sat, 20 Mar 2010 22:48:07 -0700
+ -- Cameron Dale <camrdale@gmail.com>  Sat, 20 Mar 2010 23:26:24 -0700
 
 apt-p2p (0.1.5) unstable; urgency=low
 
index 1b70b7a..3e1b1de 100644 (file)
@@ -2,7 +2,7 @@ Source: apt-p2p
 Section: net
 Priority: optional
 Maintainer: Cameron Dale <camrdale@gmail.com>
-Homepage: http://www.camrdale.org/apt-p2p.html
+Homepage: http://www.camrdale.org/apt-p2p/
 Standards-Version: 3.8.4
 Build-Depends: debhelper (>= 5.0.37.2)
 Build-Depends-Indep: python, python-support (>= 0.5.4), docbook-to-man