Move the match-all section into a separate file

[privoxy.git] / doc / source / p-config.sgml

diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml
index 5abd272..8fe3183 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.22 2007/11/09 20:26:58 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.36 2009/01/23 14:06:07 fabiankeil Exp $

 
 

- Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+ Copyright (C) 2001-2009 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.22 2007/11/09 20:26:58 fabiankeil Exp $
+ $Id: p-config.sgml,v 2.36 2009/01/23 14:06:07 fabiankeil Exp $

 </para>
 <para>
 </para>
 <para>

-Copyright (C) 2001-2007 Privoxy Developers http://www.privoxy.org/
+Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/

 </para>
 
 <para>
 </para>
 
 <para>


@@ -604,8 +604,7 @@ II. FORMAT OF THE CONFIGURATION FILE
   <listitem>
    <para>
     The directory where all logging takes place
   <listitem>
    <para>
     The directory where all logging takes place

-    (i.e. where <filename>logfile</filename> and
-    <filename>jarfile</filename> are located).
+    (i.e. where the <filename>logfile</filename> is located).

    </para>
   </listitem>
  </varlistentry>
    </para>
   </listitem>
  </varlistentry>


@@ -669,13 +668,13 @@ actionsfile
   <listitem>
    <simplelist>
     <member>
   <listitem>
    <simplelist>
     <member>

-     <msgtext><literallayout>  standard.action     # Internal purposes, no editing recommended</literallayout></msgtext>
+     <msgtext><literallayout>  match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>

     </member>
     <member>
     </member>
     <member>

-     <msgtext><literallayout>  default.action      # Main actions file</literallayout></msgtext>
+     <msgtext><literallayout>  default.action   # Main actions file</literallayout></msgtext>

     </member>
     <member>
     </member>
     <member>

-     <msgtext><literallayout>  user.action         # User customizations</literallayout></msgtext>
+     <msgtext><literallayout>  user.action      # User customizations</literallayout></msgtext>

     </member>
    </simplelist>
   </listitem>
     </member>
    </simplelist>
   </listitem>


@@ -695,9 +694,8 @@ 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 <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
+    The default values are <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> 


@@ -717,7 +715,7 @@ actionsfile
 
 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
 <!-- html -> text conversion, blah -->
 
 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
 <!-- html -> text conversion, blah -->

-<![%config-file;[<literallayout>@@actionsfile standard.action  # Internal purpose, recommended</literallayout>]]>
+<![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>

 <![%config-file;[<literallayout>@@actionsfile default.action   # Main actions file</literallayout>]]>
 <!--
  XXX: Like user.filter, user.action should probably be commented out
 <![%config-file;[<literallayout>@@actionsfile default.action   # Main actions file</literallayout>]]>
 <!--
  XXX: Like user.filter, user.action should probably be commented out


@@ -828,20 +826,13 @@ actionsfile
   <term>Effect if unset:</term>
   <listitem>
    <para>
   <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>


@@ -851,15 +842,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


@@ -867,19 +857,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>).


@@ -888,60 +865,7 @@ fk 2007-11-07
  </varlistentry>
 </variablelist>
 
  </varlistentry>
 </variablelist>
 

-<![%config-file;[<literallayout>@@#logfile logfile</literallayout>]]>
-</sect3>
-
-
-<!--   ~~~~~       New section      ~~~~~     -->
-<sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
-
-<variablelist>
- <varlistentry>
-  <term>Specifies:</term>
-  <listitem>
-   <para>
-    The file to store intercepted cookies in
-   </para>
-  </listitem>
- </varlistentry>
- <varlistentry>
-  <term>Type of value:</term>
-  <listitem>
-   <para>File name, relative to <literal>logdir</literal></para>
-  </listitem>
- </varlistentry>
- <varlistentry>
-  <term>Default value:</term>
-  <listitem>
-   <para><emphasis>Unset (commented out)</emphasis>. When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows).</para>
-  </listitem>
- </varlistentry>
- <varlistentry>
-  <term>Effect if unset:</term>
-  <listitem>
-   <para>
-    Intercepted cookies are not stored in a dedicated log file.
-   </para>
-  </listitem>
- </varlistentry>
- <varlistentry>
-  <term>Notes:</term>
-  <listitem>
-   <para>
-    The jarfile may grow to ridiculous sizes over time.
-   </para>
-   <para>
-    If debug 8 (show header parsing) is enabled, cookies are
-    also written to the logfile with the rest of the headers.
-    Therefore this option isn't very useful and may be removed
-    in future releases. Please report to the developers if you
-    are still using it.
-   </para>
-  </listitem>
- </varlistentry>
-</variablelist>
-
-<![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
+<![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>

 </sect3>
 
 
 </sect3>
 
 


@@ -1047,8 +971,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>


@@ -1061,14 +984,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>


@@ -1080,20 +1003,20 @@ fk 2007-11-07
    </para>
    <para>
     <programlisting>
    </para>
    <para>
     <programlisting>

-  debug         1 # show each GET/POST/CONNECT request
-  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        32 # debug force feature
-  debug        64 # debug regular expression filters
-  debug       128 # debug redirects
-  debug       256 # debug GIF de-animation
-  debug       512 # Common Log Format
-  debug      1024 # debug kill pop-ups
-  debug      2048 # CGI user interface
-  debug      4096 # Startup banner and warnings.
-  debug      8192 # Non-fatal errors
+  debug     1 # Log the destination for each request &my-app; let through. See also debug 1024.
+  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    32 # debug force feature
+  debug    64 # debug regular expression filters
+  debug   128 # debug redirects
+  debug   256 # debug GIF de-animation
+  debug   512 # Common Log Format
+  debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
+  debug  2048 # CGI user interface
+  debug  4096 # Startup banner and warnings.
+  debug  8192 # Non-fatal errors

 </programlisting>
    </para>
    <para>
 </programlisting>
    </para>
    <para>


@@ -1102,24 +1025,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>
     <!-- LOL -->
    </para>

-<!--

    <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>
+    If you are used to the more verbose settings, simply enable the debug lines
+    below again.

    </para>
    </para>

-   It can be disabled by not logging at all (now the default)
-   and I doubt that any user would care about not being able
-   to disable it anyway.
-   fk 2007-11-09
--->

    <para>
    <para>

-    If you want to use CLF (Common Log Format), you should set <quote>debug
+    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>


@@ -1127,13 +1049,19 @@ 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 the destination for each request &my-app; let through.</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
+<![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>

 </sect3>
 
 
 </sect3>
 
 


@@ -1184,6 +1112,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  ~  -->


@@ -1915,7 +1899,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">
 


@@ -1937,13 +1921,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>


@@ -1972,6 +1959,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


@@ -2392,6 +2382,106 @@ forward-socks4 and forward-socks4a</title>
 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
 </sect3>
 
 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
 </sect3>
 

+<sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
+<variablelist>
+ <varlistentry>
+  <term>Specifies:</term>
+  <listitem>
+   <para>
+    Number of seconds after which an open connection will no longer be reused.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Type of value:</term>
+  <listitem>
+   <para>
+    <replaceable>Time in seconds.</replaceable>
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Default value:</term>
+  <listitem>
+   <para>None</para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Effect if unset:</term>
+  <listitem>
+   <para>
+    Connections are not reused.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Notes:</term>
+  <listitem>
+   <para>
+    This option has no effect if <application>Privoxy</application>
+    has been compiled without keep-alive support.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Examples:</term>
+  <listitem>
+   <para>
+    keep-alive-timeout 300
+   </para>
+  </listitem>
+ </varlistentry>
+</variablelist>
+<![%config-file;[<literallayout>@@keep-alive-timeout 300</literallayout>]]>
+</sect3>
+
+
+<sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
+<variablelist>
+ <varlistentry>
+  <term>Specifies:</term>
+  <listitem>
+   <para>
+    Number of seconds after which a socket times out if
+    no data is received.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Type of value:</term>
+  <listitem>
+   <para>
+    <replaceable>Time in seconds.</replaceable>
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Default value:</term>
+  <listitem>
+   <para>None</para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Effect if unset:</term>
+  <listitem>
+   <para>
+    A default value of 180 seconds is used.
+   </para>
+  </listitem>
+ </varlistentry>
+ <varlistentry>
+  <term>Examples:</term>
+  <listitem>
+   <para>
+    socket-timeout 180
+   </para>
+  </listitem>
+ </varlistentry>
+</variablelist>
+<![%config-file;[<literallayout>@@socket-timeout 180</literallayout>]]>
+</sect3>
+
+

 </sect2>
 
 <!--  ~  End section  ~  -->
 </sect2>
 
 <!--  ~  End section  ~  -->