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