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.47 2009/04/17 11:40:48 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.47 2009/04/17 11:40:48 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 addresses containing colons have 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 IPv4 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. If the hostname is localhost, <application>Privoxy</application>
1242     will explicitly try to bind to an IPv4 address. For other hostnames it depends
1243     on the operating system which IP version will be used.
1244    </para>
1245    <para>
1246     If you open <application>Privoxy</application> to untrusted users, you will
1247     also want to make sure that the following actions are disabled:  <literal><link
1248     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1249     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1250    </para>
1251   </listitem>
1252  </varlistentry>
1253  <varlistentry>
1254   <term>Example:</term>
1255   <listitem>
1256    <para>
1257      Suppose you are running <application>Privoxy</application> on
1258      a machine which has the address 192.168.0.1 on your local private network
1259      (192.168.0.0) and has another outside connection with a different address.
1260      You want it to serve requests from inside only:
1261    </para>
1262    <para>
1263     <programlisting>
1264   listen-address  192.168.0.1:8118
1265 </programlisting>
1266    </para>
1267    <para>
1268     Suppose you are running <application>Privoxy</application> on an
1269     IPv6-capable machine and you want it to listen on the IPv6 address
1270     of the loopback device:
1271    </para>
1272    <para>
1273     <programlisting>
1274   listen-address [::1]:8118
1275 </programlisting>
1276    </para>
1277   </listitem>
1278  </varlistentry>
1279 </variablelist>
1280
1281 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1282 </sect3>
1283
1284
1285 <!--   ~~~~~       New section      ~~~~~     -->
1286 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1287
1288 <variablelist>
1289  <varlistentry>
1290   <term>Specifies:</term>
1291   <listitem>
1292    <para>
1293     Initial state of "toggle" status
1294    </para>
1295   </listitem>
1296  </varlistentry>
1297  <varlistentry>
1298   <term>Type of value:</term>
1299   <listitem>
1300    <para>1 or 0</para>
1301   </listitem>
1302  </varlistentry>
1303  <varlistentry>
1304   <term>Default value:</term>
1305   <listitem>
1306    <para>1</para>
1307   </listitem>
1308  </varlistentry>
1309  <varlistentry>
1310   <term>Effect if unset:</term>
1311   <listitem>
1312    <para>
1313     Act as if toggled on
1314    </para>
1315   </listitem>
1316  </varlistentry>
1317  <varlistentry>
1318   <term>Notes:</term>
1319   <listitem>
1320    <para>
1321     If set to 0, <application>Privoxy</application> will start in
1322     <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1323     content-neutral proxy with both ad blocking and content filtering
1324     disabled. See <literal>enable-remote-toggle</literal> below.
1325 <!--
1326     This is not really useful
1327     anymore, since toggling is much easier via <ulink
1328     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1329     editing the <filename>conf</filename> file.
1330
1331     Remote toggling is now disabled by default. fk 2007-11-07)
1332 -->
1333    </para>
1334    <para>
1335     The windows version will only display the toggle icon in the system tray
1336     if this option is present.
1337    </para>
1338   </listitem>
1339  </varlistentry>
1340 </variablelist>
1341
1342 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1343 </sect3>
1344
1345
1346 <!--   ~~~~~       New section      ~~~~~     -->
1347 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1348 <variablelist>
1349  <varlistentry>
1350   <term>Specifies:</term>
1351   <listitem>
1352    <para>
1353     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1354     feature</ulink> may be used
1355    </para>
1356   </listitem>
1357  </varlistentry>
1358  <varlistentry>
1359   <term>Type of value:</term>
1360   <listitem>
1361    <para>0 or 1</para>
1362   </listitem>
1363  </varlistentry>
1364  <varlistentry>
1365   <term>Default value:</term>
1366   <listitem>
1367    <para>0</para>
1368   </listitem>
1369  </varlistentry>
1370  <varlistentry>
1371   <term>Effect if unset:</term>
1372   <listitem>
1373    <para>
1374     The web-based toggle feature is disabled.
1375    </para>
1376   </listitem>
1377  </varlistentry>
1378  <varlistentry>
1379   <term>Notes:</term>
1380   <listitem>
1381    <para>
1382     When toggled off, <application>Privoxy</application> mostly acts like a normal,
1383     content-neutral proxy, i.e. doesn't block ads or filter content.
1384    </para>
1385    <para>
1386     Access to the toggle feature can <emphasis>not</emphasis> be
1387     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1388     so that everybody who can access <application>Privoxy</application> (see
1389     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1390     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1391     for multi-user environments with untrusted users.
1392    </para>
1393    <para>
1394     Note that malicious client side code (e.g Java) is also
1395     capable of using this option.
1396    </para>
1397    <para>
1398     As a lot of <application>Privoxy</application> users don't read
1399     documentation, this feature is disabled by default.
1400    </para>
1401    <para>
1402     Note that you must have compiled <application>Privoxy</application> with
1403     support for this feature, otherwise this option has no effect.
1404    </para>
1405   </listitem>
1406  </varlistentry>
1407 </variablelist>
1408
1409 <![%config-file;[<literallayout>@@enable-remote-toggle  0</literallayout>]]>
1410 </sect3>
1411
1412
1413 <!--   ~~~~~       New section      ~~~~~     -->
1414 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1415 <variablelist>
1416  <varlistentry>
1417   <term>Specifies:</term>
1418   <listitem>
1419    <para>
1420     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1421    </para>
1422   </listitem>
1423  </varlistentry>
1424  <varlistentry>
1425   <term>Type of value:</term>
1426   <listitem>
1427    <para>0 or 1</para>
1428   </listitem>
1429  </varlistentry>
1430  <varlistentry>
1431   <term>Default value:</term>
1432   <listitem>
1433    <para>0</para>
1434   </listitem>
1435  </varlistentry>
1436  <varlistentry>
1437   <term>Effect if unset:</term>
1438   <listitem>
1439    <para>
1440     Privoxy ignores special HTTP headers.
1441    </para>
1442   </listitem>
1443  </varlistentry>
1444  <varlistentry>
1445   <term>Notes:</term>
1446   <listitem>
1447    <para>
1448     When toggled on, the client can change <application>Privoxy's</application>
1449     behaviour by setting special HTTP headers. Currently the only supported
1450     special header is <quote>X-Filter: No</quote>, to disable filtering for
1451     the ongoing request, even if it is enabled in one of the action files.
1452    </para>
1453    <para>
1454     This feature is disabled by default. If you are using
1455     <application>Privoxy</application> in a environment with trusted clients,
1456     you may enable this feature at your discretion. Note that malicious client
1457     side code (e.g Java) is also capable of using this feature.
1458    </para>
1459    <para>
1460     This option will be removed in future releases as it has been obsoleted
1461     by the more general header taggers.
1462    </para>
1463   </listitem>
1464  </varlistentry>
1465 </variablelist>
1466
1467 <![%config-file;[<literallayout>@@enable-remote-http-toggle  0</literallayout>]]>
1468 </sect3>
1469
1470
1471 <!--   ~~~~~       New section      ~~~~~     -->
1472 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1473 <variablelist>
1474  <varlistentry>
1475   <term>Specifies:</term>
1476   <listitem>
1477    <para>
1478     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1479     file editor</ulink> may be used
1480    </para>
1481   </listitem>
1482  </varlistentry>
1483  <varlistentry>
1484   <term>Type of value:</term>
1485   <listitem>
1486    <para>0 or 1</para>
1487   </listitem>
1488  </varlistentry>
1489  <varlistentry>
1490   <term>Default value:</term>
1491   <listitem>
1492    <para>0</para>
1493   </listitem>
1494  </varlistentry>
1495  <varlistentry>
1496   <term>Effect if unset:</term>
1497   <listitem>
1498    <para>
1499     The web-based actions file editor is disabled.
1500    </para>
1501   </listitem>
1502  </varlistentry>
1503  <varlistentry>
1504   <term>Notes:</term>
1505   <listitem>
1506    <para>
1507     Access to the editor can <emphasis>not</emphasis> be
1508     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1509     so that everybody who can access <application>Privoxy</application> (see
1510     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1511     modify its configuration for all users.
1512    </para>
1513    <para>
1514     This option is <emphasis>not recommended</emphasis> for environments
1515     with untrusted users and as a lot of <application>Privoxy</application>
1516     users don't read documentation, this feature is disabled by default.
1517    </para>
1518    <para>
1519     Note that malicious client side code (e.g Java) is also
1520     capable of using the actions editor and you shouldn't enable
1521     this options unless you understand the consequences and are
1522     sure your browser is configured correctly.
1523    </para>
1524    <para>
1525     Note that you must have compiled <application>Privoxy</application> with
1526     support for this feature, otherwise this option has no effect.
1527    </para>
1528   </listitem>
1529  </varlistentry>
1530 </variablelist>
1531
1532 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1533 </sect3>
1534
1535
1536 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1537 <variablelist>
1538  <varlistentry>
1539   <term>Specifies:</term>
1540   <listitem>
1541    <para>
1542     Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1543    </para>
1544   </listitem>
1545  </varlistentry>
1546  <varlistentry>
1547   <term>Type of value:</term>
1548   <listitem>
1549    <para>
1550     <replaceable>0 or 1</replaceable>
1551    </para>
1552   </listitem>
1553  </varlistentry>
1554  <varlistentry>
1555   <term>Default value:</term>
1556   <listitem>
1557    <para><emphasis>0</emphasis></para>
1558   </listitem>
1559  </varlistentry>
1560  <varlistentry>
1561   <term>Effect if unset:</term>
1562   <listitem>
1563    <para>
1564     Blocks are not enforced.
1565    </para>
1566   </listitem>
1567  </varlistentry>
1568  <varlistentry>
1569   <term>Notes:</term>
1570   <listitem>
1571    <para>
1572     <application>Privoxy</application> is mainly used to block and filter
1573     requests as a service to the user, for example to block ads and other
1574     junk that clogs the pipes. <application>Privoxy's</application> configuration
1575     isn't perfect and sometimes innocent pages are blocked. In this situation it
1576     makes sense to allow the user to enforce the request and have
1577     <application>Privoxy</application> ignore the block.
1578    </para>
1579    <para>
1580     In the default configuration <application>Privoxy's</application>
1581     <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1582     link to adds a special string (the force prefix) to the request URL.
1583     If that link is used, <application>Privoxy</application> will
1584     detect the force prefix, remove it again and let the request pass.
1585    </para>
1586    <para>
1587     Of course <application>Privoxy</application> can also be used to enforce
1588     a network policy. In that case the user obviously should not be able to
1589     bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1590     option is for. If it's enabled, <application>Privoxy</application> hides
1591     the <quote>go there anyway</quote> link. If the user adds the force
1592     prefix by hand, it will not be accepted and the circumvention attempt
1593     is logged.
1594    </para>
1595   </listitem>
1596  </varlistentry>
1597  <varlistentry>
1598   <term>Examples:</term>
1599   <listitem>
1600    <para>
1601     enforce-blocks 1
1602    </para>
1603   </listitem>
1604  </varlistentry>
1605 </variablelist>
1606 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1607 </sect3>
1608
1609
1610 <!--   ~~~~~       New section      ~~~~~     -->
1611 <sect3 renderas="sect4" id="acls"><title>
1612 ACLs: permit-access and deny-access</title>
1613 <anchor id="permit-access">
1614 <anchor id="deny-access">
1615
1616 <variablelist>
1617  <varlistentry>
1618   <term>Specifies:</term>
1619   <listitem>
1620    <para>
1621     Who can access what.
1622    </para>
1623   </listitem>
1624  </varlistentry>
1625  <varlistentry>
1626   <term>Type of value:</term>
1627   <listitem>
1628    <para>
1629     <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1630     [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1631    </para>
1632    <para>
1633     Where <replaceable class="parameter">src_addr</replaceable> and
1634    <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1635     DNS names, <replaceable class="parameter">port</replaceable> is a port
1636     number, and <replaceable class="parameter">src_masklen</replaceable> and
1637     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1638     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1639     destination part are optional.
1640    </para>
1641    <para>
1642     If your system implements
1643     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1644     <replaceable class="parameter">src_addr</replaceable> and <replaceable
1645     class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1646     brackets, <replaceable class="parameter">port</replaceable> can be a number
1647     or a service name, and
1648     <replaceable class="parameter">src_masklen</replaceable> and
1649     <replaceable class="parameter">dst_masklen</replaceable> can be a number
1650     from 0 to 128.
1651    </para>
1652   </listitem>
1653  </varlistentry>
1654  <varlistentry>
1655   <term>Default value:</term>
1656   <listitem>
1657    <para><emphasis>Unset</emphasis></para>
1658    <para>
1659     If no <replaceable class="parameter">port</replaceable> is specified,
1660     any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1661     <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1662     address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1663    </para>
1664   </listitem>
1665  </varlistentry>
1666  <varlistentry>
1667   <term>Effect if unset:</term>
1668   <listitem>
1669    <para>
1670     Don't restrict access further than implied by <literal>listen-address</literal>
1671    </para>
1672   </listitem>
1673  </varlistentry>
1674  <varlistentry>
1675   <term>Notes:</term>
1676   <listitem>
1677    <para>
1678     Access controls are included at the request of ISPs and systems
1679     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1680     For a typical home user, it will normally suffice to ensure that
1681     <application>Privoxy</application> only listens on the localhost
1682     (127.0.0.1) or internal (home) network address by means of the
1683     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1684     option.
1685    </para>
1686    <para>
1687     Please see the warnings in the FAQ that <application>Privoxy</application>
1688     is not intended to be a substitute for a firewall or to encourage anyone
1689     to defer addressing basic security weaknesses.
1690    </para>
1691    <para>
1692     Multiple ACL lines are OK.
1693     If any ACLs are specified, <application>Privoxy</application> only talks
1694     to IP addresses that match at least one <literal>permit-access</literal> line
1695     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1696     last match wins, with the default being <literal>deny-access</literal>.
1697    </para>
1698    <para>
1699     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1700     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1701     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1702     of the ultimate target. This is necessary because it may be impossible for the local
1703     <application>Privoxy</application> to determine the IP address of the
1704     ultimate target (that's often what gateways are used for).
1705    </para>
1706    <para>
1707     You should prefer using IP addresses over DNS names, because the address lookups take
1708     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1709     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1710     IP addresses, only the first one is used.
1711    </para>
1712    <para>
1713      Some systems allows IPv4 client to connect to IPv6 server socket.
1714      Then the client's IPv4 address will be translated by system into
1715      IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1716      mapped IPv6 address). <application>Privoxy</application> can handle it
1717      and maps such ACL addresses automatically.
1718    </para>
1719    <para>
1720     Denying access to particular sites by ACL may have undesired side effects
1721     if the site in question is hosted on a machine which also hosts other sites
1722     (most sites are).
1723    </para>
1724   </listitem>
1725  </varlistentry>
1726  <varlistentry>
1727   <term>Examples:</term>
1728   <listitem>
1729    <para>
1730     Explicitly define the default behavior if no ACL and
1731     <literal>listen-address</literal> are set: <quote>localhost</quote>
1732     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1733     <emphasis>all</emphasis> destination addresses are OK:
1734    </para>
1735    <para>
1736     <screen>
1737   permit-access  localhost
1738 </screen>
1739    </para>
1740    <para>
1741     Allow any host on the same class C subnet as www.privoxy.org access to
1742     nothing but www.example.com (or other domains hosted on the same system):
1743    </para>
1744    <para>
1745     <screen>
1746   permit-access  www.privoxy.org/24 www.example.com/32
1747 </screen>
1748    </para>
1749    <para>
1750     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1751     with the exception that 192.168.45.73 may not access the IP address behind
1752     www.dirty-stuff.example.com:
1753    </para>
1754    <para>
1755     <screen>
1756   permit-access  192.168.45.64/26
1757   deny-access    192.168.45.73    www.dirty-stuff.example.com
1758 </screen>
1759    </para>
1760    <para>
1761      Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1762      an IPv6 wild card address (not supported on all platforms):
1763    </para>
1764    <para>
1765     <programlisting>
1766   permit-access  192.0.2.0/24
1767 </programlisting>
1768    </para>
1769    <para>
1770      This is equivalent to the following line even if listening on an
1771      IPv4 address (not supported on all platforms):
1772    </para>
1773    <para>
1774     <programlisting>
1775   permit-access  [::ffff:192.0.2.0]/120
1776 </programlisting>
1777    </para>
1778   </listitem>
1779  </varlistentry>
1780 </variablelist>
1781 </sect3>
1782
1783
1784 <!--   ~~~~~       New section      ~~~~~     -->
1785 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1786
1787 <variablelist>
1788  <varlistentry>
1789   <term>Specifies:</term>
1790   <listitem>
1791    <para>
1792     Maximum size of the buffer for content filtering.
1793    </para>
1794   </listitem>
1795  </varlistentry>
1796  <varlistentry>
1797   <term>Type of value:</term>
1798   <listitem>
1799    <para>Size in Kbytes</para>
1800   </listitem>
1801  </varlistentry>
1802  <varlistentry>
1803   <term>Default value:</term>
1804   <listitem>
1805    <para>4096</para>
1806   </listitem>
1807  </varlistentry>
1808  <varlistentry>
1809   <term>Effect if unset:</term>
1810   <listitem>
1811    <para>
1812     Use a 4MB (4096 KB) limit.
1813    </para>
1814   </listitem>
1815  </varlistentry>
1816  <varlistentry>
1817   <term>Notes:</term>
1818   <listitem>
1819    <para>
1820     For content filtering, i.e. the <literal>+filter</literal> and
1821     <literal>+deanimate-gif</literal> actions, it is necessary that
1822     <application>Privoxy</application> buffers the entire document body.
1823     This can be potentially dangerous, since a server could just keep sending
1824     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1825     Hence this option.
1826    </para>
1827    <para>
1828     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1829     flushed to the client unfiltered and no further attempt to
1830     filter the rest of the document is made. Remember that there may be multiple threads
1831     running, which might require up to <literal>buffer-limit</literal> Kbytes
1832     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1833     above.
1834    </para>
1835   </listitem>
1836  </varlistentry>
1837 </variablelist>
1838
1839 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1840 </sect3>
1841
1842 </sect2>
1843
1844 <!--  ~  End section  ~  -->
1845
1846
1847 <!--   ~~~~~       New section      ~~~~~     -->
1848
1849 <sect2 id="forwarding">
1850 <title>Forwarding</title>
1851
1852 <para>
1853  This feature allows routing of HTTP requests through a chain of
1854  multiple proxies.
1855 </para>
1856 <para>
1857  Forwarding can be used to chain Privoxy with a caching proxy to speed
1858  up browsing. Using a parent proxy may also be necessary if the machine
1859  that <application>Privoxy</application> runs on has no direct Internet access.
1860 </para>
1861 <para>
1862  Note that parent proxies can severely decrease your privacy level.
1863  For example a parent proxy could add your IP address to the request
1864  headers and if it's a caching proxy it may add the <quote>Etag</quote>
1865  header to revalidation requests again, even though you configured Privoxy
1866  to remove it. It may also ignore Privoxy's header time randomization and use the
1867  original values which could be used by the server as cookie replacement
1868  to track your steps between visits.
1869 </para>
1870
1871 <para>
1872  Also specified here are SOCKS proxies. <application>Privoxy</application>
1873  supports the SOCKS 4 and SOCKS 4A protocols.
1874 </para>
1875
1876 <sect3 renderas="sect4" id="forward"><title>forward</title>
1877 <variablelist>
1878  <varlistentry>
1879   <term>Specifies:</term>
1880   <listitem>
1881    <para>
1882     To which parent HTTP proxy specific requests should be routed.
1883    </para>
1884   </listitem>
1885  </varlistentry>
1886  <varlistentry>
1887   <term>Type of value:</term>
1888   <listitem>
1889    <para>
1890     <replaceable class="parameter">target_pattern</replaceable>
1891     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1892    </para>
1893    <para>
1894     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1895     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1896     denote <quote>all URLs</quote>.
1897     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1898     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1899     optionally followed by its listening port (default: 8000).
1900     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1901    </para>
1902   </listitem>
1903  </varlistentry>
1904  <varlistentry>
1905   <term>Default value:</term>
1906   <listitem>
1907    <para><emphasis>Unset</emphasis></para>
1908   </listitem>
1909  </varlistentry>
1910  <varlistentry>
1911   <term>Effect if unset:</term>
1912   <listitem>
1913    <para>
1914     Don't use parent HTTP proxies.
1915    </para>
1916   </listitem>
1917  </varlistentry>
1918  <varlistentry>
1919   <term>Notes:</term>
1920   <listitem>
1921    <para>
1922     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1923     forwarded to another HTTP proxy but are made directly to the web servers.
1924    </para>
1925    <para>
1926     <replaceable class="parameter">http_parent</replaceable> can be a
1927      numerical IPv6 address (if
1928     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
1929     implemented). To prevent clashes with the port delimiter, the whole IP
1930     address has to be put into brackets. On the other hand a <replaceable
1931     class="parameter">target_pattern</replaceable> containing an IPv6 address
1932     has to be put into angle brackets (normal brackets are reserved for
1933     regular expressions already).
1934    </para>
1935    <para>
1936     Multiple lines are OK, they are checked in sequence, and the last match wins.
1937    </para>
1938   </listitem>
1939  </varlistentry>
1940  <varlistentry>
1941   <term>Examples:</term>
1942   <listitem>
1943    <para>
1944     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1945    </para>
1946    <para>
1947     <screen>
1948   forward   /      parent-proxy.example.org:8080
1949   forward   :443   .
1950 </screen>
1951    </para>
1952    <para>
1953     Everything goes to our example ISP's caching proxy, except for requests
1954     to that ISP's sites:
1955    </para>
1956    <para>
1957     <screen>
1958   forward   /                  caching-proxy.isp.example.net:8000
1959   forward   .isp.example.net   .
1960 </screen>
1961    </para>
1962    <para>
1963     Parent proxy specified by an IPv6 address:
1964    </para>
1965    <para>
1966     <programlisting>
1967   foward   /                   [2001:DB8::1]:8000
1968 </programlisting>
1969    </para>
1970    <para>
1971     Suppose your parent proxy doesn't support IPv6:
1972    </para>
1973    <para>
1974     <programlisting>
1975   forward  /                        parent-proxy.example.org:8000
1976   forward  ipv6-server.example.org  .
1977   forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
1978 </programlisting>
1979    </para>
1980   </listitem>
1981  </varlistentry>
1982 </variablelist>
1983 </sect3>
1984
1985
1986 <!--   ~~~~~       New section      ~~~~~     -->
1987 <sect3 renderas="sect4" id="socks"><title>
1988 forward-socks4, forward-socks4a and forward-socks5</title>
1989 <anchor id="forward-socks4">
1990 <anchor id="forward-socks4a">
1991
1992 <variablelist>
1993  <varlistentry>
1994   <term>Specifies:</term>
1995   <listitem>
1996    <para>
1997     Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
1998    </para>
1999   </listitem>
2000  </varlistentry>
2001  <varlistentry>
2002   <term>Type of value:</term>
2003   <listitem>
2004    <para>
2005     <replaceable class="parameter">target_pattern</replaceable>
2006     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2007     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2008    </para>
2009    <para>
2010     where <replaceable class="parameter">target_pattern</replaceable> is a
2011     <link linkend="af-patterns">URL pattern</link> that specifies to which
2012     requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2013     denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2014     and <replaceable class="parameter">socks_proxy</replaceable>
2015     are IP addresses in dotted decimal notation or valid DNS names
2016     (<replaceable class="parameter">http_parent</replaceable>
2017     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2018     <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2019     i.e. integer values from 1 to 65535
2020    </para>
2021   </listitem>
2022  </varlistentry>
2023  <varlistentry>
2024   <term>Default value:</term>
2025   <listitem>
2026    <para><emphasis>Unset</emphasis></para>
2027   </listitem>
2028  </varlistentry>
2029  <varlistentry>
2030   <term>Effect if unset:</term>
2031   <listitem>
2032    <para>
2033     Don't use SOCKS proxies.
2034    </para>
2035   </listitem>
2036  </varlistentry>
2037  <varlistentry>
2038   <term>Notes:</term>
2039   <listitem>
2040    <para>
2041     Multiple lines are OK, they are checked in sequence, and the last match wins.
2042    </para>
2043    <para>
2044     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2045     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2046     server, while in SOCKS 4 it happens locally.
2047    </para>
2048    <para>
2049     With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2050    </para>
2051    <para>
2052     <replaceable class="parameter">socks_proxy</replaceable> and
2053     <replaceable class="parameter">http_parent</replaceable> can be a
2054      numerical IPv6 address (if
2055     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2056     implemented). To prevent clashes with the port delimiter, the whole IP
2057     address has to be put into brackets. On the other hand a <replaceable
2058     class="parameter">target_pattern</replaceable> containing an IPv6 address
2059     has to be put into angle brackets (normal brackets are reserved for
2060     regular expressions already).
2061    </para>
2062    <para>
2063     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2064     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2065     a SOCKS proxy.
2066    </para>
2067   </listitem>
2068  </varlistentry>
2069  <varlistentry>
2070   <term>Examples:</term>
2071   <listitem>
2072    <para>
2073      From the company example.com, direct connections are made to all
2074      <quote>internal</quote> domains, but everything outbound goes through
2075      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2076      the Internet.
2077    </para>
2078    <para>
2079     <screen>
2080   forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
2081   forward           .example.com   .
2082 </screen>
2083    </para>
2084    <para>
2085     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2086    </para>
2087    <para>
2088     <screen>
2089   forward-socks4   /               socks-gw.example.com:1080  .
2090 </screen>
2091    </para>
2092
2093     <para>
2094     To chain Privoxy and Tor, both running on the same system, you would use
2095     something like:
2096    </para>
2097    <para>
2098     <screen>
2099   forward-socks5   /               127.0.0.1:9050 .
2100 </screen>
2101    </para>
2102
2103     <para>
2104     The public <application>Tor</application> network can't be used to
2105     reach your local network, if you need to access local servers you
2106     therefore might want to make some exceptions:
2107    </para>
2108    <para>
2109     <screen>
2110   forward         192.168.*.*/     .
2111   forward            10.*.*.*/     .
2112   forward           127.*.*.*/     .
2113 </screen>
2114    </para>
2115    <para>
2116     Unencrypted connections to systems in these address ranges will
2117     be as (un)secure as the local network is, but the alternative is that you
2118     can't reach the local network through <application>Privoxy</application>
2119     at all. Of course this may actually be desired and there is no reason
2120     to make these exceptions if you aren't sure you need them.
2121    </para>
2122    <para>
2123     If you also want to be able to reach servers in your local network by
2124     using their names, you will need additional exceptions that look like
2125     this:
2126    </para>
2127    <para>
2128     <screen>
2129  forward           localhost/     .
2130 </screen>
2131    </para>
2132
2133   </listitem>
2134  </varlistentry>
2135 </variablelist>
2136 </sect3>
2137
2138 <![%user-man;[     <!-- not included in config due to length -->
2139 <!--   ~~~~~       New section      ~~~~~     -->
2140 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2141
2142 <para>
2143  If you have links to multiple ISPs that provide various special content
2144  only to their subscribers, you can configure multiple <application>Privoxies</application>
2145  which have connections to the respective ISPs to act as forwarders to each other, so that
2146  <emphasis>your</emphasis> users can see the internal content of all ISPs.
2147 </para>
2148
2149 <para>
2150  Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2151  isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2152  configuration can look like this:
2153 </para>
2154
2155 <para>
2156  host-a:
2157 </para>
2158
2159 <para>
2160  <screen>
2161   forward    /           .
2162   forward    .isp-b.example.net  host-b:8118
2163 </screen>
2164 </para>
2165
2166 <para>
2167  host-b:
2168 </para>
2169
2170 <para>
2171  <screen>
2172   forward    /           .
2173   forward    .isp-a.example.org  host-a:8118
2174 </screen>
2175 </para>
2176
2177 <para>
2178  Now, your users can set their browser's proxy to use either
2179  host-a or host-b and be able to browse the internal content
2180  of both isp-a and isp-b.
2181 </para>
2182
2183 <para>
2184  If you intend to chain <application>Privoxy</application> and
2185  <application>squid</application> locally, then chaining as
2186  <literal>browser -> squid -> privoxy</literal> is the recommended way.
2187 </para>
2188
2189 <para>
2190  Assuming that <application>Privoxy</application> and <application>squid</application>
2191  run on the same box, your <application>squid</application> configuration could then look like this:
2192 </para>
2193
2194 <para>
2195  <screen>
2196   # Define Privoxy as parent proxy (without ICP)
2197   cache_peer 127.0.0.1 parent 8118 7 no-query
2198
2199   # Define ACL for protocol FTP
2200   acl ftp proto FTP
2201
2202   # Do not forward FTP requests to Privoxy
2203   always_direct allow ftp
2204
2205   # Forward all the rest to Privoxy
2206   never_direct allow all</screen>
2207 </para>
2208
2209 <para>
2210  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2211  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2212 </para>
2213
2214 <para>
2215  You could just as well decide to only forward requests you suspect
2216  of leading to Windows executables through a virus-scanning parent proxy,
2217  say, on <literal>antivir.example.com</literal>, port 8010:
2218 </para>
2219
2220 <para>
2221  <screen>
2222   forward   /                          .
2223   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
2224 </para>
2225
2226 </sect3>
2227 ]]>
2228
2229 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2230 <variablelist>
2231  <varlistentry>
2232   <term>Specifies:</term>
2233   <listitem>
2234    <para>
2235     How often Privoxy retries if a forwarded connection request fails.
2236    </para>
2237   </listitem>
2238  </varlistentry>
2239  <varlistentry>
2240   <term>Type of value:</term>
2241   <listitem>
2242    <para>
2243     <replaceable class="parameter">Number of retries.</replaceable>
2244    </para>
2245   </listitem>
2246  </varlistentry>
2247  <varlistentry>
2248   <term>Default value:</term>
2249   <listitem>
2250    <para><emphasis>0</emphasis></para>
2251   </listitem>
2252  </varlistentry>
2253  <varlistentry>
2254   <term>Effect if unset:</term>
2255   <listitem>
2256    <para>
2257     Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2258    </para>
2259   </listitem>
2260  </varlistentry>
2261  <varlistentry>
2262   <term>Notes:</term>
2263   <listitem>
2264    <para>
2265     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2266     for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2267     The connection might have failed because of a DNS timeout in which case a retry makes sense,
2268     but it might also have failed because the server doesn't exist or isn't reachable. In this
2269     case the retry will just delay the appearance of Privoxy's error message.
2270    </para>
2271    <para>
2272     Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2273     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2274    </para>
2275    <para>
2276     Only use this option, if you are getting lots of forwarding-related error messages
2277     that go away when you try again manually. Start with a small value and check Privoxy's
2278     logfile from time to time, to see how many retries are usually needed.
2279    </para>
2280   </listitem>
2281  </varlistentry>
2282  <varlistentry>
2283   <term>Examples:</term>
2284   <listitem>
2285    <para>
2286     forwarded-connect-retries 1
2287    </para>
2288   </listitem>
2289  </varlistentry>
2290 </variablelist>
2291 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2292 </sect3>
2293
2294 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2295 <variablelist>
2296  <varlistentry>
2297   <term>Specifies:</term>
2298   <listitem>
2299    <para>
2300     Whether intercepted requests should be treated as valid.
2301    </para>
2302   </listitem>
2303  </varlistentry>
2304  <varlistentry>
2305   <term>Type of value:</term>
2306   <listitem>
2307    <para>
2308     <replaceable>0 or 1</replaceable>
2309    </para>
2310   </listitem>
2311  </varlistentry>
2312  <varlistentry>
2313   <term>Default value:</term>
2314   <listitem>
2315    <para><emphasis>0</emphasis></para>
2316   </listitem>
2317  </varlistentry>
2318  <varlistentry>
2319   <term>Effect if unset:</term>
2320   <listitem>
2321    <para>
2322     Only proxy requests are accepted, intercepted requests are treated as invalid.
2323    </para>
2324   </listitem>
2325  </varlistentry>
2326  <varlistentry>
2327   <term>Notes:</term>
2328   <listitem>
2329    <para>
2330     If you don't trust your clients and want to force them
2331     to use <application>Privoxy</application>, enable this
2332     option and configure your packet filter to redirect outgoing
2333     HTTP connections into <application>Privoxy</application>.
2334    </para>
2335    <para>
2336     Make sure that <application>Privoxy's</application> own requests
2337     aren't redirected as well. Additionally take care that
2338     <application>Privoxy</application> can't intentionally connect
2339     to itself, otherwise you could run into redirection loops if
2340     <application>Privoxy's</application> listening port is reachable
2341     by the outside or an attacker has access to the pages you visit.
2342    </para>
2343   </listitem>
2344  </varlistentry>
2345  <varlistentry>
2346   <term>Examples:</term>
2347   <listitem>
2348    <para>
2349     accept-intercepted-requests 1
2350    </para>
2351   </listitem>
2352  </varlistentry>
2353 </variablelist>
2354 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2355 </sect3>
2356
2357 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2358 <variablelist>
2359  <varlistentry>
2360   <term>Specifies:</term>
2361   <listitem>
2362    <para>
2363     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2364    </para>
2365   </listitem>
2366  </varlistentry>
2367  <varlistentry>
2368   <term>Type of value:</term>
2369   <listitem>
2370    <para>
2371     <replaceable>0 or 1</replaceable>
2372    </para>
2373   </listitem>
2374  </varlistentry>
2375  <varlistentry>
2376   <term>Default value:</term>
2377   <listitem>
2378    <para><emphasis>0</emphasis></para>
2379   </listitem>
2380  </varlistentry>
2381  <varlistentry>
2382   <term>Effect if unset:</term>
2383   <listitem>
2384    <para>
2385     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2386    </para>
2387   </listitem>
2388  </varlistentry>
2389  <varlistentry>
2390   <term>Notes:</term>
2391   <listitem>
2392    <para>
2393     By default <application>Privoxy</application> ignores block or redirect actions
2394     for its CGI pages. Intercepting these requests can be useful in multi-user
2395     setups to implement fine-grained access control, but it can also render the complete
2396     web interface useless and make debugging problems painful if done without care.
2397    </para>
2398    <para>
2399     Don't enable this option unless you're sure that you really need it.
2400    </para>
2401   </listitem>
2402  </varlistentry>
2403  <varlistentry>
2404   <term>Examples:</term>
2405   <listitem>
2406    <para>
2407     allow-cgi-request-crunching 1
2408    </para>
2409   </listitem>
2410  </varlistentry>
2411 </variablelist>
2412 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2413 </sect3>
2414
2415 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2416 <variablelist>
2417  <varlistentry>
2418   <term>Specifies:</term>
2419   <listitem>
2420    <para>
2421     Whether the CGI interface should stay compatible with broken HTTP clients.
2422    </para>
2423   </listitem>
2424  </varlistentry>
2425  <varlistentry>
2426   <term>Type of value:</term>
2427   <listitem>
2428    <para>
2429     <replaceable>0 or 1</replaceable>
2430    </para>
2431   </listitem>
2432  </varlistentry>
2433  <varlistentry>
2434   <term>Default value:</term>
2435   <listitem>
2436    <para><emphasis>0</emphasis></para>
2437   </listitem>
2438  </varlistentry>
2439  <varlistentry>
2440   <term>Effect if unset:</term>
2441   <listitem>
2442    <para>
2443     The CGI form generate long GET URLs.
2444    </para>
2445   </listitem>
2446  </varlistentry>
2447  <varlistentry>
2448   <term>Notes:</term>
2449   <listitem>
2450    <para>
2451     <application>Privoxy's</application> CGI forms can lead to
2452     rather long URLs. This isn't a problem as far as the HTTP
2453     standard is concerned, but it can confuse clients with arbitrary
2454     URL length limitations.
2455    </para>
2456    <para>
2457     Enabling split-large-forms causes <application>Privoxy</application>
2458     to divide big forms into smaller ones to keep the URL length down.
2459     It makes editing a lot less convenient and you can no longer
2460     submit all changes at once, but at least it works around this
2461     browser bug.
2462    </para>
2463    <para>
2464     If you don't notice any editing problems, there is no reason
2465     to enable this option, but if one of the submit buttons appears
2466     to be broken, you should give it a try.
2467    </para>
2468   </listitem>
2469  </varlistentry>
2470  <varlistentry>
2471   <term>Examples:</term>
2472   <listitem>
2473    <para>
2474     split-large-forms 1
2475    </para>
2476   </listitem>
2477  </varlistentry>
2478 </variablelist>
2479 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2480 </sect3>
2481
2482 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2483 <variablelist>
2484  <varlistentry>
2485   <term>Specifies:</term>
2486   <listitem>
2487    <para>
2488     Number of seconds after which an open connection will no longer be reused.
2489    </para>
2490   </listitem>
2491  </varlistentry>
2492  <varlistentry>
2493   <term>Type of value:</term>
2494   <listitem>
2495    <para>
2496     <replaceable>Time in seconds.</replaceable>
2497    </para>
2498   </listitem>
2499  </varlistentry>
2500  <varlistentry>
2501   <term>Default value:</term>
2502   <listitem>
2503    <para>None</para>
2504   </listitem>
2505  </varlistentry>
2506  <varlistentry>
2507   <term>Effect if unset:</term>
2508   <listitem>
2509    <para>
2510     Connections are not reused.
2511    </para>
2512   </listitem>
2513  </varlistentry>
2514  <varlistentry>
2515   <term>Notes:</term>
2516   <listitem>
2517    <para>
2518     This option has no effect if <application>Privoxy</application>
2519     has been compiled without keep-alive support.
2520    </para>
2521   </listitem>
2522  </varlistentry>
2523  <varlistentry>
2524   <term>Notes:</term>
2525   <listitem>
2526    <para>
2527     Note that reusing connections doesn't necessary cause speedups.
2528     There are also a few privacy implications you should be aware of.
2529    </para>
2530    <para>
2531     Outgoing connections are shared between clients (if there are more
2532     than one) and closing the client that initiated the outgoing connection
2533     does not affect the connection between &my-app; and the server unless
2534     the client's request hasn't been completed yet. If the outgoing connection
2535     is idle, it will not be closed until either <application>Privoxy's</application>
2536     or the server's timeout is reached. While it's open, the server knows
2537     that the system running &my-app; is still there.
2538    </para>
2539   </listitem>
2540  </varlistentry>
2541  <varlistentry>
2542   <term>Examples:</term>
2543   <listitem>
2544    <para>
2545     keep-alive-timeout 300
2546    </para>
2547   </listitem>
2548  </varlistentry>
2549 </variablelist>
2550 <![%config-file;[<literallayout>@@keep-alive-timeout 300</literallayout>]]>
2551 </sect3>
2552
2553
2554 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2555 <variablelist>
2556  <varlistentry>
2557   <term>Specifies:</term>
2558   <listitem>
2559    <para>
2560     Number of seconds after which a socket times out if
2561     no data is received.
2562    </para>
2563   </listitem>
2564  </varlistentry>
2565  <varlistentry>
2566   <term>Type of value:</term>
2567   <listitem>
2568    <para>
2569     <replaceable>Time in seconds.</replaceable>
2570    </para>
2571   </listitem>
2572  </varlistentry>
2573  <varlistentry>
2574   <term>Default value:</term>
2575   <listitem>
2576    <para>None</para>
2577   </listitem>
2578  </varlistentry>
2579  <varlistentry>
2580   <term>Effect if unset:</term>
2581   <listitem>
2582    <para>
2583     A default value of 300 seconds is used.
2584    </para>
2585   </listitem>
2586  </varlistentry>
2587  <varlistentry>
2588   <term>Notes:</term>
2589   <listitem>
2590    <para>
2591     For SOCKS requests the timeout currently doesn't start until
2592     the SOCKS server accepted the request. This will be fixed in
2593     the next release.
2594    </para>
2595   </listitem>
2596  </varlistentry>
2597  <varlistentry>
2598   <term>Examples:</term>
2599   <listitem>
2600    <para>
2601     socket-timeout 300
2602    </para>
2603   </listitem>
2604  </varlistentry>
2605 </variablelist>
2606 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2607 </sect3>
2608
2609
2610 </sect2>
2611
2612 <!--  ~  End section  ~  -->
2613
2614
2615 <!--   ~~~~~       New section      ~~~~~     -->
2616
2617 <sect2 id="windows-gui">
2618 <title>Windows GUI Options</title>
2619 <para>
2620  <application>Privoxy</application> has a number of options specific to the
2621  Windows GUI interface:
2622 </para>
2623
2624 <anchor id="activity-animation">
2625 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2626 <para>
2627  If <quote>activity-animation</quote> is set to 1, the
2628  <application>Privoxy</application> icon will animate when
2629  <quote>Privoxy</quote> is active. To turn off, set to 0.
2630 </para>
2631
2632 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
2633 <![%user-man;[
2634 <para>
2635  <literal>
2636   <msgtext>
2637    <literallayout>
2638   <emphasis>activity-animation   1</emphasis>
2639    </literallayout>
2640   </msgtext>
2641  </literal>
2642 </para>
2643 ]]>
2644
2645 <anchor id="log-messages">
2646 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2647 <para>
2648  If <quote>log-messages</quote> is set to 1,
2649  <application>Privoxy</application> will log messages to the console
2650  window:
2651 </para>
2652
2653 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
2654 <![%user-man;[
2655 <para>
2656  <literal>
2657   <msgtext>
2658    <literallayout>
2659   <emphasis>log-messages       1</emphasis>
2660    </literallayout>
2661   </msgtext>
2662  </literal>
2663 </para>
2664 ]]>
2665
2666 <anchor id="log-buffer-size">
2667 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2668 <para>
2669  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2670  i.e. the amount of memory used for the log messages displayed in the
2671  console window, will be limited to <quote>log-max-lines</quote> (see below).
2672 </para>
2673
2674 <para>
2675  Warning: Setting this to 0 will result in the buffer to grow infinitely and
2676  eat up all your memory!
2677 </para>
2678
2679 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2680 <![%user-man;[
2681 <para>
2682  <literal>
2683   <msgtext>
2684    <literallayout>
2685   <emphasis>log-buffer-size      1</emphasis>
2686    </literallayout>
2687   </msgtext>
2688  </literal>
2689 </para>
2690 ]]>
2691
2692 <anchor id="log-max-lines">
2693 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2694 <para>
2695  <application>log-max-lines</application> is the maximum number of lines held
2696  in the log buffer. See above.
2697 </para>
2698
2699 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2700 <![%user-man;[
2701 <para>
2702  <literal>
2703   <msgtext>
2704    <literallayout>
2705   <emphasis>log-max-lines      200</emphasis>
2706    </literallayout>
2707   </msgtext>
2708  </literal>
2709 </para>
2710 ]]>
2711
2712 <anchor id="log-highlight-messages">
2713 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2714 <para>
2715  If <quote>log-highlight-messages</quote> is set to 1,
2716  <application>Privoxy</application> will highlight portions of the log
2717  messages with a bold-faced font:
2718 </para>
2719
2720 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2721 <![%user-man;[
2722 <para>
2723  <literal>
2724   <msgtext>
2725    <literallayout>
2726   <emphasis>log-highlight-messages   1</emphasis>
2727    </literallayout>
2728   </msgtext>
2729  </literal>
2730 </para>
2731 ]]>
2732
2733 <anchor id="log-font-name">
2734 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2735 <para>
2736  The font used in the console window:
2737 </para>
2738
2739 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2740 <![%user-man;[
2741 <para>
2742  <literal>
2743   <msgtext>
2744    <literallayout>
2745   <emphasis>log-font-name        Comic Sans MS</emphasis>
2746    </literallayout>
2747   </msgtext>
2748  </literal>
2749 </para>
2750 ]]>
2751
2752 <anchor id="log-font-size">
2753 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2754 <para>
2755  Font size used in the console window:
2756 </para>
2757
2758 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2759 <![%user-man;[
2760 <para>
2761  <literal>
2762   <msgtext>
2763    <literallayout>
2764   <emphasis>log-font-size        8</emphasis>
2765    </literallayout>
2766   </msgtext>
2767  </literal>
2768 </para>
2769 ]]>
2770
2771 <anchor id="show-on-task-bar">
2772 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2773 <para>
2774  <quote>show-on-task-bar</quote> controls whether or not
2775  <application>Privoxy</application> will appear as a button on the Task bar
2776  when minimized:
2777 </para>
2778
2779 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2780 <![%user-man;[
2781 <para>
2782  <literal>
2783   <msgtext>
2784    <literallayout>
2785   <emphasis>show-on-task-bar     0</emphasis>
2786    </literallayout>
2787   </msgtext>
2788  </literal>
2789 </para>
2790 ]]>
2791
2792 <anchor id="close-button-minimizes">
2793 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2794 <para>
2795  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2796  button will minimize <application>Privoxy</application> instead of closing
2797  the program (close with the exit option on the File menu).
2798 </para>
2799
2800 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2801 <![%user-man;[
2802 <para>
2803  <literal>
2804   <msgtext>
2805    <literallayout>
2806   <emphasis>close-button-minimizes  1</emphasis>
2807    </literallayout>
2808   </msgtext>
2809  </literal>
2810 </para>
2811 ]]>
2812
2813 <anchor id="hide-console">
2814 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2815 <para>
2816  The <quote>hide-console</quote> option is specific to the MS-Win console
2817  version of <application>Privoxy</application>. If this option is used,
2818  <application>Privoxy</application> will disconnect from and hide the
2819  command console.
2820 </para>
2821
2822 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2823 <![%user-man;[
2824 <para>
2825  <literal>
2826   <msgtext>
2827    <literallayout>
2828   #<emphasis>hide-console</emphasis>
2829    </literallayout>
2830   </msgtext>
2831  </literal>
2832 </para>
2833 ]]>
2834
2835 </sect2>
2836 </sect1>
2837
2838 <!-- end config content common to both outputs -->
2839
2840 <![%config-file;[
2841 <!-- These are dummy anchors to keep the processor quiet            -->
2842 <!-- when building config-file only (ie. they are used in u-m only) -->
2843 <sect1 label="">
2844 <title></title>
2845 <anchor id="filter">
2846 <anchor id="filter-file">
2847 <anchor id="regex">
2848 <anchor id="actions-file">
2849 <anchor id="af-patterns">
2850 </sect1>
2851 ]]>
2852
2853 <!-- eof p-config.sgml -->