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