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.73 2011/06/25 12:45:47 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  By default, the main configuration file is named <filename>config</filename>,
  54  with the exception of Windows, where it is named <filename>config.txt</filename>.
  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.73 2011/06/25 12:45:47 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
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   debug 32768 # log all data read from the network
1023 </programlisting>
1024    </para>
1025    <para>
1026     To select multiple debug levels, you can either add them or use
1027     multiple <literal>debug</literal> lines.
1028    </para>
1029    <para>
1030     A debug level of 1 is informative because it will show you each request
1031     as it happens. <emphasis>1, 1024, 4096 and 8192 are recommended</emphasis>
1032     so that you will notice when things go wrong. The other levels are
1033     probably only of interest if you are hunting down a specific problem.
1034     They can produce a hell of an output (especially 16).
1035     <!-- LOL -->
1036    </para>
1037    <para>
1038     &my-app; used to ship with the debug levels recommended above enabled by
1039     default, but due to privacy concerns 3.0.7 and later are configured to
1040     only log fatal errors.
1041    </para>
1042    <para>
1043     If you are used to the more verbose settings, simply enable the debug lines
1044     below again.
1045    </para>
1046    <para>
1047     If you want to use pure CLF (Common Log Format), you should set <quote>debug
1048     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1049    </para>
1050    <para>
1051     <application>Privoxy</application> has a hard-coded limit for the
1052     length of log messages. If it's reached, messages are logged truncated
1053     and marked with <quote>... [too long, truncated]</quote>.
1054    </para>
1055    <para>
1056     Please don't file any support requests without trying to reproduce
1057     the problem with increased debug level first. Once you read the log
1058     messages, you may even be able to solve the problem on your own.
1059    </para>
1060   </listitem>
1061  </varlistentry>
1062 </variablelist>
1063
1064 <![%config-file;[<literallayout>@@#debug     1 # Log the destination for each request &my-app; let through.</literallayout>]]>
1065 <![%config-file;[<literallayout>@@#debug  1024 # Log the destination for requests &my-app; didn't let through, and the reason why.</literallayout>]]>
1066 <![%config-file;[<literallayout>@@#debug  4096 # Startup banner and warnings</literallayout>]]>
1067 <![%config-file;[<literallayout>@@#debug  8192 # Non-fatal errors</literallayout>]]>
1068 </sect3>
1069
1070
1071 <!--   ~~~~~       New section      ~~~~~     -->
1072 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1073
1074 <variablelist>
1075  <varlistentry>
1076   <term>Specifies:</term>
1077   <listitem>
1078    <para>
1079     Whether to run only one server thread.
1080    </para>
1081   </listitem>
1082  </varlistentry>
1083  <varlistentry>
1084   <term>Type of value:</term>
1085   <listitem>
1086    <para><emphasis>None</emphasis></para>
1087   </listitem>
1088  </varlistentry>
1089  <varlistentry>
1090   <term>Default value:</term>
1091   <listitem>
1092    <para><emphasis>Unset</emphasis></para>
1093   </listitem>
1094  </varlistentry>
1095  <varlistentry>
1096   <term>Effect if unset:</term>
1097   <listitem>
1098    <para>
1099     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1100     serve multiple requests simultaneously.
1101    </para>
1102   </listitem>
1103  </varlistentry>
1104  <varlistentry>
1105   <term>Notes:</term>
1106   <listitem>
1107    <para>
1108     This option is only there for debugging purposes.
1109     <emphasis>It will drastically reduce performance.</emphasis>
1110    </para>
1111   </listitem>
1112  </varlistentry>
1113 </variablelist>
1114
1115 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1116 </sect3>
1117
1118 <!--   ~~~~~       New section      ~~~~~     -->
1119 <sect3 renderas="sect4" id="hostname"><title>hostname</title>
1120
1121 <variablelist>
1122  <varlistentry>
1123   <term>Specifies:</term>
1124   <listitem>
1125    <para>
1126     The hostname shown on the CGI pages.
1127    </para>
1128   </listitem>
1129  </varlistentry>
1130  <varlistentry>
1131   <term>Type of value:</term>
1132   <listitem>
1133    <para>Text</para>
1134   </listitem>
1135  </varlistentry>
1136  <varlistentry>
1137   <term>Default value:</term>
1138   <listitem>
1139    <para><emphasis>Unset</emphasis></para>
1140   </listitem>
1141  </varlistentry>
1142  <varlistentry>
1143   <term>Effect if unset:</term>
1144   <listitem>
1145    <para>
1146     The hostname provided by the operating system is used.
1147    </para>
1148   </listitem>
1149  </varlistentry>
1150  <varlistentry>
1151   <term>Notes:</term>
1152   <listitem>
1153    <para>
1154     On some misconfigured systems resolving the hostname fails or
1155     takes too much time and slows Privoxy down. Setting a fixed hostname
1156     works around the problem.
1157    </para>
1158    <para>
1159     In other circumstances it might be desirable to show a hostname
1160     other than the one returned by the operating system. For example
1161     if the system has several different hostnames and you don't want
1162     to use the first one.
1163    </para>
1164    <para>
1165     Note that Privoxy does not validate the specified hostname value.
1166    </para>
1167   </listitem>
1168  </varlistentry>
1169 </variablelist>
1170
1171 <![%config-file;[<literallayout>@@#hostname hostname.example.org</literallayout>]]>
1172 </sect3>
1173
1174 </sect2>
1175
1176 <!--  ~  End section  ~  -->
1177
1178
1179 <!--   ~~~~~       New section      ~~~~~     -->
1180 <sect2 id="access-control">
1181 <title>Access Control and Security</title>
1182
1183  <para>
1184   This section of the config file controls the security-relevant aspects
1185   of <application>Privoxy</application>'s configuration.
1186  </para>
1187
1188
1189 <!--   ~~~~~       New section      ~~~~~     -->
1190 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1191
1192 <variablelist>
1193  <varlistentry>
1194   <term>Specifies:</term>
1195   <listitem>
1196    <para>
1197     The address and TCP port on which <application>Privoxy</application> will
1198     listen for client requests.
1199    </para>
1200   </listitem>
1201  </varlistentry>
1202  <varlistentry>
1203   <term>Type of value:</term>
1204   <listitem>
1205    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1206    <para>[<replaceable class="parameter">Hostname</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1207   </listitem>
1208  </varlistentry>
1209
1210  <varlistentry>
1211   <term>Default value:</term>
1212   <listitem>
1213    <para>127.0.0.1:8118</para>
1214   </listitem>
1215  </varlistentry>
1216  <varlistentry>
1217   <term>Effect if unset:</term>
1218   <listitem>
1219    <para>
1220     Bind to 127.0.0.1 (IPv4 localhost), port 8118. This is suitable and
1221     recommended for home users who run <application>Privoxy</application> on
1222     the same machine as their browser.
1223    </para>
1224   </listitem>
1225  </varlistentry>
1226  <varlistentry>
1227   <term>Notes:</term>
1228   <listitem>
1229    <para>
1230     You will need to configure your browser(s) to this proxy address and port.
1231    </para>
1232    <para>
1233     If you already have another service running on port 8118, or if you want to
1234     serve requests from other machines (e.g. on your local network) as well, you
1235     will need to override the default.
1236    </para>
1237    <para>
1238     If a hostname is used instead of an IP address, <application>Privoxy</application>
1239     will try to resolve it to an IP address and if there are multiple, use the first
1240     one returned.
1241    </para>
1242    <para>
1243     If the address for the hostname isn't already known on the system
1244     (for example because it's in /etc/hostname), this may result in DNS
1245     traffic.
1246    </para>
1247    <para>
1248     If the specified address isn't available on the system, or if the
1249     hostname can't be resolved, <application>Privoxy</application>
1250     will fail to start.
1251    </para>
1252    <para>
1253     IPv6 addresses containing colons have to be quoted by brackets.
1254     They can only be used if <application>Privoxy</application> has
1255     been compiled with IPv6 support. If you aren't sure if your version
1256     supports it, have a look at
1257     <literal>http://config.privoxy.org/show-status</literal>.
1258    </para>
1259    <para>
1260     Some operating systems will prefer IPv6 to IPv4 addresses even if the
1261     system has no IPv6 connectivity which is usually not expected by the user.
1262     Some even rely on DNS to resolve localhost which mean the "localhost" address
1263     used may not actually be local.
1264    </para>
1265    <para>
1266     It is therefore recommended to explicitly configure the intended IP address
1267     instead of relying on the operating system, unless there's a strong reason not to.
1268    </para>
1269    <para>
1270     If you leave out the address, <application>Privoxy</application> will bind to all
1271     IPv4 interfaces (addresses) on your machine and may become reachable from the
1272     Internet and/or the local network. Be aware that some GNU/Linux distributions
1273     modify that behaviour without updating the documentation. Check for non-standard
1274     patches if your <application>Privoxy</application>version behaves differently.
1275    </para>
1276    <para>
1277     If you configure <application>Privoxy</application>to be reachable from the
1278     network, consider using <link linkend="acls">access control lists</link>
1279     (ACL's, see below), and/or a firewall.
1280    </para>
1281    <para>
1282     If you open <application>Privoxy</application> to untrusted users, you will
1283     also want to make sure that the following actions are disabled:  <literal><link
1284     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1285     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1286    </para>
1287    <para>
1288     With the exception noted above, listening on multiple addresses is currently
1289     not supported by <application>Privoxy</application> directly.
1290     It can be done on most operating systems by letting a packet filter
1291     redirect request for certain addresses to Privoxy, though.
1292    </para>
1293   </listitem>
1294  </varlistentry>
1295  <varlistentry>
1296   <term>Example:</term>
1297   <listitem>
1298    <para>
1299      Suppose you are running <application>Privoxy</application> on
1300      a machine which has the address 192.168.0.1 on your local private network
1301      (192.168.0.0) and has another outside connection with a different address.
1302      You want it to serve requests from inside only:
1303    </para>
1304    <para>
1305     <programlisting>
1306   listen-address  192.168.0.1:8118
1307 </programlisting>
1308    </para>
1309    <para>
1310     Suppose you are running <application>Privoxy</application> on an
1311     IPv6-capable machine and you want it to listen on the IPv6 address
1312     of the loopback device:
1313    </para>
1314    <para>
1315     <programlisting>
1316   listen-address [::1]:8118
1317 </programlisting>
1318    </para>
1319   </listitem>
1320  </varlistentry>
1321 </variablelist>
1322
1323 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1324 </sect3>
1325
1326
1327 <!--   ~~~~~       New section      ~~~~~     -->
1328 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1329
1330 <variablelist>
1331  <varlistentry>
1332   <term>Specifies:</term>
1333   <listitem>
1334    <para>
1335     Initial state of "toggle" status
1336    </para>
1337   </listitem>
1338  </varlistentry>
1339  <varlistentry>
1340   <term>Type of value:</term>
1341   <listitem>
1342    <para>1 or 0</para>
1343   </listitem>
1344  </varlistentry>
1345  <varlistentry>
1346   <term>Default value:</term>
1347   <listitem>
1348    <para>1</para>
1349   </listitem>
1350  </varlistentry>
1351  <varlistentry>
1352   <term>Effect if unset:</term>
1353   <listitem>
1354    <para>
1355     Act as if toggled on
1356    </para>
1357   </listitem>
1358  </varlistentry>
1359  <varlistentry>
1360   <term>Notes:</term>
1361   <listitem>
1362    <para>
1363     If set to 0, <application>Privoxy</application> will start in
1364     <quote>toggled off</quote> mode, i.e. mostly behave like a normal,
1365     content-neutral proxy with both ad blocking and content filtering
1366     disabled. See <literal>enable-remote-toggle</literal> below.
1367 <!--
1368     This is not really useful
1369     anymore, since toggling is much easier via <ulink
1370     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1371     editing the <filename>conf</filename> file.
1372
1373     Remote toggling is now disabled by default. fk 2007-11-07)
1374 -->
1375    </para>
1376    <para>
1377     The windows version will only display the toggle icon in the system tray
1378     if this option is present.
1379    </para>
1380   </listitem>
1381  </varlistentry>
1382 </variablelist>
1383
1384 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1385 </sect3>
1386
1387
1388 <!--   ~~~~~       New section      ~~~~~     -->
1389 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1390 <variablelist>
1391  <varlistentry>
1392   <term>Specifies:</term>
1393   <listitem>
1394    <para>
1395     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1396     feature</ulink> may be used
1397    </para>
1398   </listitem>
1399  </varlistentry>
1400  <varlistentry>
1401   <term>Type of value:</term>
1402   <listitem>
1403    <para>0 or 1</para>
1404   </listitem>
1405  </varlistentry>
1406  <varlistentry>
1407   <term>Default value:</term>
1408   <listitem>
1409    <para>0</para>
1410   </listitem>
1411  </varlistentry>
1412  <varlistentry>
1413   <term>Effect if unset:</term>
1414   <listitem>
1415    <para>
1416     The web-based toggle feature is disabled.
1417    </para>
1418   </listitem>
1419  </varlistentry>
1420  <varlistentry>
1421   <term>Notes:</term>
1422   <listitem>
1423    <para>
1424     When toggled off, <application>Privoxy</application> mostly acts like a normal,
1425     content-neutral proxy, i.e. doesn't block ads or filter content.
1426    </para>
1427    <para>
1428     Access to the toggle feature can <emphasis>not</emphasis> be
1429     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1430     so that everybody who can access <application>Privoxy</application> (see
1431     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1432     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1433     for multi-user environments with untrusted users.
1434    </para>
1435    <para>
1436     Note that malicious client side code (e.g Java) is also
1437     capable of using this option.
1438    </para>
1439    <para>
1440     As a lot of <application>Privoxy</application> users don't read
1441     documentation, this feature is disabled by default.
1442    </para>
1443    <para>
1444     Note that you must have compiled <application>Privoxy</application> with
1445     support for this feature, otherwise this option has no effect.
1446    </para>
1447   </listitem>
1448  </varlistentry>
1449 </variablelist>
1450
1451 <![%config-file;[<literallayout>@@enable-remote-toggle  0</literallayout>]]>
1452 </sect3>
1453
1454
1455 <!--   ~~~~~       New section      ~~~~~     -->
1456 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1457 <variablelist>
1458  <varlistentry>
1459   <term>Specifies:</term>
1460   <listitem>
1461    <para>
1462     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1463    </para>
1464   </listitem>
1465  </varlistentry>
1466  <varlistentry>
1467   <term>Type of value:</term>
1468   <listitem>
1469    <para>0 or 1</para>
1470   </listitem>
1471  </varlistentry>
1472  <varlistentry>
1473   <term>Default value:</term>
1474   <listitem>
1475    <para>0</para>
1476   </listitem>
1477  </varlistentry>
1478  <varlistentry>
1479   <term>Effect if unset:</term>
1480   <listitem>
1481    <para>
1482     Privoxy ignores special HTTP headers.
1483    </para>
1484   </listitem>
1485  </varlistentry>
1486  <varlistentry>
1487   <term>Notes:</term>
1488   <listitem>
1489    <para>
1490     When toggled on, the client can change <application>Privoxy's</application>
1491     behaviour by setting special HTTP headers. Currently the only supported
1492     special header is <quote>X-Filter: No</quote>, to disable filtering for
1493     the ongoing request, even if it is enabled in one of the action files.
1494    </para>
1495    <para>
1496     This feature is disabled by default. If you are using
1497     <application>Privoxy</application> in a environment with trusted clients,
1498     you may enable this feature at your discretion. Note that malicious client
1499     side code (e.g Java) is also capable of using this feature.
1500    </para>
1501    <para>
1502     This option will be removed in future releases as it has been obsoleted
1503     by the more general header taggers.
1504    </para>
1505   </listitem>
1506  </varlistentry>
1507 </variablelist>
1508
1509 <![%config-file;[<literallayout>@@enable-remote-http-toggle  0</literallayout>]]>
1510 </sect3>
1511
1512
1513 <!--   ~~~~~       New section      ~~~~~     -->
1514 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1515 <variablelist>
1516  <varlistentry>
1517   <term>Specifies:</term>
1518   <listitem>
1519    <para>
1520     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1521     file editor</ulink> may be used
1522    </para>
1523   </listitem>
1524  </varlistentry>
1525  <varlistentry>
1526   <term>Type of value:</term>
1527   <listitem>
1528    <para>0 or 1</para>
1529   </listitem>
1530  </varlistentry>
1531  <varlistentry>
1532   <term>Default value:</term>
1533   <listitem>
1534    <para>0</para>
1535   </listitem>
1536  </varlistentry>
1537  <varlistentry>
1538   <term>Effect if unset:</term>
1539   <listitem>
1540    <para>
1541     The web-based actions file editor is disabled.
1542    </para>
1543   </listitem>
1544  </varlistentry>
1545  <varlistentry>
1546   <term>Notes:</term>
1547   <listitem>
1548    <para>
1549     Access to the editor can <emphasis>not</emphasis> be
1550     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1551     so that everybody who can access <application>Privoxy</application> (see
1552     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1553     modify its configuration for all users.
1554    </para>
1555    <para>
1556     This option is <emphasis>not recommended</emphasis> for environments
1557     with untrusted users and as a lot of <application>Privoxy</application>
1558     users don't read documentation, this feature is disabled by default.
1559    </para>
1560    <para>
1561     Note that malicious client side code (e.g Java) is also
1562     capable of using the actions editor and you shouldn't enable
1563     this options unless you understand the consequences and are
1564     sure your browser is configured correctly.
1565    </para>
1566    <para>
1567     Note that you must have compiled <application>Privoxy</application> with
1568     support for this feature, otherwise this option has no effect.
1569    </para>
1570   </listitem>
1571  </varlistentry>
1572 </variablelist>
1573
1574 <![%config-file;[<literallayout>@@enable-edit-actions 0</literallayout>]]>
1575 </sect3>
1576
1577
1578 <sect3 renderas="sect4" id="enforce-blocks"><title>enforce-blocks</title>
1579 <variablelist>
1580  <varlistentry>
1581   <term>Specifies:</term>
1582   <listitem>
1583    <para>
1584     Whether the user is allowed to ignore blocks and can <quote>go there anyway</quote>.
1585    </para>
1586   </listitem>
1587  </varlistentry>
1588  <varlistentry>
1589   <term>Type of value:</term>
1590   <listitem>
1591    <para>
1592     <replaceable>0 or 1</replaceable>
1593    </para>
1594   </listitem>
1595  </varlistentry>
1596  <varlistentry>
1597   <term>Default value:</term>
1598   <listitem>
1599    <para><emphasis>0</emphasis></para>
1600   </listitem>
1601  </varlistentry>
1602  <varlistentry>
1603   <term>Effect if unset:</term>
1604   <listitem>
1605    <para>
1606     Blocks are not enforced.
1607    </para>
1608   </listitem>
1609  </varlistentry>
1610  <varlistentry>
1611   <term>Notes:</term>
1612   <listitem>
1613    <para>
1614     <application>Privoxy</application> is mainly used to block and filter
1615     requests as a service to the user, for example to block ads and other
1616     junk that clogs the pipes. <application>Privoxy's</application> configuration
1617     isn't perfect and sometimes innocent pages are blocked. In this situation it
1618     makes sense to allow the user to enforce the request and have
1619     <application>Privoxy</application> ignore the block.
1620    </para>
1621    <para>
1622     In the default configuration <application>Privoxy's</application>
1623     <quote>Blocked</quote> page contains a <quote>go there anyway</quote>
1624     link to adds a special string (the force prefix) to the request URL.
1625     If that link is used, <application>Privoxy</application> will
1626     detect the force prefix, remove it again and let the request pass.
1627    </para>
1628    <para>
1629     Of course <application>Privoxy</application> can also be used to enforce
1630     a network policy. In that case the user obviously should not be able to
1631     bypass any blocks, and that's what the <quote>enforce-blocks</quote>
1632     option is for. If it's enabled, <application>Privoxy</application> hides
1633     the <quote>go there anyway</quote> link. If the user adds the force
1634     prefix by hand, it will not be accepted and the circumvention attempt
1635     is logged.
1636    </para>
1637   </listitem>
1638  </varlistentry>
1639  <varlistentry>
1640   <term>Examples:</term>
1641   <listitem>
1642    <para>
1643     enforce-blocks 1
1644    </para>
1645   </listitem>
1646  </varlistentry>
1647 </variablelist>
1648 <![%config-file;[<literallayout>@@enforce-blocks 0</literallayout>]]>
1649 </sect3>
1650
1651
1652 <!--   ~~~~~       New section      ~~~~~     -->
1653 <sect3 renderas="sect4" id="acls"><title>
1654 ACLs: permit-access and deny-access</title>
1655 <anchor id="permit-access">
1656 <anchor id="deny-access">
1657
1658 <variablelist>
1659  <varlistentry>
1660   <term>Specifies:</term>
1661   <listitem>
1662    <para>
1663     Who can access what.
1664    </para>
1665   </listitem>
1666  </varlistentry>
1667  <varlistentry>
1668   <term>Type of value:</term>
1669   <listitem>
1670    <para>
1671     <replaceable class="parameter">src_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">src_masklen</replaceable>]
1672     [<replaceable class="parameter">dst_addr</replaceable>[:<replaceable class="parameter">port</replaceable>][/<replaceable class="parameter">dst_masklen</replaceable>]]
1673    </para>
1674    <para>
1675     Where <replaceable class="parameter">src_addr</replaceable> and
1676    <replaceable class="parameter">dst_addr</replaceable> are IPv4 addresses in dotted decimal notation or valid
1677     DNS names, <replaceable class="parameter">port</replaceable> is a port
1678     number, and <replaceable class="parameter">src_masklen</replaceable> and
1679     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1680     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1681     destination part are optional.
1682    </para>
1683    <para>
1684     If your system implements
1685     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink>, then
1686     <replaceable class="parameter">src_addr</replaceable> and <replaceable
1687     class="parameter">dst_addr</replaceable> can be IPv6 addresses delimeted by
1688     brackets, <replaceable class="parameter">port</replaceable> can be a number
1689     or a service name, and
1690     <replaceable class="parameter">src_masklen</replaceable> and
1691     <replaceable class="parameter">dst_masklen</replaceable> can be a number
1692     from 0 to 128.
1693    </para>
1694   </listitem>
1695  </varlistentry>
1696  <varlistentry>
1697   <term>Default value:</term>
1698   <listitem>
1699    <para><emphasis>Unset</emphasis></para>
1700    <para>
1701     If no <replaceable class="parameter">port</replaceable> is specified,
1702     any port will match. If no <replaceable class="parameter">src_masklen</replaceable> or
1703     <replaceable class="parameter">src_masklen</replaceable> is given, the complete IP
1704     address has to match (i.e. 32 bits for IPv4 and 128 bits for IPv6).
1705    </para>
1706   </listitem>
1707  </varlistentry>
1708  <varlistentry>
1709   <term>Effect if unset:</term>
1710   <listitem>
1711    <para>
1712     Don't restrict access further than implied by <literal>listen-address</literal>
1713    </para>
1714   </listitem>
1715  </varlistentry>
1716  <varlistentry>
1717   <term>Notes:</term>
1718   <listitem>
1719    <para>
1720     Access controls are included at the request of ISPs and systems
1721     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1722     For a typical home user, it will normally suffice to ensure that
1723     <application>Privoxy</application> only listens on the localhost
1724     (127.0.0.1) or internal (home) network address by means of the
1725     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1726     option.
1727    </para>
1728    <para>
1729     Please see the warnings in the FAQ that <application>Privoxy</application>
1730     is not intended to be a substitute for a firewall or to encourage anyone
1731     to defer addressing basic security weaknesses.
1732    </para>
1733    <para>
1734     Multiple ACL lines are OK.
1735     If any ACLs are specified, <application>Privoxy</application> only talks
1736     to IP addresses that match at least one <literal>permit-access</literal> line
1737     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1738     last match wins, with the default being <literal>deny-access</literal>.
1739    </para>
1740    <para>
1741     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1742     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1743     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1744     of the ultimate target. This is necessary because it may be impossible for the local
1745     <application>Privoxy</application> to determine the IP address of the
1746     ultimate target (that's often what gateways are used for).
1747    </para>
1748    <para>
1749     You should prefer using IP addresses over DNS names, because the address lookups take
1750     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1751     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1752     IP addresses, only the first one is used.
1753    </para>
1754    <para>
1755      Some systems allow IPv4 clients to connect to IPv6 server sockets.
1756      Then the client's IPv4 address will be translated by the system into
1757      IPv6 address space with special prefix ::ffff:0:0/96 (so called IPv4
1758      mapped IPv6 address). <application>Privoxy</application> can handle it
1759      and maps such ACL addresses automatically.
1760    </para>
1761    <para>
1762     Denying access to particular sites by ACL may have undesired side effects
1763     if the site in question is hosted on a machine which also hosts other sites
1764     (most sites are).
1765    </para>
1766   </listitem>
1767  </varlistentry>
1768  <varlistentry>
1769   <term>Examples:</term>
1770   <listitem>
1771    <para>
1772     Explicitly define the default behavior if no ACL and
1773     <literal>listen-address</literal> are set: <quote>localhost</quote>
1774     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1775     <emphasis>all</emphasis> destination addresses are OK:
1776    </para>
1777    <para>
1778     <screen>
1779   permit-access  localhost
1780 </screen>
1781    </para>
1782    <para>
1783     Allow any host on the same class C subnet as www.privoxy.org access to
1784     nothing but www.example.com (or other domains hosted on the same system):
1785    </para>
1786    <para>
1787     <screen>
1788   permit-access  www.privoxy.org/24 www.example.com/32
1789 </screen>
1790    </para>
1791    <para>
1792     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1793     with the exception that 192.168.45.73 may not access the IP address behind
1794     www.dirty-stuff.example.com:
1795    </para>
1796    <para>
1797     <screen>
1798   permit-access  192.168.45.64/26
1799   deny-access    192.168.45.73    www.dirty-stuff.example.com
1800 </screen>
1801    </para>
1802    <para>
1803      Allow access from the IPv4 network 192.0.2.0/24 even if listening on
1804      an IPv6 wild card address (not supported on all platforms):
1805    </para>
1806    <para>
1807     <programlisting>
1808   permit-access  192.0.2.0/24
1809 </programlisting>
1810    </para>
1811    <para>
1812      This is equivalent to the following line even if listening on an
1813      IPv4 address (not supported on all platforms):
1814    </para>
1815    <para>
1816     <programlisting>
1817   permit-access  [::ffff:192.0.2.0]/120
1818 </programlisting>
1819    </para>
1820   </listitem>
1821  </varlistentry>
1822 </variablelist>
1823 </sect3>
1824
1825
1826 <!--   ~~~~~       New section      ~~~~~     -->
1827 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1828
1829 <variablelist>
1830  <varlistentry>
1831   <term>Specifies:</term>
1832   <listitem>
1833    <para>
1834     Maximum size of the buffer for content filtering.
1835    </para>
1836   </listitem>
1837  </varlistentry>
1838  <varlistentry>
1839   <term>Type of value:</term>
1840   <listitem>
1841    <para>Size in Kbytes</para>
1842   </listitem>
1843  </varlistentry>
1844  <varlistentry>
1845   <term>Default value:</term>
1846   <listitem>
1847    <para>4096</para>
1848   </listitem>
1849  </varlistentry>
1850  <varlistentry>
1851   <term>Effect if unset:</term>
1852   <listitem>
1853    <para>
1854     Use a 4MB (4096 KB) limit.
1855    </para>
1856   </listitem>
1857  </varlistentry>
1858  <varlistentry>
1859   <term>Notes:</term>
1860   <listitem>
1861    <para>
1862     For content filtering, i.e. the <literal>+filter</literal> and
1863     <literal>+deanimate-gif</literal> actions, it is necessary that
1864     <application>Privoxy</application> buffers the entire document body.
1865     This can be potentially dangerous, since a server could just keep sending
1866     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1867     Hence this option.
1868    </para>
1869    <para>
1870     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1871     flushed to the client unfiltered and no further attempt to
1872     filter the rest of the document is made. Remember that there may be multiple threads
1873     running, which might require up to <literal>buffer-limit</literal> Kbytes
1874     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1875     above.
1876    </para>
1877   </listitem>
1878  </varlistentry>
1879 </variablelist>
1880
1881 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1882 </sect3>
1883
1884 </sect2>
1885
1886 <!--  ~  End section  ~  -->
1887
1888
1889 <!--   ~~~~~       New section      ~~~~~     -->
1890
1891 <sect2 id="forwarding">
1892 <title>Forwarding</title>
1893
1894 <para>
1895  This feature allows routing of HTTP requests through a chain of
1896  multiple proxies.
1897 </para>
1898 <para>
1899  Forwarding can be used to chain Privoxy with a caching proxy to speed
1900  up browsing. Using a parent proxy may also be necessary if the machine
1901  that <application>Privoxy</application> runs on has no direct Internet access.
1902 </para>
1903 <para>
1904  Note that parent proxies can severely decrease your privacy level.
1905  For example a parent proxy could add your IP address to the request
1906  headers and if it's a caching proxy it may add the <quote>Etag</quote>
1907  header to revalidation requests again, even though you configured Privoxy
1908  to remove it. It may also ignore Privoxy's header time randomization and use the
1909  original values which could be used by the server as cookie replacement
1910  to track your steps between visits.
1911 </para>
1912
1913 <para>
1914  Also specified here are SOCKS proxies. <application>Privoxy</application>
1915  supports the SOCKS 4 and SOCKS 4A protocols.
1916 </para>
1917
1918 <sect3 renderas="sect4" id="forward"><title>forward</title>
1919 <variablelist>
1920  <varlistentry>
1921   <term>Specifies:</term>
1922   <listitem>
1923    <para>
1924     To which parent HTTP proxy specific requests should be routed.
1925    </para>
1926   </listitem>
1927  </varlistentry>
1928  <varlistentry>
1929   <term>Type of value:</term>
1930   <listitem>
1931    <para>
1932     <replaceable class="parameter">target_pattern</replaceable>
1933     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1934    </para>
1935    <para>
1936     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1937     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1938     denote <quote>all URLs</quote>.
1939     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1940     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1941     optionally followed by its listening port (default: 8000).
1942     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1943    </para>
1944   </listitem>
1945  </varlistentry>
1946  <varlistentry>
1947   <term>Default value:</term>
1948   <listitem>
1949    <para><emphasis>Unset</emphasis></para>
1950   </listitem>
1951  </varlistentry>
1952  <varlistentry>
1953   <term>Effect if unset:</term>
1954   <listitem>
1955    <para>
1956     Don't use parent HTTP proxies.
1957    </para>
1958   </listitem>
1959  </varlistentry>
1960  <varlistentry>
1961   <term>Notes:</term>
1962   <listitem>
1963    <para>
1964     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1965     forwarded to another HTTP proxy but are made directly to the web servers.
1966    </para>
1967    <para>
1968     <replaceable class="parameter">http_parent</replaceable> can be a
1969      numerical IPv6 address (if
1970     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
1971     implemented). To prevent clashes with the port delimiter, the whole IP
1972     address has to be put into brackets. On the other hand a <replaceable
1973     class="parameter">target_pattern</replaceable> containing an IPv6 address
1974     has to be put into angle brackets (normal brackets are reserved for
1975     regular expressions already).
1976    </para>
1977    <para>
1978     Multiple lines are OK, they are checked in sequence, and the last match wins.
1979    </para>
1980   </listitem>
1981  </varlistentry>
1982  <varlistentry>
1983   <term>Examples:</term>
1984   <listitem>
1985    <para>
1986     Everything goes to an example parent proxy, except SSL on port 443 (which it doesn't handle):
1987    </para>
1988    <para>
1989     <screen>
1990   forward   /      parent-proxy.example.org:8080
1991   forward   :443   .
1992 </screen>
1993    </para>
1994    <para>
1995     Everything goes to our example ISP's caching proxy, except for requests
1996     to that ISP's sites:
1997    </para>
1998    <para>
1999     <screen>
2000   forward   /                  caching-proxy.isp.example.net:8000
2001   forward   .isp.example.net   .
2002 </screen>
2003    </para>
2004    <para>
2005     Parent proxy specified by an IPv6 address:
2006    </para>
2007    <para>
2008     <programlisting>
2009   forward   /                   [2001:DB8::1]:8000
2010 </programlisting>
2011    </para>
2012    <para>
2013     Suppose your parent proxy doesn't support IPv6:
2014    </para>
2015    <para>
2016     <programlisting>
2017   forward  /                        parent-proxy.example.org:8000
2018   forward  ipv6-server.example.org  .
2019   forward  &lt;[2-3][0-9a-f][0-9a-f][0-9a-f]:*&gt;   .
2020 </programlisting>
2021    </para>
2022   </listitem>
2023  </varlistentry>
2024 </variablelist>
2025 </sect3>
2026
2027
2028 <!--   ~~~~~       New section      ~~~~~     -->
2029 <sect3 renderas="sect4" id="socks"><title>
2030 forward-socks4, forward-socks4a and forward-socks5</title>
2031 <anchor id="forward-socks4">
2032 <anchor id="forward-socks4a">
2033
2034 <variablelist>
2035  <varlistentry>
2036   <term>Specifies:</term>
2037   <listitem>
2038    <para>
2039     Through which SOCKS proxy (and optionally to which parent HTTP proxy) specific requests should be routed.
2040    </para>
2041   </listitem>
2042  </varlistentry>
2043  <varlistentry>
2044   <term>Type of value:</term>
2045   <listitem>
2046    <para>
2047     <replaceable class="parameter">target_pattern</replaceable>
2048     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
2049     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
2050    </para>
2051    <para>
2052     where <replaceable class="parameter">target_pattern</replaceable> is a
2053     <link linkend="af-patterns">URL pattern</link> that specifies to which
2054     requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
2055     denote <quote>all URLs</quote>. <replaceable class="parameter">http_parent</replaceable>
2056     and <replaceable class="parameter">socks_proxy</replaceable>
2057     are IP addresses in dotted decimal notation or valid DNS names
2058     (<replaceable class="parameter">http_parent</replaceable>
2059     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2060     <replaceable class="parameter">port</replaceable> parameters are TCP ports,
2061     i.e. integer values from 1 to 65535
2062    </para>
2063   </listitem>
2064  </varlistentry>
2065  <varlistentry>
2066   <term>Default value:</term>
2067   <listitem>
2068    <para><emphasis>Unset</emphasis></para>
2069   </listitem>
2070  </varlistentry>
2071  <varlistentry>
2072   <term>Effect if unset:</term>
2073   <listitem>
2074    <para>
2075     Don't use SOCKS proxies.
2076    </para>
2077   </listitem>
2078  </varlistentry>
2079  <varlistentry>
2080   <term>Notes:</term>
2081   <listitem>
2082    <para>
2083     Multiple lines are OK, they are checked in sequence, and the last match wins.
2084    </para>
2085    <para>
2086     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2087     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2088     server, while in SOCKS 4 it happens locally.
2089    </para>
2090    <para>
2091     With <literal>forward-socks5</literal> the DNS resolution will happen on the remote server as well.
2092    </para>
2093    <para>
2094     <replaceable class="parameter">socks_proxy</replaceable> and
2095     <replaceable class="parameter">http_parent</replaceable> can be a
2096      numerical IPv6 address (if
2097     <ulink url="http://tools.ietf.org/html/rfc3493">RFC 3493</ulink> is
2098     implemented). To prevent clashes with the port delimiter, the whole IP
2099     address has to be put into brackets. On the other hand a <replaceable
2100     class="parameter">target_pattern</replaceable> containing an IPv6 address
2101     has to be put into angle brackets (normal brackets are reserved for
2102     regular expressions already).
2103    </para>
2104    <para>
2105     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2106     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2107     a SOCKS proxy.
2108    </para>
2109   </listitem>
2110  </varlistentry>
2111  <varlistentry>
2112   <term>Examples:</term>
2113   <listitem>
2114    <para>
2115      From the company example.com, direct connections are made to all
2116      <quote>internal</quote> domains, but everything outbound goes through
2117      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2118      the Internet.
2119    </para>
2120    <para>
2121     <screen>
2122   forward-socks4a   /              socks-gw.example.com:1080  www-cache.isp.example.net:8080
2123   forward           .example.com   .
2124 </screen>
2125    </para>
2126    <para>
2127     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2128    </para>
2129    <para>
2130     <screen>
2131   forward-socks4   /               socks-gw.example.com:1080  .
2132 </screen>
2133    </para>
2134
2135     <para>
2136     To chain Privoxy and Tor, both running on the same system, you would use
2137     something like:
2138    </para>
2139    <para>
2140     <screen>
2141   forward-socks5   /               127.0.0.1:9050 .
2142 </screen>
2143    </para>
2144
2145     <para>
2146     The public <application>Tor</application> network can't be used to
2147     reach your local network, if you need to access local servers you
2148     therefore might want to make some exceptions:
2149    </para>
2150    <para>
2151     <screen>
2152   forward         192.168.*.*/     .
2153   forward            10.*.*.*/     .
2154   forward           127.*.*.*/     .
2155 </screen>
2156    </para>
2157    <para>
2158     Unencrypted connections to systems in these address ranges will
2159     be as (un)secure as the local network is, but the alternative is that you
2160     can't reach the local network through <application>Privoxy</application>
2161     at all. Of course this may actually be desired and there is no reason
2162     to make these exceptions if you aren't sure you need them.
2163    </para>
2164    <para>
2165     If you also want to be able to reach servers in your local network by
2166     using their names, you will need additional exceptions that look like
2167     this:
2168    </para>
2169    <para>
2170     <screen>
2171  forward           localhost/     .
2172 </screen>
2173    </para>
2174
2175   </listitem>
2176  </varlistentry>
2177 </variablelist>
2178 </sect3>
2179
2180 <![%user-man;[     <!-- not included in config due to length -->
2181 <!--   ~~~~~       New section      ~~~~~     -->
2182 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2183
2184 <para>
2185  If you have links to multiple ISPs that provide various special content
2186  only to their subscribers, you can configure multiple <application>Privoxies</application>
2187  which have connections to the respective ISPs to act as forwarders to each other, so that
2188  <emphasis>your</emphasis> users can see the internal content of all ISPs.
2189 </para>
2190
2191 <para>
2192  Assume that host-a has a PPP connection to isp-a.example.net. And host-b has a PPP connection to
2193  isp-b.example.org. Both run <application>Privoxy</application>. Their forwarding
2194  configuration can look like this:
2195 </para>
2196
2197 <para>
2198  host-a:
2199 </para>
2200
2201 <para>
2202  <screen>
2203   forward    /           .
2204   forward    .isp-b.example.net  host-b:8118
2205 </screen>
2206 </para>
2207
2208 <para>
2209  host-b:
2210 </para>
2211
2212 <para>
2213  <screen>
2214   forward    /           .
2215   forward    .isp-a.example.org  host-a:8118
2216 </screen>
2217 </para>
2218
2219 <para>
2220  Now, your users can set their browser's proxy to use either
2221  host-a or host-b and be able to browse the internal content
2222  of both isp-a and isp-b.
2223 </para>
2224
2225 <para>
2226  If you intend to chain <application>Privoxy</application> and
2227  <application>squid</application> locally, then chaining as
2228  <literal>browser -> squid -> privoxy</literal> is the recommended way.
2229 </para>
2230
2231 <para>
2232  Assuming that <application>Privoxy</application> and <application>squid</application>
2233  run on the same box, your <application>squid</application> configuration could then look like this:
2234 </para>
2235
2236 <para>
2237  <screen>
2238   # Define Privoxy as parent proxy (without ICP)
2239   cache_peer 127.0.0.1 parent 8118 7 no-query
2240
2241   # Define ACL for protocol FTP
2242   acl ftp proto FTP
2243
2244   # Do not forward FTP requests to Privoxy
2245   always_direct allow ftp
2246
2247   # Forward all the rest to Privoxy
2248   never_direct allow all</screen>
2249 </para>
2250
2251 <para>
2252  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2253  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2254 </para>
2255
2256 <para>
2257  You could just as well decide to only forward requests you suspect
2258  of leading to Windows executables through a virus-scanning parent proxy,
2259  say, on <literal>antivir.example.com</literal>, port 8010:
2260 </para>
2261
2262 <para>
2263  <screen>
2264   forward   /                          .
2265   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
2266 </para>
2267
2268 </sect3>
2269 ]]>
2270
2271 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
2272 <variablelist>
2273  <varlistentry>
2274   <term>Specifies:</term>
2275   <listitem>
2276    <para>
2277     How often Privoxy retries if a forwarded connection request fails.
2278    </para>
2279   </listitem>
2280  </varlistentry>
2281  <varlistentry>
2282   <term>Type of value:</term>
2283   <listitem>
2284    <para>
2285     <replaceable class="parameter">Number of retries.</replaceable>
2286    </para>
2287   </listitem>
2288  </varlistentry>
2289  <varlistentry>
2290   <term>Default value:</term>
2291   <listitem>
2292    <para><emphasis>0</emphasis></para>
2293   </listitem>
2294  </varlistentry>
2295  <varlistentry>
2296   <term>Effect if unset:</term>
2297   <listitem>
2298    <para>
2299     Connections forwarded through other proxies are treated like direct connections and no retry attempts are made.
2300    </para>
2301   </listitem>
2302  </varlistentry>
2303  <varlistentry>
2304   <term>Notes:</term>
2305   <listitem>
2306    <para>
2307     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
2308     for socks4a connections, where <application>Privoxy</application> can't detect why the connections failed.
2309     The connection might have failed because of a DNS timeout in which case a retry makes sense,
2310     but it might also have failed because the server doesn't exist or isn't reachable. In this
2311     case the retry will just delay the appearance of Privoxy's error message.
2312    </para>
2313    <para>
2314     Note that in the context of this option, <quote>forwarded connections</quote> includes all connections
2315     that Privoxy forwards through other proxies. This option is not limited to the HTTP CONNECT method.
2316    </para>
2317    <para>
2318     Only use this option, if you are getting lots of forwarding-related error messages
2319     that go away when you try again manually. Start with a small value and check Privoxy's
2320     logfile from time to time, to see how many retries are usually needed.
2321    </para>
2322   </listitem>
2323  </varlistentry>
2324  <varlistentry>
2325   <term>Examples:</term>
2326   <listitem>
2327    <para>
2328     forwarded-connect-retries 1
2329    </para>
2330   </listitem>
2331  </varlistentry>
2332 </variablelist>
2333 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
2334 </sect3>
2335
2336 </sect2>
2337
2338 <sect2 id="misc">
2339 <title>Miscellaneous</title>
2340
2341 <sect3 renderas="sect4" id="accept-intercepted-requests"><title>accept-intercepted-requests</title>
2342 <variablelist>
2343  <varlistentry>
2344   <term>Specifies:</term>
2345   <listitem>
2346    <para>
2347     Whether intercepted requests should be treated as valid.
2348    </para>
2349   </listitem>
2350  </varlistentry>
2351  <varlistentry>
2352   <term>Type of value:</term>
2353   <listitem>
2354    <para>
2355     <replaceable>0 or 1</replaceable>
2356    </para>
2357   </listitem>
2358  </varlistentry>
2359  <varlistentry>
2360   <term>Default value:</term>
2361   <listitem>
2362    <para><emphasis>0</emphasis></para>
2363   </listitem>
2364  </varlistentry>
2365  <varlistentry>
2366   <term>Effect if unset:</term>
2367   <listitem>
2368    <para>
2369     Only proxy requests are accepted, intercepted requests are treated as invalid.
2370    </para>
2371   </listitem>
2372  </varlistentry>
2373  <varlistentry>
2374   <term>Notes:</term>
2375   <listitem>
2376    <para>
2377     If you don't trust your clients and want to force them
2378     to use <application>Privoxy</application>, enable this
2379     option and configure your packet filter to redirect outgoing
2380     HTTP connections into <application>Privoxy</application>.
2381    </para>
2382    <para>
2383     Make sure that <application>Privoxy's</application> own requests
2384     aren't redirected as well. Additionally take care that
2385     <application>Privoxy</application> can't intentionally connect
2386     to itself, otherwise you could run into redirection loops if
2387     <application>Privoxy's</application> listening port is reachable
2388     by the outside or an attacker has access to the pages you visit.
2389    </para>
2390   </listitem>
2391  </varlistentry>
2392  <varlistentry>
2393   <term>Examples:</term>
2394   <listitem>
2395    <para>
2396     accept-intercepted-requests 1
2397    </para>
2398   </listitem>
2399  </varlistentry>
2400 </variablelist>
2401 <![%config-file;[<literallayout>@@accept-intercepted-requests 0</literallayout>]]>
2402 </sect3>
2403
2404 <sect3 renderas="sect4" id="allow-cgi-request-crunching"><title>allow-cgi-request-crunching</title>
2405 <variablelist>
2406  <varlistentry>
2407   <term>Specifies:</term>
2408   <listitem>
2409    <para>
2410     Whether requests to <application>Privoxy's</application> CGI pages can be blocked or redirected.
2411    </para>
2412   </listitem>
2413  </varlistentry>
2414  <varlistentry>
2415   <term>Type of value:</term>
2416   <listitem>
2417    <para>
2418     <replaceable>0 or 1</replaceable>
2419    </para>
2420   </listitem>
2421  </varlistentry>
2422  <varlistentry>
2423   <term>Default value:</term>
2424   <listitem>
2425    <para><emphasis>0</emphasis></para>
2426   </listitem>
2427  </varlistentry>
2428  <varlistentry>
2429   <term>Effect if unset:</term>
2430   <listitem>
2431    <para>
2432     <application>Privoxy</application> ignores block and redirect actions for its CGI pages.
2433    </para>
2434   </listitem>
2435  </varlistentry>
2436  <varlistentry>
2437   <term>Notes:</term>
2438   <listitem>
2439    <para>
2440     By default <application>Privoxy</application> ignores block or redirect actions
2441     for its CGI pages. Intercepting these requests can be useful in multi-user
2442     setups to implement fine-grained access control, but it can also render the complete
2443     web interface useless and make debugging problems painful if done without care.
2444    </para>
2445    <para>
2446     Don't enable this option unless you're sure that you really need it.
2447    </para>
2448   </listitem>
2449  </varlistentry>
2450  <varlistentry>
2451   <term>Examples:</term>
2452   <listitem>
2453    <para>
2454     allow-cgi-request-crunching 1
2455    </para>
2456   </listitem>
2457  </varlistentry>
2458 </variablelist>
2459 <![%config-file;[<literallayout>@@allow-cgi-request-crunching 0</literallayout>]]>
2460 </sect3>
2461
2462 <sect3 renderas="sect4" id="split-large-forms"><title>split-large-forms</title>
2463 <variablelist>
2464  <varlistentry>
2465   <term>Specifies:</term>
2466   <listitem>
2467    <para>
2468     Whether the CGI interface should stay compatible with broken HTTP clients.
2469    </para>
2470   </listitem>
2471  </varlistentry>
2472  <varlistentry>
2473   <term>Type of value:</term>
2474   <listitem>
2475    <para>
2476     <replaceable>0 or 1</replaceable>
2477    </para>
2478   </listitem>
2479  </varlistentry>
2480  <varlistentry>
2481   <term>Default value:</term>
2482   <listitem>
2483    <para><emphasis>0</emphasis></para>
2484   </listitem>
2485  </varlistentry>
2486  <varlistentry>
2487   <term>Effect if unset:</term>
2488   <listitem>
2489    <para>
2490     The CGI form generate long GET URLs.
2491    </para>
2492   </listitem>
2493  </varlistentry>
2494  <varlistentry>
2495   <term>Notes:</term>
2496   <listitem>
2497    <para>
2498     <application>Privoxy's</application> CGI forms can lead to
2499     rather long URLs. This isn't a problem as far as the HTTP
2500     standard is concerned, but it can confuse clients with arbitrary
2501     URL length limitations.
2502    </para>
2503    <para>
2504     Enabling split-large-forms causes <application>Privoxy</application>
2505     to divide big forms into smaller ones to keep the URL length down.
2506     It makes editing a lot less convenient and you can no longer
2507     submit all changes at once, but at least it works around this
2508     browser bug.
2509    </para>
2510    <para>
2511     If you don't notice any editing problems, there is no reason
2512     to enable this option, but if one of the submit buttons appears
2513     to be broken, you should give it a try.
2514    </para>
2515   </listitem>
2516  </varlistentry>
2517  <varlistentry>
2518   <term>Examples:</term>
2519   <listitem>
2520    <para>
2521     split-large-forms 1
2522    </para>
2523   </listitem>
2524  </varlistentry>
2525 </variablelist>
2526 <![%config-file;[<literallayout>@@split-large-forms 0</literallayout>]]>
2527 </sect3>
2528
2529 <sect3 renderas="sect4" id="keep-alive-timeout"><title>keep-alive-timeout</title>
2530 <variablelist>
2531  <varlistentry>
2532   <term>Specifies:</term>
2533   <listitem>
2534    <para>
2535     Number of seconds after which an open connection will no longer be reused.
2536    </para>
2537   </listitem>
2538  </varlistentry>
2539  <varlistentry>
2540   <term>Type of value:</term>
2541   <listitem>
2542    <para>
2543     <replaceable>Time in seconds.</replaceable>
2544    </para>
2545   </listitem>
2546  </varlistentry>
2547  <varlistentry>
2548   <term>Default value:</term>
2549   <listitem>
2550    <para>None</para>
2551   </listitem>
2552  </varlistentry>
2553  <varlistentry>
2554   <term>Effect if unset:</term>
2555   <listitem>
2556    <para>
2557     Connections are not kept alive.
2558    </para>
2559   </listitem>
2560  </varlistentry>
2561  <varlistentry>
2562   <term>Notes:</term>
2563   <listitem>
2564    <para>
2565     This option allows clients to keep the connection to &my-app;
2566     alive. If the server supports it, &my-app; will keep
2567     the connection to the server alive as well. Under certain
2568     circumstances this may result in speed-ups.
2569    </para>
2570    <para>
2571     By default, &my-app; will close the connection to the server if
2572     the client connection gets closed, or if the specified timeout
2573     has been reached without a new request coming in. This behaviour
2574     can be changed with the <ulink
2575      url="#CONNECTION-SHARING">connection-sharing</ulink> option.
2576    </para>
2577    <para>
2578     This option has no effect if <application>Privoxy</application>
2579     has been compiled without keep-alive support.
2580    </para>
2581    <para>
2582     Note that a timeout of five seconds as used in the default
2583     configuration file significantly decreases the number of
2584     connections that will be reused. The value is used because
2585     some browsers limit the number of connections they open to
2586     a single host and apply the same limit to proxies. This can
2587     result in a single website <quote>grabbing</quote> all the
2588     connections the browser allows, which means connections to
2589     other websites can't be opened until the connections currently
2590     in use time out.
2591    </para>
2592    <para>
2593     Several users have reported this as a Privoxy bug, so the
2594     default value has been reduced. Consider increasing it to
2595     300 seconds or even more if you think your browser can handle
2596     it. If your browser appears to be hanging it can't.
2597    </para>
2598   </listitem>
2599  </varlistentry>
2600  <varlistentry>
2601   <term>Examples:</term>
2602   <listitem>
2603    <para>
2604     keep-alive-timeout 300
2605    </para>
2606   </listitem>
2607  </varlistentry>
2608 </variablelist>
2609 <![%config-file;[<literallayout>@@keep-alive-timeout 5</literallayout>]]>
2610 </sect3>
2611
2612
2613 <sect3 renderas="sect4" id="default-server-timeout"><title>default-server-timeout</title>
2614 <variablelist>
2615  <varlistentry>
2616   <term>Specifies:</term>
2617   <listitem>
2618    <para>
2619     Assumed server-side keep-alive timeout if not specified by the server.
2620    </para>
2621   </listitem>
2622  </varlistentry>
2623  <varlistentry>
2624   <term>Type of value:</term>
2625   <listitem>
2626    <para>
2627     <replaceable>Time in seconds.</replaceable>
2628    </para>
2629   </listitem>
2630  </varlistentry>
2631  <varlistentry>
2632   <term>Default value:</term>
2633   <listitem>
2634    <para>None</para>
2635   </listitem>
2636  </varlistentry>
2637  <varlistentry>
2638   <term>Effect if unset:</term>
2639   <listitem>
2640    <para>
2641     Connections for which the server didn't specify the keep-alive
2642     timeout are not reused.
2643    </para>
2644   </listitem>
2645  </varlistentry>
2646  <varlistentry>
2647   <term>Notes:</term>
2648   <listitem>
2649    <para>
2650     Enabling this option significantly increases the number of connections
2651     that are reused, provided the <ulink
2652      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> option
2653     is also enabled.
2654    </para>
2655    <para>
2656     While it also increases the number of connections problems
2657     when &my-app; tries to reuse a connection that already has
2658     been closed on the server side, or is closed while &my-app;
2659     is trying to reuse it, this should only be a problem if it
2660     happens for the first request sent by the client. If it happens
2661     for requests on reused client connections, &my-app; will simply
2662     close the connection and the client is supposed to retry the
2663     request without bothering the user.
2664    </para>
2665    <para>
2666     Enabling this option is therefore only recommended if the
2667     <ulink
2668      url="#CONNECTION-SHARING">connection-sharing</ulink> option
2669     is disabled.
2670    </para>
2671    <para>
2672     It is an error to specify a value larger than the <ulink
2673      url="#KEEP-ALIVE-TIMEOUT">keep-alive-timeout</ulink> value.
2674    </para>
2675    <para>
2676     This option has no effect if <application>Privoxy</application>
2677     has been compiled without keep-alive support.
2678    </para>
2679   </listitem>
2680  </varlistentry>
2681  <varlistentry>
2682   <term>Examples:</term>
2683   <listitem>
2684    <para>
2685     default-server-timeout 60
2686    </para>
2687   </listitem>
2688  </varlistentry>
2689 </variablelist>
2690 <![%config-file;[<literallayout>@@#default-server-timeout 60</literallayout>]]>
2691 </sect3>
2692
2693
2694 <sect3 renderas="sect4" id="connection-sharing"><title>connection-sharing</title>
2695 <variablelist>
2696  <varlistentry>
2697   <term>Specifies:</term>
2698   <listitem>
2699    <para>
2700     Whether or not outgoing connections that have been kept alive
2701     should be shared between different incoming connections.
2702    </para>
2703   </listitem>
2704  </varlistentry>
2705  <varlistentry>
2706   <term>Type of value:</term>
2707   <listitem>
2708    <para>
2709     <replaceable>0 or 1</replaceable>
2710    </para>
2711   </listitem>
2712  </varlistentry>
2713  <varlistentry>
2714   <term>Default value:</term>
2715   <listitem>
2716    <para>None</para>
2717   </listitem>
2718  </varlistentry>
2719  <varlistentry>
2720   <term>Effect if unset:</term>
2721   <listitem>
2722    <para>
2723     Connections are not shared.
2724    </para>
2725   </listitem>
2726  </varlistentry>
2727  <varlistentry>
2728   <term>Notes:</term>
2729   <listitem>
2730    <para>
2731     This option has no effect if <application>Privoxy</application>
2732     has been compiled without keep-alive support, or if it's disabled.
2733    </para>
2734   </listitem>
2735  </varlistentry>
2736  <varlistentry>
2737   <term>Notes:</term>
2738   <listitem>
2739    <para>
2740     Note that reusing connections doesn't necessary cause speedups.
2741     There are also a few privacy implications you should be aware of.
2742    </para>
2743    <para>
2744     If this option is effective, outgoing connections are shared between
2745     clients (if there are more than one) and closing the browser that initiated
2746     the outgoing connection does no longer affect the connection between &my-app;
2747     and the server unless the client's request hasn't been completed yet.
2748    </para>
2749    <para>
2750     If the outgoing connection  is idle, it will not be closed until either
2751     <application>Privoxy's</application> or the server's timeout is reached.
2752     While it's open, the server knows that the system running &my-app; is still
2753     there.
2754    </para>
2755    <para>
2756     If there are more than one client (maybe even belonging to multiple users),
2757     they will be able to reuse each others connections. This is potentially
2758     dangerous in case of authentication schemes like NTLM where only the
2759     connection is authenticated, instead of requiring authentication for
2760     each request.
2761    </para>
2762    <para>
2763     If there is only a single client, and if said client can keep connections
2764     alive on its own, enabling this option has next to no effect. If the client
2765     doesn't support connection keep-alive, enabling this option may make sense
2766     as it allows &my-app; to keep outgoing connections alive even if the client
2767     itself doesn't support it.
2768    </para>
2769    <para>
2770     You should also be aware that enabling this option increases the likelihood
2771     of getting the "No server or forwarder data" error message, especially if you
2772     are using a slow connection to the Internet.
2773    </para>
2774    <para>
2775     This option should only be used by experienced users who
2776     understand the risks and can weight them against the benefits.
2777    </para>
2778   </listitem>
2779  </varlistentry>
2780  <varlistentry>
2781   <term>Examples:</term>
2782   <listitem>
2783    <para>
2784     connection-sharing 1
2785    </para>
2786   </listitem>
2787  </varlistentry>
2788 </variablelist>
2789 <![%config-file;[<literallayout>@@#connection-sharing 1</literallayout>]]>
2790 </sect3>
2791
2792
2793 <sect3 renderas="sect4" id="socket-timeout"><title>socket-timeout</title>
2794 <variablelist>
2795  <varlistentry>
2796   <term>Specifies:</term>
2797   <listitem>
2798    <para>
2799     Number of seconds after which a socket times out if
2800     no data is received.
2801    </para>
2802   </listitem>
2803  </varlistentry>
2804  <varlistentry>
2805   <term>Type of value:</term>
2806   <listitem>
2807    <para>
2808     <replaceable>Time in seconds.</replaceable>
2809    </para>
2810   </listitem>
2811  </varlistentry>
2812  <varlistentry>
2813   <term>Default value:</term>
2814   <listitem>
2815    <para>None</para>
2816   </listitem>
2817  </varlistentry>
2818  <varlistentry>
2819   <term>Effect if unset:</term>
2820   <listitem>
2821    <para>
2822     A default value of 300 seconds is used.
2823    </para>
2824   </listitem>
2825  </varlistentry>
2826  <varlistentry>
2827   <term>Notes:</term>
2828   <listitem>
2829    <para>
2830     The default is quite high and you probably want to reduce it.
2831     If you aren't using an occasionally slow proxy like Tor, reducing
2832     it to a few seconds should be fine.
2833    </para>
2834   </listitem>
2835  </varlistentry>
2836  <varlistentry>
2837   <term>Examples:</term>
2838   <listitem>
2839    <para>
2840     socket-timeout 300
2841    </para>
2842   </listitem>
2843  </varlistentry>
2844 </variablelist>
2845 <![%config-file;[<literallayout>@@socket-timeout 300</literallayout>]]>
2846 </sect3>
2847
2848
2849 <sect3 renderas="sect4" id="max-client-connections"><title>max-client-connections</title>
2850 <variablelist>
2851  <varlistentry>
2852   <term>Specifies:</term>
2853   <listitem>
2854    <para>
2855     Maximum number of client connections that will be served.
2856    </para>
2857   </listitem>
2858  </varlistentry>
2859  <varlistentry>
2860   <term>Type of value:</term>
2861   <listitem>
2862    <para>
2863     <replaceable>Positive number.</replaceable>
2864    </para>
2865   </listitem>
2866  </varlistentry>
2867  <varlistentry>
2868   <term>Default value:</term>
2869   <listitem>
2870    <para>None</para>
2871   </listitem>
2872  </varlistentry>
2873  <varlistentry>
2874   <term>Effect if unset:</term>
2875   <listitem>
2876    <para>
2877     Connections are served until a resource limit is reached.
2878    </para>
2879   </listitem>
2880  </varlistentry>
2881  <varlistentry>
2882   <term>Notes:</term>
2883   <listitem>
2884    <para>
2885     &my-app; creates one thread (or process) for every incoming client
2886     connection that isn't rejected based on the access control settings.
2887    </para>
2888    <para>
2889     If the system is powerful enough, &my-app; can theoretically deal with
2890     several hundred (or thousand) connections at the same time, but some
2891     operating systems enforce resource limits by shutting down offending
2892     processes and their default limits may be below the ones &my-app; would
2893     require under heavy load.
2894    </para>
2895    <para>
2896     Configuring &my-app; to enforce a connection limit below the thread
2897     or process limit used by the operating system makes sure this doesn't
2898     happen. Simply increasing the operating system's limit would work too,
2899     but if &my-app; isn't the only application running on the system,
2900     you may actually want to limit the resources used by &my-app;.
2901    </para>
2902    <para>
2903     If &my-app; is only used by a single trusted user, limiting the
2904     number of client connections is probably unnecessary. If there
2905     are multiple possibly untrusted users you probably still want to
2906     additionally use a packet filter to limit the maximal number of
2907     incoming connections per client. Otherwise a malicious user could
2908     intentionally create a high number of connections to prevent other
2909     users from using &my-app;.
2910    </para>
2911    <para>
2912     Obviously using this option only makes sense if you choose a limit
2913     below the one enforced by the operating system.
2914    </para>
2915   </listitem>
2916  </varlistentry>
2917  <varlistentry>
2918   <term>Examples:</term>
2919   <listitem>
2920    <para>
2921     max-client-connections 256
2922    </para>
2923   </listitem>
2924  </varlistentry>
2925 </variablelist>
2926 <![%config-file;[<literallayout>@@#max-client-connections 256</literallayout>]]>
2927 </sect3>
2928
2929
2930 <sect3 renderas="sect4" id="handle-as-empty-doc-returns-ok"><title>handle-as-empty-doc-returns-ok</title>
2931 <variablelist>
2932  <varlistentry>
2933   <term>Specifies:</term>
2934   <listitem>
2935    <para>
2936     The status code Privoxy returns for pages blocked with
2937     <!--  URL will only end up in the user manual so the relative link should work. -->
2938     <literal><ulink url="actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">+handle-as-empty-document</ulink></literal>.
2939    </para>
2940   </listitem>
2941  </varlistentry>
2942  <varlistentry>
2943   <term>Type of value:</term>
2944   <listitem>
2945    <para>
2946     <replaceable>0 or 1</replaceable>
2947    </para>
2948   </listitem>
2949  </varlistentry>
2950  <varlistentry>
2951   <term>Default value:</term>
2952   <listitem>
2953    <para>0</para>
2954   </listitem>
2955  </varlistentry>
2956  <varlistentry>
2957   <term>Effect if unset:</term>
2958   <listitem>
2959    <para>
2960     Privoxy returns a status 403(forbidden) for all blocked pages.
2961    </para>
2962   </listitem>
2963  </varlistentry>
2964  <varlistentry>
2965   <term>Effect if set:</term>
2966   <listitem>
2967    <para>
2968     Privoxy returns a status 200(OK) for pages blocked with +handle-as-empty-document
2969     and a status 403(Forbidden) for all other blocked pages.
2970    </para>
2971   </listitem>
2972  </varlistentry>
2973  <varlistentry>
2974   <term>Notes:</term>
2975   <listitem>
2976    <para>
2977     This is a work-around for Firefox bug 492459:
2978     <quote>
2979     Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy.
2980     </quote>
2981     (<ulink url="https://bugzilla.mozilla.org/show_bug.cgi?id=492459"
2982         >https://bugzilla.mozilla.org/show_bug.cgi?id=492459</ulink>)
2983     As the bug has been fixed for quite some time this option should no longer
2984     be needed and will be removed in a future release. Please speak up if you
2985     have a reason why the option should be kept around.
2986    </para>
2987   </listitem>
2988  </varlistentry>
2989 </variablelist>
2990 <![%config-file;[<literallayout>@@#handle-as-empty-doc-returns-ok 1</literallayout>]]>
2991 </sect3>
2992
2993
2994 <sect3 renderas="sect4" id="enable-compression"><title>enable-compression</title>
2995 <variablelist>
2996  <varlistentry>
2997   <term>Specifies:</term>
2998   <listitem>
2999    <para>
3000     Whether or not buffered content is compressed before delivery.
3001    </para>
3002   </listitem>
3003  </varlistentry>
3004  <varlistentry>
3005   <term>Type of value:</term>
3006   <listitem>
3007    <para>
3008     <replaceable>0 or 1</replaceable>
3009    </para>
3010   </listitem>
3011  </varlistentry>
3012  <varlistentry>
3013   <term>Default value:</term>
3014   <listitem>
3015    <para>0</para>
3016   </listitem>
3017  </varlistentry>
3018  <varlistentry>
3019   <term>Effect if unset:</term>
3020   <listitem>
3021    <para>
3022     Privoxy does not compress buffered content.
3023    </para>
3024   </listitem>
3025  </varlistentry>
3026  <varlistentry>
3027   <term>Effect if set:</term>
3028   <listitem>
3029    <para>
3030     Privoxy compresses buffered content before delivering it to the client,
3031     provided the client supports it.
3032    </para>
3033   </listitem>
3034  </varlistentry>
3035  <varlistentry>
3036   <term>Notes:</term>
3037   <listitem>
3038    <para>
3039     This directive is only supported if Privoxy has been compiled with
3040     FEATURE_COMPRESSION, which should not to be confused with FEATURE_ZLIB.
3041    </para>
3042    <para>
3043     Compressing buffered content is mainly useful if Privoxy and the
3044     client are running on different systems. If they are running on the
3045     same system, enabling compression is likely to slow things down.
3046     If you didn't measure otherwise, you should assume that it does
3047     and keep this option disabled.
3048    </para>
3049    <para>
3050     Privoxy will not compress buffered content below a certain length.
3051    </para>
3052   </listitem>
3053  </varlistentry>
3054 </variablelist>
3055 <![%config-file;[<literallayout>@@#enable-compression 1</literallayout>]]>
3056 </sect3>
3057
3058
3059 </sect2>
3060
3061 <!--  ~  End section  ~  -->
3062
3063
3064 <!--   ~~~~~       New section      ~~~~~     -->
3065
3066 <sect2 id="windows-gui">
3067 <title>Windows GUI Options</title>
3068 <para>
3069  <application>Privoxy</application> has a number of options specific to the
3070  Windows GUI interface:
3071 </para>
3072
3073 <anchor id="activity-animation">
3074 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3075 <para>
3076  If <quote>activity-animation</quote> is set to 1, the
3077  <application>Privoxy</application> icon will animate when
3078  <quote>Privoxy</quote> is active. To turn off, set to 0.
3079 </para>
3080
3081 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
3082 <![%user-man;[
3083 <para>
3084  <literal>
3085   <msgtext>
3086    <literallayout>
3087   <emphasis>activity-animation   1</emphasis>
3088    </literallayout>
3089   </msgtext>
3090  </literal>
3091 </para>
3092 ]]>
3093
3094 <anchor id="log-messages">
3095 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3096 <para>
3097  If <quote>log-messages</quote> is set to 1,
3098  <application>Privoxy</application> will log messages to the console
3099  window:
3100 </para>
3101
3102 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
3103 <![%user-man;[
3104 <para>
3105  <literal>
3106   <msgtext>
3107    <literallayout>
3108   <emphasis>log-messages       1</emphasis>
3109    </literallayout>
3110   </msgtext>
3111  </literal>
3112 </para>
3113 ]]>
3114
3115 <anchor id="log-buffer-size">
3116 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3117 <para>
3118  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
3119  i.e. the amount of memory used for the log messages displayed in the
3120  console window, will be limited to <quote>log-max-lines</quote> (see below).
3121 </para>
3122
3123 <para>
3124  Warning: Setting this to 0 will result in the buffer to grow infinitely and
3125  eat up all your memory!
3126 </para>
3127
3128 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
3129 <![%user-man;[
3130 <para>
3131  <literal>
3132   <msgtext>
3133    <literallayout>
3134   <emphasis>log-buffer-size      1</emphasis>
3135    </literallayout>
3136   </msgtext>
3137  </literal>
3138 </para>
3139 ]]>
3140
3141 <anchor id="log-max-lines">
3142 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3143 <para>
3144  <application>log-max-lines</application> is the maximum number of lines held
3145  in the log buffer. See above.
3146 </para>
3147
3148 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
3149 <![%user-man;[
3150 <para>
3151  <literal>
3152   <msgtext>
3153    <literallayout>
3154   <emphasis>log-max-lines      200</emphasis>
3155    </literallayout>
3156   </msgtext>
3157  </literal>
3158 </para>
3159 ]]>
3160
3161 <anchor id="log-highlight-messages">
3162 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3163 <para>
3164  If <quote>log-highlight-messages</quote> is set to 1,
3165  <application>Privoxy</application> will highlight portions of the log
3166  messages with a bold-faced font:
3167 </para>
3168
3169 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
3170 <![%user-man;[
3171 <para>
3172  <literal>
3173   <msgtext>
3174    <literallayout>
3175   <emphasis>log-highlight-messages   1</emphasis>
3176    </literallayout>
3177   </msgtext>
3178  </literal>
3179 </para>
3180 ]]>
3181
3182 <anchor id="log-font-name">
3183 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3184 <para>
3185  The font used in the console window:
3186 </para>
3187
3188 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
3189 <![%user-man;[
3190 <para>
3191  <literal>
3192   <msgtext>
3193    <literallayout>
3194   <emphasis>log-font-name        Comic Sans MS</emphasis>
3195    </literallayout>
3196   </msgtext>
3197  </literal>
3198 </para>
3199 ]]>
3200
3201 <anchor id="log-font-size">
3202 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3203 <para>
3204  Font size used in the console window:
3205 </para>
3206
3207 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
3208 <![%user-man;[
3209 <para>
3210  <literal>
3211   <msgtext>
3212    <literallayout>
3213   <emphasis>log-font-size        8</emphasis>
3214    </literallayout>
3215   </msgtext>
3216  </literal>
3217 </para>
3218 ]]>
3219
3220 <anchor id="show-on-task-bar">
3221 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3222 <para>
3223  <quote>show-on-task-bar</quote> controls whether or not
3224  <application>Privoxy</application> will appear as a button on the Task bar
3225  when minimized:
3226 </para>
3227
3228 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
3229 <![%user-man;[
3230 <para>
3231  <literal>
3232   <msgtext>
3233    <literallayout>
3234   <emphasis>show-on-task-bar     0</emphasis>
3235    </literallayout>
3236   </msgtext>
3237  </literal>
3238 </para>
3239 ]]>
3240
3241 <anchor id="close-button-minimizes">
3242 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3243 <para>
3244  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
3245  button will minimize <application>Privoxy</application> instead of closing
3246  the program (close with the exit option on the File menu).
3247 </para>
3248
3249 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
3250 <![%user-man;[
3251 <para>
3252  <literal>
3253   <msgtext>
3254    <literallayout>
3255   <emphasis>close-button-minimizes  1</emphasis>
3256    </literallayout>
3257   </msgtext>
3258  </literal>
3259 </para>
3260 ]]>
3261
3262 <anchor id="hide-console">
3263 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
3264 <para>
3265  The <quote>hide-console</quote> option is specific to the MS-Win console
3266  version of <application>Privoxy</application>. If this option is used,
3267  <application>Privoxy</application> will disconnect from and hide the
3268  command console.
3269 </para>
3270
3271 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
3272 <![%user-man;[
3273 <para>
3274  <literal>
3275   <msgtext>
3276    <literallayout>
3277   #<emphasis>hide-console</emphasis>
3278    </literallayout>
3279   </msgtext>
3280  </literal>
3281 </para>
3282 ]]>
3283
3284 </sect2>
3285 </sect1>
3286
3287 <!-- end config content common to both outputs -->
3288
3289 <![%config-file;[
3290 <!-- These are dummy anchors to keep the processor quiet            -->
3291 <!-- when building config-file only (ie. they are used in u-m only) -->
3292 <sect1 label="">
3293 <title></title>
3294 <anchor id="filter">
3295 <anchor id="filter-file">
3296 <anchor id="regex">
3297 <anchor id="actions-file">
3298 <anchor id="af-patterns">
3299 </sect1>
3300 ]]>
3301
3302 <!-- eof p-config.sgml -->