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.10 2006/09/07 02:02:56 hal9 Exp $
   7
   8  Copyright (C) 2001-2006 Privoxy Developers <developers@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.10 2006/09/07 02:02:56 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    <para>
 527     When development goes modular and multi-user, the blocker, filter, and
 528     per-user config will be stored in subdirectories of <quote>confdir</quote>.
 529     For now, the configuration directory structure is flat, except for
 530     <filename>confdir/templates</filename>, where the HTML templates for CGI
 531     output reside (e.g. <application>Privoxy's</application> 404 error page).
 532    </para>
 533   </listitem>
 534  </varlistentry>
 535 </variablelist>
 536
 537 <![%config-file;[<literallayout>@@confdir .</literallayout>]]>
 538 </sect3>
 539
 540
 541 <!--   ~~~~~       New section      ~~~~~     -->
 542 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
 543
 544 <variablelist>
 545  <varlistentry>
 546   <term>Specifies:</term>
 547   <listitem>
 548    <para>
 549     The directory where all logging takes place (i.e. where <filename>logfile</filename> and
 550     <filename>jarfile</filename> are located)
 551    </para>
 552   </listitem>
 553  </varlistentry>
 554  <varlistentry>
 555   <term>Type of value:</term>
 556   <listitem>
 557    <para>Path name</para>
 558   </listitem>
 559  </varlistentry>
 560  <varlistentry>
 561   <term>Default value:</term>
 562   <listitem>
 563    <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
 564   </listitem>
 565  </varlistentry>
 566  <varlistentry>
 567   <term>Effect if unset:</term>
 568   <listitem>
 569    <para><emphasis>Mandatory</emphasis></para>
 570   </listitem>
 571  </varlistentry>
 572  <varlistentry>
 573   <term>Notes:</term>
 574   <listitem>
 575    <para>
 576     No trailing <quote><literal>/</literal></quote>, please
 577    </para>
 578   </listitem>
 579  </varlistentry>
 580 </variablelist>
 581
 582 <![%config-file;[<literallayout>@@logdir .</literallayout>]]>
 583 </sect3>
 584
 585
 586 <!--   ~~~~~       New section      ~~~~~     -->
 587 <sect3 renderas="sect4" id="actionsfile"><title>
 588 actionsfile
 589 </title>
 590 <anchor id="default.action">
 591 <anchor id="standard.action">
 592 <anchor id="user.action">
 593 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
 594 <variablelist>
 595  <varlistentry>
 596   <term>Specifies:</term>
 597   <listitem>
 598    <para>
 599     The <link linkend="actions-file">actions file(s)</link> to use
 600    </para>
 601   </listitem>
 602  </varlistentry>
 603  <varlistentry>
 604   <term>Type of value:</term>
 605   <listitem>
 606    <para>File name, relative to <literal>confdir</literal>, without the <literal>.action</literal> suffix</para>
 607   </listitem>
 608  </varlistentry>
 609  <varlistentry>
 610   <term>Default values:</term>
 611   <listitem>
 612    <simplelist>
 613     <member>
 614      <msgtext><literallayout>  standard     # Internal purposes, no editing recommended</literallayout></msgtext>
 615     </member>
 616     <member>
 617      <msgtext><literallayout>  default      # Main actions file</literallayout></msgtext>
 618     </member>
 619     <member>
 620      <msgtext><literallayout>  user         # User customizations</literallayout></msgtext>
 621     </member>
 622    </simplelist>
 623   </listitem>
 624  </varlistentry>
 625  <varlistentry>
 626   <term>Effect if unset:</term>
 627   <listitem>
 628    <para>
 629     No actions are taken at all. Simple neutral proxying.
 630    </para>
 631   </listitem>
 632  </varlistentry>
 633  <varlistentry>
 634   <term>Notes:</term>
 635   <listitem>
 636    <para>
 637     Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
 638    </para>
 639    <para>
 640     The default values include standard.action, which is used for internal
 641     purposes and should be loaded, default.action, which is the
 642     <quote>main</quote> actions file maintained by the developers, and
 643     <filename>user.action</filename>, where you can make your personal additions.
 644    </para>
 645    <para>
 646     Actions files are where all the per site and per URL configuration is done for
 647     ad blocking, cookie management, privacy considerations, etc.
 648     There is no point in using <application>Privoxy</application> without at
 649     least one actions file.
 650    </para>
 651   </listitem>
 652  </varlistentry>
 653 </variablelist>
 654
 655 <!-- NOTE: alternate markup to make a simpler list doesn't work due to -->
 656 <!-- html -> text conversion, blah -->
 657 <![%config-file;[<literallayout>@@actionsfile standard  # Internal purpose, recommended</literallayout>]]>
 658 <![%config-file;[<literallayout>@@actionsfile default   # Main actions file</literallayout>]]>
 659 <![%config-file;[<literallayout>@@actionsfile user      # User customizations</literallayout>]]>
 660 </sect3>
 661
 662 <!--   ~~~~~       New section      ~~~~~     -->
 663 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
 664 <anchor id="default.filter">
 665 <variablelist>
 666  <varlistentry>
 667   <term>Specifies:</term>
 668   <listitem>
 669    <para>
 670     The <link linkend="filter-file">filter file(s)</link> to use
 671    </para>
 672   </listitem>
 673  </varlistentry>
 674  <varlistentry>
 675   <term>Type of value:</term>
 676   <listitem>
 677    <para>File name, relative to <literal>confdir</literal></para>
 678   </listitem>
 679  </varlistentry>
 680  <varlistentry>
 681   <term>Default value:</term>
 682   <listitem>
 683    <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
 684   </listitem>
 685  </varlistentry>
 686  <varlistentry>
 687   <term>Effect if unset:</term>
 688   <listitem>
 689    <para>
 690     No textual content filtering takes place, i.e. all
 691     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 692     actions in the actions files are turned neutral.
 693    </para>
 694   </listitem>
 695  </varlistentry>
 696  <varlistentry>
 697   <term>Notes:</term>
 698   <listitem>
 699    <para>
 700     Multiple <literal>filterfile</literal> lines are permitted.
 701    </para>
 702    <para>
 703     The <link linkend="filter-file">filter files</link> contain content modification
 704     rules that use <link linkend="regex">regular expressions</link>. These rules permit
 705     powerful changes on the content of Web pages, and optionally the headers
 706     as well, e.g., you could disable your favorite JavaScript annoyances,
 707     re-write the actual displayed text, or just have some fun
 708     playing buzzword bingo with web pages.
 709    </para>
 710    <para>
 711     The
 712     <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
 713     actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
 714     to be defined in a filter file!
 715    </para>
 716    <para>
 717     A pre-defined filter file called <filename>default.filter</filename> that contains
 718     a number of useful filters for common problems is included in the distribution.
 719     See the section on the <literal><link linkend="filter">filter</link></literal>
 720     action for a list.
 721    </para>
 722    <para>
 723     It is recommended to place any locally adapted filters into a separate
 724     file, such as <filename>user.filter</filename>.
 725    </para>
 726   </listitem>
 727  </varlistentry>
 728 </variablelist>
 729
 730 <![%config-file;[<literallayout>@@filterfile default.filter</literallayout>]]>
 731 <![%config-file;[<literallayout>@@#filterfile user.filter      # User customizations</literallayout>]]>
 732 </sect3>
 733
 734
 735 <!--   ~~~~~       New section      ~~~~~     -->
 736 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
 737
 738 <variablelist>
 739  <varlistentry>
 740   <term>Specifies:</term>
 741   <listitem>
 742    <para>
 743     The log file to use
 744    </para>
 745   </listitem>
 746  </varlistentry>
 747  <varlistentry>
 748   <term>Type of value:</term>
 749   <listitem>
 750    <para>File name, relative to <literal>logdir</literal></para>
 751   </listitem>
 752  </varlistentry>
 753  <varlistentry>
 754   <term>Default value:</term>
 755   <listitem>
 756    <para>logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
 757   </listitem>
 758  </varlistentry>
 759  <varlistentry>
 760   <term>Effect if unset:</term>
 761   <listitem>
 762    <para>
 763     No log file is used, all log messages go to the console (<literal>STDERR</literal>).
 764    </para>
 765   </listitem>
 766  </varlistentry>
 767  <varlistentry>
 768   <term>Notes:</term>
 769   <listitem>
 770  <!--
 771   removed per bug report 688728 02/20/03 HB
 772
 773    <para>
 774     The windows version will additionally log to the console.
 775    </para>
 776   -->
 777    <para>
 778     The logfile is where all logging and error messages are written. The level
 779     of detail and number of messages are set with the <literal>debug</literal>
 780     option (see below). The logfile can be useful for tracking down a problem with
 781     <application>Privoxy</application> (e.g., it's not blocking an ad you
 782     think it should block) but in most cases you probably will never look at it.
 783    </para>
 784    <para>
 785     Your logfile will grow indefinitely, and you will probably want to
 786     periodically remove it.  On Unix systems, you can do this with a cron job
 787     (see <quote>man cron</quote>). For Red Hat, a <command>logrotate</command>
 788     script has been included.
 789    </para>
 790    <para>
 791     On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
 792     +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
 793     the effect that cron.daily will automatically archive, gzip, and empty the
 794     log, when it exceeds 1M size.
 795    </para>
 796    <para>
 797     Any log files must be writable by whatever user <application>Privoxy</application>
 798     is being run as (default on UNIX, user id is <quote>privoxy</quote>).
 799    </para>
 800   </listitem>
 801  </varlistentry>
 802 </variablelist>
 803
 804 <![%config-file;[<literallayout>@@logfile logfile</literallayout>]]>
 805 </sect3>
 806
 807
 808 <!--   ~~~~~       New section      ~~~~~     -->
 809 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
 810
 811 <variablelist>
 812  <varlistentry>
 813   <term>Specifies:</term>
 814   <listitem>
 815    <para>
 816     The file to store intercepted cookies in
 817    </para>
 818   </listitem>
 819  </varlistentry>
 820  <varlistentry>
 821   <term>Type of value:</term>
 822   <listitem>
 823    <para>File name, relative to <literal>logdir</literal></para>
 824   </listitem>
 825  </varlistentry>
 826  <varlistentry>
 827   <term>Default value:</term>
 828   <listitem>
 829    <para>Unset (commented out). When activated: jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
 830   </listitem>
 831  </varlistentry>
 832  <varlistentry>
 833   <term>Effect if unset:</term>
 834   <listitem>
 835    <para>
 836     Intercepted cookies are not stored in a dedicated log file.
 837    </para>
 838   </listitem>
 839  </varlistentry>
 840  <varlistentry>
 841   <term>Notes:</term>
 842   <listitem>
 843    <para>
 844     The jarfile may grow to ridiculous sizes over time.
 845    </para>
 846    <para>
 847     If debug 8 (show header parsing) is enabled, cookies are
 848     written to the logfile with the rest of the headers.
 849    </para>
 850   </listitem>
 851  </varlistentry>
 852 </variablelist>
 853
 854 <![%config-file;[<literallayout>@@#jarfile jarfile</literallayout>]]>
 855 </sect3>
 856
 857
 858 <!--   ~~~~~       New section      ~~~~~     -->
 859 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
 860 <variablelist>
 861  <varlistentry>
 862   <term>Specifies:</term>
 863   <listitem>
 864    <para>
 865     The trust file to use
 866    </para>
 867   </listitem>
 868  </varlistentry>
 869  <varlistentry>
 870   <term>Type of value:</term>
 871   <listitem>
 872    <para>File name, relative to <literal>confdir</literal></para>
 873   </listitem>
 874  </varlistentry>
 875  <varlistentry>
 876   <term>Default value:</term>
 877   <listitem>
 878    <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
 879   </listitem>
 880  </varlistentry>
 881  <varlistentry>
 882   <term>Effect if unset:</term>
 883   <listitem>
 884    <para>
 885     The entire trust mechanism is turned off.
 886    </para>
 887   </listitem>
 888  </varlistentry>
 889  <varlistentry>
 890   <term>Notes:</term>
 891   <listitem>
 892    <para>
 893     The trust mechanism is an experimental feature for building white-lists and should
 894     be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
 895    </para>
 896    <para>
 897     If you specify a trust file, <application>Privoxy</application> will only allow
 898     access to sites that are specified in the trustfile. Sites can be listed
 899     in one of two ways:
 900    </para>
 901    <para>
 902     Prepending a <literal>~</literal> character limits access to this site
 903     only (and any sub-paths within this site), e.g.
 904     <literal>~www.example.com</literal>.
 905    </para>
 906    <para>
 907     Or, you can designate sites as <emphasis>trusted referrers</emphasis>, by
 908     prepending the name with a <literal>+</literal> character. The effect is that
 909     access to untrusted sites will be granted -- but only if a link from this
 910     trusted referrer was used. The link target will then be added to the
 911     <quote>trustfile</quote> so that future, direct accesses will be granted.
 912     Sites added via this mechanism do not become trusted referrers themselves
 913     (i.e. they are added with a <literal>~</literal> designation).
 914    </para>
 915    <para>
 916     If you use the <literal>+</literal> operator in the trust file, it may grow
 917     considerably over time.
 918    </para>
 919    <para>
 920     It is recommended that <application>Privoxy</application> be compiled with
 921     the <literal>--disable-force</literal>, <literal>--disable-toggle</literal> and
 922     <literal> --disable-editor</literal> options, if this feature is to be
 923     used.
 924    </para>
 925    <para>
 926     Possible applications include limiting Internet access for children.
 927    </para>
 928
 929   </listitem>
 930  </varlistentry>
 931 </variablelist>
 932
 933 <![%config-file;[<literallayout>@@#trustfile trust</literallayout>]]>
 934 </sect3>
 935 </sect2>
 936
 937 <!--  ~  End section  ~  -->
 938
 939 <!--   ~~~~~       New section      ~~~~~     -->
 940 <sect2 id="debugging">
 941 <title>Debugging</title>
 942
 943  <para>
 944   These options are mainly useful when tracing a problem.
 945   Note that you might also want to invoke
 946   <application>Privoxy</application> with the <literal>--no-daemon</literal>
 947   command line option when debugging.
 948  </para>
 949
 950 <sect3 renderas="sect4" id="debug"><title>debug</title>
 951
 952 <variablelist>
 953  <varlistentry>
 954   <term>Specifies:</term>
 955   <listitem>
 956    <para>
 957     Key values that determine what information gets logged to the
 958     <link linkend="logfile"><emphasis>logfile</emphasis></link>.
 959    </para>
 960   </listitem>
 961  </varlistentry>
 962  <varlistentry>
 963   <term>Type of value:</term>
 964   <listitem>
 965    <para>Integer values</para>
 966   </listitem>
 967  </varlistentry>
 968  <varlistentry>
 969   <term>Default value:</term>
 970   <listitem>
 971    <para>12289 (i.e.: URLs plus informational and warning messages)</para>
 972   </listitem>
 973  </varlistentry>
 974  <varlistentry>
 975   <term>Effect if unset:</term>
 976   <listitem>
 977    <para>
 978     Nothing gets logged.
 979    </para>
 980   </listitem>
 981  </varlistentry>
 982  <varlistentry>
 983   <term>Notes:</term>
 984   <listitem>
 985    <para>
 986     The available debug levels are:
 987    </para>
 988    <para>
 989     <programlisting>
 990   debug         1 # show each GET/POST/CONNECT request
 991   debug         2 # show each connection status
 992   debug         4 # show I/O status
 993   debug         8 # show header parsing
 994   debug        16 # log all data into the logfile
 995   debug        32 # debug force feature
 996   debug        64 # debug regular expression filter
 997   debug       128 # debug fast redirects
 998   debug       256 # debug GIF de-animation
 999   debug       512 # Common Log Format
1000   debug      1024 # debug kill pop-ups
1001   debug      2048 # CGI user interface
1002   debug      4096 # Startup banner and warnings.
1003   debug      8192 # Non-fatal errors
1004 </programlisting>
1005    </para>
1006    <para>
1007     To select multiple debug levels, you can either add them or use
1008     multiple <literal>debug</literal> lines.
1009    </para>
1010    <para>
1011     A debug level of 1 is informative because it will show you each request
1012     as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
1013     so that you will notice when things go wrong. The other levels are probably
1014     only of interest if you are hunting down a specific problem. They can produce
1015     a hell of an output (especially 16).
1016     <!-- LOL -->
1017    </para>
1018    <para>
1019     The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which crash
1020     <application>Privoxy</application>) is always on and cannot be disabled.
1021    </para>
1022    <para>
1023     If you want to use CLF (Common Log Format), you should set <quote>debug
1024     512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
1025    </para>
1026   </listitem>
1027  </varlistentry>
1028 </variablelist>
1029
1030 <![%config-file;[<literallayout>@@debug   1    # show each GET/POST/CONNECT request</literallayout>]]>
1031 <![%config-file;[<literallayout>@@debug   4096 # Startup banner and warnings</literallayout>]]>
1032 <![%config-file;[<literallayout>@@debug   8192 # Errors - *we highly recommended enabling this*</literallayout>]]>
1033 </sect3>
1034
1035
1036 <!--   ~~~~~       New section      ~~~~~     -->
1037 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
1038
1039 <variablelist>
1040  <varlistentry>
1041   <term>Specifies:</term>
1042   <listitem>
1043    <para>
1044     Whether to run only one server thread
1045    </para>
1046   </listitem>
1047  </varlistentry>
1048  <varlistentry>
1049   <term>Type of value:</term>
1050   <listitem>
1051    <para><emphasis>None</emphasis></para>
1052   </listitem>
1053  </varlistentry>
1054  <varlistentry>
1055   <term>Default value:</term>
1056   <listitem>
1057    <para><emphasis>Unset</emphasis></para>
1058   </listitem>
1059  </varlistentry>
1060  <varlistentry>
1061   <term>Effect if unset:</term>
1062   <listitem>
1063    <para>
1064     Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
1065     serve multiple requests simultaneously.
1066    </para>
1067   </listitem>
1068  </varlistentry>
1069  <varlistentry>
1070   <term>Notes:</term>
1071   <listitem>
1072    <para>
1073     This option is only there for debug purposes and you should never
1074     need to use it. <emphasis>It will drastically reduce performance.</emphasis>
1075    </para>
1076   </listitem>
1077  </varlistentry>
1078 </variablelist>
1079
1080 <![%config-file;[<literallayout>@@#single-threaded</literallayout>]]>
1081 </sect3>
1082
1083 </sect2>
1084
1085 <!--  ~  End section  ~  -->
1086
1087
1088 <!--   ~~~~~       New section      ~~~~~     -->
1089 <sect2 id="access-control">
1090 <title>Access Control and Security</title>
1091
1092  <para>
1093   This section of the config file controls the security-relevant aspects
1094   of <application>Privoxy</application>'s configuration.
1095  </para>
1096
1097
1098 <!--   ~~~~~       New section      ~~~~~     -->
1099 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
1100
1101 <variablelist>
1102  <varlistentry>
1103   <term>Specifies:</term>
1104   <listitem>
1105    <para>
1106     The IP address and TCP port on which <application>Privoxy</application> will
1107     listen for client requests.
1108    </para>
1109   </listitem>
1110  </varlistentry>
1111  <varlistentry>
1112   <term>Type of value:</term>
1113   <listitem>
1114    <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
1115   </listitem>
1116  </varlistentry>
1117
1118  <varlistentry>
1119   <term>Default value:</term>
1120   <listitem>
1121    <para>127.0.0.1:8118</para>
1122   </listitem>
1123  </varlistentry>
1124  <varlistentry>
1125   <term>Effect if unset:</term>
1126   <listitem>
1127    <para>
1128     Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
1129     home users who run <application>Privoxy</application> on the same machine as
1130     their browser.
1131    </para>
1132   </listitem>
1133  </varlistentry>
1134  <varlistentry>
1135   <term>Notes:</term>
1136   <listitem>
1137    <para>
1138     You will need to configure your browser(s) to this proxy address and port.
1139    </para>
1140    <para>
1141     If you already have another service running on port 8118, or if you want to
1142     serve requests from other machines (e.g. on your local network) as well, you
1143     will need to override the default.
1144    </para>
1145    <para>
1146     If you leave out the IP address, <application>Privoxy</application> will
1147     bind to all interfaces (addresses) on your machine and may become reachable
1148     from the Internet. In that case, consider using <link
1149     linkend="acls">access control lists</link> (ACL's, see below), and/or
1150     a firewall.
1151    </para>
1152    <para>
1153     If you open <application>Privoxy</application> to untrusted users, you will
1154     also want to turn off the <literal><link
1155     linkend="enable-edit-actions">enable-edit-actions</link></literal> and
1156     <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
1157     options!
1158    </para>
1159   </listitem>
1160  </varlistentry>
1161  <varlistentry>
1162   <term>Example:</term>
1163   <listitem>
1164    <para>
1165      Suppose you are running <application>Privoxy</application> on
1166      a machine which has the address 192.168.0.1 on your local private network
1167      (192.168.0.0) and has another outside connection with a different address.
1168      You want it to serve requests from inside only:
1169    </para>
1170    <para>
1171     <programlisting>
1172   listen-address  192.168.0.1:8118
1173 </programlisting>
1174    </para>
1175   </listitem>
1176  </varlistentry>
1177 </variablelist>
1178
1179 <![%config-file;[<literallayout>@@listen-address  127.0.0.1:8118</literallayout>]]>
1180 </sect3>
1181
1182
1183 <!--   ~~~~~       New section      ~~~~~     -->
1184 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
1185
1186 <variablelist>
1187  <varlistentry>
1188   <term>Specifies:</term>
1189   <listitem>
1190    <para>
1191     Initial state of "toggle" status
1192    </para>
1193   </listitem>
1194  </varlistentry>
1195  <varlistentry>
1196   <term>Type of value:</term>
1197   <listitem>
1198    <para>1 or 0</para>
1199   </listitem>
1200  </varlistentry>
1201  <varlistentry>
1202   <term>Default value:</term>
1203   <listitem>
1204    <para>1</para>
1205   </listitem>
1206  </varlistentry>
1207  <varlistentry>
1208   <term>Effect if unset:</term>
1209   <listitem>
1210    <para>
1211     Act as if toggled on
1212    </para>
1213   </listitem>
1214  </varlistentry>
1215  <varlistentry>
1216   <term>Notes:</term>
1217   <listitem>
1218    <para>
1219     If set to 0, <application>Privoxy</application> will start in
1220     <quote>toggled off</quote> mode, i.e. behave like a normal, content-neutral
1221     proxy where all ad blocking, filtering, etc are disabled. See
1222     <literal>enable-remote-toggle</literal> below. This is not really useful
1223     anymore, since toggling is much easier via <ulink
1224     url="http://config.privoxy.org/toggle">the web interface</ulink> than via
1225     editing the <filename>conf</filename> file.
1226    </para>
1227    <para>
1228     The windows version will only display the toggle icon in the system tray
1229     if this option is present.
1230    </para>
1231   </listitem>
1232  </varlistentry>
1233 </variablelist>
1234
1235 <![%config-file;[<literallayout>@@toggle  1</literallayout>]]>
1236 </sect3>
1237
1238
1239 <!--   ~~~~~       New section      ~~~~~     -->
1240 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
1241 <variablelist>
1242  <varlistentry>
1243   <term>Specifies:</term>
1244   <listitem>
1245    <para>
1246     Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
1247     feature</ulink> may be used
1248    </para>
1249   </listitem>
1250  </varlistentry>
1251  <varlistentry>
1252   <term>Type of value:</term>
1253   <listitem>
1254    <para>0 or 1</para>
1255   </listitem>
1256  </varlistentry>
1257  <varlistentry>
1258   <term>Default value:</term>
1259   <listitem>
1260    <para>1</para>
1261   </listitem>
1262  </varlistentry>
1263  <varlistentry>
1264   <term>Effect if unset:</term>
1265   <listitem>
1266    <para>
1267     The web-based toggle feature is disabled.
1268    </para>
1269   </listitem>
1270  </varlistentry>
1271  <varlistentry>
1272   <term>Notes:</term>
1273   <listitem>
1274    <para>
1275     When toggled off, <application>Privoxy</application> acts like a normal,
1276     content-neutral proxy, i.e. it acts as if none of the actions applied to
1277     any URL.
1278    </para>
1279    <para>
1280     For the time being, access to the toggle feature can <emphasis>not</emphasis> be
1281     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1282     so that everybody who can access <application>Privoxy</application> (see
1283     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1284     toggle it for all users. So this option is <emphasis>not recommended</emphasis>
1285     for multi-user environments with untrusted users.
1286    </para>
1287    <para>
1288     Note that you must have compiled <application>Privoxy</application> with
1289     support for this feature, otherwise this option has no effect.
1290    </para>
1291   </listitem>
1292  </varlistentry>
1293 </variablelist>
1294
1295 <![%config-file;[<literallayout>@@enable-remote-toggle  1</literallayout>]]>
1296 </sect3>
1297
1298
1299 <!--   ~~~~~       New section      ~~~~~     -->
1300 <sect3 renderas="sect4" id="enable-remote-http-toggle"><title>enable-remote-http-toggle</title>
1301 <variablelist>
1302  <varlistentry>
1303   <term>Specifies:</term>
1304   <listitem>
1305    <para>
1306     Whether or not Privoxy recognizes special HTTP headers to change its behaviour.
1307    </para>
1308   </listitem>
1309  </varlistentry>
1310  <varlistentry>
1311   <term>Type of value:</term>
1312   <listitem>
1313    <para>0 or 1</para>
1314   </listitem>
1315  </varlistentry>
1316  <varlistentry>
1317   <term>Default value:</term>
1318   <listitem>
1319    <para>1</para>
1320   </listitem>
1321  </varlistentry>
1322  <varlistentry>
1323   <term>Effect if unset:</term>
1324   <listitem>
1325    <para>
1326     Privoxy ignores special HTTP headers.
1327    </para>
1328   </listitem>
1329  </varlistentry>
1330  <varlistentry>
1331   <term>Notes:</term>
1332   <listitem>
1333    <para>
1334     When toggled on, the client can change <application>Privoxy's</application>
1335     behaviour by setting special HTTP headers. Currently the only supported
1336     special header is <quote>X-Filter: No</quote>, to disable filtering for
1337     the ongoing request, even if it is enabled in one of the action files.
1338    </para>
1339    <para>
1340     If you are using <application>Privoxy</application> in a
1341     multi-user environment or with untrustworthy clients and want to
1342     enforce filtering, you will have to disable this option,
1343     otherwise you can ignore it.
1344    </para>
1345   </listitem>
1346  </varlistentry>
1347 </variablelist>
1348
1349 <![%config-file;[<literallayout>@@enable-remote-http-toggle  1</literallayout>]]>
1350 </sect3>
1351
1352
1353 <!--   ~~~~~       New section      ~~~~~     -->
1354 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
1355 <variablelist>
1356  <varlistentry>
1357   <term>Specifies:</term>
1358   <listitem>
1359    <para>
1360     Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
1361     file editor</ulink> may be used
1362    </para>
1363   </listitem>
1364  </varlistentry>
1365  <varlistentry>
1366   <term>Type of value:</term>
1367   <listitem>
1368    <para>0 or 1</para>
1369   </listitem>
1370  </varlistentry>
1371  <varlistentry>
1372   <term>Default value:</term>
1373   <listitem>
1374    <para>1</para>
1375   </listitem>
1376  </varlistentry>
1377  <varlistentry>
1378   <term>Effect if unset:</term>
1379   <listitem>
1380    <para>
1381     The web-based actions file editor is disabled.
1382    </para>
1383   </listitem>
1384  </varlistentry>
1385  <varlistentry>
1386   <term>Notes:</term>
1387   <listitem>
1388    <para>
1389     For the time being, access to the editor can <emphasis>not</emphasis> be
1390     controlled separately by <quote>ACLs</quote> or HTTP authentication,
1391     so that everybody who can access <application>Privoxy</application> (see
1392     <quote>ACLs</quote> and <literal>listen-address</literal> above) can
1393     modify its configuration for all users. So this option is <emphasis>not
1394     recommended</emphasis> for multi-user environments with untrusted users.
1395    </para>
1396    <para>
1397     Note that you must have compiled <application>Privoxy</application> with
1398     support for this feature, otherwise this option has no effect.
1399    </para>
1400   </listitem>
1401  </varlistentry>
1402 </variablelist>
1403
1404 <![%config-file;[<literallayout>@@enable-edit-actions 1</literallayout>]]>
1405 </sect3>
1406
1407 <!--   ~~~~~       New section      ~~~~~     -->
1408 <sect3 renderas="sect4" id="acls"><title>
1409 ACLs: permit-access and deny-access</title>
1410 <anchor id="permit-access">
1411 <anchor id="deny-access">
1412
1413 <variablelist>
1414  <varlistentry>
1415   <term>Specifies:</term>
1416   <listitem>
1417    <para>
1418     Who can access what.
1419    </para>
1420   </listitem>
1421  </varlistentry>
1422  <varlistentry>
1423   <term>Type of value:</term>
1424   <listitem>
1425    <para>
1426     <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
1427     [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
1428    </para>
1429    <para>
1430     Where <replaceable class="parameter">src_addr</replaceable> and
1431    <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
1432     DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
1433     <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
1434     values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
1435     destination part are optional.
1436    </para>
1437   </listitem>
1438  </varlistentry>
1439  <varlistentry>
1440   <term>Default value:</term>
1441   <listitem>
1442    <para><emphasis>Unset</emphasis></para>
1443   </listitem>
1444  </varlistentry>
1445  <varlistentry>
1446   <term>Effect if unset:</term>
1447   <listitem>
1448    <para>
1449     Don't restrict access further than implied by <literal>listen-address</literal>
1450    </para>
1451   </listitem>
1452  </varlistentry>
1453  <varlistentry>
1454   <term>Notes:</term>
1455   <listitem>
1456    <para>
1457     Access controls are included at the request of ISPs and systems
1458     administrators, and <emphasis>are not usually needed by individual users</emphasis>.
1459     For a typical home user, it will normally suffice to ensure that
1460     <application>Privoxy</application> only listens on the localhost
1461     (127.0.0.1) or internal (home) network address by means of the
1462     <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
1463     option.
1464    </para>
1465    <para>
1466     Please see the warnings in the FAQ that this proxy is not intended to be a substitute
1467     for a firewall or to encourage anyone to defer addressing basic security
1468     weaknesses.
1469    </para>
1470    <para>
1471     Multiple ACL lines are OK.
1472     If any ACLs are specified, then the <application>Privoxy</application>
1473     talks only to IP addresses that match at least one <literal>permit-access</literal> line
1474     and don't match any subsequent <literal>deny-access</literal> line. In other words, the
1475     last match wins, with the default being <literal>deny-access</literal>.
1476    </para>
1477    <para>
1478     If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
1479     for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
1480     that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
1481     of the ultimate target. This is necessary because it may be impossible for the local
1482     <application>Privoxy</application> to determine the IP address of the
1483     ultimate target (that's often what gateways are used for).
1484    </para>
1485    <para>
1486     You should prefer using IP addresses over DNS names, because the address lookups take
1487     time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
1488     like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
1489     IP addresses, only the first one is used.
1490    </para>
1491    <para>
1492     Denying access to particular sites by ACL may have undesired side effects
1493     if the site in question is hosted on a machine which also hosts other sites.
1494    </para>
1495   </listitem>
1496  </varlistentry>
1497  <varlistentry>
1498   <term>Examples:</term>
1499   <listitem>
1500    <para>
1501     Explicitly define the default behavior if no ACL and
1502     <literal>listen-address</literal> are set: <quote>localhost</quote>
1503     is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
1504     <emphasis>all</emphasis> destination addresses are OK:
1505    </para>
1506    <para>
1507     <screen>
1508   permit-access  localhost
1509 </screen>
1510    </para>
1511    <para>
1512     Allow any host on the same class C subnet as www.privoxy.org access to
1513     nothing but www.example.com:
1514    </para>
1515    <para>
1516     <screen>
1517   permit-access  www.privoxy.org/24 www.example.com/32
1518 </screen>
1519    </para>
1520    <para>
1521     Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
1522     with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com:
1523    </para>
1524    <para>
1525     <screen>
1526   permit-access  192.168.45.64/26
1527   deny-access    192.168.45.73    www.dirty-stuff.example.com
1528 </screen>
1529    </para>
1530   </listitem>
1531  </varlistentry>
1532 </variablelist>
1533 </sect3>
1534
1535
1536 <!--   ~~~~~       New section      ~~~~~     -->
1537 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
1538
1539 <variablelist>
1540  <varlistentry>
1541   <term>Specifies:</term>
1542   <listitem>
1543    <para>
1544     Maximum size of the buffer for content filtering.
1545    </para>
1546   </listitem>
1547  </varlistentry>
1548  <varlistentry>
1549   <term>Type of value:</term>
1550   <listitem>
1551    <para>Size in Kbytes</para>
1552   </listitem>
1553  </varlistentry>
1554  <varlistentry>
1555   <term>Default value:</term>
1556   <listitem>
1557    <para>4096</para>
1558   </listitem>
1559  </varlistentry>
1560  <varlistentry>
1561   <term>Effect if unset:</term>
1562   <listitem>
1563    <para>
1564     Use a 4MB (4096 KB) limit.
1565    </para>
1566   </listitem>
1567  </varlistentry>
1568  <varlistentry>
1569   <term>Notes:</term>
1570   <listitem>
1571    <para>
1572     For content filtering, i.e. the <literal>+filter</literal> and
1573     <literal>+deanimate-gif</literal> actions, it is necessary that
1574     <application>Privoxy</application> buffers the entire document body.
1575     This can be potentially dangerous, since a server could just keep sending
1576     data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
1577     Hence this option.
1578    </para>
1579    <para>
1580     When a document buffer size reaches the <literal>buffer-limit</literal>, it is
1581     flushed to the client unfiltered and no further attempt to
1582     filter the rest of the document is made. Remember that there may be multiple threads
1583     running, which might require up to <literal>buffer-limit</literal> Kbytes
1584     <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
1585     above.
1586    </para>
1587   </listitem>
1588  </varlistentry>
1589 </variablelist>
1590
1591 <![%config-file;[<literallayout>@@buffer-limit 4096</literallayout>]]>
1592 </sect3>
1593
1594 </sect2>
1595
1596 <!--  ~  End section  ~  -->
1597
1598
1599 <!--   ~~~~~       New section      ~~~~~     -->
1600
1601 <sect2 id="forwarding">
1602 <title>Forwarding</title>
1603
1604 <para>
1605  This feature allows routing of HTTP requests through a chain of
1606  multiple proxies.
1607  It can be used to better protect privacy and confidentiality when
1608  accessing specific domains by routing requests to those domains
1609  through an anonymous public proxy (see e.g. <ulink
1610  url="http://www.multiproxy.org/anon_list.htm">http://www.multiproxy.org/anon_list.htm</ulink>)
1611  Or to use a caching proxy to speed up browsing. Or chaining to a parent
1612  proxy may be necessary because the machine that <application>Privoxy</application>
1613  runs on has no direct Internet access.
1614 </para>
1615
1616 <para>
1617  Also specified here are SOCKS proxies. <application>Privoxy</application>
1618  supports the SOCKS 4 and SOCKS 4A protocols.
1619 </para>
1620
1621 <sect3 renderas="sect4" id="forward"><title>forward</title>
1622 <variablelist>
1623  <varlistentry>
1624   <term>Specifies:</term>
1625   <listitem>
1626    <para>
1627     To which parent HTTP proxy specific requests should be routed.
1628    </para>
1629   </listitem>
1630  </varlistentry>
1631  <varlistentry>
1632   <term>Type of value:</term>
1633   <listitem>
1634    <para>
1635     <replaceable class="parameter">target_pattern</replaceable>
1636     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1637    </para>
1638    <para>
1639     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1640     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1641     denote <quote>all URLs</quote>.
1642     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1643     is the DNS name or IP address of the parent HTTP proxy through which the requests should be forwarded,
1644     optionally followed by its listening port (default: 8080).
1645     Use a single dot (<literal>.</literal>) to denote <quote>no forwarding</quote>.
1646    </para>
1647   </listitem>
1648  </varlistentry>
1649  <varlistentry>
1650   <term>Default value:</term>
1651   <listitem>
1652    <para><emphasis>Unset</emphasis></para>
1653   </listitem>
1654  </varlistentry>
1655  <varlistentry>
1656   <term>Effect if unset:</term>
1657   <listitem>
1658    <para>
1659     Don't use parent HTTP proxies.
1660    </para>
1661   </listitem>
1662  </varlistentry>
1663  <varlistentry>
1664   <term>Notes:</term>
1665   <listitem>
1666    <para>
1667     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1668     forwarded to another HTTP proxy but are made directly to the web servers.
1669    </para>
1670    <para>
1671     Multiple lines are OK, they are checked in sequence, and the last match wins.
1672    </para>
1673   </listitem>
1674  </varlistentry>
1675  <varlistentry>
1676   <term>Examples:</term>
1677   <listitem>
1678    <para>
1679     Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle):
1680    </para>
1681    <para>
1682     <screen>
1683   forward   /      anon-proxy.example.org:8080
1684   forward   :443   .
1685 </screen>
1686    </para>
1687    <para>
1688     Everything goes to our example ISP's caching proxy, except for requests
1689     to that ISP's sites:
1690    </para>
1691    <para>
1692     <screen>
1693   forward   /                  caching-proxy.example-isp.net:8000
1694   forward   .example-isp.net   .
1695 </screen>
1696    </para>
1697   </listitem>
1698  </varlistentry>
1699 </variablelist>
1700 </sect3>
1701
1702
1703 <!--   ~~~~~       New section      ~~~~~     -->
1704 <sect3 renderas="sect4" id="socks"><title>
1705 forward-socks4 and forward-socks4a</title>
1706 <anchor id="forward-socks4">
1707 <anchor id="forward-socks4a">
1708
1709 <variablelist>
1710  <varlistentry>
1711   <term>Specifies:</term>
1712   <listitem>
1713    <para>
1714     Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed.
1715    </para>
1716   </listitem>
1717  </varlistentry>
1718  <varlistentry>
1719   <term>Type of value:</term>
1720   <listitem>
1721    <para>
1722     <replaceable class="parameter">target_pattern</replaceable>
1723     <replaceable class="parameter">socks_proxy</replaceable>[:<replaceable class="parameter">port</replaceable>]
1724     <replaceable class="parameter">http_parent</replaceable>[:<replaceable class="parameter">port</replaceable>]
1725    </para>
1726    <para>
1727     where <replaceable class="parameter">target_pattern</replaceable> is a <link linkend="af-patterns">URL pattern</link>
1728     that specifies to which requests (i.e. URLs) this forward rule shall apply. Use <literal>/</literal> to
1729     denote <quote>all URLs</quote>.
1730     <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
1731     are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
1732     may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
1733     <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
1734    </para>
1735   </listitem>
1736  </varlistentry>
1737  <varlistentry>
1738   <term>Default value:</term>
1739   <listitem>
1740    <para><emphasis>Unset</emphasis></para>
1741   </listitem>
1742  </varlistentry>
1743  <varlistentry>
1744   <term>Effect if unset:</term>
1745   <listitem>
1746    <para>
1747     Don't use SOCKS proxies.
1748    </para>
1749   </listitem>
1750  </varlistentry>
1751  <varlistentry>
1752   <term>Notes:</term>
1753   <listitem>
1754    <para>
1755     Multiple lines are OK, they are checked in sequence, and the last match wins.
1756    </para>
1757    <para>
1758     The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
1759     is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
1760     server, while in SOCKS 4 it happens locally.
1761    </para>
1762    <para>
1763     If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
1764     forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
1765     a SOCKS proxy.
1766    </para>
1767   </listitem>
1768  </varlistentry>
1769  <varlistentry>
1770   <term>Examples:</term>
1771   <listitem>
1772    <para>
1773      From the company example.com, direct connections are made to all
1774      <quote>internal</quote> domains, but everything outbound goes through
1775      their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
1776      the Internet.
1777    </para>
1778    <para>
1779     <screen>
1780   forward-socks4a   /              socks-gw.example.com:1080  www-cache.example-isp.net:8080
1781   forward           .example.com   .
1782 </screen>
1783    </para>
1784    <para>
1785     A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
1786    </para>
1787    <para>
1788     <screen>
1789   forward-socks4   /               socks-gw.example.com:1080  .
1790 </screen>
1791    </para>
1792
1793     <para>
1794     To chain Privoxy and Tor, both running on the same system, you should use
1795     the rule:
1796    </para>
1797    <para>
1798     <screen>
1799   forward-socks4   /               127.0.0.1:9050 .
1800 </screen>
1801    </para>
1802
1803     <para>
1804     The public <application>Tor</application> network can't be used to reach your local network,
1805     therefore it's a good idea to make some exceptions:
1806    </para>
1807    <para>
1808     <screen>
1809   forward         192.168.*.*/     .
1810   forward            10.*.*.*/     .
1811   forward           127.*.*.*/     .
1812 </screen>
1813    </para>
1814    <para>
1815     Unencrypted connections to systems in these address ranges will
1816     be as (un)secure as the local network is, but the alternative is that you
1817     can't reach the network at all.
1818    </para>
1819    <para>
1820     If you also want to be able to reach servers in your local network by
1821     using their names, you will need additional exceptions that look like
1822     this:
1823    </para>
1824    <para>
1825     <screen>
1826  forward           localhost/     .
1827 </screen>
1828    </para>
1829
1830   </listitem>
1831  </varlistentry>
1832 </variablelist>
1833 </sect3>
1834
1835 <![%user-man;[     <!-- not included in config due to length -->
1836 <!--   ~~~~~       New section      ~~~~~     -->
1837 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
1838
1839 <para>
1840  If you have links to multiple ISPs that provide various special content
1841  only to their subscribers, you can configure multiple <application>Privoxies</application>
1842  which have connections to the respective ISPs to act as forwarders to each other, so that
1843  <emphasis>your</emphasis> users can see the internal content of all ISPs.
1844 </para>
1845
1846 <para>
1847  Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
1848  isp-b.net. Both run <application>Privoxy</application>. Their forwarding
1849  configuration can look like this:
1850 </para>
1851
1852 <para>
1853  host-a:
1854 </para>
1855
1856 <para>
1857  <screen>
1858   forward    /           .
1859   forward    .isp-b.net  host-b:8118
1860 </screen>
1861 </para>
1862
1863 <para>
1864  host-b:
1865 </para>
1866
1867 <para>
1868  <screen>
1869   forward    /           .
1870   forward    .isp-a.net  host-a:8118
1871 </screen>
1872 </para>
1873
1874 <para>
1875  Now, your users can set their browser's proxy to use either
1876  host-a or host-b and be able to browse the internal content
1877  of both isp-a and isp-b.
1878 </para>
1879
1880 <para>
1881  If you intend to chain <application>Privoxy</application> and
1882  <application>squid</application> locally, then chain as
1883  <literal>browser -> squid -> privoxy</literal> is the recommended way.
1884 </para>
1885
1886 <para>
1887  Assuming that <application>Privoxy</application> and <application>squid</application>
1888  run on the same box, your <application>squid</application> configuration could then look like this:
1889 </para>
1890
1891 <para>
1892  <screen>
1893   # Define Privoxy as parent proxy (without ICP)
1894   cache_peer 127.0.0.1 parent 8118 7 no-query
1895
1896   # Define ACL for protocol FTP
1897   acl ftp proto FTP
1898
1899   # Do not forward FTP requests to Privoxy
1900   always_direct allow ftp
1901
1902   # Forward all the rest to Privoxy
1903   never_direct allow all</screen>
1904 </para>
1905
1906 <para>
1907  You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
1908  Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
1909 </para>
1910
1911 <para>
1912  You could just as well decide to only forward requests for Windows executables through
1913  a virus-scanning parent proxy, say, on <literal>antivir.example.com</literal>, port 8010:
1914 </para>
1915
1916 <para>
1917  <screen>
1918   forward   /                          .
1919   forward   /.*\.(exe|com|dll|zip)$    antivir.example.com:8010</screen>
1920 </para>
1921
1922 </sect3>
1923 ]]>
1924
1925 <sect3 renderas="sect4" id="forwarded-connect-retries"><title>forwarded-connect-retries</title>
1926 <variablelist>
1927  <varlistentry>
1928   <term>Specifies:</term>
1929   <listitem>
1930    <para>
1931     How often Privoxy retries if a forwarded connection request fails.
1932    </para>
1933   </listitem>
1934  </varlistentry>
1935  <varlistentry>
1936   <term>Type of value:</term>
1937   <listitem>
1938    <para>
1939     <replaceable class="parameter">Number of retries.</replaceable>
1940    </para>
1941   </listitem>
1942  </varlistentry>
1943  <varlistentry>
1944   <term>Default value:</term>
1945   <listitem>
1946    <para><emphasis>0</emphasis></para>
1947   </listitem>
1948  </varlistentry>
1949  <varlistentry>
1950   <term>Effect if unset:</term>
1951   <listitem>
1952    <para>
1953     Forwarded connections are treated like direct connections and no retry attempts are made.
1954    </para>
1955   </listitem>
1956  </varlistentry>
1957  <varlistentry>
1958   <term>Notes:</term>
1959   <listitem>
1960    <para>
1961     <replaceable class="parameter">forwarded-connect-retries</replaceable> is mainly interesting
1962     for socks4a connections, where Privoxy can't detect why the connections failed.
1963     The connection might have failed because of a DNS timeout in which case a retry makes sense,
1964     but it might also have failed because the server doesn't exist or isn't reachable. In this
1965     case the retry will just delay the appearance of Privoxy's error message.
1966    </para>
1967    <para>
1968     Only use this option, if you are getting many forwarding related error messages,
1969     that go away when you try again manually. Start with a small value and check Privoxy's
1970     logfile from time to time, to see how many retries are usually needed.
1971    </para>
1972   </listitem>
1973  </varlistentry>
1974  <varlistentry>
1975   <term>Examples:</term>
1976   <listitem>
1977    <para>
1978     forwarded-connect-retries 1
1979    </para>
1980   </listitem>
1981  </varlistentry>
1982 </variablelist>
1983 <![%config-file;[<literallayout>@@forwarded-connect-retries  0</literallayout>]]>
1984 </sect3>
1985
1986 </sect2>
1987
1988 <!--  ~  End section  ~  -->
1989
1990
1991 <!--   ~~~~~       New section      ~~~~~     -->
1992
1993 <sect2 id="windows-gui">
1994 <title>Windows GUI Options</title>
1995 <para>
1996  <application>Privoxy</application> has a number of options specific to the
1997  Windows GUI interface:
1998 </para>
1999
2000 <anchor id="activity-animation">
2001 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2002 <para>
2003  If <quote>activity-animation</quote> is set to 1, the
2004  <application>Privoxy</application> icon will animate when
2005  <quote>Privoxy</quote> is active. To turn off, set to 0.
2006 </para>
2007
2008 <![%config-file;[<literallayout>@@#activity-animation   1</literallayout>]]>
2009 <![%user-man;[
2010 <para>
2011  <literal>
2012   <msgtext>
2013    <literallayout>
2014   <emphasis>activity-animation   1</emphasis>
2015    </literallayout>
2016   </msgtext>
2017  </literal>
2018 </para>
2019 ]]>
2020
2021 <anchor id="log-messages">
2022 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2023 <para>
2024  If <quote>log-messages</quote> is set to 1,
2025  <application>Privoxy</application> will log messages to the console
2026  window:
2027 </para>
2028
2029 <![%config-file;[<literallayout>@@#log-messages   1</literallayout>]]>
2030 <![%user-man;[
2031 <para>
2032  <literal>
2033   <msgtext>
2034    <literallayout>
2035   <emphasis>log-messages       1</emphasis>
2036    </literallayout>
2037   </msgtext>
2038  </literal>
2039 </para>
2040 ]]>
2041
2042 <anchor id="log-buffer-size">
2043 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2044 <para>
2045  If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2046  i.e. the amount of memory used for the log messages displayed in the
2047  console window, will be limited to <quote>log-max-lines</quote> (see below).
2048 </para>
2049
2050 <para>
2051  Warning: Setting this to 0 will result in the buffer to grow infinitely and
2052  eat up all your memory!
2053 </para>
2054
2055 <![%config-file;[<literallayout>@@#log-buffer-size 1</literallayout>]]>
2056 <![%user-man;[
2057 <para>
2058  <literal>
2059   <msgtext>
2060    <literallayout>
2061   <emphasis>log-buffer-size      1</emphasis>
2062    </literallayout>
2063   </msgtext>
2064  </literal>
2065 </para>
2066 ]]>
2067
2068 <anchor id="log-max-lines">
2069 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2070 <para>
2071  <application>log-max-lines</application> is the maximum number of lines held
2072  in the log buffer. See above.
2073 </para>
2074
2075 <![%config-file;[<literallayout>@@#log-max-lines 200</literallayout>]]>
2076 <![%user-man;[
2077 <para>
2078  <literal>
2079   <msgtext>
2080    <literallayout>
2081   <emphasis>log-max-lines      200</emphasis>
2082    </literallayout>
2083   </msgtext>
2084  </literal>
2085 </para>
2086 ]]>
2087
2088 <anchor id="log-highlight-messages">
2089 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2090 <para>
2091  If <quote>log-highlight-messages</quote> is set to 1,
2092  <application>Privoxy</application> will highlight portions of the log
2093  messages with a bold-faced font:
2094 </para>
2095
2096 <![%config-file;[<literallayout>@@#log-highlight-messages 1</literallayout>]]>
2097 <![%user-man;[
2098 <para>
2099  <literal>
2100   <msgtext>
2101    <literallayout>
2102   <emphasis>log-highlight-messages   1</emphasis>
2103    </literallayout>
2104   </msgtext>
2105  </literal>
2106 </para>
2107 ]]>
2108
2109 <anchor id="log-font-name">
2110 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2111 <para>
2112  The font used in the console window:
2113 </para>
2114
2115 <![%config-file;[<literallayout>@@#log-font-name Comic Sans MS</literallayout>]]>
2116 <![%user-man;[
2117 <para>
2118  <literal>
2119   <msgtext>
2120    <literallayout>
2121   <emphasis>log-font-name        Comic Sans MS</emphasis>
2122    </literallayout>
2123   </msgtext>
2124  </literal>
2125 </para>
2126 ]]>
2127
2128 <anchor id="log-font-size">
2129 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2130 <para>
2131  Font size used in the console window:
2132 </para>
2133
2134 <![%config-file;[<literallayout>@@#log-font-size 8</literallayout>]]>
2135 <![%user-man;[
2136 <para>
2137  <literal>
2138   <msgtext>
2139    <literallayout>
2140   <emphasis>log-font-size        8</emphasis>
2141    </literallayout>
2142   </msgtext>
2143  </literal>
2144 </para>
2145 ]]>
2146
2147 <anchor id="show-on-task-bar">
2148 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2149 <para>
2150  <quote>show-on-task-bar</quote> controls whether or not
2151  <application>Privoxy</application> will appear as a button on the Task bar
2152  when minimized:
2153 </para>
2154
2155 <![%config-file;[<literallayout>@@#show-on-task-bar 0</literallayout>]]>
2156 <![%user-man;[
2157 <para>
2158  <literal>
2159   <msgtext>
2160    <literallayout>
2161   <emphasis>show-on-task-bar     0</emphasis>
2162    </literallayout>
2163   </msgtext>
2164  </literal>
2165 </para>
2166 ]]>
2167
2168 <anchor id="close-button-minimizes">
2169 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2170 <para>
2171  If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2172  button will minimize <application>Privoxy</application> instead of closing
2173  the program (close with the exit option on the File menu).
2174 </para>
2175
2176 <![%config-file;[<literallayout>@@#close-button-minimizes 1</literallayout>]]>
2177 <![%user-man;[
2178 <para>
2179  <literal>
2180   <msgtext>
2181    <literallayout>
2182   <emphasis>close-button-minimizes  1</emphasis>
2183    </literallayout>
2184   </msgtext>
2185  </literal>
2186 </para>
2187 ]]>
2188
2189 <anchor id="hide-console">
2190 <![%config-file;[<para>@@</para>]]> <!-- for spacing -->
2191 <para>
2192  The <quote>hide-console</quote> option is specific to the MS-Win console
2193  version of <application>Privoxy</application>. If this option is used,
2194  <application>Privoxy</application> will disconnect from and hide  the
2195  command console.
2196 </para>
2197
2198 <![%config-file;[<literallayout>@@#hide-console</literallayout>]]>
2199 <![%user-man;[
2200 <para>
2201  <literal>
2202   <msgtext>
2203    <literallayout>
2204   #<emphasis>hide-console</emphasis>
2205    </literallayout>
2206   </msgtext>
2207  </literal>
2208 </para>
2209 ]]>
2210
2211 </sect2>
2212 </sect1>
2213
2214 <!-- end config content common to both outputs -->
2215
2216 <![%config-file;[
2217 <!-- These are dummy anchors to keep the processor quiet            -->
2218 <!-- when building config-file only (ie. they are used in u-m only) -->
2219 <sect1 label="">
2220 <title></title>
2221 <anchor id="filter">
2222 <anchor id="filter-file">
2223 <anchor id="regex">
2224 <anchor id="actions-file">
2225 <anchor id="af-patterns">
2226 </sect1>
2227 ]]>
2228
2229 <!-- eof p-config.sgml -->