projects / privoxy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Remove kill-popups action.
[privoxy.git] / doc / source / p-config.sgml
diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index b25860f..0e47644 100644 (file)
--- a/doc/source/p-config.sgml
+++ b/doc/source/p-config.sgml
@@ -3,9 +3,9 @@
 
  Purpose     :  Used with other docs and files only.
 
 
  Purpose     :  Used with other docs and files only.
 
- $Id: p-config.sgml,v 2.20 2007/11/07 11:36:53 hal9 Exp $
+ $Id: p-config.sgml,v 2.29 2008/03/26 18:07:18 fabiankeil Exp $
 
 
- Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
  See LICENSE.
 
  ========================================================================
  See LICENSE.
 
  ========================================================================
@@ -95,10 +95,10 @@
  Sample Configuration File for Privoxy v&p-version;
 </title>
 <para>
  Sample Configuration File for Privoxy v&p-version;
 </title>
 <para>
- $Id: p-config.sgml,v 2.20 2007/11/07 11:36:53 hal9 Exp $
+ $Id: p-config.sgml,v 2.29 2008/03/26 18:07:18 fabiankeil Exp $
 </para>
 <para>
 </para>
 <para>
-Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
 </para>
 
 <para>
 </para>
 
 <para>
@@ -354,7 +354,7 @@ II. FORMAT OF THE CONFIGURATION FILE
   <listitem>
    <para>
     The value of this option only matters if the experimental trust mechanism has been
   <listitem>
    <para>
     The value of this option only matters if the experimental trust mechanism has been
-    activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> above.)
+    activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
    </para>
    <para>
     If you use the trust mechanism, it is a good idea to write up some on-line
    </para>
    <para>
     If you use the trust mechanism, it is a good idea to write up some on-line
@@ -504,7 +504,7 @@ II. FORMAT OF THE CONFIGURATION FILE
  <varlistentry>
   <term>Specifies:</term>
   <listitem>
  <varlistentry>
   <term>Specifies:</term>
   <listitem>
-   <para>The directory where the other configuration files are located</para>
+   <para>The directory where the other configuration files are located.</para>
   </listitem>
  </varlistentry>
  <varlistentry>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -529,7 +529,7 @@ II. FORMAT OF THE CONFIGURATION FILE
   <term>Notes:</term>
   <listitem>
    <para>
   <term>Notes:</term>
   <listitem>
    <para>
-    No trailing <quote><literal>/</literal></quote>, please
+    No trailing <quote><literal>/</literal></quote>, please.
    </para>
   <!-- 
    This is really outdated and not likely to happen. HB 09/20/06
    </para>
   <!-- 
    This is really outdated and not likely to happen. HB 09/20/06
@@ -555,7 +555,7 @@ II. FORMAT OF THE CONFIGURATION FILE
  <varlistentry>
   <term>Specifies:</term>
   <listitem>
  <varlistentry>
   <term>Specifies:</term>
   <listitem>
-   <para>An alternative directory where the templates are loaded from</para>
+   <para>An alternative directory where the templates are loaded from.</para>
   </listitem>
  </varlistentry>
  <varlistentry>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -580,12 +580,12 @@ II. FORMAT OF THE CONFIGURATION FILE
   <term>Notes:</term>
   <listitem>
    <para>
   <term>Notes:</term>
   <listitem>
    <para>
-    Privoxy's original templates are usually overwritten
-    with each update. Use this option to relocate customized templates
-    that should be kept. Note that template variables might change
-    between updates and templates are not guaranteed to work with
+    <application>Privoxy's</application> original templates are usually
+    overwritten with each update. Use this option to relocate customized
+    templates that should be kept. As template variables might change
+    between updates, you shouldn't expect templates to work with
     <application>Privoxy</application> releases other than the one
     <application>Privoxy</application> releases other than the one
-    they were part of.
+    they were part of, though.
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -603,8 +603,9 @@ II. FORMAT OF THE CONFIGURATION FILE
   <term>Specifies:</term>
   <listitem>
    <para>
   <term>Specifies:</term>
   <listitem>
    <para>
-    The directory where all logging takes place (i.e. where <filename>logfile</filename> and 
-    <filename>jarfile</filename> are located) 
+    The directory where all logging takes place
+    (i.e. where <filename>logfile</filename> and
+    <filename>jarfile</filename> are located).
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -630,7 +631,7 @@ II. FORMAT OF THE CONFIGURATION FILE
   <term>Notes:</term>
   <listitem>
    <para>
   <term>Notes:</term>
   <listitem>
    <para>
-    No trailing <quote><literal>/</literal></quote>, please
+    No trailing <quote><literal>/</literal></quote>, please.
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -694,13 +695,13 @@ actionsfile
     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
    </para>
    <para> 
     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
    </para>
    <para> 
-    The default values include standard.action, which is used for internal
-    purposes and should be loaded, default.action, which is the
-    <quote>main</quote> actions file maintained by the developers, and
+    The default values include <filename>standard.action</filename>, which is used
+    for internal purposes and should be loaded, <filename>default.action</filename>,
+    which is the <quote>main</quote> actions file maintained by the developers, and
     <filename>user.action</filename>, where you can make your personal additions.
    </para>
    <para> 
     <filename>user.action</filename>, where you can make your personal additions.
    </para>
    <para> 
-    Actions files are where all the per site and per URL configuration is done for 
+    Actions files contain all the per site and per URL configuration for 
     ad blocking, cookie management, privacy considerations, etc.
     There is no point in using <application>Privoxy</application> without at 
     least one actions file.
     ad blocking, cookie management, privacy considerations, etc.
     There is no point in using <application>Privoxy</application> without at 
     least one actions file.
@@ -820,27 +821,20 @@ actionsfile
  <varlistentry>
   <term>Default value:</term>
   <listitem>
  <varlistentry>
   <term>Default value:</term>
   <listitem>
-   <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
+   <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>Effect if unset:</term>
   <listitem>
    <para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>Effect if unset:</term>
   <listitem>
    <para>
-    Logging is disabled unless <literal>--no-daemon</literal> mode is used.
+    No logfile is written.
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>Notes:</term>
   <listitem>
    </para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>Notes:</term>
   <listitem>
- <!--
-  removed per bug report 688728 02/20/03 HB
-  
-   <para>
-    The windows version will additionally log to the console.
-   </para>
-  --> 
    <para>
     The logfile is where all logging and error messages are written. The level
     of detail and number of messages are set with the <literal>debug</literal>
    <para>
     The logfile is where all logging and error messages are written. The level
     of detail and number of messages are set with the <literal>debug</literal>
@@ -850,15 +844,14 @@ actionsfile
     is doing.
    </para>
    <para>
     is doing.
    </para>
    <para>
-    Many users will never look at it, however, and it's a privacy risk
-    if third parties can get access to it. It is therefore disabled by
-    default in <application>Privoxy</application> 3.0.7 and later.
-  </para>
-  <para>
-    For troubleshooting purposes, you will have to explicitly enable it.
-    Please don't file any support requests without trying to reproduce
-    the problem with logging enabled first. Once you read the log messages,
-    you may even be able to solve the problem on your own.
+    Depending on the debug options below, the logfile may be a privacy risk
+    if third parties can get access to it. As most users will never look
+    at it, <application>Privoxy</application> 3.0.7 and later only log fatal
+    errors by default.
+   </para>
+   <para>
+    For most troubleshooting purposes, you will have to change that,
+    please refer to the debugging section for details.
    </para>
    <para>
     Your logfile will grow indefinitely, and you will probably want to
    </para>
    <para>
     Your logfile will grow indefinitely, and you will probably want to
@@ -866,19 +859,6 @@ actionsfile
     (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
     <command>logrotate</command> script has been included.
    </para> 
     (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
     <command>logrotate</command> script has been included.
    </para> 
-<!--
-No one cares enough about SuSE to build privoxy packages,
-so most Privoxy users seem to use different platforms and
-are thus unlikely to care about these instructions.
-It's also questionable if they still work.
-fk 2007-11-07
-   <para>
-    On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
-    +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
-    the effect that cron.daily will automatically archive, gzip, and empty the
-    log, when it exceeds 1M size.
-   </para>
--->
    <para>
     Any log files must be writable by whatever user <application>Privoxy</application>
     is being run as (on Unix, default user id is <quote>privoxy</quote>).
    <para>
     Any log files must be writable by whatever user <application>Privoxy</application>
     is being run as (on Unix, default user id is <quote>privoxy</quote>).
@@ -887,7 +867,7 @@ fk 2007-11-07
  </varlistentry>
 </variablelist>
 
  </varlistentry>
 </variablelist>
 
-<![%config-file;[<literallayout>@@#logfile logfile</literallayout>]]>
+<![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
 </sect3>
 
 
 </sect3>
 
 
@@ -912,7 +892,7 @@ fk 2007-11-07
  <varlistentry>
   <term>Default value:</term>
   <listitem>
  <varlistentry>
   <term>Default value:</term>
   <listitem>
-   <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
+   <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows).</para>
   </listitem>
  </varlistentry>
  <varlistentry>
   </listitem>
  </varlistentry>
  <varlistentry>
@@ -1046,8 +1026,7 @@ fk 2007-11-07
   <term>Specifies:</term>
   <listitem>
    <para>
   <term>Specifies:</term>
   <listitem>
    <para>
-    Key values that determine what information gets logged to the 
-    <link linkend="logfile"><emphasis>logfile</emphasis></link>.
+    Key values that determine what information gets logged.
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -1060,14 +1039,14 @@ fk 2007-11-07
  <varlistentry>
   <term>Default value:</term>
   <listitem>
  <varlistentry>
   <term>Default value:</term>
   <listitem>
-   <para>12289 (i.e.: URLs plus informational and warning messages)</para>
+   <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>Effect if unset:</term>
   <listitem>
    <para>
   </listitem>
  </varlistentry>
  <varlistentry>
   <term>Effect if unset:</term>
   <listitem>
    <para>
-    Nothing gets logged.
+    Default value is used (see above).
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -1079,7 +1058,7 @@ fk 2007-11-07
    </para>
    <para>
     <programlisting>
    </para>
    <para>
     <programlisting>
-  debug         1 # show each GET/POST/CONNECT request
+  debug         1 # log each request destination (and the crunch reason if &my-app; intercepted the request)
   debug         2 # show each connection status
   debug         4 # show I/O status
   debug         8 # show header parsing
   debug         2 # show each connection status
   debug         4 # show I/O status
   debug         8 # show header parsing
@@ -1089,7 +1068,7 @@ fk 2007-11-07
   debug       128 # debug redirects
   debug       256 # debug GIF de-animation
   debug       512 # Common Log Format
   debug       128 # debug redirects
   debug       256 # debug GIF de-animation
   debug       512 # Common Log Format
-  debug      1024 # debug kill pop-ups
+  debug      1024 # Unused
   debug      2048 # CGI user interface
   debug      4096 # Startup banner and warnings.
   debug      8192 # Non-fatal errors
   debug      2048 # CGI user interface
   debug      4096 # Startup banner and warnings.
   debug      8192 # Non-fatal errors
@@ -1101,18 +1080,23 @@ fk 2007-11-07
    </para>
    <para>
     A debug level of 1 is informative because it will show you each request
    </para>
    <para>
     A debug level of 1 is informative because it will show you each request
-    as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
-    so that you will notice when things go wrong. The other levels are probably
-    only of interest if you are hunting down a specific problem. They can produce
-    a hell of an output (especially 16).
+    as it happens. <emphasis>1, 4096 and 8192 are recommended</emphasis>
+    so that you will notice when things go wrong. The other levels are
+    probably only of interest if you are hunting down a specific problem.
+    They can produce a hell of an output (especially 16).
     <!-- LOL -->
    </para>
    <para>
     <!-- LOL -->
    </para>
    <para>
-    The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which causes 
-    <application>Privoxy</application> to exit) is always on and cannot be disabled.
+    &my-app; used to ship with the debug levels recommended above enabled by
+    default, but due to privacy concerns 3.0.7 and later are configured to
+    only log fatal errors.
    </para>
    <para>
    </para>
    <para>
-    If you want to use CLF (Common Log Format), you should set <quote>debug
+    If you are used to the more verbose settings, simply enable the debug lines
+    below again.
+   </para>
+   <para>
+    If you want to use pure CLF (Common Log Format), you should set <quote>debug
     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
    </para>
    <para>
     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
    </para>
    <para>
@@ -1120,13 +1104,18 @@ fk 2007-11-07
     length of log messages. If it's reached, messages are logged truncated
     and marked with <quote>... [too long, truncated]</quote>.
    </para>
     length of log messages. If it's reached, messages are logged truncated
     and marked with <quote>... [too long, truncated]</quote>.
    </para>
+   <para>
+    Please don't file any support requests without trying to reproduce
+    the problem with increased debug level first. Once you read the log
+    messages, you may even be able to solve the problem on your own.
+   </para>
   </listitem>
  </varlistentry>
 </variablelist>
 
   </listitem>
  </varlistentry>
 </variablelist>
 
-<![%config-file;[<literallayout>@@debug   1    # show each GET/POST/CONNECT request</literallayout>]]>
-<![%config-file;[<literallayout>@@debug   4096 # Startup banner and warnings</literallayout>]]>
-<![%config-file;[<literallayout>@@debug   8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug      1 # log each request destination (and the crunch reason if &my-app; intercepted the request)</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug   4096 # Startup banner and warnings</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug   8192 # Non-fatal errors</literallayout>]]>
 </sect3>
 
 
 </sect3>
 
 
@@ -1138,7 +1127,7 @@ fk 2007-11-07
   <term>Specifies:</term>
   <listitem>
    <para>
   <term>Specifies:</term>
   <listitem>
    <para>
-    Whether to run only one server thread
+    Whether to run only one server thread.
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -1167,8 +1156,8 @@ fk 2007-11-07
   <term>Notes:</term>
   <listitem>
    <para>
   <term>Notes:</term>
   <listitem>
    <para>
-    This option is only there for debugging purposes and you should never
-    need to use it. <emphasis>It will drastically reduce performance.</emphasis>
+    This option is only there for debugging purposes.
+    <emphasis>It will drastically reduce performance.</emphasis>
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -1177,6 +1166,62 @@ fk 2007-11-07
 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
 </sect3>
 
 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
 </sect3>
 
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect3 renderas="sect4" id="hostname"><title>hostname</title>
+
+<variablelist>
+ <varlistentry>
+  <term>Specifies:</term>
+  <listitem>
+   <para>
+    The hostname shown on the CGI pages.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Type of value:</term>
+  <listitem>
+   <para>Text</para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Default value:</term>
+  <listitem>
+   <para><emphasis>Unset</emphasis></para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Effect if unset:</term>
+  <listitem>
+   <para>
+    The hostname provided by the operating system is used.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Notes:</term>
+  <listitem>
+   <para>
+    On some misconfigured systems resolving the hostname fails or
+    takes too much time and slows Privoxy down. Setting a fixed hostname
+    works around the problem.
+   </para>
+   <para>
+    In other circumstances it might be desirable to show a hostname
+    other than the one returned by the operating system. For example
+    if the system has several different hostnames and you don't want
+    to use the first one.
+   </para>
+   <para>
+    Note that Privoxy does not validate the specified hostname value.
+   </para>
+  </listitem>
+ </varlistentry>
+</variablelist>
+
+<![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
+</sect3>
+
 </sect2>
 
 <!--  ~  End section  ~  -->
 </sect2>
 
 <!--  ~  End section  ~  -->
@@ -1390,7 +1435,7 @@ fk 2007-11-07
    </para>
    <para>
     As a lot of <application>Privoxy</application> users don't read
    </para>
    <para>
     As a lot of <application>Privoxy</application> users don't read
-    documentation, this feature has been disabled by default.
+    documentation, this feature is disabled by default.
    </para>
    <para>
     Note that you must have compiled <application>Privoxy</application> with
    </para>
    <para>
     Note that you must have compiled <application>Privoxy</application> with
@@ -1451,7 +1496,7 @@ fk 2007-11-07
     side code (e.g Java) is also capable of using this feature.
    </para>
    <para>
     side code (e.g Java) is also capable of using this feature.
    </para>
    <para>
-    This option may be removed in future releases as it has been obsoleted
+    This option will be removed in future releases as it has been obsoleted
     by the more general header taggers.
    </para>
   </listitem>
     by the more general header taggers.
    </para>
   </listitem>
@@ -1506,7 +1551,8 @@ fk 2007-11-07
    </para>
    <para>
     This option is <emphasis>not recommended</emphasis> for environments
    </para>
    <para>
     This option is <emphasis>not recommended</emphasis> for environments
-    with untrusted users and is therefore disabled by default.
+    with untrusted users and as a lot of <application>Privoxy</application>
+    users don't read documentation, this feature is disabled by default.
    </para>
    <para>
     Note that malicious client side code (e.g Java) is also
    </para>
    <para>
     Note that malicious client side code (e.g Java) is also
@@ -1514,10 +1560,6 @@ fk 2007-11-07
     this options unless you understand the consequences and are
     sure your browser is configured correctly.
    </para>
     this options unless you understand the consequences and are
     sure your browser is configured correctly.
    </para>
-   <para>
-    As a lot of <application>Privoxy</application> users don't read
-    documentation, this feature has been disabled by default.
-   </para>
    <para>
     Note that you must have compiled <application>Privoxy</application> with
     support for this feature, otherwise this option has no effect. 
    <para>
     Note that you must have compiled <application>Privoxy</application> with
     support for this feature, otherwise this option has no effect. 
@@ -1663,9 +1705,9 @@ ACLs: permit-access and deny-access</title>
     option. 
    </para>
    <para>
     option. 
    </para>
    <para>
-    Please see the warnings in the FAQ that this proxy is not intended to be a substitute
-    for a firewall or to encourage anyone to defer addressing basic security
-    weaknesses.
+    Please see the warnings in the FAQ that <application>Privoxy</application>
+    is not intended to be a substitute for a firewall or to encourage anyone
+    to defer addressing basic security weaknesses.
    </para>
    <para>
     Multiple ACL lines are OK.
    </para>
    <para>
     Multiple ACL lines are OK.
@@ -1899,8 +1941,8 @@ ACLs: permit-access and deny-access</title>
    </para>
    <para>
     <screen>
    </para>
    <para>
     <screen>
-  forward   /                  caching-proxy.example-isp.net:8000
-  forward   .example-isp.net   .
+  forward   /                  caching-proxy.isp.example.net:8000
+  forward   .isp.example.net   .
 </screen>
    </para>
   </listitem>
 </screen>
    </para>
   </listitem>
@@ -1911,7 +1953,7 @@ ACLs: permit-access and deny-access</title>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect3 renderas="sect4" id="socks"><title>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect3 renderas="sect4" id="socks"><title>
-forward-socks4 and forward-socks4a</title>
+forward-socks4, forward-socks4a and forward-socks5</title>
 <anchor id="forward-socks4">
 <anchor id="forward-socks4a">
 
 <anchor id="forward-socks4">
 <anchor id="forward-socks4a">
 
@@ -1933,13 +1975,16 @@ forward-socks4 and forward-socks4a</title>
     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
    </para>
    <para>
     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
    </para>
    <para>
-    where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link> 
-    that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
-    denote <quote>all URLs</quote>.
-    <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
-    are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
+    where <replaceable class="parameter">target_pattern</replaceable> is a
+    <link linkend="af-patterns">URL pattern</link> that specifies to which
+    requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
+    denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
+    and <replaceable class="parameter">socks_proxy</replaceable>
+    are IP addresses in dotted decimal notation or valid DNS names
+    (<replaceable class="parameter">http_parent</replaceable>
     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional 
     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional 
-    <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
+    <replaceable class="parameter">port</replaceable> parameters are TCP ports,
+    i.e. integer values from 1 to 65535
    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>
@@ -1968,6 +2013,9 @@ forward-socks4 and forward-socks4a</title>
     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
     server, while in SOCKS 4 it happens locally.
    </para>
     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
     server, while in SOCKS 4 it happens locally.
    </para>
+   <para>
+    With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
+   </para>
    <para>
     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
    <para>
     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
@@ -1986,7 +2034,7 @@ forward-socks4 and forward-socks4a</title>
    </para>
    <para>
     <screen>
    </para>
    <para>
     <screen>
-  forward-socks4a   /              socks-gw.example.com:1080  www-cache.example-isp.net:8080
+  forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
   forward           .example.com   .
 </screen>
    </para>
   forward           .example.com   .
 </screen>
    </para>
@@ -2000,8 +2048,8 @@ forward-socks4 and forward-socks4a</title>
    </para>
   
     <para>
    </para>
   
     <para>
-    To chain Privoxy and Tor, both running on the same system, you should use 
-    the rule:
+    To chain Privoxy and Tor, both running on the same system, you would use 
+    something like:
    </para>
    <para>
     <screen>
    </para>
    <para>
     <screen>
@@ -2025,7 +2073,8 @@ forward-socks4 and forward-socks4a</title>
     Unencrypted connections to systems in these address ranges will
     be as (un)secure as the local network is, but the alternative is that you
     can't reach the local network through <application>Privoxy</application>
     Unencrypted connections to systems in these address ranges will
     be as (un)secure as the local network is, but the alternative is that you
     can't reach the local network through <application>Privoxy</application>
-    at all.
+    at all. Of course this may actually be desired and there is no reason
+    to make these exceptions if you aren't sure you need them.
    </para>
    <para>
     If you also want to be able to reach servers in your local network by
    </para>
    <para>
     If you also want to be able to reach servers in your local network by
@@ -2055,8 +2104,8 @@ forward-socks4 and forward-socks4a</title>
 </para>
 
 <para>
 </para>
 
 <para>
- Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
- isp-b.net. Both run <application>Privoxy</application>. Their forwarding
+ Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
+ isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
  configuration can look like this:
 </para>
 
  configuration can look like this:
 </para>
 
@@ -2067,7 +2116,7 @@ forward-socks4 and forward-socks4a</title>
 <para>
  <screen>
   forward    /           .
 <para>
  <screen>
   forward    /           .
-  forward    .isp-b.net  host-b:8118
+  forward    .isp-b.example.net  host-b:8118
 </screen>
 </para>
 
 </screen>
 </para>
 
@@ -2078,7 +2127,7 @@ forward-socks4 and forward-socks4a</title>
 <para>
  <screen>
   forward    /           .
 <para>
  <screen>
   forward    /           .
-  forward    .isp-a.net  host-a:8118
+  forward    .isp-a.example.org  host-a:8118
 </screen>
 </para>
 
 </screen>
 </para>
 
@@ -2090,7 +2139,7 @@ forward-socks4 and forward-socks4a</title>
 
 <para>
  If you intend to chain <application>Privoxy</application> and 
 
 <para>
  If you intend to chain <application>Privoxy</application> and 
- <application>squid</application> locally, then chain as 
+ <application>squid</application> locally, then chaining as 
  <literal>browser -> squid -> privoxy</literal> is the recommended way. 
 </para>
 
  <literal>browser -> squid -> privoxy</literal> is the recommended way. 
 </para>
 
@@ -2120,8 +2169,9 @@ forward-socks4 and forward-socks4a</title>
 </para>
 
 <para>
 </para>
 
 <para>
- You could just as well decide to only forward requests for Windows executables through
- a virus-scanning parent proxy, say, on <literal>antivir.example.com</literal>, port 8010:
+ You could just as well decide to only forward requests you suspect
+ of leading to Windows executables through a virus-scanning parent proxy,
+ say, on <literal>antivir.example.com</literal>, port 8010:
 </para>
 
 <para>
 </para>
 
 <para>
@@ -2358,11 +2408,11 @@ forward-socks4 and forward-socks4a</title>
     <application>Privoxy's</application> CGI forms can lead to
     rather long URLs. This isn't a problem as far as the HTTP
     standard is concerned, but it can confuse clients with arbitrary
     <application>Privoxy's</application> CGI forms can lead to
     rather long URLs. This isn't a problem as far as the HTTP
     standard is concerned, but it can confuse clients with arbitrary
-    URL lenght limitations.
+    URL length limitations.
    </para>
    <para>
     Enabling split-large-forms causes <application>Privoxy</application>
    </para>
    <para>
     Enabling split-large-forms causes <application>Privoxy</application>
-    to devide big forms into smaller ones to keep the URL length down.
+    to divide big forms into smaller ones to keep the URL length down.
     It makes editing a lot less convenient and you can no longer
     submit all changes at once, but at least it works around this
     browser bug.
     It makes editing a lot less convenient and you can no longer
     submit all changes at once, but at least it works around this
     browser bug.
@@ -2594,7 +2644,7 @@ forward-socks4 and forward-socks4a</title>
 <para>
  The <quote>hide-console</quote> option is specific to the MS-Win console
  version of <application>Privoxy</application>. If this option is used,
 <para>
  The <quote>hide-console</quote> option is specific to the MS-Win console
  version of <application>Privoxy</application>. If this option is used,
- <application>Privoxy</application> will disconnect from and hide  the
+ <application>Privoxy</application> will disconnect from and hide the
  command console.
 </para>
 
  command console.
 </para>
 
The official Privoxy git repository