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