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