Fix spelling errors in the documentation. Found with codespell.
[privoxy.git] / doc / source / p-config.sgml
index 6dcc4c9..ce36f36 100644 (file)
@@ -3,9 +3,9 @@
 
  Purpose     :  Used with other docs and files only.
 
- $Id: p-config.sgml,v 2.57 2010/01/11 12:40:23 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.69 2011/03/27 14:14:13 fabiankeil Exp $
 
- Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
@@ -97,7 +97,7 @@
  Sample Configuration File for Privoxy v&p-version;
 </title>
 <para>
- $Id: p-config.sgml,v 2.57 2010/01/11 12:40:23 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.69 2011/03/27 14:14:13 fabiankeil Exp $
 </para>
 <para>
 Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
@@ -796,7 +796,7 @@ actionsfile
 </variablelist>
 
 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
-<![%config-file;[<literallayout>@@#filterfile user.filter      # User customizations</literallayout>]]>
+<![%config-file;[<literallayout>@@filterfile user.filter      # User customizations</literallayout>]]>
 </sect3>
 
 
@@ -1009,7 +1009,7 @@ actionsfile
   debug     2 # show each connection status
   debug     4 # show I/O status
   debug     8 # show header parsing
-  debug    16 # log all data written to the network into the logfile
+  debug    16 # log all data written to the network
   debug    32 # debug force feature
   debug    64 # debug regular expression filters
   debug   128 # debug redirects
@@ -1019,6 +1019,7 @@ actionsfile
   debug  2048 # CGI user interface
   debug  4096 # Startup banner and warnings.
   debug  8192 # Non-fatal errors
+  debug 32768 # log all data read from the network
 </programlisting>
    </para>
    <para>
@@ -1710,8 +1711,8 @@ ACLs: permit-access and deny-access</title>
     IP addresses, only the first one is used.
    </para>
    <para>
-     Some systems allows IPv4 client to connect to IPv6 server socket.
-     Then the client's IPv4 address will be translated by system into
+     Some systems allow IPv4 clients to connect to IPv6 server sockets.
+     Then the client's IPv4 address will be translated by the system into
      IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
      mapped IPv6 address). <application>Privoxy</application> can handle it
      and maps such ACL addresses automatically.
@@ -1964,7 +1965,7 @@ ACLs: permit-access and deny-access</title>
    </para>
    <para>
     <programlisting>
-  foward   /                   [2001:DB8::1]:8000
+  forward   /                   [2001:DB8::1]:8000
 </programlisting>
    </para>
    <para>
@@ -2536,6 +2537,23 @@ forward-socks4, forward-socks4a and forward-socks5</title>
     This option has no effect if <application>Privoxy</application>
     has been compiled without keep-alive support.
    </para>
+   <para>
+    Note that a timeout of five seconds as used in the default
+    configuration file significantly decreases the number of
+    connections that will be reused. The value is used because
+    some browsers limit the number of connections they open to
+    a single host and apply the same limit to proxies. This can
+    result in a single website <quote>grabbing</quote> all the
+    connections the browser allows, which means connections to
+    other websites can't be opened until the connections currently
+    in use time out.
+   </para>
+   <para>
+    Several users have reported this as a Privoxy bug, so the
+    default value has been reduced. Consider increasing it to
+    300 seconds or even more if you think your browser can handle
+    it. If your browser appears to be hanging it can't.
+   </para>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -2547,7 +2565,7 @@ forward-socks4, forward-socks4a and forward-socks5</title>
   </listitem>
  </varlistentry>
 </variablelist>
-<![%config-file;[<literallayout>@@keep-alive-timeout 300</literallayout>]]>
+<![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
 </sect3>
 
 
@@ -2768,9 +2786,9 @@ forward-socks4, forward-socks4a and forward-socks5</title>
   <term>Notes:</term>
   <listitem>
    <para>
-    For SOCKS requests the timeout currently doesn't start until
-    the SOCKS server accepted the request. This will be fixed in
-    the next release.
+    The default is quite high and you probably want to reduce it.
+    If you aren't using an occasionally slow proxy like Tor, reducing
+    it to a few seconds should be fine.
    </para>
   </listitem>
  </varlistentry>
@@ -2870,25 +2888,13 @@ forward-socks4, forward-socks4a and forward-socks5</title>
 
 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
 <variablelist>
- <varlistentry>
-  <term>Note:</term>
-  <listitem>
-   <para>
-    This is a work-around for Firefox bug 492459:
-    <quote>
-    Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
-    </quote>
-    (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
-       >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
-   </para>
-  </listitem>
- </varlistentry>
  <varlistentry>
   <term>Specifies:</term>
   <listitem>
    <para>
     The status code Privoxy returns for pages blocked with
-    <literal><link linkend="handle-as-empty-document">+handle-as-empty-document</link></literal>.
+    <!--  URL will only end up in the user manual so the relative link should work. -->
+    <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
    </para>
   </listitem>
  </varlistentry>
@@ -2923,8 +2929,24 @@ forward-socks4, forward-socks4a and forward-socks5</title>
    </para>
   </listitem>
  </varlistentry>
+ <varlistentry>
+  <term>Notes:</term>
+  <listitem>
+   <para>
+    This is a work-around for Firefox bug 492459:
+    <quote>
+    Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
+    </quote>
+    (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
+       >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
+    As the bug has been fixed for quite some time this option should no longer
+    be needed and will be removed in a future release. Please speak up if you
+    have a reason why the option should be kept around.
+   </para>
+  </listitem>
+ </varlistentry>
 </variablelist>
-<![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 0</literallayout>]]>
+<![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
 </sect3>