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