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.61 2010/02/04 09:35:04 fabiankeil Exp $
   7
   8  Copyright (C) 2001-2010 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). Like the filter and action files, the config file is
  85  a plain text file and can be modified with a text editor like emacs, vim or
  86  notepad.exe.
  87 </para>
  88
  89 ]]>
  90
  91
  92 <![%config-file;[
  93 <!-- This part only goes into the config file -->
  94 <sect1 id="config">
  95 <title>
  96  @@TITLE<!-- between the @@ is stripped by Makefile -->@@
  97  Sample Configuration File for Privoxy v&p-version;
  98 </title>
  99 <para>
 100  $Id: p-config.sgml,v 2.61 2010/02/04 09:35:04 fabiankeil Exp $
 101 </para>
 102 <para>
 103 Copyright (C) 2001-2010 Privoxy Developers http://www.privoxy.org/
 104 </para>
 105
 106 <para>
 107  <literallayout>
 108 #################################################################
 109                                                                 #
 110                     Table of Contents                           #
 111                                                                 #
 112       I. INTRODUCTION                                           #
 113      II. FORMAT OF THE CONFIGURATION FILE                       #
 114                                                                 #
 115       1. LOCAL SET-UP DOCUMENTATION                             #
 116       2. CONFIGURATION AND LOG FILE LOCATIONS                   #
 117       3. DEBUGGING                                              #
 118       4. ACCESS CONTROL AND SECURITY                            #
 119       5. FORWARDING                                             #
 120       6. WINDOWS GUI OPTIONS                                    #
 121                                                                 #
 122 #################################################################
 123  </literallayout>
 124 </para>
 125
 126 <literallayout>I. INTRODUCTION
 127  ===============  <!-- fuck this madness --></literallayout>
 128
 129 <para>
 130  This file holds Privoxy's main configuration.  Privoxy detects
 131  configuration changes automatically, so you don't have to restart it
 132  unless you want to load a different configuration file.
 133 </para>
 134 <para>
 135  The configuration will be reloaded with the first request after the
 136  change was done, this request itself will still use the old configuration,
 137  though. In other words: it takes two requests before you see the result of
 138  your changes. Requests that are dropped due to ACL don't trigger reloads.
 139 </para>
 140 <para>
 141  When starting Privoxy on Unix systems, give the location of this
 142  file as last argument.  On Windows systems, Privoxy will look for
 143  this file with the name 'config.txt' in the current working directory
 144  of the Privoxy process.
 145 </para>
 146
 147 <para>
 148  <literallayout><!-- funky spacing -->
 149
 150 II. FORMAT OF THE CONFIGURATION FILE
 151 ====================================</literallayout>
 152 </para>
 153 <para>
 154  Configuration lines consist of an initial keyword followed by a list
 155  of values, all separated by whitespace (any number of spaces or
 156  tabs).  For example,
 157 </para>
 158 <para>
 159  actionsfile default.action
 160 </para>
 161 <para>
 162  Indicates that the actionsfile is named 'default.action'.
 163 </para>
 164 <para>
 165  The '#' indicates a comment.  Any part of a line following a '#' is
 166  ignored, except if the '#' is preceded by a '\'.
 167 </para>
 168 <para>
 169  Thus, by placing a # at the start of an existing configuration line,
 170  you can make it a comment and it will be treated as if it weren't there.
 171  This is called "commenting out" an option and can be useful. Removing
 172  the # again is called "uncommenting".
 173 </para>
 174 <para>
 175  Note that commenting out an option and leaving it at its default
 176  are two completely different things! Most options behave very
 177  differently when unset. See the "Effect if unset" explanation
 178  in each option's description for details.
 179 </para>
 180 <para>
 181  Long lines can be continued on the next line by using a `\' as
 182  the last character.
 183 </para>
 184
 185 ]]>
 186
 187 <!-- ************************************************ -->
 188 <!-- The following is common to both outputs (mostly) -->
 189 <!-- ************************************************ -->
 190
 191
 192
 193 <!--   ~~~~~       New section      ~~~~~     -->
 194 <sect2 id="local-set-up">
 195 <title>Local Set-up Documentation</title>
 196
 197   <para>
 198     If you intend to operate <application>Privoxy</application> for more users
 199     than just yourself, it might be a good idea to let them know how to reach
 200     you, what you block and why you do that, your policies, etc.
 201    </para>
 202
 203
 204 <!--   ~~~~~       New section      ~~~~~     -->
 205 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
 206 <variablelist>
 207  <varlistentry>
 208   <term>Specifies:</term>
 209   <listitem>
 210    <para>
 211     Location of the <application>Privoxy</application> User Manual.
 212    </para>
 213   </listitem>
 214  </varlistentry>
 215  <varlistentry>
 216   <term>Type of value:</term>
 217   <listitem>
 218    <para>A fully qualified URI</para>
 219   </listitem>
 220  </varlistentry>
 221  <varlistentry>
 222   <term>Default value:</term>
 223   <listitem>
 224    <para><emphasis>Unset</emphasis></para>
 225   </listitem>
 226  </varlistentry>
 227  <varlistentry>
 228   <term>Effect if unset:</term>
 229   <listitem>
 230    <para>
 231     <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
 232     will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
 233    </para>
 234   </listitem>
 235  </varlistentry>
 236  <varlistentry>
 237   <term>Notes:</term>
 238   <listitem>
 239     <para>
 240     The User Manual URI is the single best source of information on
 241     <application>Privoxy</application>, and is used for help links from some
 242     of the internal CGI pages. The manual itself is normally packaged with the
 243     binary distributions, so you probably want to set this to a locally
 244     installed copy.
 245    </para>
 246    <para>
 247     Examples:
 248    </para>
 249   <!--
 250   <para>
 251    Unix, in local filesystem (may not work with all browsers):
 252   </para>
 253   <para>
 254    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
 255   </para>
 256   <para>
 257    Windows, in local filesystem, <emphasis>must</emphasis> use forward slash notation:
 258   </para>
 259   <para>
 260    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file:/c:/some-dir/privoxy-&p-version;/user-manual/</screen>
 261   </para>
 262   <para>
 263    Windows, UNC notation (with forward slashes):
 264   </para>
 265   <para>
 266    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;file://///some-server/some-path/privoxy-&p-version;/user-manual/</screen>
 267   </para>
 268  -->
 269   <para>
 270    The best all purpose solution is simply to put the full local
 271    <literal>PATH</literal> to where the <citetitle>User Manual</citetitle> is
 272    located:
 273   </para>
 274   <para>
 275    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;/usr/share/doc/privoxy/user-manual</screen>
 276   </para>
 277   <para>
 278    The User Manual is then available to anyone with access to
 279    <application>Privoxy</application>, by following the built-in URL:
 280    <literal>http://config.privoxy.org/user-manual/</literal>
 281    (or the shortcut: <literal>http://p.p/user-manual/</literal>).
 282   </para>
 283   <para>
 284    If the documentation is not on the local system, it can be accessed
 285    from a remote server, as:
 286   </para>
 287   <para>
 288    <screen>&nbsp;&nbsp;user-manual&nbsp;&nbsp;http://example.com/privoxy/user-manual/</screen>
 289   </para>
 290   <![%user-man;[
 291    <!-- this gets hammered in conversion to config. Text repeated below. -->
 292   <warning>
 293    <para>
 294      If set, this option should be <emphasis>the first option in the config
 295      file</emphasis>, because it is used while the config file is being read
 296      on start-up.
 297    </para>
 298   </warning>
 299   ]]>
 300
 301   <![%config-file;[
 302    <!-- alternate -->
 303    <para>
 304     WARNING!!!
 305    </para>
 306    <blockquote>
 307     <para>
 308      If set, this option should be the first option in the config
 309      file, because it is used while the config file is being read.
 310     </para>
 311    </blockquote>
 312   ]]>
 313
 314  </listitem>
 315  </varlistentry>
 316 </variablelist>
 317
 318 <![%config-file;[<literallayout>@@#user-manual http://www.privoxy.org/user-manual/</literallayout>]]>
 319 </sect3>
 320
 321
 322 <!--   ~~~~~       New section      ~~~~~     -->
 323 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
 324
 325 <variablelist>
 326  <varlistentry>
 327   <term>Specifies:</term>
 328   <listitem>
 329    <para>
 330     A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
 331    </para>
 332   </listitem>
 333  </varlistentry>
 334  <varlistentry>
 335   <term>Type of value:</term>
 336   <listitem>
 337    <para>URL</para>
 338   </listitem>
 339  </varlistentry>
 340  <varlistentry>
 341   <term>Default value:</term>
 342   <listitem>
 343    <para><emphasis>Unset</emphasis></para>
 344   </listitem>
 345  </varlistentry>
 346  <varlistentry>
 347   <term>Effect if unset:</term>
 348   <listitem>
 349    <para>
 350     No links are displayed on the "untrusted" error page.
 351    </para>
 352   </listitem>
 353  </varlistentry>
 354  <varlistentry>
 355   <term>Notes:</term>
 356   <listitem>
 357    <para>
 358     The value of this option only matters if the experimental trust mechanism has been
 359     activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> below.)
 360    </para>
 361    <para>
 362     If you use the trust mechanism, it is a good idea to write up some on-line
 363     documentation about your trust policy and to specify the URL(s) here.
 364     Use multiple times for multiple URLs.
 365    </para>
 366    <para>
 367     The URL(s) should be added to the trustfile as well, so users don't end up
 368     locked out from the information on why they were locked out in the first place!
 369    </para>
 370   </listitem>
 371  </varlistentry>
 372 </variablelist>
 373
 374 <![%config-file;[<literallayout>@@#trust-info-url  http://www.example.com/why_we_block.html</literallayout>]]>
 375 <![%config-file;[<literallayout>@@#trust-info-url  http://www.example.com/what_we_allow.html</literallayout>]]>
 376 </sect3>
 377
 378
 379 <!--   ~~~~~       New section      ~~~~~     -->
 380 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
 381
 382 <variablelist>
 383  <varlistentry>
 384   <term>Specifies:</term>
 385   <listitem>
 386    <para>
 387     An email address to reach the <application>Privoxy</application> administrator.
 388    </para>
 389   </listitem>
 390  </varlistentry>
 391  <varlistentry>
 392   <term>Type of value:</term>
 393   <listitem>
 394    <para>Email address</para>
 395   </listitem>
 396  </varlistentry>
 397  <varlistentry>
 398   <term>Default value:</term>
 399   <listitem>
 400    <para><emphasis>Unset</emphasis></para>
 401   </listitem>
 402  </varlistentry>
 403  <varlistentry>
 404   <term>Effect if unset:</term>
 405   <listitem>
 406    <para>
 407     No email address is displayed on error pages and the CGI user interface.
 408    </para>
 409   </listitem>
 410  </varlistentry>
 411  <varlistentry>
 412   <term>Notes:</term>
 413   <listitem>
 414    <para>
 415     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
 416     are unset, the whole "Local Privoxy Support" box on all generated pages will
 417     not be shown.
 418    </para>
 419   </listitem>
 420  </varlistentry>
 421 </variablelist>
 422
 423 <![%config-file;[<literallayout>@@#admin-address privoxy-admin@example.com</literallayout>]]>
 424 </sect3>
 425
 426
 427 <!--   ~~~~~       New section      ~~~~~     -->
 428 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
 429
 430 <variablelist>
 431  <varlistentry>
 432   <term>Specifies:</term>
 433   <listitem>
 434    <para>
 435     A URL to documentation about the local <application>Privoxy</application> setup,
 436     configuration or policies.
 437    </para>
 438   </listitem>
 439  </varlistentry>
 440  <varlistentry>
 441   <term>Type of value:</term>
 442   <listitem>
 443    <para>URL</para>
 444   </listitem>
 445  </varlistentry>
 446  <varlistentry>
 447   <term>Default value:</term>
 448   <listitem>
 449    <para><emphasis>Unset</emphasis></para>
 450   </listitem>
 451  </varlistentry>
 452  <varlistentry>
 453   <term>Effect if unset:</term>
 454   <listitem>
 455    <para>
 456     No link to local documentation is displayed on error pages and the CGI user interface.
 457    </para>
 458   </listitem>
 459  </varlistentry>
 460  <varlistentry>
 461   <term>Notes:</term>
 462   <listitem>
 463    <para>
 464     If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
 465     are unset, the whole "Local Privoxy Support" box on all generated pages will
 466     not be shown.
 467    </para>
 468    <para>
 469     This URL shouldn't be blocked ;-)
 470    </para>
 471   </listitem>
 472  </varlistentry>
 473 </variablelist>
 474
 475 <![%config-file;[<literallayout>@@#proxy-info-url http://www.example.com/proxy-service.html</literallayout>]]>
 476 </sect3>
 477
 478 </sect2>
 479 <!--  ~  End section  ~  -->
 480
 481
 482
 483 <!--   ~~~~~       New section      ~~~~~     -->
 484
 485 <sect2 id="conf-log-loc">
 486 <title>Configuration and Log File Locations</title>
 487
 488 <para>
 489  <application>Privoxy</application> can (and normally does) use a number of
 490  other files for additional configuration, help and logging.
 491  This section of the configuration file tells <application>Privoxy</application>
 492  where to find those other files.
 493 </para>
 494
 495 <para>
 496  The user running <application>Privoxy</application>, must have read
 497  permission for all configuration files, and write permission to any files
 498  that would be modified, such as log files and actions files.
 499 </para>
 500
 501
 502 <!--   ~~~~~       New section      ~~~~~     -->
 503 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
 504
 505 <variablelist>
 506  <varlistentry>
 507   <term>Specifies:</term>
 508   <listitem>
 509    <para>The directory where the other configuration files are located.</para>
 510   </listitem>
 511  </varlistentry>
 512  <varlistentry>
 513   <term>Type of value:</term>
 514   <listitem>
 515    <para>Path name</para>
 516   </listitem>
 517  </varlistentry>
 518  <varlistentry>
 519   <term>Default value:</term>
 520   <listitem>
 521    <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 522   </listitem>
 523  </varlistentry>
 524  <varlistentry>
 525   <term>Effect if unset:</term>
 526   <listitem>
 527    <para><emphasis>Mandatory</emphasis></para>
 528   </listitem>
 529  </varlistentry>
 530  <varlistentry>
 531   <term>Notes:</term>
 532   <listitem>
 533    <para>
 534     No trailing <quote><literal>/</literal></quote>, please.
 535    </para>
 536   <!--
 537    This is really outdated and not likely to happen. HB 09/20/06
 538    <para>
 539     When development goes modular and multi-user, the blocker, filter, and
 540     per-user config will be stored in subdirectories of <quote>confdir</quote>.
 541     For now, the configuration directory structure is flat, except for
 542     <filename>confdir/templates</filename>, where the HTML templates for CGI
 543     output reside (e.g. <application>Privoxy's</application> 404 error page).
 544    </para>
 545   -->
 546   </listitem>
 547  </varlistentry>
 548 </variablelist>
 549
 550 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
 551 </sect3>
 552
 553 <!--   ~~~~~       New section      ~~~~~     -->
 554 <sect3 renderas="sect4" id="templdir"><title>templdir</title>
 555
 556 <variablelist>
 557  <varlistentry>
 558   <term>Specifies:</term>
 559   <listitem>
 560    <para>An alternative directory where the templates are loaded from.</para>
 561   </listitem>
 562  </varlistentry>
 563  <varlistentry>
 564   <term>Type of value:</term>
 565   <listitem>
 566    <para>Path name</para>
 567   </listitem>
 568  </varlistentry>
 569  <varlistentry>
 570   <term>Default value:</term>
 571   <listitem>
 572    <para>unset</para>
 573   </listitem>
 574  </varlistentry>
 575  <varlistentry>
 576   <term>Effect if unset:</term>
 577   <listitem>
 578    <para>The templates are assumed to be located in confdir/template.</para>
 579   </listitem>
 580  </varlistentry>
 581  <varlistentry>
 582   <term>Notes:</term>
 583   <listitem>
 584    <para>
 585     <application>Privoxy's</application> original templates are usually
 586     overwritten with each update. Use this option to relocate customized
 587     templates that should be kept. As template variables might change
 588     between updates, you shouldn't expect templates to work with
 589     <application>Privoxy</application> releases other than the one
 590     they were part of, though.
 591    </para>
 592   </listitem>
 593  </varlistentry>
 594 </variablelist>
 595
 596 <![%config-file;[<literallayout>@@#templdir .</literallayout>]]>
 597 </sect3>
 598
 599
 600 <!--   ~~~~~       New section      ~~~~~     -->
 601 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
 602
 603 <variablelist>
 604  <varlistentry>
 605   <term>Specifies:</term>
 606   <listitem>
 607    <para>
 608     The directory where all logging takes place
 609     (i.e. where the <filename>logfile</filename> is located).
 610    </para>
 611   </listitem>
 612  </varlistentry>
 613  <varlistentry>
 614   <term>Type of value:</term>
 615   <listitem>
 616    <para>Path name</para>
 617   </listitem>
 618  </varlistentry>
 619  <varlistentry>
 620   <term>Default value:</term>
 621   <listitem>
 622    <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 623   </listitem>
 624  </varlistentry>
 625  <varlistentry>
 626   <term>Effect if unset:</term>
 627   <listitem>
 628    <para><emphasis>Mandatory</emphasis></para>
 629   </listitem>
 630  </varlistentry>
 631  <varlistentry>
 632   <term>Notes:</term>
 633   <listitem>
 634    <para>
 635     No trailing <quote><literal>/</literal></quote>, please.
 636    </para>
 637   </listitem>
 638  </varlistentry>
 639 </variablelist>
 640
 641 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
 642 </sect3>
 643
 644
 645 <!--   ~~~~~       New section      ~~~~~     -->
 646 <sect3 renderas="sect4" id="actionsfile"><title>
 647 actionsfile
 648 </title>
 649 <anchor id="default.action">
 650 <anchor id="standard.action">
 651 <anchor id="user.action">
 652 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
 653 <variablelist>
 654  <varlistentry>
 655   <term>Specifies:</term>
 656   <listitem>
 657    <para>
 658     The <link linkend="actions-file">actions file(s)</link> to use
 659    </para>
 660   </listitem>
 661  </varlistentry>
 662  <varlistentry>
 663   <term>Type of value:</term>
 664   <listitem>
 665    <para>Complete file name, relative to <literal>confdir</literal></para>
 666   </listitem>
 667  </varlistentry>
 668  <varlistentry>
 669   <term>Default values:</term>
 670   <listitem>
 671    <simplelist>
 672     <member>
 673      <msgtext><literallayout>  match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout></msgtext>
 674     </member>
 675     <member>
 676      <msgtext><literallayout>  default.action   # Main actions file</literallayout></msgtext>
 677     </member>
 678     <member>
 679      <msgtext><literallayout>  user.action      # User customizations</literallayout></msgtext>
 680     </member>
 681    </simplelist>
 682   </listitem>
 683  </varlistentry>
 684  <varlistentry>
 685   <term>Effect if unset:</term>
 686   <listitem>
 687    <para>
 688     No actions are taken at all. More or less neutral proxying.
 689    </para>
 690   </listitem>
 691  </varlistentry>
 692  <varlistentry>
 693   <term>Notes:</term>
 694   <listitem>
 695    <para>
 696     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
 697    </para>
 698    <para>
 699     The default values are <filename>default.action</filename>, which is the
 700     <quote>main</quote> actions file maintained by the developers, and
 701     <filename>user.action</filename>, where you can make your personal additions.
 702    </para>
 703    <para>
 704     Actions files contain all the per site and per URL configuration for
 705     ad blocking, cookie management, privacy considerations, etc.
 706     There is no point in using <application>Privoxy</application> without at
 707     least one actions file.
 708    </para>
 709    <para>
 710     Note that since Privoxy 3.0.7, the complete filename, including the <quote>.action</quote>
 711     extension has to be specified.  The syntax change was necessary to be consistent
 712     with the other file options and to allow previously forbidden characters.
 713    </para>
 714   </listitem>
 715  </varlistentry>
 716 </variablelist>
 717
 718 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
 719 <!-- html -> text conversion, blah -->
 720 <![%config-file;[<literallayout>@@actionsfile match-all.action # Actions that are applied to all sites and maybe overruled later on.</literallayout>]]>
 721 <![%config-file;[<literallayout>@@actionsfile default.action   # Main actions file</literallayout>]]>
 722 <!--
 723  XXX: Like user.filter, user.action should probably be commented out
 724  by default as not all packages install it into the default directory.
 725  fk 2007-11-07
 726 -->
 727 <![%config-file;[<literallayout>@@actionsfile user.action      # User customizations</literallayout>]]>
 728 </sect3>
 729
 730 <!--   ~~~~~       New section      ~~~~~     -->
 731 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
 732 <anchor id="default.filter">
 733 <variablelist>
 734  <varlistentry>
 735   <term>Specifies:</term>
 736   <listitem>
 737    <para>
 738     The <link linkend="filter-file">filter file(s)</link> to use
 739    </para>
 740   </listitem>
 741  </varlistentry>
 742  <varlistentry>
 743   <term>Type of value:</term>
 744   <listitem>
 745    <para>File name, relative to <literal>confdir</literal></para>
 746   </listitem>
 747  </varlistentry>
 748  <varlistentry>
 749   <term>Default value:</term>
 750   <listitem>
 751    <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
 752   </listitem>
 753  </varlistentry>
 754  <varlistentry>
 755   <term>Effect if unset:</term>
 756   <listitem>
 757    <para>
 758     No textual content filtering takes place, i.e. all
 759     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 760     actions in the actions files are turned neutral.
 761    </para>
 762   </listitem>
 763  </varlistentry>
 764  <varlistentry>
 765   <term>Notes:</term>
 766   <listitem>
 767    <para>
 768     Multiple <literal>filterfile</literal> lines are permitted.
 769    </para>
 770    <para>
 771     The <link linkend="filter-file">filter files</link> contain content modification
 772     rules that use <link linkend="regex">regular expressions</link>. These rules permit
 773     powerful changes on the content of Web pages, and optionally the headers
 774     as well, e.g., you could try to disable your favorite JavaScript annoyances,
 775     re-write the actual displayed text, or just have some fun
 776     playing buzzword bingo with web pages.
 777    </para>
 778    <para>
 779     The
 780     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 781     actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
 782     to be defined in a filter file!
 783    </para>
 784    <para>
 785     A pre-defined filter file called <filename>default.filter</filename> that contains
 786     a number of useful filters for common problems is included in the distribution.
 787     See the section on the <literal><link linkend="filter">filter</link></literal>
 788     action for a list.
 789    </para>
 790    <para>
 791     It is recommended to place any locally adapted filters into a separate
 792     file, such as <filename>user.filter</filename>.
 793    </para>
 794   </listitem>
 795  </varlistentry>
 796 </variablelist>
 797
 798 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
 799 <![%config-file;[<literallayout>@@#filterfile user.filter      # User customizations</literallayout>]]>
 800 </sect3>
 801
 802
 803 <!--   ~~~~~       New section      ~~~~~     -->
 804 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
 805
 806 <variablelist>
 807  <varlistentry>
 808   <term>Specifies:</term>
 809   <listitem>
 810    <para>
 811     The log file to use
 812    </para>
 813   </listitem>
 814  </varlistentry>
 815  <varlistentry>
 816   <term>Type of value:</term>
 817   <listitem>
 818    <para>File name, relative to <literal>logdir</literal></para>
 819   </listitem>
 820  </varlistentry>
 821  <varlistentry>
 822   <term>Default value:</term>
 823   <listitem>
 824    <para><emphasis>Unset (commented out)</emphasis>. When activated: logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows).</para>
 825   </listitem>
 826  </varlistentry>
 827  <varlistentry>
 828   <term>Effect if unset:</term>
 829   <listitem>
 830    <para>
 831     No logfile is written.
 832    </para>
 833   </listitem>
 834  </varlistentry>
 835  <varlistentry>
 836   <term>Notes:</term>
 837   <listitem>
 838    <para>
 839     The logfile is where all logging and error messages are written. The level
 840     of detail and number of messages are set with the <literal>debug</literal>
 841     option (see below). The logfile can be useful for tracking down a problem with
 842     <application>Privoxy</application> (e.g., it's not blocking an ad you
 843     think it should block) and it can help you to monitor what your browser
 844     is doing.
 845    </para>
 846    <para>
 847     Depending on the debug options below, the logfile may be a privacy risk
 848     if third parties can get access to it. As most users will never look
 849     at it, <application>Privoxy</application> 3.0.7 and later only log fatal
 850     errors by default.
 851    </para>
 852    <para>
 853     For most troubleshooting purposes, you will have to change that,
 854     please refer to the debugging section for details.
 855    </para>
 856    <para>
 857     Your logfile will grow indefinitely, and you will probably want to
 858     periodically remove it.  On Unix systems, you can do this with a cron job
 859     (see <quote>man cron</quote>). For Red Hat based Linux distributions, a
 860     <command>logrotate</command> script has been included.
 861    </para>
 862    <para>
 863     Any log files must be writable by whatever user <application>Privoxy</application>
 864     is being run as (on Unix, default user id is <quote>privoxy</quote>).
 865    </para>
 866   </listitem>
 867  </varlistentry>
 868 </variablelist>
 869
 870 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
 871 </sect3>
 872
 873
 874 <!--   ~~~~~       New section      ~~~~~     -->
 875 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
 876 <variablelist>
 877  <varlistentry>
 878   <term>Specifies:</term>
 879   <listitem>
 880    <para>
 881     The name of the trust file to use
 882    </para>
 883   </listitem>
 884  </varlistentry>
 885  <varlistentry>
 886   <term>Type of value:</term>
 887   <listitem>
 888    <para>File name, relative to <literal>confdir</literal></para>
 889   </listitem>
 890  </varlistentry>
 891  <varlistentry>
 892   <term>Default value:</term>
 893   <listitem>
 894    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
 895   </listitem>
 896  </varlistentry>
 897  <varlistentry>
 898   <term>Effect if unset:</term>
 899   <listitem>
 900    <para>
 901     The entire trust mechanism is disabled.
 902    </para>
 903   </listitem>
 904  </varlistentry>
 905  <varlistentry>
 906   <term>Notes:</term>
 907   <listitem>
 908    <para>
 909     The trust mechanism is an experimental feature for building white-lists and should
 910     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
 911    </para>
 912    <para>
 913     If you specify a trust file, <application>Privoxy</application> will only allow
 914     access to sites that are specified in the trustfile. Sites can be listed
 915     in one of two ways:
 916    </para>
 917    <para>
 918     Prepending a <literal>~</literal> character limits access to this site
 919     only (and any sub-paths within this site), e.g.
 920     <literal>~www.example.com</literal> allows access to
 921     <literal>~www.example.com/features/news.html</literal>, etc.
 922    </para>
 923    <para>
 924     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
 925     prepending the name with a <literal>+</literal> character. The effect is that
 926     access to untrusted sites will be granted -- but only if a link from this
 927     trusted referrer was used to get there. The link target will then be added
 928     to the <quote>trustfile</quote> so that future, direct accesses will be
 929     granted. Sites added via this mechanism do not become trusted referrers
 930     themselves (i.e. they are added with a <literal>~</literal> designation).
 931     There is a limit of 512 such entries, after which new entries will not be
 932     made.
 933    </para>
 934    <para>
 935     If you use the <literal>+</literal> operator in the trust file, it may grow
 936     considerably over time.
 937    </para>
 938    <para>
 939     It is recommended that <application>Privoxy</application> be compiled with
 940     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
 941     <literal> --disable-editor</literal> options, if this feature is to be
 942     used.
 943    </para>
 944    <para>
 945     Possible applications include limiting Internet access for children.
 946    </para>
 947
 948   </listitem>
 949  </varlistentry>
 950 </variablelist>
 951
 952 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
 953 </sect3>
 954 </sect2>
 955
 956 <!--  ~  End section  ~  -->
 957
 958 <!--   ~~~~~       New section      ~~~~~     -->
 959 <sect2 id="debugging">
 960 <title>Debugging</title>
 961
 962  <para>
 963   These options are mainly useful when tracing a problem.
 964   Note that you might also want to invoke
 965   <application>Privoxy</application> with the <literal>--no-daemon</literal>
 966   command line option when debugging.
 967  </para>
 968
 969 <sect3 renderas="sect4" id="debug"><title>debug</title>
 970
 971 <variablelist>
 972  <varlistentry>
 973   <term>Specifies:</term>
 974   <listitem>
 975    <para>
 976     Key values that determine what information gets logged.
 977    </para>
 978   </listitem>
 979  </varlistentry>
 980  <varlistentry>
 981   <term>Type of value:</term>
 982   <listitem>
 983    <para>Integer values</para>
 984   </listitem>
 985  </varlistentry>
 986  <varlistentry>
 987   <term>Default value:</term>
 988   <listitem>
 989    <para>0 (i.e.: only fatal errors (that cause Privoxy to exit) are logged)</para>
 990   </listitem>
 991  </varlistentry>
 992  <varlistentry>
 993   <term>Effect if unset:</term>
 994   <listitem>
 995    <para>
 996     Default value is used (see above).
 997    </para>
 998   </listitem>
 999  </varlistentry>
1000  <varlistentry>
1001   <term>Notes:</term>
1002   <listitem>
1003    <para>
1004     The available debug levels are:
1005    </para>
1006    <para>
1007     <programlisting>
1008   debug     1 # Log the destination for each request &my-app; let through. See also debug 1024.
1009   debug     2 # show each connection status
1010   debug     4 # show I/O status
1011   debug     8 # show header parsing
1012   debug    16 # log all data written to the network into the logfile
1013   debug    32 # debug force feature
1014   debug    64 # debug regular expression filters
1015   debug   128 # debug redirects
1016   debug   256 # debug GIF de-animation
1017   debug   512 # Common Log Format
1018   debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.
1019   debug  2048 # CGI user interface
1020   debug  4096 # Startup banner and warnings.
1021   debug  8192 # Non-fatal errors
1022 </programlisting>
1023    </para>
1024    <para>
1025     To select multiple debug levels, you can either add them or use
1026     multiple <literal>debug</literal> lines.
1027    </para>
1028    <para>
1029     A debug level of 1 is informative because it will show you each request
1030     as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1031     so that you will notice when things go wrong. The other levels are
1032     probably only of interest if you are hunting down a specific problem.
1033     They can produce a hell of an output (especially 16).
1034     <!-- LOL -->
1035    </para>
1036    <para>
1037     &my-app; used to ship with the debug levels recommended above enabled by
1038     default, but due to privacy concerns 3.0.7 and later are configured to
1039     only log fatal errors.
1040    </para>
1041    <para>
1042     If you are used to the more verbose settings, simply enable the debug lines
1043     below again.
1044    </para>
1045    <para>
1046     If you want to use pure CLF (Common Log Format), you should set <quote>debug
1047     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1048    </para>
1049    <para>
1050     <application>Privoxy</application> has a hard-coded limit for the
1051     length of log messages. If it's reached, messages are logged truncated
1052     and marked with <quote>... [too long, truncated]</quote>.
1053    </para>
1054    <para>
1055     Please don't file any support requests without trying to reproduce
1056     the problem with increased debug level first. Once you read the log
1057     messages, you may even be able to solve the problem on your own.
1058    </para>
1059   </listitem>
1060  </varlistentry>
1061 </variablelist>
1062
1063 <![%config-file;[<literallayout>@@#debug     1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1064 <![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1065 <![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
1066 <![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>
1067 </sect3>
1068
1069
1070 <!--   ~~~~~       New section      ~~~~~     -->
1071 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1072
1073 <variablelist>
1074  <varlistentry>
1075   <term>Specifies:</term>
1076   <listitem>
1077    <para>
1078     Whether to run only one server thread.
1079    </para>
1080   </listitem>
1081  </varlistentry>
1082  <varlistentry>
1083   <term>Type of value:</term>
1084   <listitem>
1085    <para><emphasis>None</emphasis></para>
1086   </listitem>
1087  </varlistentry>
1088  <varlistentry>
1089   <term>Default value:</term>
1090   <listitem>
1091    <para><emphasis>Unset</emphasis></para>
1092   </listitem>
1093  </varlistentry>
1094  <varlistentry>
1095   <term>Effect if unset:</term>
1096   <listitem>
1097    <para>
1098     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1099     serve multiple requests simultaneously.
1100    </para>
1101   </listitem>
1102  </varlistentry>
1103  <varlistentry>
1104   <term>Notes:</term>
1105   <listitem>
1106    <para>
1107     This option is only there for debugging purposes.
1108     <emphasis>It will drastically reduce performance.</emphasis>
1109    </para>
1110   </listitem>
1111  </varlistentry>
1112 </variablelist>
1113
1114 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1115 </sect3>
1116
1117 <!--   ~~~~~       New section      ~~~~~     -->
1118 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1119
1120 <variablelist>
1121  <varlistentry>
1122   <term>Specifies:</term>
1123   <listitem>
1124    <para>
1125     The hostname shown on the CGI pages.
1126    </para>
1127   </listitem>
1128  </varlistentry>
1129  <varlistentry>
1130   <term>Type of value:</term>
1131   <listitem>
1132    <para>Text</para>
1133   </listitem>
1134  </varlistentry>
1135  <varlistentry>
1136   <term>Default value:</term>
1137   <listitem>
1138    <para><emphasis>Unset</emphasis></para>
1139   </listitem>
1140  </varlistentry>
1141  <varlistentry>
1142   <term>Effect if unset:</term>
1143   <listitem>
1144    <para>
1145     The hostname provided by the operating system is used.
1146    </para>
1147   </listitem>
1148  </varlistentry>
1149  <varlistentry>
1150   <term>Notes:</term>
1151   <listitem>
1152    <para>
1153     On some misconfigured systems resolving the hostname fails or
1154     takes too much time and slows Privoxy down. Setting a fixed hostname
1155     works around the problem.
1156    </para>
1157    <para>
1158     In other circumstances it might be desirable to show a hostname
1159     other than the one returned by the operating system. For example
1160     if the system has several different hostnames and you don't want
1161     to use the first one.
1162    </para>
1163    <para>
1164     Note that Privoxy does not validate the specified hostname value.
1165    </para>
1166   </listitem>
1167  </varlistentry>
1168 </variablelist>
1169
1170 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1171 </sect3>
1172
1173 </sect2>
1174
1175 <!--  ~  End section  ~  -->
1176
1177
1178 <!--   ~~~~~       New section      ~~~~~     -->
1179 <sect2 id="access-control">
1180 <title>Access Control and Security</title>
1181
1182  <para>
1183   This section of the config file controls the security-relevant aspects
1184   of <application>Privoxy</application>'s configuration.
1185  </para>
1186
1187
1188 <!--   ~~~~~       New section      ~~~~~     -->
1189 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1190
1191 <variablelist>
1192  <varlistentry>
1193   <term>Specifies:</term>
1194   <listitem>
1195    <para>
1196     The IP address and TCP port on which <application>Privoxy</application> will
1197     listen for client requests.
1198    </para>
1199   </listitem>
1200  </varlistentry>
1201  <varlistentry>
1202   <term>Type of value:</term>
1203   <listitem>
1204    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1205   </listitem>
1206  </varlistentry>
1207
1208  <varlistentry>
1209   <term>Default value:</term>
1210   <listitem>
1211    <para>127.0.0.1:8118</para>
1212   </listitem>
1213  </varlistentry>
1214  <varlistentry>
1215   <term>Effect if unset:</term>
1216   <listitem>
1217    <para>
1218     Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1219     recommended for home users who run <application>Privoxy</application> on
1220     the same machine as their browser.
1221    </para>
1222   </listitem>
1223  </varlistentry>
1224  <varlistentry>
1225   <term>Notes:</term>
1226   <listitem>
1227    <para>
1228     You will need to configure your browser(s) to this proxy address and port.
1229    </para>
1230    <para>
1231     If you already have another service running on port 8118, or if you want to
1232     serve requests from other machines (e.g. on your local network) as well, you
1233     will need to override the default.
1234    </para>
1235    <para>
1236     IPv6 addresses containing colons have to be quoted by brackets.
1237    </para>
1238    <para>
1239     If you leave out the IP address, <application>Privoxy</application> will
1240     bind to all IPv4 interfaces (addresses) on your machine and may become reachable
1241     from the Internet. In that case, consider using <link
1242     linkend="acls">access control lists</link> (ACL's, see below), and/or
1243     a firewall.
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    <para>
2281     Due to a bug, this option currently also causes Privoxy to
2282     retry in case of certain problems with direct connections.
2283    </para>
2284   </listitem>
2285  </varlistentry>
2286  <varlistentry>
2287   <term>Examples:</term>
2288   <listitem>
2289    <para>
2290     forwarded-connect-retries 1
2291    </para>
2292   </listitem>
2293  </varlistentry>
2294 </variablelist>
2295 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2296 </sect3>
2297
2298 </sect2>
2299
2300 <sect2 id="misc">
2301 <title>Miscellaneous</title>
2302
2303 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2304 <variablelist>
2305  <varlistentry>
2306   <term>Specifies:</term>
2307   <listitem>
2308    <para>
2309     Whether intercepted requests should be treated as valid.
2310    </para>
2311   </listitem>
2312  </varlistentry>
2313  <varlistentry>
2314   <term>Type of value:</term>
2315   <listitem>
2316    <para>
2317     <replaceable>0 or 1</replaceable>
2318    </para>
2319   </listitem>
2320  </varlistentry>
2321  <varlistentry>
2322   <term>Default value:</term>
2323   <listitem>
2324    <para><emphasis>0</emphasis></para>
2325   </listitem>
2326  </varlistentry>
2327  <varlistentry>
2328   <term>Effect if unset:</term>
2329   <listitem>
2330    <para>
2331     Only proxy requests are accepted, intercepted requests are treated as invalid.
2332    </para>
2333   </listitem>
2334  </varlistentry>
2335  <varlistentry>
2336   <term>Notes:</term>
2337   <listitem>
2338    <para>
2339     If you don't trust your clients and want to force them
2340     to use <application>Privoxy</application>, enable this
2341     option and configure your packet filter to redirect outgoing
2342     HTTP connections into <application>Privoxy</application>.
2343    </para>
2344    <para>
2345     Make sure that <application>Privoxy's</application> own requests
2346     aren't redirected as well. Additionally take care that
2347     <application>Privoxy</application> can't intentionally connect
2348     to itself, otherwise you could run into redirection loops if
2349     <application>Privoxy's</application> listening port is reachable
2350     by the outside or an attacker has access to the pages you visit.
2351    </para>
2352   </listitem>
2353  </varlistentry>
2354  <varlistentry>
2355   <term>Examples:</term>
2356   <listitem>
2357    <para>
2358     accept-intercepted-requests 1
2359    </para>
2360   </listitem>
2361  </varlistentry>
2362 </variablelist>
2363 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2364 </sect3>
2365
2366 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2367 <variablelist>
2368  <varlistentry>
2369   <term>Specifies:</term>
2370   <listitem>
2371    <para>
2372     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2373    </para>
2374   </listitem>
2375  </varlistentry>
2376  <varlistentry>
2377   <term>Type of value:</term>
2378   <listitem>
2379    <para>
2380     <replaceable>0 or 1</replaceable>
2381    </para>
2382   </listitem>
2383  </varlistentry>
2384  <varlistentry>
2385   <term>Default value:</term>
2386   <listitem>
2387    <para><emphasis>0</emphasis></para>
2388   </listitem>
2389  </varlistentry>
2390  <varlistentry>
2391   <term>Effect if unset:</term>
2392   <listitem>
2393    <para>
2394     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2395    </para>
2396   </listitem>
2397  </varlistentry>
2398  <varlistentry>
2399   <term>Notes:</term>
2400   <listitem>
2401    <para>
2402     By default <application>Privoxy</application> ignores block or redirect actions
2403     for its CGI pages. Intercepting these requests can be useful in multi-user
2404     setups to implement fine-grained access control, but it can also render the complete
2405     web interface useless and make debugging problems painful if done without care.
2406    </para>
2407    <para>
2408     Don't enable this option unless you're sure that you really need it.
2409    </para>
2410   </listitem>
2411  </varlistentry>
2412  <varlistentry>
2413   <term>Examples:</term>
2414   <listitem>
2415    <para>
2416     allow-cgi-request-crunching 1
2417    </para>
2418   </listitem>
2419  </varlistentry>
2420 </variablelist>
2421 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2422 </sect3>
2423
2424 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2425 <variablelist>
2426  <varlistentry>
2427   <term>Specifies:</term>
2428   <listitem>
2429    <para>
2430     Whether the CGI interface should stay compatible with broken HTTP clients.
2431    </para>
2432   </listitem>
2433  </varlistentry>
2434  <varlistentry>
2435   <term>Type of value:</term>
2436   <listitem>
2437    <para>
2438     <replaceable>0 or 1</replaceable>
2439    </para>
2440   </listitem>
2441  </varlistentry>
2442  <varlistentry>
2443   <term>Default value:</term>
2444   <listitem>
2445    <para><emphasis>0</emphasis></para>
2446   </listitem>
2447  </varlistentry>
2448  <varlistentry>
2449   <term>Effect if unset:</term>
2450   <listitem>
2451    <para>
2452     The CGI form generate long GET URLs.
2453    </para>
2454   </listitem>
2455  </varlistentry>
2456  <varlistentry>
2457   <term>Notes:</term>
2458   <listitem>
2459    <para>
2460     <application>Privoxy's</application> CGI forms can lead to
2461     rather long URLs. This isn't a problem as far as the HTTP
2462     standard is concerned, but it can confuse clients with arbitrary
2463     URL length limitations.
2464    </para>
2465    <para>
2466     Enabling split-large-forms causes <application>Privoxy</application>
2467     to divide big forms into smaller ones to keep the URL length down.
2468     It makes editing a lot less convenient and you can no longer
2469     submit all changes at once, but at least it works around this
2470     browser bug.
2471    </para>
2472    <para>
2473     If you don't notice any editing problems, there is no reason
2474     to enable this option, but if one of the submit buttons appears
2475     to be broken, you should give it a try.
2476    </para>
2477   </listitem>
2478  </varlistentry>
2479  <varlistentry>
2480   <term>Examples:</term>
2481   <listitem>
2482    <para>
2483     split-large-forms 1
2484    </para>
2485   </listitem>
2486  </varlistentry>
2487 </variablelist>
2488 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2489 </sect3>
2490
2491 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2492 <variablelist>
2493  <varlistentry>
2494   <term>Specifies:</term>
2495   <listitem>
2496    <para>
2497     Number of seconds after which an open connection will no longer be reused.
2498    </para>
2499   </listitem>
2500  </varlistentry>
2501  <varlistentry>
2502   <term>Type of value:</term>
2503   <listitem>
2504    <para>
2505     <replaceable>Time in seconds.</replaceable>
2506    </para>
2507   </listitem>
2508  </varlistentry>
2509  <varlistentry>
2510   <term>Default value:</term>
2511   <listitem>
2512    <para>None</para>
2513   </listitem>
2514  </varlistentry>
2515  <varlistentry>
2516   <term>Effect if unset:</term>
2517   <listitem>
2518    <para>
2519     Connections are not kept alive.
2520    </para>
2521   </listitem>
2522  </varlistentry>
2523  <varlistentry>
2524   <term>Notes:</term>
2525   <listitem>
2526    <para>
2527     This option allows clients to keep the connection to &my-app;
2528     alive. If the server supports it, &my-app; will keep
2529     the connection to the server alive as well. Under certain
2530     circumstances this may result in speed-ups.
2531    </para>
2532    <para>
2533     By default, &my-app; will close the connection to the server if
2534     the client connection gets closed, or if the specified timeout
2535     has been reached without a new request coming in. This behaviour
2536     can be changed with the <ulink
2537      url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2538    </para>
2539    <para>
2540     This option has no effect if <application>Privoxy</application>
2541     has been compiled without keep-alive support.
2542    </para>
2543    <para>
2544     Note that a timeout of five seconds as used in the default
2545     configuration file significantly decreases the number of
2546     connections that will be reused. The value is used because
2547     some browsers limit the number of connections they open to
2548     a single host and apply the same limit to proxies. This can
2549     result in a single website <quote>grabbing</quote> all the
2550     connections the browser allows, which means connections to
2551     other websites can't be opened until the connections currently
2552     in use time out.
2553    </para>
2554    <para>
2555     Several users have reported this as a Privoxy bug, so the
2556     default value has been reduced. Consider increasing it to
2557     300 seconds or even more if you think your browser can handle
2558     it. If your browser appears to be hanging it can't.
2559    </para>
2560   </listitem>
2561  </varlistentry>
2562  <varlistentry>
2563   <term>Examples:</term>
2564   <listitem>
2565    <para>
2566     keep-alive-timeout 300
2567    </para>
2568   </listitem>
2569  </varlistentry>
2570 </variablelist>
2571 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2572 </sect3>
2573
2574
2575 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2576 <variablelist>
2577  <varlistentry>
2578   <term>Specifies:</term>
2579   <listitem>
2580    <para>
2581     Assumed server-side keep-alive timeout if not specified by the server.
2582    </para>
2583   </listitem>
2584  </varlistentry>
2585  <varlistentry>
2586   <term>Type of value:</term>
2587   <listitem>
2588    <para>
2589     <replaceable>Time in seconds.</replaceable>
2590    </para>
2591   </listitem>
2592  </varlistentry>
2593  <varlistentry>
2594   <term>Default value:</term>
2595   <listitem>
2596    <para>None</para>
2597   </listitem>
2598  </varlistentry>
2599  <varlistentry>
2600   <term>Effect if unset:</term>
2601   <listitem>
2602    <para>
2603     Connections for which the server didn't specify the keep-alive
2604     timeout are not reused.
2605    </para>
2606   </listitem>
2607  </varlistentry>
2608  <varlistentry>
2609   <term>Notes:</term>
2610   <listitem>
2611    <para>
2612     Enabling this option significantly increases the number of connections
2613     that are reused, provided the <ulink
2614      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2615     is also enabled.
2616    </para>
2617    <para>
2618     While it also increases the number of connections problems
2619     when &my-app; tries to reuse a connection that already has
2620     been closed on the server side, or is closed while &my-app;
2621     is trying to reuse it, this should only be a problem if it
2622     happens for the first request sent by the client. If it happens
2623     for requests on reused client connections, &my-app; will simply
2624     close the connection and the client is supposed to retry the
2625     request without bothering the user.
2626    </para>
2627    <para>
2628     Enabling this option is therefore only recommended if the
2629     <ulink
2630      url="#CONNECTION-SHARING">connection-sharing</ulink> option
2631     is disabled.
2632    </para>
2633    <para>
2634     It is an error to specify a value larger than the <ulink
2635      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2636    </para>
2637    <para>
2638     This option has no effect if <application>Privoxy</application>
2639     has been compiled without keep-alive support.
2640    </para>
2641   </listitem>
2642  </varlistentry>
2643  <varlistentry>
2644   <term>Examples:</term>
2645   <listitem>
2646    <para>
2647     default-server-timeout 60
2648    </para>
2649   </listitem>
2650  </varlistentry>
2651 </variablelist>
2652 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2653 </sect3>
2654
2655
2656 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2657 <variablelist>
2658  <varlistentry>
2659   <term>Specifies:</term>
2660   <listitem>
2661    <para>
2662     Whether or not outgoing connections that have been kept alive
2663     should be shared between different incoming connections.
2664    </para>
2665   </listitem>
2666  </varlistentry>
2667  <varlistentry>
2668   <term>Type of value:</term>
2669   <listitem>
2670    <para>
2671     <replaceable>0 or 1</replaceable>
2672    </para>
2673   </listitem>
2674  </varlistentry>
2675  <varlistentry>
2676   <term>Default value:</term>
2677   <listitem>
2678    <para>None</para>
2679   </listitem>
2680  </varlistentry>
2681  <varlistentry>
2682   <term>Effect if unset:</term>
2683   <listitem>
2684    <para>
2685     Connections are not shared.
2686    </para>
2687   </listitem>
2688  </varlistentry>
2689  <varlistentry>
2690   <term>Notes:</term>
2691   <listitem>
2692    <para>
2693     This option has no effect if <application>Privoxy</application>
2694     has been compiled without keep-alive support, or if it's disabled.
2695    </para>
2696   </listitem>
2697  </varlistentry>
2698  <varlistentry>
2699   <term>Notes:</term>
2700   <listitem>
2701    <para>
2702     Note that reusing connections doesn't necessary cause speedups.
2703     There are also a few privacy implications you should be aware of.
2704    </para>
2705    <para>
2706     If this option is effective, outgoing connections are shared between
2707     clients (if there are more than one) and closing the browser that initiated
2708     the outgoing connection does no longer affect the connection between &my-app;
2709     and the server unless the client's request hasn't been completed yet.
2710    </para>
2711    <para>
2712     If the outgoing connection  is idle, it will not be closed until either
2713     <application>Privoxy's</application> or the server's timeout is reached.
2714     While it's open, the server knows that the system running &my-app; is still
2715     there.
2716    </para>
2717    <para>
2718     If there are more than one client (maybe even belonging to multiple users),
2719     they will be able to reuse each others connections. This is potentially
2720     dangerous in case of authentication schemes like NTLM where only the
2721     connection is authenticated, instead of requiring authentication for
2722     each request.
2723    </para>
2724    <para>
2725     If there is only a single client, and if said client can keep connections
2726     alive on its own, enabling this option has next to no effect. If the client
2727     doesn't support connection keep-alive, enabling this option may make sense
2728     as it allows &my-app; to keep outgoing connections alive even if the client
2729     itself doesn't support it.
2730    </para>
2731    <para>
2732     You should also be aware that enabling this option increases the likelihood
2733     of getting the "No server or forwarder data" error message, especially if you
2734     are using a slow connection to the Internet.
2735    </para>
2736    <para>
2737     This option should only be used by experienced users who
2738     understand the risks and can weight them against the benefits.
2739    </para>
2740   </listitem>
2741  </varlistentry>
2742  <varlistentry>
2743   <term>Examples:</term>
2744   <listitem>
2745    <para>
2746     connection-sharing 1
2747    </para>
2748   </listitem>
2749  </varlistentry>
2750 </variablelist>
2751 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2752 </sect3>
2753
2754
2755 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2756 <variablelist>
2757  <varlistentry>
2758   <term>Specifies:</term>
2759   <listitem>
2760    <para>
2761     Number of seconds after which a socket times out if
2762     no data is received.
2763    </para>
2764   </listitem>
2765  </varlistentry>
2766  <varlistentry>
2767   <term>Type of value:</term>
2768   <listitem>
2769    <para>
2770     <replaceable>Time in seconds.</replaceable>
2771    </para>
2772   </listitem>
2773  </varlistentry>
2774  <varlistentry>
2775   <term>Default value:</term>
2776   <listitem>
2777    <para>None</para>
2778   </listitem>
2779  </varlistentry>
2780  <varlistentry>
2781   <term>Effect if unset:</term>
2782   <listitem>
2783    <para>
2784     A default value of 300 seconds is used.
2785    </para>
2786   </listitem>
2787  </varlistentry>
2788  <varlistentry>
2789   <term>Notes:</term>
2790   <listitem>
2791    <para>
2792     For SOCKS requests the timeout currently doesn't start until
2793     the SOCKS server accepted the request. This will be fixed in
2794     the next release.
2795    </para>
2796   </listitem>
2797  </varlistentry>
2798  <varlistentry>
2799   <term>Examples:</term>
2800   <listitem>
2801    <para>
2802     socket-timeout 300
2803    </para>
2804   </listitem>
2805  </varlistentry>
2806 </variablelist>
2807 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2808 </sect3>
2809
2810
2811 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
2812 <variablelist>
2813  <varlistentry>
2814   <term>Specifies:</term>
2815   <listitem>
2816    <para>
2817     Maximum number of client connections that will be served.
2818    </para>
2819   </listitem>
2820  </varlistentry>
2821  <varlistentry>
2822   <term>Type of value:</term>
2823   <listitem>
2824    <para>
2825     <replaceable>Positive number.</replaceable>
2826    </para>
2827   </listitem>
2828  </varlistentry>
2829  <varlistentry>
2830   <term>Default value:</term>
2831   <listitem>
2832    <para>None</para>
2833   </listitem>
2834  </varlistentry>
2835  <varlistentry>
2836   <term>Effect if unset:</term>
2837   <listitem>
2838    <para>
2839     Connections are served until a resource limit is reached.
2840    </para>
2841   </listitem>
2842  </varlistentry>
2843  <varlistentry>
2844   <term>Notes:</term>
2845   <listitem>
2846    <para>
2847     &my-app; creates one thread (or process) for every incoming client
2848     connection that isn't rejected based on the access control settings.
2849    </para>
2850    <para>
2851     If the system is powerful enough, &my-app; can theoretically deal with
2852     several hundred (or thousand) connections at the same time, but some
2853     operating systems enforce resource limits by shutting down offending
2854     processes and their default limits may be below the ones &my-app; would
2855     require under heavy load.
2856    </para>
2857    <para>
2858     Configuring &my-app; to enforce a connection limit below the thread
2859     or process limit used by the operating system makes sure this doesn't
2860     happen. Simply increasing the operating system's limit would work too,
2861     but if &my-app; isn't the only application running on the system,
2862     you may actually want to limit the resources used by &my-app;.
2863    </para>
2864    <para>
2865     If &my-app; is only used by a single trusted user, limiting the
2866     number of client connections is probably unnecessary. If there
2867     are multiple possibly untrusted users you probably still want to
2868     additionally use a packet filter to limit the maximal number of
2869     incoming connections per client. Otherwise a malicious user could
2870     intentionally create a high number of connections to prevent other
2871     users from using &my-app;.
2872    </para>
2873    <para>
2874     Obviously using this option only makes sense if you choose a limit
2875     below the one enforced by the operating system.
2876    </para>
2877   </listitem>
2878  </varlistentry>
2879  <varlistentry>
2880   <term>Examples:</term>
2881   <listitem>
2882    <para>
2883     max-client-connections 256
2884    </para>
2885   </listitem>
2886  </varlistentry>
2887 </variablelist>
2888 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
2889 </sect3>
2890
2891
2892 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
2893 <variablelist>
2894  <varlistentry>
2895   <term>Note:</term>
2896   <listitem>
2897    <para>
2898     This is a work-around for Firefox bug 492459:
2899     <quote>
2900     Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
2901     </quote>
2902     (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
2903         >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
2904    </para>
2905   </listitem>
2906  </varlistentry>
2907  <varlistentry>
2908   <term>Specifies:</term>
2909   <listitem>
2910    <para>
2911     The status code Privoxy returns for pages blocked with
2912     <!--  URL will only end up in the user manual so the relative link should work. -->
2913     <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
2914    </para>
2915   </listitem>
2916  </varlistentry>
2917  <varlistentry>
2918   <term>Type of value:</term>
2919   <listitem>
2920    <para>
2921     <replaceable>0 or 1</replaceable>
2922    </para>
2923   </listitem>
2924  </varlistentry>
2925  <varlistentry>
2926   <term>Default value:</term>
2927   <listitem>
2928    <para>0</para>
2929   </listitem>
2930  </varlistentry>
2931  <varlistentry>
2932   <term>Effect if unset:</term>
2933   <listitem>
2934    <para>
2935     Privoxy returns a status 403(forbidden) for all blocked pages.
2936    </para>
2937   </listitem>
2938  </varlistentry>
2939  <varlistentry>
2940   <term>Effect if set:</term>
2941   <listitem>
2942    <para>
2943     Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
2944     and a status 403(Forbidden) for all other blocked pages.
2945    </para>
2946   </listitem>
2947  </varlistentry>
2948 </variablelist>
2949 <![%config-file;[<literallayout>@@handle-as-empty-doc-returns-ok 1</literallayout>]]>
2950 </sect3>
2951
2952
2953 </sect2>
2954
2955 <!--  ~  End section  ~  -->
2956
2957
2958 <!--   ~~~~~       New section      ~~~~~     -->
2959
2960 <sect2 id="windows-gui">
2961 <title>Windows GUI Options</title>
2962 <para>
2963  <application>Privoxy</application> has a number of options specific to the
2964  Windows GUI interface:
2965 </para>
2966
2967 <anchor id="activity-animation">
2968 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2969 <para>
2970  If <quote>activity-animation</quote> is set to 1, the
2971  <application>Privoxy</application> icon will animate when
2972  <quote>Privoxy</quote> is active. To turn off, set to 0.
2973 </para>
2974
2975 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
2976 <![%user-man;[
2977 <para>
2978  <literal>
2979   <msgtext>
2980    <literallayout>
2981   <emphasis>activity-animation   1</emphasis>
2982    </literallayout>
2983   </msgtext>
2984  </literal>
2985 </para>
2986 ]]>
2987
2988 <anchor id="log-messages">
2989 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2990 <para>
2991  If <quote>log-messages</quote> is set to 1,
2992  <application>Privoxy</application> will log messages to the console
2993  window:
2994 </para>
2995
2996 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
2997 <![%user-man;[
2998 <para>
2999  <literal>
3000   <msgtext>
3001    <literallayout>
3002   <emphasis>log-messages       1</emphasis>
3003    </literallayout>
3004   </msgtext>
3005  </literal>
3006 </para>
3007 ]]>
3008
3009 <anchor id="log-buffer-size">
3010 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3011 <para>
3012  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3013  i.e. the amount of memory used for the log messages displayed in the
3014  console window, will be limited to <quote>log-max-lines</quote> (see below).
3015 </para>
3016
3017 <para>
3018  Warning: Setting this to 0 will result in the buffer to grow infinitely and
3019  eat up all your memory!
3020 </para>
3021
3022 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3023 <![%user-man;[
3024 <para>
3025  <literal>
3026   <msgtext>
3027    <literallayout>
3028   <emphasis>log-buffer-size      1</emphasis>
3029    </literallayout>
3030   </msgtext>
3031  </literal>
3032 </para>
3033 ]]>
3034
3035 <anchor id="log-max-lines">
3036 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3037 <para>
3038  <application>log-max-lines</application> is the maximum number of lines held
3039  in the log buffer. See above.
3040 </para>
3041
3042 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3043 <![%user-man;[
3044 <para>
3045  <literal>
3046   <msgtext>
3047    <literallayout>
3048   <emphasis>log-max-lines      200</emphasis>
3049    </literallayout>
3050   </msgtext>
3051  </literal>
3052 </para>
3053 ]]>
3054
3055 <anchor id="log-highlight-messages">
3056 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3057 <para>
3058  If <quote>log-highlight-messages</quote> is set to 1,
3059  <application>Privoxy</application> will highlight portions of the log
3060  messages with a bold-faced font:
3061 </para>
3062
3063 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3064 <![%user-man;[
3065 <para>
3066  <literal>
3067   <msgtext>
3068    <literallayout>
3069   <emphasis>log-highlight-messages   1</emphasis>
3070    </literallayout>
3071   </msgtext>
3072  </literal>
3073 </para>
3074 ]]>
3075
3076 <anchor id="log-font-name">
3077 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3078 <para>
3079  The font used in the console window:
3080 </para>
3081
3082 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3083 <![%user-man;[
3084 <para>
3085  <literal>
3086   <msgtext>
3087    <literallayout>
3088   <emphasis>log-font-name        Comic Sans MS</emphasis>
3089    </literallayout>
3090   </msgtext>
3091  </literal>
3092 </para>
3093 ]]>
3094
3095 <anchor id="log-font-size">
3096 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3097 <para>
3098  Font size used in the console window:
3099 </para>
3100
3101 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3102 <![%user-man;[
3103 <para>
3104  <literal>
3105   <msgtext>
3106    <literallayout>
3107   <emphasis>log-font-size        8</emphasis>
3108    </literallayout>
3109   </msgtext>
3110  </literal>
3111 </para>
3112 ]]>
3113
3114 <anchor id="show-on-task-bar">
3115 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3116 <para>
3117  <quote>show-on-task-bar</quote> controls whether or not
3118  <application>Privoxy</application> will appear as a button on the Task bar
3119  when minimized:
3120 </para>
3121
3122 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3123 <![%user-man;[
3124 <para>
3125  <literal>
3126   <msgtext>
3127    <literallayout>
3128   <emphasis>show-on-task-bar     0</emphasis>
3129    </literallayout>
3130   </msgtext>
3131  </literal>
3132 </para>
3133 ]]>
3134
3135 <anchor id="close-button-minimizes">
3136 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3137 <para>
3138  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3139  button will minimize <application>Privoxy</application> instead of closing
3140  the program (close with the exit option on the File menu).
3141 </para>
3142
3143 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3144 <![%user-man;[
3145 <para>
3146  <literal>
3147   <msgtext>
3148    <literallayout>
3149   <emphasis>close-button-minimizes  1</emphasis>
3150    </literallayout>
3151   </msgtext>
3152  </literal>
3153 </para>
3154 ]]>
3155
3156 <anchor id="hide-console">
3157 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3158 <para>
3159  The <quote>hide-console</quote> option is specific to the MS-Win console
3160  version of <application>Privoxy</application>. If this option is used,
3161  <application>Privoxy</application> will disconnect from and hide the
3162  command console.
3163 </para>
3164
3165 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3166 <![%user-man;[
3167 <para>
3168  <literal>
3169   <msgtext>
3170    <literallayout>
3171   #<emphasis>hide-console</emphasis>
3172    </literallayout>
3173   </msgtext>
3174  </literal>
3175 </para>
3176 ]]>
3177
3178 </sect2>
3179 </sect1>
3180
3181 <!-- end config content common to both outputs -->
3182
3183 <![%config-file;[
3184 <!-- These are dummy anchors to keep the processor quiet            -->
3185 <!-- when building config-file only (ie. they are used in u-m only) -->
3186 <sect1 label="">
3187 <title></title>
3188 <anchor id="filter">
3189 <anchor id="filter-file">
3190 <anchor id="regex">
3191 <anchor id="actions-file">
3192 <anchor id="af-patterns">
3193 </sect1>
3194 ]]>
3195
3196 <!-- eof p-config.sgml -->