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