doc/source/p-config.sgml

   1 <!--
   2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/p-config.sgml,v $
   3
   4  Purpose     :  Used with other docs and files only.
   5
   6  $Id: p-config.sgml,v 2.43 2009/03/28 15:33:41 fabiankeil Exp $
   7
   8  Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
   9  See LICENSE.
  10
  11  ========================================================================
  12  NOTE: Please read developer-manual/documentation.html before touching
  13  anything in this, or other Privoxy documentation.
  14  ========================================================================
  15
  16
  17  This file contains all the config file comments and options. It used to
  18  build both the user-manual config sections, and all of config (yes, the main
  19  config file) itself.
  20
  21  Rationale: This is broken up into two files since a file with a prolog
  22  (DTD, etc) cannot be sourced as a secondary file. config.sgml is basically
  23  a wrapper for this file.
  24
  25  IMPORTANT:
  26
  27  OPTIONS: The actual options are included in this file and prefixed with
  28  '@@', and processed by the Makefile to strip the '@@'. Default options
  29  that should appear commented out should be listed as: '@@#OPTION'.
  30  Otherwise, as '@@OPTION'. Example:
  31
  32   @@listen-address  127.0.0.1:8118
  33
  34  The Makefile does significant other processing too. The final results
  35  should be checked to make sure that the perl processing does not
  36  fubar something!!! Makefile processing requires w3m, fmt (shell line
  37  formatter), and perl.
  38
  39
  40  This file is included into:
  41
  42    user-manual.sgml
  43    config   (the actual Privoxy config file)
  44
  45 -->
  46
  47 <![%user-man;[
  48 <!-- This part only goes into user-manual -->
  49 <sect1 id="config">
  50 <title>The Main Configuration File</title>
  51
  52 <para>
  53  Again, the main configuration file is named <filename>config</filename> on
  54  Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
  55  Configuration lines consist of an initial keyword followed by a list of
  56  values, all separated by whitespace (any number of spaces or tabs). For
  57  example:
  58 </para>
  59
  60 <para>
  61  <literal>
  62   <msgtext>
  63    <literallayout>
  64   <emphasis>confdir /etc/privoxy</emphasis></literallayout>
  65   </msgtext>
  66  </literal>
  67 </para>
  68
  69 <para>
  70  Assigns the value <literal>/etc/privoxy</literal> to the option
  71  <literal>confdir</literal> and thus indicates that the configuration
  72  directory is named <quote>/etc/privoxy/</quote>.
  73 </para>
  74
  75 <para>
  76  All options in the config file except for <literal>confdir</literal> and
  77  <literal>logdir</literal> are optional. Watch out in the below description
  78  for what happens if you leave them unset.
  79 </para>
  80
  81 <para>
  82  The main config file controls all aspects of <application>Privoxy</application>'s
  83  operation that are not location dependent (i.e. they apply universally, no matter
  84  where you may be surfing).
  85 </para>
  86
  87 ]]>
  88
  89
  90 <![%config-file;[
  91 <!-- This part only goes into the config file -->
  92 <sect1 id="config">
  93 <title>
  94  @@TITLE<!-- between the @@ is stripped by Makefile -->@@
  95  Sample Configuration File for Privoxy v&p-version;
  96 </title>
  97 <para>
  98  $Id: p-config.sgml,v 2.43 2009/03/28 15:33:41 fabiankeil Exp $
  99 </para>
 100 <para>
 101 Copyright (C) 2001-2009 Privoxy Developers http://www.privoxy.org/
 102 </para>
 103
 104 <para>
 105  <literallayout>
 106 #################################################################
 107                                                                 #
 108                     Table of Contents                           #
 109                                                                 #
 110       I. INTRODUCTION                                           #
 111      II. FORMAT OF THE CONFIGURATION FILE                       #
 112                                                                 #
 113       1. LOCAL SET-UP DOCUMENTATION                             #
 114       2. CONFIGURATION AND LOG FILE LOCATIONS                   #
 115       3. DEBUGGING                                              #
 116       4. ACCESS CONTROL AND SECURITY                            #
 117       5. FORWARDING                                             #
 118       6. WINDOWS GUI OPTIONS                                    #
 119                                                                 #
 120 #################################################################
 121  </literallayout>
 122 </para>
 123
 124 <literallayout>I. INTRODUCTION
 125  ===============  <!-- fuck this madness --></literallayout>
 126
 127 <para>
 128  This file holds Privoxy's main configuration.  Privoxy detects
 129  configuration changes automatically, so you don't have to restart it
 130  unless you want to load a different configuration file.
 131 </para>
 132 <para>
 133  The configuration will be reloaded with the first request after the
 134  change was done, this request itself will still use the old configuration,
 135  though. In other words: it takes two requests before you see the result of
 136  your changes. Requests that are dropped due to ACL don't trigger reloads.
 137 </para>
 138 <para>
 139  When starting Privoxy on Unix systems, give the location of this
 140  file as last argument.  On Windows systems, Privoxy will look for
 141  this file with the name 'config.txt' in the current working directory
 142  of the Privoxy process.
 143 </para>
 144
 145 <para>
 146  <literallayout><!-- funky spacing -->
 147
 148 II. FORMAT OF THE CONFIGURATION FILE
 149 ====================================</literallayout>
 150 </para>
 151 <para>
 152  Configuration lines consist of an initial keyword followed by a list
 153  of values, all separated by whitespace (any number of spaces or
 154  tabs).  For example,
 155 </para>
 156 <para>
 157  actionsfile default.action
 158 </para>
 159 <para>
 160  Indicates that the actionsfile is named 'default.action'.
 161 </para>
 162 <para>
 163  The '#' indicates a comment.  Any part of a line following a '#' is
 164  ignored, except if the '#' is preceded by a '\'.
 165 </para>
 166 <para>
 167  Thus, by placing a # at the start of an existing configuration line,
 168  you can make it a comment and it will be treated as if it weren't there.
 169  This is called "commenting out" an option and can be useful. Removing
 170  the # again is called "uncommenting".
 171 </para>
 172 <para>
 173  Note that commenting out an option and leaving it at its default
 174  are two completely different things! Most options behave very
 175  differently when unset. See the "Effect if unset" explanation
 176  in each option's description for details.
 177 </para>
 178 <para>
 179  Long lines can be continued on the next line by using a `\' as
 180  the last character.
 181 </para>
 182
 183 ]]>
 184
 185 <!-- ************************************************ -->
 186 <!-- The following is common to both outputs (mostly) -->
 187 <!-- ************************************************ -->
 188
 189
 190
 191 <!--   ~~~~~       New section      ~~~~~     -->
 192 <sect2 id="local-set-up">
 193 <title>Local Set-up Documentation</title>
 194
 195   <para>
 196     If you intend to operate <application>Privoxy</application> for more users
 197     than just yourself, it might be a good idea to let them know how to reach
 198     you, what you block and why you do that, your policies, etc.
 199    </para>
 200
 201
 202 <!--   ~~~~~       New section      ~~~~~     -->
 203 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
 204 <variablelist>
 205  <varlistentry>
 206   <term>Specifies:</term>
 207   <listitem>
 208    <para>
 209     Location of the <application>Privoxy</application> User Manual.
 210    </para>
 211   </listitem>
 212  </varlistentry>
 213  <varlistentry>
 214   <term>Type of value:</term>
 215   <listitem>
 216    <para>A fully qualified URI</para>
 217   </listitem>
 218  </varlistentry>
 219  <varlistentry>
 220   <term>Default value:</term>
 221   <listitem>
 222    <para><emphasis>Unset</emphasis></para>
 223   </listitem>
 224  </varlistentry>
 225  <varlistentry>
 226   <term>Effect if unset:</term>
 227   <listitem>
 228    <para>
 229     <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
 230     will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
 231    </para>
 232   </listitem>
 233  </varlistentry>
 234  <varlistentry>
 235   <term>Notes:</term>
 236   <listitem>
 237     <para>
 238     The User Manual URI is the single best source of information on
 239     <application>Privoxy</application>, and is used for help links from some
 240     of the internal CGI pages. The manual itself is normally packaged with the
 241     binary distributions, so you probably want to set this to a locally
 242     installed copy.
 243    </para>
 244    <para>
 245     Examples:
 246    </para>
 247   <!--
 248   <para>
 249    Unix, in local filesystem (may not work with all browsers):
 250   </para>
 251   <para>
 252    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
 253   </para>
 254   <para>
 255    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
 256   </para>
 257   <para>
 258    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
 259   </para>
 260   <para>
 261    Windows, UNC notation (with forward slashes):
 262   </para>
 263   <para>
 264    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
 265   </para>
 266  -->
 267   <para>
 268    The best all purpose solution is simply to put the full local
 269    <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
 270    located:
 271   </para>
 272   <para>
 273    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;/usr/share/doc/privoxy/user-manual</screen>
 274   </para>
 275   <para>
 276    The User Manual is then available to anyone with access to
 277    <application>Privoxy</application>, by following the built-in URL:
 278    <literal>http://config.privoxy.org/user-manual/</literal>
 279    (or the shortcut: <literal>http://p.p/user-manual/</literal>).
 280   </para>
 281   <para>
 282    If the documentation is not on the local system, it can be accessed
 283    from a remote server, as:
 284   </para>
 285   <para>
 286    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;http://example.com/privoxy/user-manual/</screen>
 287   </para>
 288   <![%user-man;[
 289    <!-- this gets hammered in conversion to config. Text repeated below. -->
 290   <warning>
 291    <para>
 292      If set, this option should be <emphasis>the first option in the config
 293      file</emphasis>, because it is used while the config file is being read
 294      on start-up.
 295    </para>
 296   </warning>
 297   ]]>
 298
 299   <![%config-file;[
 300    <!-- alternate -->
 301    <para>
 302     WARNING!!!
 303    </para>
 304    <blockquote>
 305     <para>
 306      If set, this option should be the first option in the config
 307      file, because it is used while the config file is being read.
 308     </para>
 309    </blockquote>
 310   ]]>
 311
 312  </listitem>
 313  </varlistentry>
 314 </variablelist>
 315
 316 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
 317 </sect3>
 318
 319
 320 <!--   ~~~~~       New section      ~~~~~     -->
 321 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
 322
 323 <variablelist>
 324  <varlistentry>
 325   <term>Specifies:</term>
 326   <listitem>
 327    <para>
 328     A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
 329    </para>
 330   </listitem>
 331  </varlistentry>
 332  <varlistentry>
 333   <term>Type of value:</term>
 334   <listitem>
 335    <para>URL</para>
 336   </listitem>
 337  </varlistentry>
 338  <varlistentry>
 339   <term>Default value:</term>
 340   <listitem>
 341    <para><emphasis>Unset</emphasis></para>
 342   </listitem>
 343  </varlistentry>
 344  <varlistentry>
 345   <term>Effect if unset:</term>
 346   <listitem>
 347    <para>
 348     No links are displayed on the "untrusted" error page.
 349    </para>
 350   </listitem>
 351  </varlistentry>
 352  <varlistentry>
 353   <term>Notes:</term>
 354   <listitem>
 355    <para>
 356     The value of this option only matters if the experimental trust mechanism has been
 357     activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
 358    </para>
 359    <para>
 360     If you use the trust mechanism, it is a good idea to write up some on-line
 361     documentation about your trust policy and to specify the URL(s) here.
 362     Use multiple times for multiple URLs.
 363    </para>
 364    <para>
 365     The URL(s) should be added to the trustfile as well, so users don't end up
 366     locked out from the information on why they were locked out in the first place!
 367    </para>
 368   </listitem>
 369  </varlistentry>
 370 </variablelist>
 371
 372 <![%config-file;[<literallayout>@@#trust-info-url  http://www.example.com/why_we_block.html</literallayout>]]>
 373 <![%config-file;[<literallayout>@@#trust-info-url  http://www.example.com/what_we_allow.html</literallayout>]]>
 374 </sect3>
 375
 376
 377 <!--   ~~~~~       New section      ~~~~~     -->
 378 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
 379
 380 <variablelist>
 381  <varlistentry>
 382   <term>Specifies:</term>
 383   <listitem>
 384    <para>
 385     An email address to reach the <application>Privoxy</application> administrator.
 386    </para>
 387   </listitem>
 388  </varlistentry>
 389  <varlistentry>
 390   <term>Type of value:</term>
 391   <listitem>
 392    <para>Email address</para>
 393   </listitem>
 394  </varlistentry>
 395  <varlistentry>
 396   <term>Default value:</term>
 397   <listitem>
 398    <para><emphasis>Unset</emphasis></para>
 399   </listitem>
 400  </varlistentry>
 401  <varlistentry>
 402   <term>Effect if unset:</term>
 403   <listitem>
 404    <para>
 405     No email address is displayed on error pages and the CGI user interface.
 406    </para>
 407   </listitem>
 408  </varlistentry>
 409  <varlistentry>
 410   <term>Notes:</term>
 411   <listitem>
 412    <para>
 413     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
 414     are unset, the whole "Local Privoxy Support" box on all generated pages will
 415     not be shown.
 416    </para>
 417   </listitem>
 418  </varlistentry>
 419 </variablelist>
 420
 421 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
 422 </sect3>
 423
 424
 425 <!--   ~~~~~       New section      ~~~~~     -->
 426 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
 427
 428 <variablelist>
 429  <varlistentry>
 430   <term>Specifies:</term>
 431   <listitem>
 432    <para>
 433     A URL to documentation about the local <application>Privoxy</application> setup,
 434     configuration or policies.
 435    </para>
 436   </listitem>
 437  </varlistentry>
 438  <varlistentry>
 439   <term>Type of value:</term>
 440   <listitem>
 441    <para>URL</para>
 442   </listitem>
 443  </varlistentry>
 444  <varlistentry>
 445   <term>Default value:</term>
 446   <listitem>
 447    <para><emphasis>Unset</emphasis></para>
 448   </listitem>
 449  </varlistentry>
 450  <varlistentry>
 451   <term>Effect if unset:</term>
 452   <listitem>
 453    <para>
 454     No link to local documentation is displayed on error pages and the CGI user interface.
 455    </para>
 456   </listitem>
 457  </varlistentry>
 458  <varlistentry>
 459   <term>Notes:</term>
 460   <listitem>
 461    <para>
 462     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
 463     are unset, the whole "Local Privoxy Support" box on all generated pages will
 464     not be shown.
 465    </para>
 466    <para>
 467     This URL shouldn't be blocked ;-)
 468    </para>
 469   </listitem>
 470  </varlistentry>
 471 </variablelist>
 472
 473 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
 474 </sect3>
 475
 476 </sect2>
 477 <!--  ~  End section  ~  -->
 478
 479
 480
 481 <!--   ~~~~~       New section      ~~~~~     -->
 482
 483 <sect2 id="conf-log-loc">
 484 <title>Configuration and Log File Locations</title>
 485
 486 <para>
 487  <application>Privoxy</application> can (and normally does) use a number of
 488  other files for additional configuration, help and logging.
 489  This section of the configuration file tells <application>Privoxy</application>
 490  where to find those other files.
 491 </para>
 492
 493 <para>
 494  The user running <application>Privoxy</application>, must have read
 495  permission for all configuration files, and write permission to any files
 496  that would be modified, such as log files and actions files.
 497 </para>
 498
 499
 500 <!--   ~~~~~       New section      ~~~~~     -->
 501 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
 502
 503 <variablelist>
 504  <varlistentry>
 505   <term>Specifies:</term>
 506   <listitem>
 507    <para>The directory where the other configuration files are located.</para>
 508   </listitem>
 509  </varlistentry>
 510  <varlistentry>
 511   <term>Type of value:</term>
 512   <listitem>
 513    <para>Path name</para>
 514   </listitem>
 515  </varlistentry>
 516  <varlistentry>
 517   <term>Default value:</term>
 518   <listitem>
 519    <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 520   </listitem>
 521  </varlistentry>
 522  <varlistentry>
 523   <term>Effect if unset:</term>
 524   <listitem>
 525    <para><emphasis>Mandatory</emphasis></para>
 526   </listitem>
 527  </varlistentry>
 528  <varlistentry>
 529   <term>Notes:</term>
 530   <listitem>
 531    <para>
 532     No trailing <quote><literal>/</literal></quote>, please.
 533    </para>
 534   <!--
 535    This is really outdated and not likely to happen. HB 09/20/06
 536    <para>
 537     When development goes modular and multi-user, the blocker, filter, and
 538     per-user config will be stored in subdirectories of <quote>confdir</quote>.
 539     For now, the configuration directory structure is flat, except for
 540     <filename>confdir/templates</filename>, where the HTML templates for CGI
 541     output reside (e.g. <application>Privoxy's</application> 404 error page).
 542    </para>
 543   -->
 544   </listitem>
 545  </varlistentry>
 546 </variablelist>
 547
 548 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
 549 </sect3>
 550
 551 <!--   ~~~~~       New section      ~~~~~     -->
 552 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
 553
 554 <variablelist>
 555  <varlistentry>
 556   <term>Specifies:</term>
 557   <listitem>
 558    <para>An alternative directory where the templates are loaded from.</para>
 559   </listitem>
 560  </varlistentry>
 561  <varlistentry>
 562   <term>Type of value:</term>
 563   <listitem>
 564    <para>Path name</para>
 565   </listitem>
 566  </varlistentry>
 567  <varlistentry>
 568   <term>Default value:</term>
 569   <listitem>
 570    <para>unset</para>
 571   </listitem>
 572  </varlistentry>
 573  <varlistentry>
 574   <term>Effect if unset:</term>
 575   <listitem>
 576    <para>The templates are assumed to be located in confdir/template.</para>
 577   </listitem>
 578  </varlistentry>
 579  <varlistentry>
 580   <term>Notes:</term>
 581   <listitem>
 582    <para>
 583     <application>Privoxy's</application> original templates are usually
 584     overwritten with each update. Use this option to relocate customized
 585     templates that should be kept. As template variables might change
 586     between updates, you shouldn't expect templates to work with
 587     <application>Privoxy</application> releases other than the one
 588     they were part of, though.
 589    </para>
 590   </listitem>
 591  </varlistentry>
 592 </variablelist>
 593
 594 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
 595 </sect3>
 596
 597
 598 <!--   ~~~~~       New section      ~~~~~     -->
 599 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
 600
 601 <variablelist>
 602  <varlistentry>
 603   <term>Specifies:</term>
 604   <listitem>
 605    <para>
 606     The directory where all logging takes place
 607     (i.e. where the <filename>logfile</filename> is located).
 608    </para>
 609   </listitem>
 610  </varlistentry>
 611  <varlistentry>
 612   <term>Type of value:</term>
 613   <listitem>
 614    <para>Path name</para>
 615   </listitem>
 616  </varlistentry>
 617  <varlistentry>
 618   <term>Default value:</term>
 619   <listitem>
 620    <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 621   </listitem>
 622  </varlistentry>
 623  <varlistentry>
 624   <term>Effect if unset:</term>
 625   <listitem>
 626    <para><emphasis>Mandatory</emphasis></para>
 627   </listitem>
 628  </varlistentry>
 629  <varlistentry>
 630   <term>Notes:</term>
 631   <listitem>
 632    <para>
 633     No trailing <quote><literal>/</literal></quote>, please.
 634    </para>
 635   </listitem>
 636  </varlistentry>
 637 </variablelist>
 638
 639 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
 640 </sect3>
 641
 642
 643 <!--   ~~~~~       New section      ~~~~~     -->
 644 <sect3 renderas="sect4" id="actionsfile"><title>
 645 actionsfile
 646 </title>
 647 <anchor id="default.action">
 648 <anchor id="standard.action">
 649 <anchor id="user.action">
 650 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
 651 <variablelist>
 652  <varlistentry>
 653   <term>Specifies:</term>
 654   <listitem>
 655    <para>
 656     The <link linkend="actions-file">actions file(s)</link> to use
 657    </para>
 658   </listitem>
 659  </varlistentry>
 660  <varlistentry>
 661   <term>Type of value:</term>
 662   <listitem>
 663    <para>Complete file name, relative to <literal>confdir</literal></para>
 664   </listitem>
 665  </varlistentry>
 666  <varlistentry>
 667   <term>Default values:</term>
 668   <listitem>
 669    <simplelist>
 670     <member>
 671      <msgtext><literallayout>  match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
 672     </member>
 673     <member>
 674      <msgtext><literallayout>  default.action   # Main actions file</literallayout></msgtext>
 675     </member>
 676     <member>
 677      <msgtext><literallayout>  user.action      # User customizations</literallayout></msgtext>
 678     </member>
 679    </simplelist>
 680   </listitem>
 681  </varlistentry>
 682  <varlistentry>
 683   <term>Effect if unset:</term>
 684   <listitem>
 685    <para>
 686     No actions are taken at all. More or less neutral proxying.
 687    </para>
 688   </listitem>
 689  </varlistentry>
 690  <varlistentry>
 691   <term>Notes:</term>
 692   <listitem>
 693    <para>
 694     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
 695    </para>
 696    <para>
 697     The default values are <filename>default.action</filename>, which is the
 698     <quote>main</quote> actions file maintained by the developers, and
 699     <filename>user.action</filename>, where you can make your personal additions.
 700    </para>
 701    <para>
 702     Actions files contain all the per site and per URL configuration for
 703     ad blocking, cookie management, privacy considerations, etc.
 704     There is no point in using <application>Privoxy</application> without at
 705     least one actions file.
 706    </para>
 707    <para>
 708     Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
 709     extension has to be specified.  The syntax change was necessary to be consistent
 710     with the other file options and to allow previously forbidden characters.
 711    </para>
 712   </listitem>
 713  </varlistentry>
 714 </variablelist>
 715
 716 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
 717 <!-- html -> text conversion, blah -->
 718 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
 719 <![%config-file;[<literallayout>@@actionsfile default.action   # Main actions file</literallayout>]]>
 720 <!--
 721  XXX: Like user.filter, user.action should probably be commented out
 722  by default as not all packages install it into the default directory.
 723  fk 2007-11-07
 724 -->
 725 <![%config-file;[<literallayout>@@actionsfile user.action      # User customizations</literallayout>]]>
 726 </sect3>
 727
 728 <!--   ~~~~~       New section      ~~~~~     -->
 729 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
 730 <anchor id="default.filter">
 731 <variablelist>
 732  <varlistentry>
 733   <term>Specifies:</term>
 734   <listitem>
 735    <para>
 736     The <link linkend="filter-file">filter file(s)</link> to use
 737    </para>
 738   </listitem>
 739  </varlistentry>
 740  <varlistentry>
 741   <term>Type of value:</term>
 742   <listitem>
 743    <para>File name, relative to <literal>confdir</literal></para>
 744   </listitem>
 745  </varlistentry>
 746  <varlistentry>
 747   <term>Default value:</term>
 748   <listitem>
 749    <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
 750   </listitem>
 751  </varlistentry>
 752  <varlistentry>
 753   <term>Effect if unset:</term>
 754   <listitem>
 755    <para>
 756     No textual content filtering takes place, i.e. all
 757     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 758     actions in the actions files are turned neutral.
 759    </para>
 760   </listitem>
 761  </varlistentry>
 762  <varlistentry>
 763   <term>Notes:</term>
 764   <listitem>
 765    <para>
 766     Multiple <literal>filterfile</literal> lines are permitted.
 767    </para>
 768    <para>
 769     The <link linkend="filter-file">filter files</link> contain content modification
 770     rules that use <link linkend="regex">regular expressions</link>. These rules permit
 771     powerful changes on the content of Web pages, and optionally the headers
 772     as well, e.g., you could try to disable your favorite JavaScript annoyances,
 773     re-write the actual displayed text, or just have some fun
 774     playing buzzword bingo with web pages.
 775    </para>
 776    <para>
 777     The
 778     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 779     actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
 780     to be defined in a filter file!
 781    </para>
 782    <para>
 783     A pre-defined filter file called <filename>default.filter</filename> that contains
 784     a number of useful filters for common problems is included in the distribution.
 785     See the section on the <literal><link linkend="filter">filter</link></literal>
 786     action for a list.
 787    </para>
 788    <para>
 789     It is recommended to place any locally adapted filters into a separate
 790     file, such as <filename>user.filter</filename>.
 791    </para>
 792   </listitem>
 793  </varlistentry>
 794 </variablelist>
 795
 796 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
 797 <![%config-file;[<literallayout>@@#filterfile user.filter      # User customizations</literallayout>]]>
 798 </sect3>
 799
 800
 801 <!--   ~~~~~       New section      ~~~~~     -->
 802 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
 803
 804 <variablelist>
 805  <varlistentry>
 806   <term>Specifies:</term>
 807   <listitem>
 808    <para>
 809     The log file to use
 810    </para>
 811   </listitem>
 812  </varlistentry>
 813  <varlistentry>
 814   <term>Type of value:</term>
 815   <listitem>
 816    <para>File name, relative to <literal>logdir</literal></para>
 817   </listitem>
 818  </varlistentry>
 819  <varlistentry>
 820   <term>Default value:</term>
 821   <listitem>
 822    <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
 823   </listitem>
 824  </varlistentry>
 825  <varlistentry>
 826   <term>Effect if unset:</term>
 827   <listitem>
 828    <para>
 829     No logfile is written.
 830    </para>
 831   </listitem>
 832  </varlistentry>
 833  <varlistentry>
 834   <term>Notes:</term>
 835   <listitem>
 836    <para>
 837     The logfile is where all logging and error messages are written. The level
 838     of detail and number of messages are set with the <literal>debug</literal>
 839     option (see below). The logfile can be useful for tracking down a problem with
 840     <application>Privoxy</application> (e.g., it's not blocking an ad you
 841     think it should block) and it can help you to monitor what your browser
 842     is doing.
 843    </para>
 844    <para>
 845     Depending on the debug options below, the logfile may be a privacy risk
 846     if third parties can get access to it. As most users will never look
 847     at it, <application>Privoxy</application> 3.0.7 and later only log fatal
 848     errors by default.
 849    </para>
 850    <para>
 851     For most troubleshooting purposes, you will have to change that,
 852     please refer to the debugging section for details.
 853    </para>
 854    <para>
 855     Your logfile will grow indefinitely, and you will probably want to
 856     periodically remove it.  On Unix systems, you can do this with a cron job
 857     (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
 858     <command>logrotate</command> script has been included.
 859    </para>
 860    <para>
 861     Any log files must be writable by whatever user <application>Privoxy</application>
 862     is being run as (on Unix, default user id is <quote>privoxy</quote>).
 863    </para>
 864   </listitem>
 865  </varlistentry>
 866 </variablelist>
 867
 868 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
 869 </sect3>
 870
 871
 872 <!--   ~~~~~       New section      ~~~~~     -->
 873 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
 874 <variablelist>
 875  <varlistentry>
 876   <term>Specifies:</term>
 877   <listitem>
 878    <para>
 879     The name of the trust file to use
 880    </para>
 881   </listitem>
 882  </varlistentry>
 883  <varlistentry>
 884   <term>Type of value:</term>
 885   <listitem>
 886    <para>File name, relative to <literal>confdir</literal></para>
 887   </listitem>
 888  </varlistentry>
 889  <varlistentry>
 890   <term>Default value:</term>
 891   <listitem>
 892    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
 893   </listitem>
 894  </varlistentry>
 895  <varlistentry>
 896   <term>Effect if unset:</term>
 897   <listitem>
 898    <para>
 899     The entire trust mechanism is disabled.
 900    </para>
 901   </listitem>
 902  </varlistentry>
 903  <varlistentry>
 904   <term>Notes:</term>
 905   <listitem>
 906    <para>
 907     The trust mechanism is an experimental feature for building white-lists and should
 908     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
 909    </para>
 910    <para>
 911     If you specify a trust file, <application>Privoxy</application> will only allow
 912     access to sites that are specified in the trustfile. Sites can be listed
 913     in one of two ways:
 914    </para>
 915    <para>
 916     Prepending a <literal>~</literal> character limits access to this site
 917     only (and any sub-paths within this site), e.g.
 918     <literal>~www.example.com</literal> allows access to
 919     <literal>~www.example.com/features/news.html</literal>, etc.
 920    </para>
 921    <para>
 922     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
 923     prepending the name with a <literal>+</literal> character. The effect is that
 924     access to untrusted sites will be granted -- but only if a link from this
 925     trusted referrer was used to get there. The link target will then be added
 926     to the <quote>trustfile</quote> so that future, direct accesses will be
 927     granted. Sites added via this mechanism do not become trusted referrers
 928     themselves (i.e. they are added with a <literal>~</literal> designation).
 929     There is a limit of 512 such entries, after which new entries will not be
 930     made.
 931    </para>
 932    <para>
 933     If you use the <literal>+</literal> operator in the trust file, it may grow
 934     considerably over time.
 935    </para>
 936    <para>
 937     It is recommended that <application>Privoxy</application> be compiled with
 938     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
 939     <literal> --disable-editor</literal> options, if this feature is to be
 940     used.
 941    </para>
 942    <para>
 943     Possible applications include limiting Internet access for children.
 944    </para>
 945
 946   </listitem>
 947  </varlistentry>
 948 </variablelist>
 949
 950 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
 951 </sect3>
 952 </sect2>
 953
 954 <!--  ~  End section  ~  -->
 955
 956 <!--   ~~~~~       New section      ~~~~~     -->
 957 <sect2 id="debugging">
 958 <title>Debugging</title>
 959
 960  <para>
 961   These options are mainly useful when tracing a problem.
 962   Note that you might also want to invoke
 963   <application>Privoxy</application> with the <literal>--no-daemon</literal>
 964   command line option when debugging.
 965  </para>
 966
 967 <sect3 renderas="sect4" id="debug"><title>debug</title>
 968
 969 <variablelist>
 970  <varlistentry>
 971   <term>Specifies:</term>
 972   <listitem>
 973    <para>
 974     Key values that determine what information gets logged.
 975    </para>
 976   </listitem>
 977  </varlistentry>
 978  <varlistentry>
 979   <term>Type of value:</term>
 980   <listitem>
 981    <para>Integer values</para>
 982   </listitem>
 983  </varlistentry>
 984  <varlistentry>
 985   <term>Default value:</term>
 986   <listitem>
 987    <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
 988   </listitem>
 989  </varlistentry>
 990  <varlistentry>
 991   <term>Effect if unset:</term>
 992   <listitem>
 993    <para>
 994     Default value is used (see above).
 995    </para>
 996   </listitem>
 997  </varlistentry>
 998  <varlistentry>
 999   <term>Notes:</term>
1000   <listitem>
1001    <para>
1002     The available debug levels are:
1003    </para>
1004    <para>
1005     <programlisting>
1006   debug     1 # Log the destination for each request &my-app; let through. See also debug 1024.
1007   debug     2 # show each connection status
1008   debug     4 # show I/O status
1009   debug     8 # show header parsing
1010   debug    16 # log all data written to the network into the logfile
1011   debug    32 # debug force feature
1012   debug    64 # debug regular expression filters
1013   debug   128 # debug redirects
1014   debug   256 # debug GIF de-animation
1015   debug   512 # Common Log Format
1016   debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1017   debug  2048 # CGI user interface
1018   debug  4096 # Startup banner and warnings.
1019   debug  8192 # Non-fatal errors
1020 </programlisting>
1021    </para>
1022    <para>
1023     To select multiple debug levels, you can either add them or use
1024     multiple <literal>debug</literal> lines.
1025    </para>
1026    <para>
1027     A debug level of 1 is informative because it will show you each request
1028     as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1029     so that you will notice when things go wrong. The other levels are
1030     probably only of interest if you are hunting down a specific problem.
1031     They can produce a hell of an output (especially 16).
1032     <!-- LOL -->
1033    </para>
1034    <para>
1035     &my-app; used to ship with the debug levels recommended above enabled by
1036     default, but due to privacy concerns 3.0.7 and later are configured to
1037     only log fatal errors.
1038    </para>
1039    <para>
1040     If you are used to the more verbose settings, simply enable the debug lines
1041     below again.
1042    </para>
1043    <para>
1044     If you want to use pure CLF (Common Log Format), you should set <quote>debug
1045     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1046    </para>
1047    <para>
1048     <application>Privoxy</application> has a hard-coded limit for the
1049     length of log messages. If it's reached, messages are logged truncated
1050     and marked with <quote>... [too long, truncated]</quote>.
1051    </para>
1052    <para>
1053     Please don't file any support requests without trying to reproduce
1054     the problem with increased debug level first. Once you read the log
1055     messages, you may even be able to solve the problem on your own.
1056    </para>
1057   </listitem>
1058  </varlistentry>
1059 </variablelist>
1060
1061 <![%config-file;[<literallayout>@@#debug     1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1062 <![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1063 <![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
1064 <![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>
1065 </sect3>
1066
1067
1068 <!--   ~~~~~       New section      ~~~~~     -->
1069 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1070
1071 <variablelist>
1072  <varlistentry>
1073   <term>Specifies:</term>
1074   <listitem>
1075    <para>
1076     Whether to run only one server thread.
1077    </para>
1078   </listitem>
1079  </varlistentry>
1080  <varlistentry>
1081   <term>Type of value:</term>
1082   <listitem>
1083    <para><emphasis>None</emphasis></para>
1084   </listitem>
1085  </varlistentry>
1086  <varlistentry>
1087   <term>Default value:</term>
1088   <listitem>
1089    <para><emphasis>Unset</emphasis></para>
1090   </listitem>
1091  </varlistentry>
1092  <varlistentry>
1093   <term>Effect if unset:</term>
1094   <listitem>
1095    <para>
1096     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1097     serve multiple requests simultaneously.
1098    </para>
1099   </listitem>
1100  </varlistentry>
1101  <varlistentry>
1102   <term>Notes:</term>
1103   <listitem>
1104    <para>
1105     This option is only there for debugging purposes.
1106     <emphasis>It will drastically reduce performance.</emphasis>
1107    </para>
1108   </listitem>
1109  </varlistentry>
1110 </variablelist>
1111
1112 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1113 </sect3>
1114
1115 <!--   ~~~~~       New section      ~~~~~     -->
1116 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1117
1118 <variablelist>
1119  <varlistentry>
1120   <term>Specifies:</term>
1121   <listitem>
1122    <para>
1123     The hostname shown on the CGI pages.
1124    </para>
1125   </listitem>
1126  </varlistentry>
1127  <varlistentry>
1128   <term>Type of value:</term>
1129   <listitem>
1130    <para>Text</para>
1131   </listitem>
1132  </varlistentry>
1133  <varlistentry>
1134   <term>Default value:</term>
1135   <listitem>
1136    <para><emphasis>Unset</emphasis></para>
1137   </listitem>
1138  </varlistentry>
1139  <varlistentry>
1140   <term>Effect if unset:</term>
1141   <listitem>
1142    <para>
1143     The hostname provided by the operating system is used.
1144    </para>
1145   </listitem>
1146  </varlistentry>
1147  <varlistentry>
1148   <term>Notes:</term>
1149   <listitem>
1150    <para>
1151     On some misconfigured systems resolving the hostname fails or
1152     takes too much time and slows Privoxy down. Setting a fixed hostname
1153     works around the problem.
1154    </para>
1155    <para>
1156     In other circumstances it might be desirable to show a hostname
1157     other than the one returned by the operating system. For example
1158     if the system has several different hostnames and you don't want
1159     to use the first one.
1160    </para>
1161    <para>
1162     Note that Privoxy does not validate the specified hostname value.
1163    </para>
1164   </listitem>
1165  </varlistentry>
1166 </variablelist>
1167
1168 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1169 </sect3>
1170
1171 </sect2>
1172
1173 <!--  ~  End section  ~  -->
1174
1175
1176 <!--   ~~~~~       New section      ~~~~~     -->
1177 <sect2 id="access-control">
1178 <title>Access Control and Security</title>
1179
1180  <para>
1181   This section of the config file controls the security-relevant aspects
1182   of <application>Privoxy</application>'s configuration.
1183  </para>
1184
1185
1186 <!--   ~~~~~       New section      ~~~~~     -->
1187 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1188
1189 <variablelist>
1190  <varlistentry>
1191   <term>Specifies:</term>
1192   <listitem>
1193    <para>
1194     The IP address and TCP port on which <application>Privoxy</application> will
1195     listen for client requests.
1196    </para>
1197   </listitem>
1198  </varlistentry>
1199  <varlistentry>
1200   <term>Type of value:</term>
1201   <listitem>
1202    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1203   </listitem>
1204  </varlistentry>
1205
1206  <varlistentry>
1207   <term>Default value:</term>
1208   <listitem>
1209    <para>127.0.0.1:8118</para>
1210   </listitem>
1211  </varlistentry>
1212  <varlistentry>
1213   <term>Effect if unset:</term>
1214   <listitem>
1215    <para>
1216     Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1217     recommended for home users who run <application>Privoxy</application> on
1218     the same machine as their browser.
1219    </para>
1220   </listitem>
1221  </varlistentry>
1222  <varlistentry>
1223   <term>Notes:</term>
1224   <listitem>
1225    <para>
1226     You will need to configure your browser(s) to this proxy address and port.
1227    </para>
1228    <para>
1229     If you already have another service running on port 8118, or if you want to
1230     serve requests from other machines (e.g. on your local network) as well, you
1231     will need to override the default.
1232    </para>
1233    <para>
1234     IPv6 address containing colons has to be quoted by brackets.
1235    </para>
1236    <para>
1237     If you leave out the IP address, <application>Privoxy</application> will
1238     bind to all interfaces (addresses) on your machine and may become reachable
1239     from the Internet. In that case, consider using <link
1240     linkend="acls">access control lists</link> (ACL's, see below), and/or
1241     a firewall.
1242    </para>
1243    <para>
1244     If you open <application>Privoxy</application> to untrusted users, you will
1245     also want to make sure that the following actions are disabled:  <literal><link
1246     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1247     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1248    </para>
1249   </listitem>
1250  </varlistentry>
1251  <varlistentry>
1252   <term>Example:</term>
1253   <listitem>
1254    <para>
1255      Suppose you are running <application>Privoxy</application> on
1256      a machine which has the address 192.168.0.1 on your local private network
1257      (192.168.0.0) and has another outside connection with a different address.
1258      You want it to serve requests from inside only:
1259    </para>
1260    <para>
1261     <programlisting>
1262   listen-address  192.168.0.1:8118
1263 </programlisting>
1264    </para>
1265    <para>
1266     Suppose you are running <application>Privoxy</application> on IPv6 capable
1267     machine and you want to listen on IPv6 loopback device:
1268    </para>
1269    <para>
1270     <programlisting>
1271   listen-address [::1]:8118
1272 </programlisting>
1273    </para>
1274   </listitem>
1275  </varlistentry>
1276 </variablelist>
1277
1278 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1279 </sect3>
1280
1281
1282 <!--   ~~~~~       New section      ~~~~~     -->
1283 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1284
1285 <variablelist>
1286  <varlistentry>
1287   <term>Specifies:</term>
1288   <listitem>
1289    <para>
1290     Initial state of "toggle" status
1291    </para>
1292   </listitem>
1293  </varlistentry>
1294  <varlistentry>
1295   <term>Type of value:</term>
1296   <listitem>
1297    <para>1 or 0</para>
1298   </listitem>
1299  </varlistentry>
1300  <varlistentry>
1301   <term>Default value:</term>
1302   <listitem>
1303    <para>1</para>
1304   </listitem>
1305  </varlistentry>
1306  <varlistentry>
1307   <term>Effect if unset:</term>
1308   <listitem>
1309    <para>
1310     Act as if toggled on
1311    </para>
1312   </listitem>
1313  </varlistentry>
1314  <varlistentry>
1315   <term>Notes:</term>
1316   <listitem>
1317    <para>
1318     If set to 0, <application>Privoxy</application> will start in
1319     <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1320     content-neutral proxy with both ad blocking and content filtering
1321     disabled. See <literal>enable-remote-toggle</literal> below.
1322 <!--
1323     This is not really useful
1324     anymore, since toggling is much easier via <ulink
1325     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1326     editing the <filename>conf</filename> file.
1327
1328     Remote toggling is now disabled by default. fk 2007-11-07)
1329 -->
1330    </para>
1331    <para>
1332     The windows version will only display the toggle icon in the system tray
1333     if this option is present.
1334    </para>
1335   </listitem>
1336  </varlistentry>
1337 </variablelist>
1338
1339 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1340 </sect3>
1341
1342
1343 <!--   ~~~~~       New section      ~~~~~     -->
1344 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1345 <variablelist>
1346  <varlistentry>
1347   <term>Specifies:</term>
1348   <listitem>
1349    <para>
1350     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1351     feature</ulink> may be used
1352    </para>
1353   </listitem>
1354  </varlistentry>
1355  <varlistentry>
1356   <term>Type of value:</term>
1357   <listitem>
1358    <para>0 or 1</para>
1359   </listitem>
1360  </varlistentry>
1361  <varlistentry>
1362   <term>Default value:</term>
1363   <listitem>
1364    <para>0</para>
1365   </listitem>
1366  </varlistentry>
1367  <varlistentry>
1368   <term>Effect if unset:</term>
1369   <listitem>
1370    <para>
1371     The web-based toggle feature is disabled.
1372    </para>
1373   </listitem>
1374  </varlistentry>
1375  <varlistentry>
1376   <term>Notes:</term>
1377   <listitem>
1378    <para>
1379     When toggled off, <application>Privoxy</application> mostly acts like a normal,
1380     content-neutral proxy, i.e. doesn't block ads or filter content.
1381    </para>
1382    <para>
1383     Access to the toggle feature can <emphasis>not</emphasis> be
1384     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1385     so that everybody who can access <application>Privoxy</application> (see
1386     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1387     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1388     for multi-user environments with untrusted users.
1389    </para>
1390    <para>
1391     Note that malicious client side code (e.g Java) is also
1392     capable of using this option.
1393    </para>
1394    <para>
1395     As a lot of <application>Privoxy</application> users don't read
1396     documentation, this feature is disabled by default.
1397    </para>
1398    <para>
1399     Note that you must have compiled <application>Privoxy</application> with
1400     support for this feature, otherwise this option has no effect.
1401    </para>
1402   </listitem>
1403  </varlistentry>
1404 </variablelist>
1405
1406 <![%config-file;[<literallayout>@@enable-remote-toggle  0</literallayout>]]>
1407 </sect3>
1408
1409
1410 <!--   ~~~~~       New section      ~~~~~     -->
1411 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1412 <variablelist>
1413  <varlistentry>
1414   <term>Specifies:</term>
1415   <listitem>
1416    <para>
1417     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1418    </para>
1419   </listitem>
1420  </varlistentry>
1421  <varlistentry>
1422   <term>Type of value:</term>
1423   <listitem>
1424    <para>0 or 1</para>
1425   </listitem>
1426  </varlistentry>
1427  <varlistentry>
1428   <term>Default value:</term>
1429   <listitem>
1430    <para>0</para>
1431   </listitem>
1432  </varlistentry>
1433  <varlistentry>
1434   <term>Effect if unset:</term>
1435   <listitem>
1436    <para>
1437     Privoxy ignores special HTTP headers.
1438    </para>
1439   </listitem>
1440  </varlistentry>
1441  <varlistentry>
1442   <term>Notes:</term>
1443   <listitem>
1444    <para>
1445     When toggled on, the client can change <application>Privoxy's</application>
1446     behaviour by setting special HTTP headers. Currently the only supported
1447     special header is <quote>X-Filter: No</quote>, to disable filtering for
1448     the ongoing request, even if it is enabled in one of the action files.
1449    </para>
1450    <para>
1451     This feature is disabled by default. If you are using
1452     <application>Privoxy</application> in a environment with trusted clients,
1453     you may enable this feature at your discretion. Note that malicious client
1454     side code (e.g Java) is also capable of using this feature.
1455    </para>
1456    <para>
1457     This option will be removed in future releases as it has been obsoleted
1458     by the more general header taggers.
1459    </para>
1460   </listitem>
1461  </varlistentry>
1462 </variablelist>
1463
1464 <![%config-file;[<literallayout>@@enable-remote-http-toggle  0</literallayout>]]>
1465 </sect3>
1466
1467
1468 <!--   ~~~~~       New section      ~~~~~     -->
1469 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1470 <variablelist>
1471  <varlistentry>
1472   <term>Specifies:</term>
1473   <listitem>
1474    <para>
1475     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1476     file editor</ulink> may be used
1477    </para>
1478   </listitem>
1479  </varlistentry>
1480  <varlistentry>
1481   <term>Type of value:</term>
1482   <listitem>
1483    <para>0 or 1</para>
1484   </listitem>
1485  </varlistentry>
1486  <varlistentry>
1487   <term>Default value:</term>
1488   <listitem>
1489    <para>0</para>
1490   </listitem>
1491  </varlistentry>
1492  <varlistentry>
1493   <term>Effect if unset:</term>
1494   <listitem>
1495    <para>
1496     The web-based actions file editor is disabled.
1497    </para>
1498   </listitem>
1499  </varlistentry>
1500  <varlistentry>
1501   <term>Notes:</term>
1502   <listitem>
1503    <para>
1504     Access to the editor can <emphasis>not</emphasis> be
1505     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1506     so that everybody who can access <application>Privoxy</application> (see
1507     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1508     modify its configuration for all users.
1509    </para>
1510    <para>
1511     This option is <emphasis>not recommended</emphasis> for environments
1512     with untrusted users and as a lot of <application>Privoxy</application>
1513     users don't read documentation, this feature is disabled by default.
1514    </para>
1515    <para>
1516     Note that malicious client side code (e.g Java) is also
1517     capable of using the actions editor and you shouldn't enable
1518     this options unless you understand the consequences and are
1519     sure your browser is configured correctly.
1520    </para>
1521    <para>
1522     Note that you must have compiled <application>Privoxy</application> with
1523     support for this feature, otherwise this option has no effect.
1524    </para>
1525   </listitem>
1526  </varlistentry>
1527 </variablelist>
1528
1529 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1530 </sect3>
1531
1532
1533 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1534 <variablelist>
1535  <varlistentry>
1536   <term>Specifies:</term>
1537   <listitem>
1538    <para>
1539     Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1540    </para>
1541   </listitem>
1542  </varlistentry>
1543  <varlistentry>
1544   <term>Type of value:</term>
1545   <listitem>
1546    <para>
1547     <replaceable>0 or 1</replaceable>
1548    </para>
1549   </listitem>
1550  </varlistentry>
1551  <varlistentry>
1552   <term>Default value:</term>
1553   <listitem>
1554    <para><emphasis>0</emphasis></para>
1555   </listitem>
1556  </varlistentry>
1557  <varlistentry>
1558   <term>Effect if unset:</term>
1559   <listitem>
1560    <para>
1561     Blocks are not enforced.
1562    </para>
1563   </listitem>
1564  </varlistentry>
1565  <varlistentry>
1566   <term>Notes:</term>
1567   <listitem>
1568    <para>
1569     <application>Privoxy</application> is mainly used to block and filter
1570     requests as a service to the user, for example to block ads and other
1571     junk that clogs the pipes. <application>Privoxy's</application> configuration
1572     isn't perfect and sometimes innocent pages are blocked. In this situation it
1573     makes sense to allow the user to enforce the request and have
1574     <application>Privoxy</application> ignore the block.
1575    </para>
1576    <para>
1577     In the default configuration <application>Privoxy's</application>
1578     <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1579     link to adds a special string (the force prefix) to the request URL.
1580     If that link is used, <application>Privoxy</application> will
1581     detect the force prefix, remove it again and let the request pass.
1582    </para>
1583    <para>
1584     Of course <application>Privoxy</application> can also be used to enforce
1585     a network policy. In that case the user obviously should not be able to
1586     bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1587     option is for. If it's enabled, <application>Privoxy</application> hides
1588     the <quote>go there anyway</quote> link. If the user adds the force
1589     prefix by hand, it will not be accepted and the circumvention attempt
1590     is logged.
1591    </para>
1592   </listitem>
1593  </varlistentry>
1594  <varlistentry>
1595   <term>Examples:</term>
1596   <listitem>
1597    <para>
1598     enforce-blocks 1
1599    </para>
1600   </listitem>
1601  </varlistentry>
1602 </variablelist>
1603 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1604 </sect3>
1605
1606
1607 <!--   ~~~~~       New section      ~~~~~     -->
1608 <sect3 renderas="sect4" id="acls"><title>
1609 ACLs: permit-access and deny-access</title>
1610 <anchor id="permit-access">
1611 <anchor id="deny-access">
1612
1613 <variablelist>
1614  <varlistentry>
1615   <term>Specifies:</term>
1616   <listitem>
1617    <para>
1618     Who can access what.
1619    </para>
1620   </listitem>
1621  </varlistentry>
1622  <varlistentry>
1623   <term>Type of value:</term>
1624   <listitem>
1625    <para>
1626     <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1627     [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1628    </para>
1629    <para>
1630     Where <replaceable class="parameter">src_addr</replaceable> and
1631    <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1632     DNS names, <replaceable class="parameter">port</replaceable> is port
1633     number, and <replaceable class="parameter">src_masklen</replaceable> and
1634     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1635     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1636     destination part are optional.
1637    </para>
1638    <para>
1639     If your system implements
1640     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1641     <replaceable class="parameter">src_addr</replaceable> and <replaceable
1642     class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1643     brackets, <replaceable class="parameter">port</replaceable> can be number
1644     or service name, and
1645     <replaceable class="parameter">src_masklen</replaceable> and
1646     <replaceable class="parameter">dst_masklen</replaceable> can be number
1647     from 0 to 128.
1648    </para>
1649   </listitem>
1650  </varlistentry>
1651  <varlistentry>
1652   <term>Default value:</term>
1653   <listitem>
1654    <para><emphasis>Unset</emphasis></para>
1655    <para>
1656     No <replaceable class="parameter">port</replaceable> means match any port
1657     and no <replaceable class="parameter">src_masklen</replaceable> or
1658     no <replaceable class="parameter">src_masklen</replaceable> means exactly
1659     given IP address (i.e. 32 for IPv4 and 128 for IPv6).
1660    </para>
1661   </listitem>
1662  </varlistentry>
1663  <varlistentry>
1664   <term>Effect if unset:</term>
1665   <listitem>
1666    <para>
1667     Don't restrict access further than implied by <literal>listen-address</literal>
1668    </para>
1669   </listitem>
1670  </varlistentry>
1671  <varlistentry>
1672   <term>Notes:</term>
1673   <listitem>
1674    <para>
1675     Access controls are included at the request of ISPs and systems
1676     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1677     For a typical home user, it will normally suffice to ensure that
1678     <application>Privoxy</application> only listens on the localhost
1679     (127.0.0.1) or internal (home) network address by means of the
1680     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1681     option.
1682    </para>
1683    <para>
1684     Please see the warnings in the FAQ that <application>Privoxy</application>
1685     is not intended to be a substitute for a firewall or to encourage anyone
1686     to defer addressing basic security weaknesses.
1687    </para>
1688    <para>
1689     Multiple ACL lines are OK.
1690     If any ACLs are specified, <application>Privoxy</application> only talks
1691     to IP addresses that match at least one <literal>permit-access</literal> line
1692     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1693     last match wins, with the default being <literal>deny-access</literal>.
1694    </para>
1695    <para>
1696     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1697     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1698     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1699     of the ultimate target. This is necessary because it may be impossible for the local
1700     <application>Privoxy</application> to determine the IP address of the
1701     ultimate target (that's often what gateways are used for).
1702    </para>
1703    <para>
1704     You should prefer using IP addresses over DNS names, because the address lookups take
1705     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1706     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1707     IP addresses, only the first one is used.
1708    </para>
1709    <para>
1710      Some systems allows IPv4 client to connect to IPv6 server socket.
1711      Then the client's IPv4 address will be translated by system into
1712      IPv6 address space with special prefix ::ffff/96 (so called IPv4
1713      mapped IPv6 address). <application>Privoxy</application> can handle it
1714      and maps such ACL addresses automatically.
1715    </para>
1716    <para>
1717     Denying access to particular sites by ACL may have undesired side effects
1718     if the site in question is hosted on a machine which also hosts other sites
1719     (most sites are).
1720    </para>
1721   </listitem>
1722  </varlistentry>
1723  <varlistentry>
1724   <term>Examples:</term>
1725   <listitem>
1726    <para>
1727     Explicitly define the default behavior if no ACL and
1728     <literal>listen-address</literal> are set: <quote>localhost</quote>
1729     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1730     <emphasis>all</emphasis> destination addresses are OK:
1731    </para>
1732    <para>
1733     <screen>
1734   permit-access  localhost
1735 </screen>
1736    </para>
1737    <para>
1738     Allow any host on the same class C subnet as www.privoxy.org access to
1739     nothing but www.example.com (or other domains hosted on the same system):
1740    </para>
1741    <para>
1742     <screen>
1743   permit-access  www.privoxy.org/24 www.example.com/32
1744 </screen>
1745    </para>
1746    <para>
1747     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1748     with the exception that 192.168.45.73 may not access the IP address behind
1749     www.dirty-stuff.example.com:
1750    </para>
1751    <para>
1752     <screen>
1753   permit-access  192.168.45.64/26
1754   deny-access    192.168.45.73    www.dirty-stuff.example.com
1755 </screen>
1756    </para>
1757    <para>
1758      Allow access from IPv4 network 192.0.2.0/24 even if listening on
1759      IPv6 wild card address (where supported by operating system):
1760    </para>
1761    <para>
1762     <programlisting>
1763   permit-access  192.0.2.0/24
1764 </programlisting>
1765    </para>
1766    <para>
1767      This is equivalent to the following line even if listening on IPv4
1768      address (where supported by operating system):
1769    </para>
1770    <para>
1771     <programlisting>
1772   permit-access  [::ffff:192.0.2.0]/120
1773 </programlisting>
1774    </para>
1775   </listitem>
1776  </varlistentry>
1777 </variablelist>
1778 </sect3>
1779
1780
1781 <!--   ~~~~~       New section      ~~~~~     -->
1782 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1783
1784 <variablelist>
1785  <varlistentry>
1786   <term>Specifies:</term>
1787   <listitem>
1788    <para>
1789     Maximum size of the buffer for content filtering.
1790    </para>
1791   </listitem>
1792  </varlistentry>
1793  <varlistentry>
1794   <term>Type of value:</term>
1795   <listitem>
1796    <para>Size in Kbytes</para>
1797   </listitem>
1798  </varlistentry>
1799  <varlistentry>
1800   <term>Default value:</term>
1801   <listitem>
1802    <para>4096</para>
1803   </listitem>
1804  </varlistentry>
1805  <varlistentry>
1806   <term>Effect if unset:</term>
1807   <listitem>
1808    <para>
1809     Use a 4MB (4096 KB) limit.
1810    </para>
1811   </listitem>
1812  </varlistentry>
1813  <varlistentry>
1814   <term>Notes:</term>
1815   <listitem>
1816    <para>
1817     For content filtering, i.e. the <literal>+filter</literal> and
1818     <literal>+deanimate-gif</literal> actions, it is necessary that
1819     <application>Privoxy</application> buffers the entire document body.
1820     This can be potentially dangerous, since a server could just keep sending
1821     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1822     Hence this option.
1823    </para>
1824    <para>
1825     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1826     flushed to the client unfiltered and no further attempt to
1827     filter the rest of the document is made. Remember that there may be multiple threads
1828     running, which might require up to <literal>buffer-limit</literal> Kbytes
1829     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1830     above.
1831    </para>
1832   </listitem>
1833  </varlistentry>
1834 </variablelist>
1835
1836 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1837 </sect3>
1838
1839 </sect2>
1840
1841 <!--  ~  End section  ~  -->
1842
1843
1844 <!--   ~~~~~       New section      ~~~~~     -->
1845
1846 <sect2 id="forwarding">
1847 <title>Forwarding</title>
1848
1849 <para>
1850  This feature allows routing of HTTP requests through a chain of
1851  multiple proxies.
1852 </para>
1853 <para>
1854  Forwarding can be used to chain Privoxy with a caching proxy to speed
1855  up browsing. Using a parent proxy may also be necessary if the machine
1856  that <application>Privoxy</application> runs on has no direct Internet access.
1857 </para>
1858 <para>
1859  Note that parent proxies can severely decrease your privacy level.
1860  For example a parent proxy could add your IP address to the request
1861  headers and if it's a caching proxy it may add the <quote>Etag</quote>
1862  header to revalidation requests again, even though you configured Privoxy
1863  to remove it. It may also ignore Privoxy's header time randomization and use the
1864  original values which could be used by the server as cookie replacement
1865  to track your steps between visits.
1866 </para>
1867
1868 <para>
1869  Also specified here are SOCKS proxies. <application>Privoxy</application>
1870  supports the SOCKS 4 and SOCKS 4A protocols.
1871 </para>
1872
1873 <sect3 renderas="sect4" id="forward"><title>forward</title>
1874 <variablelist>
1875  <varlistentry>
1876   <term>Specifies:</term>
1877   <listitem>
1878    <para>
1879     To which parent HTTP proxy specific requests should be routed.
1880    </para>
1881   </listitem>
1882  </varlistentry>
1883  <varlistentry>
1884   <term>Type of value:</term>
1885   <listitem>
1886    <para>
1887     <replaceable class="parameter">target_pattern</replaceable>
1888     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1889    </para>
1890    <para>
1891     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1892     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1893     denote <quote>all URLs</quote>.
1894     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1895     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1896     optionally followed by its listening port (default: 8000).
1897     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1898    </para>
1899   </listitem>
1900  </varlistentry>
1901  <varlistentry>
1902   <term>Default value:</term>
1903   <listitem>
1904    <para><emphasis>Unset</emphasis></para>
1905   </listitem>
1906  </varlistentry>
1907  <varlistentry>
1908   <term>Effect if unset:</term>
1909   <listitem>
1910    <para>
1911     Don't use parent HTTP proxies.
1912    </para>
1913   </listitem>
1914  </varlistentry>
1915  <varlistentry>
1916   <term>Notes:</term>
1917   <listitem>
1918    <para>
1919     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1920     forwarded to another HTTP proxy but are made directly to the web servers.
1921    </para>
1922    <para>
1923     <replaceable class="parameter">http_parent</replaceable> can be IPv6
1924     numerical address (if
1925     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
1926     implemented). However not to clash with port delimiter, quote
1927     whole IP address with brackets. On the other hand <replaceable
1928     class="parameter">target_pattern</replaceable> containing IPv6 address
1929     must be delimited by angle brackets (normal brackets are reserved for
1930     regular expression already).
1931    </para>
1932    <para>
1933     Multiple lines are OK, they are checked in sequence, and the last match wins.
1934    </para>
1935   </listitem>
1936  </varlistentry>
1937  <varlistentry>
1938   <term>Examples:</term>
1939   <listitem>
1940    <para>
1941     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1942    </para>
1943    <para>
1944     <screen>
1945   forward   /      parent-proxy.example.org:8080
1946   forward   :443   .
1947 </screen>
1948    </para>
1949    <para>
1950     Everything goes to our example ISP's caching proxy, except for requests
1951     to that ISP's sites:
1952    </para>
1953    <para>
1954     <screen>
1955   forward   /                  caching-proxy.isp.example.net:8000
1956   forward   .isp.example.net   .
1957 </screen>
1958    </para>
1959    <para>
1960     Parent proxy specified by IPv6 address:
1961    </para>
1962    <para>
1963     <programlisting>
1964   foward   /                   [2001:DB8::1]:8000
1965 </programlisting>
1966    </para>
1967    <para>
1968     Suppose your parent proxy doesn't support IPv6:
1969    </para>
1970    <para>
1971     <programlisting>
1972   forward  /                        parent-proxy.example.org:8000
1973   forward  ipv6-server.example.org  .
1974   forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
1975 </programlisting>
1976    </para>
1977   </listitem>
1978  </varlistentry>
1979 </variablelist>
1980 </sect3>
1981
1982
1983 <!--   ~~~~~       New section      ~~~~~     -->
1984 <sect3 renderas="sect4" id="socks"><title>
1985 forward-socks4, forward-socks4a and forward-socks5</title>
1986 <anchor id="forward-socks4">
1987 <anchor id="forward-socks4a">
1988
1989 <variablelist>
1990  <varlistentry>
1991   <term>Specifies:</term>
1992   <listitem>
1993    <para>
1994     Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
1995    </para>
1996   </listitem>
1997  </varlistentry>
1998  <varlistentry>
1999   <term>Type of value:</term>
2000   <listitem>
2001    <para>
2002     <replaceable class="parameter">target_pattern</replaceable>
2003     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2004     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2005    </para>
2006    <para>
2007     where <replaceable class="parameter">target_pattern</replaceable> is a
2008     <link linkend="af-patterns">URL pattern</link> that specifies to which
2009     requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2010     denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2011     and <replaceable class="parameter">socks_proxy</replaceable>
2012     are IP addresses in dotted decimal notation or valid DNS names
2013     (<replaceable class="parameter">http_parent</replaceable>
2014     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2015     <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2016     i.e. integer values from 1 to 65535
2017    </para>
2018   </listitem>
2019  </varlistentry>
2020  <varlistentry>
2021   <term>Default value:</term>
2022   <listitem>
2023    <para><emphasis>Unset</emphasis></para>
2024   </listitem>
2025  </varlistentry>
2026  <varlistentry>
2027   <term>Effect if unset:</term>
2028   <listitem>
2029    <para>
2030     Don't use SOCKS proxies.
2031    </para>
2032   </listitem>
2033  </varlistentry>
2034  <varlistentry>
2035   <term>Notes:</term>
2036   <listitem>
2037    <para>
2038     Multiple lines are OK, they are checked in sequence, and the last match wins.
2039    </para>
2040    <para>
2041     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2042     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2043     server, while in SOCKS 4 it happens locally.
2044    </para>
2045    <para>
2046     With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2047    </para>
2048    <para>
2049     <replaceable class="parameter">socks_proxy</replaceable> and
2050     <replaceable clss="parameter">http_parent</replaceable> can be IPv6
2051     numerical address (if
2052     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2053     implemented). However not to clash with port
2054     delimiter, quote whole IP address with brackets. On the other
2055     hand <replaceable class="parameter">target_pattern</replaceable> containing
2056     IPv6 address must be delimited by angle brackets (normal brackets are
2057     reserved for regular expression already). The only exception is SOCKS 4
2058     version where only IPv4 is suppored.
2059    </para>
2060    <para>
2061     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2062     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2063     a SOCKS proxy.
2064    </para>
2065   </listitem>
2066  </varlistentry>
2067  <varlistentry>
2068   <term>Examples:</term>
2069   <listitem>
2070    <para>
2071      From the company example.com, direct connections are made to all
2072      <quote>internal</quote> domains, but everything outbound goes through
2073      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2074      the Internet.
2075    </para>
2076    <para>
2077     <screen>
2078   forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
2079   forward           .example.com   .
2080 </screen>
2081    </para>
2082    <para>
2083     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2084    </para>
2085    <para>
2086     <screen>
2087   forward-socks4   /               socks-gw.example.com:1080  .
2088 </screen>
2089    </para>
2090
2091     <para>
2092     To chain Privoxy and Tor, both running on the same system, you would use
2093     something like:
2094    </para>
2095    <para>
2096     <screen>
2097   forward-socks5   /               127.0.0.1:9050 .
2098 </screen>
2099    </para>
2100
2101     <para>
2102     The public <application>Tor</application> network can't be used to
2103     reach your local network, if you need to access local servers you
2104     therefore might want to make some exceptions:
2105    </para>
2106    <para>
2107     <screen>
2108   forward         192.168.*.*/     .
2109   forward            10.*.*.*/     .
2110   forward           127.*.*.*/     .
2111 </screen>
2112    </para>
2113    <para>
2114     Unencrypted connections to systems in these address ranges will
2115     be as (un)secure as the local network is, but the alternative is that you
2116     can't reach the local network through <application>Privoxy</application>
2117     at all. Of course this may actually be desired and there is no reason
2118     to make these exceptions if you aren't sure you need them.
2119    </para>
2120    <para>
2121     If you also want to be able to reach servers in your local network by
2122     using their names, you will need additional exceptions that look like
2123     this:
2124    </para>
2125    <para>
2126     <screen>
2127  forward           localhost/     .
2128 </screen>
2129    </para>
2130
2131   </listitem>
2132  </varlistentry>
2133 </variablelist>
2134 </sect3>
2135
2136 <![%user-man;[     <!-- not included in config due to length -->
2137 <!--   ~~~~~       New section      ~~~~~     -->
2138 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2139
2140 <para>
2141  If you have links to multiple ISPs that provide various special content
2142  only to their subscribers, you can configure multiple <application>Privoxies</application>
2143  which have connections to the respective ISPs to act as forwarders to each other, so that
2144  <emphasis>your</emphasis> users can see the internal content of all ISPs.
2145 </para>
2146
2147 <para>
2148  Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2149  isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2150  configuration can look like this:
2151 </para>
2152
2153 <para>
2154  host-a:
2155 </para>
2156
2157 <para>
2158  <screen>
2159   forward    /           .
2160   forward    .isp-b.example.net  host-b:8118
2161 </screen>
2162 </para>
2163
2164 <para>
2165  host-b:
2166 </para>
2167
2168 <para>
2169  <screen>
2170   forward    /           .
2171   forward    .isp-a.example.org  host-a:8118
2172 </screen>
2173 </para>
2174
2175 <para>
2176  Now, your users can set their browser's proxy to use either
2177  host-a or host-b and be able to browse the internal content
2178  of both isp-a and isp-b.
2179 </para>
2180
2181 <para>
2182  If you intend to chain <application>Privoxy</application> and
2183  <application>squid</application> locally, then chaining as
2184  <literal>browser -> squid -> privoxy</literal> is the recommended way.
2185 </para>
2186
2187 <para>
2188  Assuming that <application>Privoxy</application> and <application>squid</application>
2189  run on the same box, your <application>squid</application> configuration could then look like this:
2190 </para>
2191
2192 <para>
2193  <screen>
2194   # Define Privoxy as parent proxy (without ICP)
2195   cache_peer 127.0.0.1 parent 8118 7 no-query
2196
2197   # Define ACL for protocol FTP
2198   acl ftp proto FTP
2199
2200   # Do not forward FTP requests to Privoxy
2201   always_direct allow ftp
2202
2203   # Forward all the rest to Privoxy
2204   never_direct allow all</screen>
2205 </para>
2206
2207 <para>
2208  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2209  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2210 </para>
2211
2212 <para>
2213  You could just as well decide to only forward requests you suspect
2214  of leading to Windows executables through a virus-scanning parent proxy,
2215  say, on <literal>antivir.example.com</literal>, port 8010:
2216 </para>
2217
2218 <para>
2219  <screen>
2220   forward   /                          .
2221   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
2222 </para>
2223
2224 </sect3>
2225 ]]>
2226
2227 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2228 <variablelist>
2229  <varlistentry>
2230   <term>Specifies:</term>
2231   <listitem>
2232    <para>
2233     How often Privoxy retries if a forwarded connection request fails.
2234    </para>
2235   </listitem>
2236  </varlistentry>
2237  <varlistentry>
2238   <term>Type of value:</term>
2239   <listitem>
2240    <para>
2241     <replaceable class="parameter">Number of retries.</replaceable>
2242    </para>
2243   </listitem>
2244  </varlistentry>
2245  <varlistentry>
2246   <term>Default value:</term>
2247   <listitem>
2248    <para><emphasis>0</emphasis></para>
2249   </listitem>
2250  </varlistentry>
2251  <varlistentry>
2252   <term>Effect if unset:</term>
2253   <listitem>
2254    <para>
2255     Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2256    </para>
2257   </listitem>
2258  </varlistentry>
2259  <varlistentry>
2260   <term>Notes:</term>
2261   <listitem>
2262    <para>
2263     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2264     for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2265     The connection might have failed because of a DNS timeout in which case a retry makes sense,
2266     but it might also have failed because the server doesn't exist or isn't reachable. In this
2267     case the retry will just delay the appearance of Privoxy's error message.
2268    </para>
2269    <para>
2270     Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2271     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2272    </para>
2273    <para>
2274     Only use this option, if you are getting lots of forwarding-related error messages
2275     that go away when you try again manually. Start with a small value and check Privoxy's
2276     logfile from time to time, to see how many retries are usually needed.
2277    </para>
2278   </listitem>
2279  </varlistentry>
2280  <varlistentry>
2281   <term>Examples:</term>
2282   <listitem>
2283    <para>
2284     forwarded-connect-retries 1
2285    </para>
2286   </listitem>
2287  </varlistentry>
2288 </variablelist>
2289 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2290 </sect3>
2291
2292 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2293 <variablelist>
2294  <varlistentry>
2295   <term>Specifies:</term>
2296   <listitem>
2297    <para>
2298     Whether intercepted requests should be treated as valid.
2299    </para>
2300   </listitem>
2301  </varlistentry>
2302  <varlistentry>
2303   <term>Type of value:</term>
2304   <listitem>
2305    <para>
2306     <replaceable>0 or 1</replaceable>
2307    </para>
2308   </listitem>
2309  </varlistentry>
2310  <varlistentry>
2311   <term>Default value:</term>
2312   <listitem>
2313    <para><emphasis>0</emphasis></para>
2314   </listitem>
2315  </varlistentry>
2316  <varlistentry>
2317   <term>Effect if unset:</term>
2318   <listitem>
2319    <para>
2320     Only proxy requests are accepted, intercepted requests are treated as invalid.
2321    </para>
2322   </listitem>
2323  </varlistentry>
2324  <varlistentry>
2325   <term>Notes:</term>
2326   <listitem>
2327    <para>
2328     If you don't trust your clients and want to force them
2329     to use <application>Privoxy</application>, enable this
2330     option and configure your packet filter to redirect outgoing
2331     HTTP connections into <application>Privoxy</application>.
2332    </para>
2333    <para>
2334     Make sure that <application>Privoxy's</application> own requests
2335     aren't redirected as well. Additionally take care that
2336     <application>Privoxy</application> can't intentionally connect
2337     to itself, otherwise you could run into redirection loops if
2338     <application>Privoxy's</application> listening port is reachable
2339     by the outside or an attacker has access to the pages you visit.
2340    </para>
2341   </listitem>
2342  </varlistentry>
2343  <varlistentry>
2344   <term>Examples:</term>
2345   <listitem>
2346    <para>
2347     accept-intercepted-requests 1
2348    </para>
2349   </listitem>
2350  </varlistentry>
2351 </variablelist>
2352 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2353 </sect3>
2354
2355 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2356 <variablelist>
2357  <varlistentry>
2358   <term>Specifies:</term>
2359   <listitem>
2360    <para>
2361     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2362    </para>
2363   </listitem>
2364  </varlistentry>
2365  <varlistentry>
2366   <term>Type of value:</term>
2367   <listitem>
2368    <para>
2369     <replaceable>0 or 1</replaceable>
2370    </para>
2371   </listitem>
2372  </varlistentry>
2373  <varlistentry>
2374   <term>Default value:</term>
2375   <listitem>
2376    <para><emphasis>0</emphasis></para>
2377   </listitem>
2378  </varlistentry>
2379  <varlistentry>
2380   <term>Effect if unset:</term>
2381   <listitem>
2382    <para>
2383     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2384    </para>
2385   </listitem>
2386  </varlistentry>
2387  <varlistentry>
2388   <term>Notes:</term>
2389   <listitem>
2390    <para>
2391     By default <application>Privoxy</application> ignores block or redirect actions
2392     for its CGI pages. Intercepting these requests can be useful in multi-user
2393     setups to implement fine-grained access control, but it can also render the complete
2394     web interface useless and make debugging problems painful if done without care.
2395    </para>
2396    <para>
2397     Don't enable this option unless you're sure that you really need it.
2398    </para>
2399   </listitem>
2400  </varlistentry>
2401  <varlistentry>
2402   <term>Examples:</term>
2403   <listitem>
2404    <para>
2405     allow-cgi-request-crunching 1
2406    </para>
2407   </listitem>
2408  </varlistentry>
2409 </variablelist>
2410 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2411 </sect3>
2412
2413 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2414 <variablelist>
2415  <varlistentry>
2416   <term>Specifies:</term>
2417   <listitem>
2418    <para>
2419     Whether the CGI interface should stay compatible with broken HTTP clients.
2420    </para>
2421   </listitem>
2422  </varlistentry>
2423  <varlistentry>
2424   <term>Type of value:</term>
2425   <listitem>
2426    <para>
2427     <replaceable>0 or 1</replaceable>
2428    </para>
2429   </listitem>
2430  </varlistentry>
2431  <varlistentry>
2432   <term>Default value:</term>
2433   <listitem>
2434    <para><emphasis>0</emphasis></para>
2435   </listitem>
2436  </varlistentry>
2437  <varlistentry>
2438   <term>Effect if unset:</term>
2439   <listitem>
2440    <para>
2441     The CGI form generate long GET URLs.
2442    </para>
2443   </listitem>
2444  </varlistentry>
2445  <varlistentry>
2446   <term>Notes:</term>
2447   <listitem>
2448    <para>
2449     <application>Privoxy's</application> CGI forms can lead to
2450     rather long URLs. This isn't a problem as far as the HTTP
2451     standard is concerned, but it can confuse clients with arbitrary
2452     URL length limitations.
2453    </para>
2454    <para>
2455     Enabling split-large-forms causes <application>Privoxy</application>
2456     to divide big forms into smaller ones to keep the URL length down.
2457     It makes editing a lot less convenient and you can no longer
2458     submit all changes at once, but at least it works around this
2459     browser bug.
2460    </para>
2461    <para>
2462     If you don't notice any editing problems, there is no reason
2463     to enable this option, but if one of the submit buttons appears
2464     to be broken, you should give it a try.
2465    </para>
2466   </listitem>
2467  </varlistentry>
2468  <varlistentry>
2469   <term>Examples:</term>
2470   <listitem>
2471    <para>
2472     split-large-forms 1
2473    </para>
2474   </listitem>
2475  </varlistentry>
2476 </variablelist>
2477 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2478 </sect3>
2479
2480 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2481 <variablelist>
2482  <varlistentry>
2483   <term>Specifies:</term>
2484   <listitem>
2485    <para>
2486     Number of seconds after which an open connection will no longer be reused.
2487    </para>
2488   </listitem>
2489  </varlistentry>
2490  <varlistentry>
2491   <term>Type of value:</term>
2492   <listitem>
2493    <para>
2494     <replaceable>Time in seconds.</replaceable>
2495    </para>
2496   </listitem>
2497  </varlistentry>
2498  <varlistentry>
2499   <term>Default value:</term>
2500   <listitem>
2501    <para>None</para>
2502   </listitem>
2503  </varlistentry>
2504  <varlistentry>
2505   <term>Effect if unset:</term>
2506   <listitem>
2507    <para>
2508     Connections are not reused.
2509    </para>
2510   </listitem>
2511  </varlistentry>
2512  <varlistentry>
2513   <term>Notes:</term>
2514   <listitem>
2515    <para>
2516     This option has no effect if <application>Privoxy</application>
2517     has been compiled without keep-alive support.
2518    </para>
2519   </listitem>
2520  </varlistentry>
2521  <varlistentry>
2522   <term>Notes:</term>
2523   <listitem>
2524    <para>
2525     Note that reusing connections doesn't necessary cause speedups.
2526     There are also a few privacy implications you should be aware of.
2527    </para>
2528    <para>
2529     Outgoing connections are shared between clients (if there are more
2530     than one) and closing the client that initiated the outgoing connection
2531     does not affect the connection between &my-app; and the server unless
2532     the client's request hasn't been completed yet. If the outgoing connection
2533     is idle, it will not be closed until either <application>Privoxy's</application>
2534     or the server's timeout is reached. While it's open, the server knows
2535     that the system running &my-app; is still there.
2536    </para>
2537   </listitem>
2538  </varlistentry>
2539  <varlistentry>
2540   <term>Examples:</term>
2541   <listitem>
2542    <para>
2543     keep-alive-timeout 300
2544    </para>
2545   </listitem>
2546  </varlistentry>
2547 </variablelist>
2548 <![%config-file;[<literallayout>@@keep-alive-timeout 300</literallayout>]]>
2549 </sect3>
2550
2551
2552 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2553 <variablelist>
2554  <varlistentry>
2555   <term>Specifies:</term>
2556   <listitem>
2557    <para>
2558     Number of seconds after which a socket times out if
2559     no data is received.
2560    </para>
2561   </listitem>
2562  </varlistentry>
2563  <varlistentry>
2564   <term>Type of value:</term>
2565   <listitem>
2566    <para>
2567     <replaceable>Time in seconds.</replaceable>
2568    </para>
2569   </listitem>
2570  </varlistentry>
2571  <varlistentry>
2572   <term>Default value:</term>
2573   <listitem>
2574    <para>None</para>
2575   </listitem>
2576  </varlistentry>
2577  <varlistentry>
2578   <term>Effect if unset:</term>
2579   <listitem>
2580    <para>
2581     A default value of 300 seconds is used.
2582    </para>
2583   </listitem>
2584  </varlistentry>
2585  <varlistentry>
2586   <term>Notes:</term>
2587   <listitem>
2588    <para>
2589     For SOCKS requests the timeout currently doesn't start until
2590     the SOCKS server accepted the request. This will be fixed in
2591     the next release.
2592    </para>
2593   </listitem>
2594  </varlistentry>
2595  <varlistentry>
2596   <term>Examples:</term>
2597   <listitem>
2598    <para>
2599     socket-timeout 300
2600    </para>
2601   </listitem>
2602  </varlistentry>
2603 </variablelist>
2604 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2605 </sect3>
2606
2607
2608 </sect2>
2609
2610 <!--  ~  End section  ~  -->
2611
2612
2613 <!--   ~~~~~       New section      ~~~~~     -->
2614
2615 <sect2 id="windows-gui">
2616 <title>Windows GUI Options</title>
2617 <para>
2618  <application>Privoxy</application> has a number of options specific to the
2619  Windows GUI interface:
2620 </para>
2621
2622 <anchor id="activity-animation">
2623 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2624 <para>
2625  If <quote>activity-animation</quote> is set to 1, the
2626  <application>Privoxy</application> icon will animate when
2627  <quote>Privoxy</quote> is active. To turn off, set to 0.
2628 </para>
2629
2630 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
2631 <![%user-man;[
2632 <para>
2633  <literal>
2634   <msgtext>
2635    <literallayout>
2636   <emphasis>activity-animation   1</emphasis>
2637    </literallayout>
2638   </msgtext>
2639  </literal>
2640 </para>
2641 ]]>
2642
2643 <anchor id="log-messages">
2644 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2645 <para>
2646  If <quote>log-messages</quote> is set to 1,
2647  <application>Privoxy</application> will log messages to the console
2648  window:
2649 </para>
2650
2651 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
2652 <![%user-man;[
2653 <para>
2654  <literal>
2655   <msgtext>
2656    <literallayout>
2657   <emphasis>log-messages       1</emphasis>
2658    </literallayout>
2659   </msgtext>
2660  </literal>
2661 </para>
2662 ]]>
2663
2664 <anchor id="log-buffer-size">
2665 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2666 <para>
2667  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2668  i.e. the amount of memory used for the log messages displayed in the
2669  console window, will be limited to <quote>log-max-lines</quote> (see below).
2670 </para>
2671
2672 <para>
2673  Warning: Setting this to 0 will result in the buffer to grow infinitely and
2674  eat up all your memory!
2675 </para>
2676
2677 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2678 <![%user-man;[
2679 <para>
2680  <literal>
2681   <msgtext>
2682    <literallayout>
2683   <emphasis>log-buffer-size      1</emphasis>
2684    </literallayout>
2685   </msgtext>
2686  </literal>
2687 </para>
2688 ]]>
2689
2690 <anchor id="log-max-lines">
2691 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2692 <para>
2693  <application>log-max-lines</application> is the maximum number of lines held
2694  in the log buffer. See above.
2695 </para>
2696
2697 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2698 <![%user-man;[
2699 <para>
2700  <literal>
2701   <msgtext>
2702    <literallayout>
2703   <emphasis>log-max-lines      200</emphasis>
2704    </literallayout>
2705   </msgtext>
2706  </literal>
2707 </para>
2708 ]]>
2709
2710 <anchor id="log-highlight-messages">
2711 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2712 <para>
2713  If <quote>log-highlight-messages</quote> is set to 1,
2714  <application>Privoxy</application> will highlight portions of the log
2715  messages with a bold-faced font:
2716 </para>
2717
2718 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2719 <![%user-man;[
2720 <para>
2721  <literal>
2722   <msgtext>
2723    <literallayout>
2724   <emphasis>log-highlight-messages   1</emphasis>
2725    </literallayout>
2726   </msgtext>
2727  </literal>
2728 </para>
2729 ]]>
2730
2731 <anchor id="log-font-name">
2732 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2733 <para>
2734  The font used in the console window:
2735 </para>
2736
2737 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2738 <![%user-man;[
2739 <para>
2740  <literal>
2741   <msgtext>
2742    <literallayout>
2743   <emphasis>log-font-name        Comic Sans MS</emphasis>
2744    </literallayout>
2745   </msgtext>
2746  </literal>
2747 </para>
2748 ]]>
2749
2750 <anchor id="log-font-size">
2751 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2752 <para>
2753  Font size used in the console window:
2754 </para>
2755
2756 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2757 <![%user-man;[
2758 <para>
2759  <literal>
2760   <msgtext>
2761    <literallayout>
2762   <emphasis>log-font-size        8</emphasis>
2763    </literallayout>
2764   </msgtext>
2765  </literal>
2766 </para>
2767 ]]>
2768
2769 <anchor id="show-on-task-bar">
2770 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2771 <para>
2772  <quote>show-on-task-bar</quote> controls whether or not
2773  <application>Privoxy</application> will appear as a button on the Task bar
2774  when minimized:
2775 </para>
2776
2777 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2778 <![%user-man;[
2779 <para>
2780  <literal>
2781   <msgtext>
2782    <literallayout>
2783   <emphasis>show-on-task-bar     0</emphasis>
2784    </literallayout>
2785   </msgtext>
2786  </literal>
2787 </para>
2788 ]]>
2789
2790 <anchor id="close-button-minimizes">
2791 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2792 <para>
2793  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2794  button will minimize <application>Privoxy</application> instead of closing
2795  the program (close with the exit option on the File menu).
2796 </para>
2797
2798 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2799 <![%user-man;[
2800 <para>
2801  <literal>
2802   <msgtext>
2803    <literallayout>
2804   <emphasis>close-button-minimizes  1</emphasis>
2805    </literallayout>
2806   </msgtext>
2807  </literal>
2808 </para>
2809 ]]>
2810
2811 <anchor id="hide-console">
2812 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2813 <para>
2814  The <quote>hide-console</quote> option is specific to the MS-Win console
2815  version of <application>Privoxy</application>. If this option is used,
2816  <application>Privoxy</application> will disconnect from and hide the
2817  command console.
2818 </para>
2819
2820 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2821 <![%user-man;[
2822 <para>
2823  <literal>
2824   <msgtext>
2825    <literallayout>
2826   #<emphasis>hide-console</emphasis>
2827    </literallayout>
2828   </msgtext>
2829  </literal>
2830 </para>
2831 ]]>
2832
2833 </sect2>
2834 </sect1>
2835
2836 <!-- end config content common to both outputs -->
2837
2838 <![%config-file;[
2839 <!-- These are dummy anchors to keep the processor quiet            -->
2840 <!-- when building config-file only (ie. they are used in u-m only) -->
2841 <sect1 label="">
2842 <title></title>
2843 <anchor id="filter">
2844 <anchor id="filter-file">
2845 <anchor id="regex">
2846 <anchor id="actions-file">
2847 <anchor id="af-patterns">
2848 </sect1>
2849 ]]>
2850
2851 <!-- eof p-config.sgml -->