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