doc/source/user-manual.sgml

   1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
   2 <!entity % dummy "IGNORE">
   3 <!entity supported SYSTEM "supported.sgml">
   4 <!entity newfeatures SYSTEM "newfeatures.sgml">
   5 <!entity p-intro SYSTEM "privoxy.sgml">
   6 <!entity seealso SYSTEM "seealso.sgml">
   7 <!entity buildsource SYSTEM "buildsource.sgml">
   8 <!entity contacting SYSTEM "contacting.sgml">
   9 <!entity history SYSTEM "history.sgml">
  10 <!entity copyright SYSTEM "copyright.sgml">
  11 <!entity license SYSTEM "license.sgml">
  12 <!entity p-authors SYSTEM "p-authors.sgml">
  13 <!entity config SYSTEM "p-config.sgml">
  14 <!entity p-version "3.0.4">
  15 <!entity p-status "beta">
  16 <!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc  -->
  17 <!entity % p-not-stable "INCLUDE">
  18 <!entity % p-stable "IGNORE">
  19 <!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
  20 <!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
  21 <!entity % p-readme "IGNORE">
  22 <!entity % user-man "IGNORE">
  23 <!entity % config-file "IGNORE">
  24 <!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml    -->
  25 <!entity  my-copy "&copy;">         <!-- kludge for docbook2man           -->
  26 <!entity % draft "IGNORE">          <!-- WIP stuff    -->
  27 ]>
  28 <!--
  29  File        :  $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
  30
  31  Purpose     :  user manual
  32                 This file belongs into
  33                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
  34
  35  $Id: user-manual.sgml,v 2.17 2006/09/05 13:25:12 david__schmidt Exp $
  36
  37  Copyright (C) 2001- 2006 Privoxy Developers <developers@privoxy.org>
  38  See LICENSE.
  39
  40  ========================================================================
  41  NOTE: Please read developer-manual/documentation.html before touching
  42  anything in this, or other Privoxy documentation.
  43  ========================================================================
  44
  45 -->
  46
  47 <article id="index">
  48 <artheader>
  49
  50 <title>Privoxy &p-version; User Manual</title>
  51
  52 <pubdate>
  53  <subscript>
  54 <!-- Completely the wrong markup, but very little is allowed  -->
  55 <!-- in this part of an article. FIXME -->
  56  <link linkend="copyright">Copyright</link> &my-copy; 2001 - 2006 by
  57  <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
  58  </subscript>
  59 </pubdate>
  60
  61 <pubdate>$Id: user-manual.sgml,v 2.17 2006/09/05 13:25:12 david__schmidt Exp $</pubdate>
  62
  63 <!--
  64
  65 Note: the following should generate a separate page, and a live link to it,
  66 all nicely done. But it doesn't for some mysterious reason. Please leave
  67 commented unless it can be fixed proper. For the time being, the
  68 copyright/license declarations will be in their own sgml.
  69
  70 Hal.
  71
  72
  73 -->
  74
  75
  76 <abstract>
  77
  78 <![%dummy;[
  79  <para>
  80  <comment>
  81   This is here to keep vim syntax file from breaking :/
  82   If I knew enough to fix it, I would.
  83   PLEASE DO NOT REMOVE! HB: hal@foobox.net
  84  </comment>
  85  </para>
  86 ]]>
  87
  88  <para>
  89   The <citetitle>User Manual</citetitle> gives users information on how to
  90   install, configure and use <ulink
  91   url="http://www.privoxy.org/"><application>Privoxy</application></ulink>.
  92  </para>
  93
  94 <!-- Include privoxy.sgml boilerplate: -->
  95  &p-intro;
  96 <!-- end privoxy.sgml -->
  97
  98  <para>
  99   You can find the latest version of the <citetitle>User Manual</citetitle> at  <ulink
 100   url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
 101   Please see the <link linkend="contact">Contact section</link> on how to
 102   contact the developers.
 103  </para>
 104
 105 <!--   <para> -->
 106 <!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
 107 <!--   </para> -->
 108 </abstract>
 109
 110 </artheader>
 111
 112 <!--   ~~~~~       New section      ~~~~~     -->
 113 <sect1 label="1" id="introduction"><title>Introduction</title>
 114 <para>
 115  This documentation is included with the current &p-status; version of
 116  <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[,
 117  and is mostly complete at this point. The most up to date reference for the
 118  time being is still the comments in the source files and in the individual
 119  configuration files. Development of a new version is currently nearing
 120  completion, and includes significant changes and enhancements over
 121  earlier versions. ]]>.
 122 </para>
 123
 124 <!-- include only in non-stable versions -->
 125 <![%p-not-stable;[
 126 <para>
 127  Since this is a &p-status; version, not all new features are well tested. This
 128  documentation may be slightly out of sync as a result (especially with
 129  CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
 130  not many!
 131 </para>
 132 ]]>
 133
 134 <!--   ~~~~~       New section      ~~~~~     -->
 135 <sect2 id="features"><title>Features</title>
 136 <para>
 137  In addition to the core
 138  features of ad blocking and cookie management,
 139  <application>Privoxy</application> provides many supplemental
 140  features<![%p-not-stable;[, some of them currently under development]]>,
 141  that give the end-user more control, more privacy and more freedom:
 142 </para>
 143 <!-- Include newfeatures.sgml boilerplate here: -->
 144  &newfeatures;
 145 <!-- end boilerplate -->
 146 </sect2>
 147
 148 </sect1>
 149
 150 <!--  ~  End section  ~  -->
 151
 152
 153 <!--   ~~~~~       New section      ~~~~~     -->
 154 <sect1 id="installation"><title>Installation</title>
 155
 156 <para>
 157  <application>Privoxy</application> is available both in convenient pre-compiled
 158  packages for a wide range of operating systems, and as raw source code.
 159  For most users, we recommend using the packages, which can be downloaded from our
 160  <ulink url="http://sourceforge.net/projects/ijbswa/">Privoxy Project
 161  Page</ulink>.
 162 </para>
 163
 164 <para>
 165  Note:
 166  On some platforms, the installer may remove previously installed versions, if
 167  found. (See below for your platform). In any case <emphasis>be sure to backup
 168  your old configuration if it is valuable to you.</emphasis> See the <link
 169  linkend="upgradersnote">note to upgraders</link> section below.
 170 </para>
 171
 172 <!--   ~~~~~       New section      ~~~~~     -->
 173 <sect2 id="installation-packages"><title>Binary Packages</title>
 174 <para>
 175 How to install the binary packages depends on your operating system:
 176 </para>
 177
 178 <!--   ~~~~~       New section      ~~~~~     -->
 179 <sect3 id="installation-pack-rpm"><title>Red Hat, SuSE and Conectiva RPMs</title>
 180
 181 <para>
 182  RPMs can be installed with <literal>rpm -Uvh privoxy-&p-version;-1.rpm</literal>,
 183  and will use <filename>/etc/privoxy</filename> for the location
 184  of configuration files.
 185 </para>
 186
 187 <para>
 188  Note that on Red Hat, <application>Privoxy</application> will
 189  <emphasis>not</emphasis> be automatically started on system boot. You will
 190  need to enable that using <command>chkconfig</command>,
 191  <command>ntsysv</command>, or similar methods. Note that SuSE will
 192 automatically start Privoxy in the boot process.
 193 </para>
 194
 195 <para>
 196  If you have problems with failed dependencies, try rebuilding the SRC RPM:
 197  <literal>rpm --rebuild privoxy-&p-version;-1.src.rpm</literal>. This
 198  will use your locally installed libraries and RPM version.
 199 </para>
 200
 201 <para>
 202  Also note that if you have a <application>Junkbuster</application> RPM installed
 203  on your system, you need to remove it first, because the packages conflict.
 204  Otherwise, RPM will try to remove <application>Junkbuster</application>
 205  automatically if found, before installing <application>Privoxy</application>.
 206 </para>
 207 </sect3>
 208
 209 <!--   ~~~~~       New section      ~~~~~     -->
 210 <sect3 id="installation-deb"><title>Debian</title>
 211 <para>
 212  DEBs can be installed with <literal>apt-get install privoxy</literal>,
 213  and will use <filename>/etc/privoxy</filename> for the location of
 214  configuration files.
 215 </para>
 216 </sect3>
 217
 218 <!--   ~~~~~       New section      ~~~~~     -->
 219 <sect3 id="installation-pack-win"><title>Windows</title>
 220
 221 <para>
 222  Just double-click the installer, which will guide you through
 223  the installation process. You will find the configuration files
 224  in the same directory as you installed <application>Privoxy</application> in.
 225 </para>
 226 <para>
 227  Version 3.0.4 introduces full <application>Windows</application> service
 228  functionality. On Windows only, the <application>Privoxy</application>
 229  program has two new command line arguments to install and uninstall
 230  <application>Privoxy</application> as a <emphasis>service</emphasis>.
 231 </para>
 232  <variablelist>
 233   <varlistentry>
 234    <term>Arguments:</term>
 235    <listitem>
 236     <para>
 237      <replaceable class="parameter">--install</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
 238     </para>
 239     <para>
 240      <replaceable class="parameter">--uninstall</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
 241     </para>
 242    </listitem>
 243   </varlistentry>
 244  </variablelist>
 245  <para>
 246  After invoking <application>Privoxy</application> with
 247  <command>--install</command>, you will need to bring up the
 248  <application>Windows</application> service console to assign the user you
 249  want <application>Privoxy</application> to run under, and whether or not you
 250  want it to run whenever the system starts. You can start the
 251  <application>Windows</application> services console with the following
 252  command: <command>services.msc</command>  If you do not take the manual step
 253  of modifying <application>Privoxy's</application> service settings, it will
 254  not start.  Note too that you will need to give Privoxy a user account that
 255  actually exists, or it will not be permitted to
 256  write to its log and configuration files.
 257 </para>
 258
 259 </sect3>
 260
 261 <!--   ~~~~~       New section      ~~~~~     -->
 262 <sect3 id="installation-pack-bintgz"><title>Solaris, NetBSD, FreeBSD, HP-UX</title>
 263
 264 <para>
 265  Create a new directory, <literal>cd</literal> to it, then unzip and
 266  untar the archive. For the most part, you'll have to figure out where
 267  things go. <!-- FIXME, more info needed? -->
 268 </para>
 269 </sect3>
 270
 271 <!--   ~~~~~       New section      ~~~~~     -->
 272 <sect3 id="installation-os2"><title>OS/2</title>
 273
 274 <para>
 275  First, make sure that no previous installations of
 276  <application>Junkbuster</application> and / or
 277  <application>Privoxy</application> are left on your
 278  system. Check that no <application>Junkbuster</application>
 279  or <application>Privoxy</application> objects are in
 280  your startup folder.
 281
 282 </para>
 283
 284 <para>
 285  Then, just double-click the WarpIN self-installing archive, which will
 286  guide you through the installation process. A shadow of the
 287  <application>Privoxy</application> executable will be placed in your
 288  startup folder so it will start automatically whenever OS/2 starts.
 289 </para>
 290
 291 <para>
 292  The directory you choose to install <application>Privoxy</application>
 293  into will contain all of the configuration files.
 294 </para>
 295 </sect3>
 296
 297 <!--   ~~~~~       New section      ~~~~~     -->
 298 <sect3 id="installation-mac"><title>Mac OSX</title>
 299 <para>
 300  Unzip the downloaded file (you can either double-click on the file
 301  from the finder, or from the desktop if you downloaded it there).
 302  Then, double-click on the package installer icon named
 303  <literal>Privoxy.pkg</literal>
 304  and follow the installation process.
 305  <application>Privoxy</application> will be installed in the folder
 306  <literal>/Library/Privoxy</literal>.
 307  It will start automatically whenever you start up.  To prevent it from
 308  starting automatically, remove or rename the folder
 309  <literal>/Library/StartupItems/Privoxy</literal>.
 310 </para>
 311 <para>
 312  To start Privoxy by hand, double-click on
 313  <literal>StartPrivoxy.command</literal> in the
 314  <literal>/Library/Privoxy</literal> folder.
 315  Or, type this command in the Terminal:
 316 </para>
 317 <para>
 318   <screen>
 319   /Library/Privoxy/StartPrivoxy.command
 320   </screen>
 321 </para>
 322 <para>
 323  You will be prompted for the administrator password.
 324 </para>
 325 </sect3>
 326
 327 <!--   ~~~~~       New section      ~~~~~     -->
 328 <sect3 id="installation-amiga"><title>AmigaOS</title>
 329 <para>
 330  Copy and then unpack the <filename>lha</filename> archive to a suitable location.
 331  All necessary files will be installed into <application>Privoxy</application>
 332  directory, including all configuration and log files. To uninstall, just
 333  remove this directory.
 334 </para>
 335 </sect3>
 336
 337 <!--   ~~~~~       New section      ~~~~~     -->
 338 <sect3 id="installattion-gentoo"><title>Gentoo</title>
 339 <para>
 340  Gentoo source packages (Ebuilds) for <application>Privoxy</application> are
 341  contained in the Gentoo  Portage Tree (they are not on the download page,
 342  but there is a Gentoo section, where you can see when a new
 343  <application>Privoxy</application> Version is added to the  Portage Tree).
 344 </para>
 345 <para>
 346  Before installing <application>Privoxy</application> under Gentoo just do
 347  first <literal>emerge rsync</literal> to get the latest changes from the
 348  Portage tree. With <literal>emerge privoxy</literal> you install the latest
 349  version.
 350 </para>
 351 <para>
 352  Configuration files are in <filename>/etc/privoxy</filename>, the
 353  documentation is in <filename>/usr/share/doc/privoxy-&p-version;</filename>
 354  and the Log directory is in <filename>/var/log/privoxy</filename>.
 355 </para>
 356 </sect3>
 357
 358 </sect2>
 359
 360 <!--   ~~~~~       New section      ~~~~~     -->
 361 <sect2 id="installation-source"><title>Building from Source</title>
 362
 363 <para>
 364  The most convenient way to obtain the <application>Privoxy</application> sources
 365  is to download the source tarball from our <ulink url="http://sf.net/projects/ijbswa/">project
 366  page</ulink>.
 367 </para>
 368
 369 <para>
 370  If you like to live on the bleeding edge and are not afraid of using
 371  possibly unstable development versions, you can check out the up-to-the-minute
 372  version directly from <ulink url="http://sourceforge.net/cvs/?group_id=11118">the
 373  CVS repository</ulink>.
 374 <!--
 375  deprecated...out of business.
 376  or simply download <ulink
 377  url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.bz2">the nightly CVS
 378  tarball.</ulink>
 379 -->
 380 </para>
 381
 382 <!-- include buildsource.sgml boilerplate: -->
 383 &buildsource;
 384 <!-- end boilerplate -->
 385
 386 </sect2>
 387 <!--   ~~~~~       New section      ~~~~~     -->
 388 <sect2 id="installation-keepupdated"><title>Keeping your Installation Up-to-Date</title>
 389 <para>
 390  As user feedback comes in and development continues, we will make updated versions
 391  of both the main <link linkend="actions-file">actions file</link> (as a <ulink
 392  url="http://sourceforge.net/project/showfiles.php?group_id=11118&amp;release_id=103670">separate
 393  package</ulink>) and the software itself (including the actions file) available for
 394  download.
 395 </para>
 396
 397 <para>
 398  If you wish to receive an email notification whenever we release updates of
 399  <application>Privoxy</application> or the actions file, <ulink
 400  url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/">subscribe
 401  to our announce  mailing list</ulink>, ijbswa-announce@lists.sourceforge.net.
 402 </para>
 403
 404 <para>
 405  In order not to lose your personal changes and adjustments when updating
 406  to the latest <literal>default.action</literal> file we <emphasis>strongly
 407  recommend</emphasis> that you use <literal>user.action</literal> and
 408  <literal>user.filter</literal> for your local
 409  customizations of <application>Privoxy</application>. See the <link
 410  linkend="actions-file">Chapter on actions files</link> for details.
 411 </para>
 412
 413 </sect2>
 414
 415
 416 </sect1>
 417
 418 <!--  ~  End section  ~  -->
 419
 420 <!--   ~~~~~       New section      ~~~~~     -->
 421 <sect1 id="whatsnew">
 422 <title>What's New in this Release</title>
 423 <para>
 424  There are many improvements and new features in <application>Privoxy</application> &p-version;
 425  :
 426 </para>
 427
 428 <para>
 429  <itemizedlist>
 430   <listitem>
 431    <para>
 432     Mulitiple <link linkend="filter-file">filter files</link> can now be specifed in <filename>config</filename>. This allows for
 433     locally defined filters that can be maintained separately from the filters as
 434     supplied by the developers.
 435    </para>
 436   </listitem>
 437
 438  <listitem>
 439   <para>
 440    There are a number of new <link linkend="actions-file">actions</link>:
 441   </para>
 442
 443   <para>
 444   <itemizedlist>
 445
 446      <listitem>
 447       <para>
 448        <literal><link linkend="content-type-overwrite">content-type-overwrite</link></literal>
 449       </para>
 450      </listitem>
 451      <listitem>
 452       <para>
 453        <literal><link linkend="crunch-client-header">crunch-client-header</link></literal>
 454       </para>
 455      </listitem>
 456      <listitem>
 457       <para>
 458        <literal><link linkend="crunch-if-none-match">crunch-if-none-match</link></literal>
 459       </para>
 460      </listitem>
 461      <listitem>
 462       <para>
 463        <literal><link linkend="crunch-server-header">crunch-server-header</link></literal>
 464       </para>
 465      </listitem>
 466      <listitem>
 467       <para>
 468        <literal><link linkend="filter-client-headers">filter-client-headers</link></literal>
 469       </para>
 470      </listitem>
 471      <listitem>
 472       <para>
 473        <literal><link linkend="filter-server-headers">filter-server-headers</link></literal>
 474       </para>
 475      </listitem>
 476      <listitem>
 477       <para>
 478        <literal><link linkend="force-text-mode">force-text-mode</link></literal>
 479       </para>
 480      </listitem>
 481      <listitem>
 482       <para>
 483        <literal><link linkend="handle-as-empty-document">handle-as-empty-document</link></literal>
 484       </para>
 485      </listitem>
 486      <listitem>
 487       <para>
 488        <literal><link linkend="hide-accept-language">hide-accept-language</link></literal>
 489       </para>
 490      </listitem>
 491      <listitem>
 492       <para>
 493        <literal><link linkend="hide-content-disposition">hide-content-disposition</link></literal>
 494       </para>
 495      </listitem>
 496      <listitem>
 497       <para>
 498        <literal><link linkend="hide-if-modified-since">hide-if-modified-since</link></literal>
 499       </para>
 500      </listitem>
 501     <listitem>
 502       <para>
 503        <literal><link linkend="inspect-jpegs">inspect-jpegs</link></literal>
 504       </para>
 505      </listitem>
 506      <listitem>
 507       <para>
 508        <literal><link linkend="overwrite-last-modified">overwrite-last-modified</link></literal>
 509       </para>
 510      </listitem>
 511      <listitem>
 512       <para>
 513        <literal><link linkend="redirect">redirect</link></literal>
 514       </para>
 515      </listitem>
 516      <listitem>
 517       <para>
 518        <literal><link linkend="treat-forbidden-connects-like-blocks">treat-forbidden-connects-like-blocks</link></literal>
 519       </para>
 520      </listitem>
 521
 522   </itemizedlist>
 523   </para>
 524   <para>
 525      In addition, <literal><link linkend="fast-redirects">fast-redirects</link></literal>
 526      has been significantly improved with enhanced syntax.
 527   </para>
 528    <para>
 529      And <literal><link linkend="hide-referrer">hide-referrer</link></literal>
 530      has a new option, <literal>conditional block</literal>.
 531    </para>
 532
 533  </listitem>
 534
 535   <listitem>
 536    <para>
 537     <application>MS-Windows</application> versions can now be
 538     <link
 539     linkend="installation-pack-win">installed and
 540     started as a <emphasis>Windows service</emphasis></link>.
 541    </para>
 542   </listitem>
 543
 544   <listitem>
 545    <para>
 546     <filename>config</filename> has two new options:
 547     <link
 548     linkend="enable-remote-http-toggle">enable-remote-http-toggle</link>,
 549     and <link
 550     linkend="forwarded-connect-retries">forwarded-connect-retries</link>.
 551    </para>
 552    <para>
 553     And there is improved handling of the <link
 554     linkend="user-manual">user-manual</link>
 555     option, for placing documentation and help files on the local system.
 556    </para>
 557   </listitem>
 558
 559   <listitem>
 560    <para>
 561     Actions files problems and suggestions are now being directed to: <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288">http://sourceforge.net/tracker/?group_id=11118&amp;atid=460288</ulink>.
 562     Please use this to report such configuration related problems as missed
 563     ads, sites that don't function properly due to one action or another,
 564     innocent images being blocked, etc.
 565    </para>
 566   </listitem>
 567
 568   <listitem>
 569    <para>
 570     In addition, there are various bug fixes and significant enhancements, including
 571     error pages should no longer be cached if the problem is fixed, better DNS
 572     error handling, and various logging improvements.
 573    </para>
 574   </listitem>
 575
 576
 577  </itemizedlist>
 578 </para>
 579
 580 <!--   ~~~~~       New section      ~~~~~     -->
 581
 582 <sect2 id="upgradersnote">
 583 <title>Note to Upgraders</title>
 584
 585 <para>
 586  A quick list of things to be aware of before upgrading from earlier
 587  versions of <application>Privoxy</application>:
 588 </para>
 589
 590 <para>
 591  <itemizedlist>
 592
 593  <listitem>
 594   <para>
 595     Some installers may remove earlier versions completely, including
 596     configuration files. Save any important configuration files!
 597   </para>
 598  </listitem>
 599  <listitem>
 600   <para>
 601    On the other hand, some installers may not overwrite any existing configuration
 602    files, thinking you will want to do that. You may want to manually check
 603    your saved files against the newer versions to see if the improvements have
 604    merit, or whether there are new options that you may want to consider.
 605    There are a number of new features, but most won't be available unless
 606    these features are incorporated into your configuration somehow.
 607   </para>
 608  </listitem>
 609  <listitem>
 610     <para>
 611      See the full documentation on
 612      <literal><link linkend="fast-redirects">fast-redirects</link></literal>
 613      which has changed syntax, and may require adjustments to local configs.
 614    </para>
 615   </listitem>
 616  <listitem>
 617     <para>
 618      The <filename>jarfile</filename>, cookie logger, is off by default now.
 619     </para>
 620   </listitem>
 621
 622  <listitem>
 623   <para>
 624    What constitutes a <quote>default</quote> configuration has changed,
 625    and you may want to review which actions are <quote>on</quote> by
 626    default. This is primarily a matter of emphasis, but some features
 627    you may have been used to, may now be <quote>off</quote> by default.
 628   </para>
 629  </listitem>
 630
 631   <listitem>
 632   <para>
 633 <!-- I think it is best to keep this somewhat vague, in case  -->
 634 <!-- the situation changes under our feet. -->
 635    Some installers may not automatically start
 636    <application>Privoxy</application> after installation.
 637   </para>
 638  </listitem>
 639
 640  </itemizedlist>
 641 </para>
 642 </sect2>
 643 </sect1>
 644
 645 <!--   ~~~~~       New section      ~~~~~     -->
 646 <sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
 647 <para>
 648  <itemizedlist>
 649
 650  <listitem>
 651   <para>
 652   Install <application>Privoxy</application>. See the <link
 653   linkend="installation">Installation Section</link> below for platform specific
 654   information.
 655  </para>
 656  </listitem>
 657
 658  <listitem>
 659   <para>
 660    Advanced users and those who want to offer <application>Privoxy</application>
 661    service to more than just their local machine should check the <link
 662    linkend="config">main config file</link>, especially the <link
 663    linkend="access-control">security-relevant</link> options. These are
 664    off by default.
 665   </para>
 666  </listitem>
 667
 668  <listitem>
 669   <para>
 670   Start <application>Privoxy</application>, if the installation program has
 671   not done this already (may vary according to platform). See the section
 672   <link linkend="startup">Starting <application>Privoxy</application></link>.
 673   </para>
 674  </listitem>
 675
 676  <listitem>
 677   <para>
 678    Set your browser to use <application>Privoxy</application> as HTTP and
 679    HTTPS (SSL) proxy by setting the proxy configuration for address of
 680    <literal>127.0.0.1</literal> and port <literal>8118</literal>.
 681    <emphasis>DO NOT</emphasis> activate proxying for <literal>FTP</literal> or
 682    any protocols besides HTTP and HTTPS (SSL)! It won't work!
 683   </para>
 684  </listitem>
 685
 686  <listitem>
 687   <para>
 688     Flush your browser's disk and memory caches, to remove any cached ad images.
 689     If using <application>Privoxy</application> to manage cookies, you should
 690     remove any currently stored cookies too.
 691   </para>
 692  </listitem>
 693
 694  <listitem>
 695   <para>
 696    A default installation should provide a reasonable starting point for
 697    most. There will undoubtedly be occasions where you will want to adjust the
 698    configuration, but that can be dealt with as the need arises. Little
 699    to no initial configuration is required in most cases.
 700   </para>
 701   <para>
 702    See the <link linkend="configuration">Configuration section</link> for more
 703    configuration options, and how to customize your installation.
 704  <![%draft;[  You might also want to look at the <link
 705    linkend="quickstart-ad-blocking">next section</link> for a quick
 706    introduction to how <application>Privoxy</application> blocks ads and
 707    banners.]]>
 708 </para>
 709  </listitem>
 710
 711  <listitem>
 712   <para>
 713     If you experience ads that slipped through, innocent images that are
 714     blocked, or otherwise feel the need to fine-tune
 715     <application>Privoxy's</application> behaviour, take a look at the <link
 716     linkend="actions-file">actions files</link>. As a quick start, you might
 717     find the <link linkend="act-examples">richly commented examples</link>
 718     helpful. You can also view and edit the actions files through the <ulink
 719     url="http://config.privoxy.org">web-based user interface</ulink>. The
 720     Appendix <quote><link linkend="actionsanat">Anatomy of an
 721     Action</link></quote> has hints how to debug actions that
 722     <quote>misbehave</quote>.
 723   </para>
 724  </listitem>
 725
 726  <listitem>
 727   <para>
 728    For easy access to Privoxy's most important controls, drag the provided
 729    <link linkend="bookmarklets">Bookmarklets</link> into your browser's
 730    personal toolbar.
 731   </para>
 732  </listitem>
 733
 734  <listitem>
 735   <para>
 736    Please see the section <link linkend="contact">Contacting the
 737    Developers</link> on how to report bugs, problems with websites or to get
 738    help.
 739   </para>
 740  </listitem>
 741
 742  <listitem>
 743   <para>
 744    Now enjoy surfing with enhanced control, comfort and privacy!
 745   </para>
 746  </listitem>
 747
 748  </itemizedlist>
 749 </para>
 750
 751
 752 <!--   ~~~~~       New section      ~~~~~     -->
 753
 754 <sect2 id="quickstart-ad-blocking">
 755 <title>Quickstart to Ad Blocking</title>
 756 <!--
 757  NOTE:  This section is deliberately redundant for those that don't
 758  want to read the whole thing (which is getting lengthy).
 759 -->
 760 <para>
 761  Ad blocking is but one of <application>Privoxy's</application>
 762  array of features. Many of these features are for the technically minded advanced
 763  user. But, ad and banner blocking is surely common ground for everybody.
 764 </para>
 765 <para>
 766  This section will provide a quick summary of ad blocking so
 767  you can get up to speed quickly without having to read the more extensive
 768  information provided below, though this is highly recommended.
 769 </para>
 770 <para>
 771  First a bit of a warning ... blocking ads is much like blocking SPAM: the
 772  more aggressive you are about it, the more likely you are to block
 773  things that were not intended. So there is a trade off here. If you want
 774  extreme ad free browsing, be prepared to deal with more
 775  <quote>problem</quote> sites, and to spend more time adjusting the
 776  configuration to solve these unintended consequences. In short, there is
 777  not an easy way to eliminate <emphasis>all</emphasis> ads. Either take
 778  the easy way and settle for <emphasis>most</emphasis> ads blocked with the
 779  default configuration, or jump in and tweak it for your personal surfing
 780  habits and preferences.
 781 </para>
 782 <para>
 783  Secondly, a brief explanation of <application>Privoxy's </application>
 784  <quote>actions</quote>. <quote>Actions</quote> in this context, are
 785  the directives we use to tell <application>Privoxy</application> to perform
 786  some task relating to HTTP transactions (i.e. web browsing). We tell
 787  <application>Privoxy</application> to take some <quote>action</quote>. Each
 788  action has a unique name and function. While there are many potential
 789  <application>actions</application> in <application>Privoxy's</application>
 790  arsenal, only a few are used for ad blocking. <link
 791  linkend="actions">Actions</link>, and <link linkend="actions-file">action
 792  configuration files</link>, are explained in depth below.
 793 </para>
 794 <para>
 795  Actions are specified in <application>Privoxy's</application> configuration,
 796  followed by one or more URLs to which the action should apply. URLs
 797  can actually be URL type <link linkend="af-patterns">patterns</link> that use
 798  wildcards so they can apply potentially to a range of similar URLs. The
 799  actions, together with the URL patterns are called a section.
 800 </para>
 801 <para>
 802  When you connect to a website, the full URL will either match one or more
 803  of the sections as defined in <application>Privoxy's</application> configuration,
 804  or not. If so, then <application>Privoxy</application> will perform the
 805  respective actions. If not, then nothing special happens. Furthermore, web
 806  pages may contain embedded, secondary URLs that your web browser will
 807  use to load additional components of the page, as it parses the
 808  original page's HTML content. An ad image for instance, is just an URL
 809  embedded in the page somewhere. The image itself may be on the same server,
 810  or a server somewhere else on the Internet. Complex web pages will have many
 811  such embedded URLs.
 812 </para>
 813
 814 <para>
 815  The actions we need to know about for ad blocking are:  <literal><link
 816  linkend="block">block</link></literal>, <literal><link
 817  linkend="handle-as-image">handle-as-image</link></literal>, and
 818  <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>:
 819 </para>
 820
 821 <para>
 822  <itemizedlist>
 823
 824  <listitem>
 825   <para>
 826    <literal><link linkend="block">block</link></literal> - this action stops
 827    any contact between your browser and any URL patterns that match this
 828    action's configuration. It can be used for blocking ads, but also anything
 829    that is determined to be unwanted. By itself, it simply stops any
 830    communication with the remote server and sends <application>Privoxy</application>'s
 831    own built-in BLOCKED page instead to let you now what has happened.
 832   </para>
 833  </listitem>
 834
 835  <listitem>
 836   <para>
 837    <literal><link linkend="handle-as-image">handle-as-image</link></literal> -
 838    tells <application>Privoxy</application> to treat this URL as an image.
 839    <application>Privoxy</application>'s default configuration already does this
 840    for all common image types (e.g. GIF), but there are many situations where this
 841    is not so easy to determine. So we'll force it in these cases. This is particularly
 842    important for ad blocking, since  only if we know that it's an image of
 843    some kind, can we replace it with an image of our choosing, instead of the
 844    <application>Privoxy</application> BLOCKED page (which would only result in
 845    a <quote>broken image</quote> icon). There are some limitations to this
 846    though. For instance, you can't just brute-force an image substitution for
 847    an entire HTML page in most situations.
 848   </para>
 849  </listitem>
 850
 851  <listitem>
 852   <para>
 853    <literal><link
 854    linkend="set-image-blocker">set-image-blocker</link></literal> - tells
 855    <application>Privoxy</application> what to display in place of an ad image that
 856    has hit a block rule. For this to come into play, the URL must match a
 857    <literal><link linkend="block">block</link></literal> action somewhere in the
 858    configuration, <emphasis>and</emphasis>, it must also match an
 859    <literal><link linkend="handle-as-image">handle-as-image</link></literal> action.
 860   </para>
 861   <para>
 862    The configuration options on what to display instead of the ad are:
 863   </para>
 864   <simplelist>
 865    <member>
 866     &nbsp;&nbsp;&nbsp;<emphasis>pattern</emphasis> - a checkerboard pattern, so that an ad
 867     replacement is obvious. This is the default.
 868    </member>
 869   </simplelist>
 870   <simplelist>
 871    <member>
 872     &nbsp;&nbsp;&nbsp;<emphasis>blank</emphasis> - A very small empty GIF image is displayed.
 873     This is the so-called <quote>invisible</quote> configuration option.
 874    </member>
 875   </simplelist>
 876   <simplelist>
 877    <member>
 878     &nbsp;&nbsp;&nbsp;<emphasis>http://&lt;URL&gt;</emphasis> - A redirect to any image anywhere
 879     of the user's choosing (advanced usage).
 880    </member>
 881   </simplelist>
 882   </listitem>
 883
 884 </itemizedlist>
 885 </para>
 886
 887 <para>
 888  The quickest way to adjust any of these settings is with your browser through
 889  the special <application>Privoxy</application> editor at <ulink
 890  url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
 891  (shortcut: <ulink url="http://p.p/">http://p.p/show-status</ulink>). This
 892  is an internal page, and does not require Internet access. Select the
 893  appropriate <quote>actions</quote> file, and click
 894  <quote><guibutton>Edit</guibutton></quote>. It is best to put personal or
 895  local preferences in <filename>user.action</filename> since this is not
 896  meant to be overwritten during upgrades, and will over-ride the settings in
 897  other files. Here you can insert new <quote>actions</quote>, and URLs for ad
 898  blocking or other purposes, and make other adjustments to the configuration.
 899  <application>Privoxy</application> will detect these changes automatically.
 900 </para>
 901
 902 <para>
 903  A quick and simple step by step example:
 904 </para>
 905
 906 <para>
 907  <itemizedlist>
 908
 909   <listitem>
 910    <para>
 911      Right click on the ad image to be blocked, then select
 912      <quote><guimenuitem>Copy Link Location</guimenuitem></quote> from the
 913      pop-up menu.
 914    </para>
 915   </listitem>
 916   <listitem>
 917    <para>
 918     Set your browser to
 919     <ulink
 920  url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
 921    </para>
 922   </listitem>
 923   <listitem>
 924    <para>
 925     Find <filename>user.action</filename> in the top section, and click
 926     on <quote><guibutton>Edit</guibutton></quote>:
 927    </para>
 928
 929  <!-- image of editor and actions files selections -->
 930  <para>
 931   <figure pgwide="0" float="0"><title>Actions Files in Use</title>
 932    <mediaobject>
 933      <imageobject>
 934       <imagedata  fileref="../images/files-in-use.jpg" format="jpg">
 935        </imageobject>
 936        <textobject>
 937         <phrase>[ Screenshot of Actions Files in Use ]</phrase>
 938       </textobject>
 939    </mediaobject>
 940   </figure>
 941  </para>
 942  </listitem>
 943
 944  <listitem>
 945   <para>
 946    You should have a section with only
 947    <literal><link linkend="block">block</link></literal> listed under
 948    <quote>Actions:</quote>.
 949    If not, click a <quote><guibutton>Insert new section below</guibutton></quote>
 950    button, and in the new section that just appeared, click the
 951    <guibutton>Edit</guibutton> button right under the word <quote>Actions:</quote>.
 952    This will bring up a list of all actions. Find
 953    <literal><link linkend="block">block</link></literal> near the top, and click
 954    in the <quote>Enabled</quote> column, then <quote><guibutton>Submit</guibutton></quote>
 955    just below the list.
 956   </para>
 957  </listitem>
 958  <listitem>
 959   <para>
 960    Now, in the <literal><link linkend="block">block</link></literal> actions section,
 961    click the <quote><guibutton>Add</guibutton></quote> button, and paste the URL the
 962    browser got from <quote><guimenuitem>Copy Link Location</guimenuitem></quote>.
 963    Remove the <literal>http://</literal> at the beginning of the URL. Then, click
 964    <quote><guibutton>Submit</guibutton></quote> (or
 965    <quote><guibutton>OK</guibutton></quote> if in a pop-up window).
 966   </para>
 967  </listitem>
 968  <listitem>
 969   <para>
 970    Now go back to the original page, and press <keycap>SHIFT-Reload</keycap>
 971    (or flush all browser caches). The image should be gone now.
 972   </para>
 973  </listitem>
 974
 975  </itemizedlist>
 976 </para>
 977
 978 <para>
 979  This is a very crude and simple example. There might be good reasons to use a
 980  wildcard pattern match to include potentially similar images from the same
 981  site. For a more extensive explanation of <quote>patterns</quote>, and
 982  the entire actions concept, see <link linkend="actions-file">the Actions
 983  section</link>.
 984 </para>
 985
 986 <para>
 987  For advanced users who want to hand edit their config files, you might want
 988  to now go to the <link linkend="act-examples">Actions Files Tutorial</link>.
 989  The ideas explained therein also apply to the web-based editor.
 990 </para>
 991
 992 </sect2>
 993
 994 </sect1>
 995
 996 <!--  ~  End section  ~  -->
 997
 998
 999 <!--   ~~~~~       New section      ~~~~~     -->
1000 <sect1 id="startup">
1001 <title>Starting <application>Privoxy</application></title>
1002 <para>
1003  Before launching <application>Privoxy</application> for the first time, you
1004  will want to configure your browser(s) to use
1005  <application>Privoxy</application> as a HTTP and HTTPS proxy. The default is
1006  127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions
1007  used port 8000). This is the one configuration step that must be done!
1008 </para>
1009 <para>
1010  Please note that <application>Privoxy</application> can only proxy HTTP and
1011  HTTPS traffic. It will not work with FTP or other protocols.
1012 </para>
1013
1014  <!-- image of Mozilla Proxy configuration -->
1015  <para>
1016   <figure pgwide="0" float="0"><title>Proxy Configuration (Mozilla)</title>
1017    <mediaobject>
1018      <imageobject>
1019       <imagedata  fileref="../images/proxy_setup.jpg" format="jpg">
1020        </imageobject>
1021        <textobject>
1022         <phrase>[ Screenshot of Mozilla Proxy Configuration ]</phrase>
1023       </textobject>
1024    </mediaobject>
1025   </figure>
1026  </para>
1027
1028
1029 <para>
1030  With <application>Firefox</application>, this can be set under:
1031 </para>
1032
1033 <literallayout>
1034 <!-- Mix ascii and gui art, something for everybody -->
1035 <!-- spacing on this is tricky -->
1036  <guibutton>Tools</guibutton>
1037    |_
1038          <guibutton>Options</guibutton>
1039                 |_
1040                         <guibutton>General</guibutton>
1041                               |_
1042                                     <guibutton>Connection Settings</guibutton>
1043                                          |_
1044                                                 <guibutton>Manual Proxy Configuration</guibutton>
1045 </literallayout>
1046
1047
1048 <para>
1049  With <application>Netscape</application> (and
1050  <application>Mozilla</application>), this can be set under:
1051 </para>
1052
1053
1054 <literallayout>
1055 <!-- Mix ascii and gui art, something for everybody -->
1056 <!-- spacing on this is tricky -->
1057  <guibutton>Edit</guibutton>
1058    |_
1059          <guibutton>Preferences</guibutton>
1060                 |_
1061                         <guibutton>Advanced</guibutton>
1062                               |_
1063                                     <guibutton>Proxies</guibutton>
1064                                          |_
1065                                                 <guibutton>HTTP Proxy</guibutton>
1066 </literallayout>
1067
1068 <para>
1069  For <application>Internet Explorer</application>:
1070 </para>
1071
1072 <literallayout>
1073 <!-- Mix ascii and gui art, something for everybody -->
1074 <!-- spacing on this is tricky -->
1075  <guibutton>Tools</guibutton>
1076      |_
1077          <guibutton>Internet Properties</guibutton>
1078                             |_
1079                                       <guibutton>Connections</guibutton>
1080                                                |_
1081                                                             <guibutton>LAN Settings</guibutton>
1082 </literallayout>
1083
1084 <para>
1085  Then, check <quote>Use Proxy</quote> and fill in the appropriate info
1086  (Address: 127.0.0.1, Port: 8118). Include HTTPS (SSL), if you want HTTPS
1087  proxy support too.
1088 </para>
1089
1090 <para>
1091  After doing this, flush your browser's disk and memory caches to force a
1092  re-reading of all pages and to get rid of any ads that may be cached. You
1093  are now ready to start enjoying the benefits of using
1094  <application>Privoxy</application>!
1095 </para>
1096
1097 <para>
1098  <application>Privoxy</application> itself is typically started by specifying the
1099  main configuration file to be used on the command line. If no configuration
1100  file is specified on the command line, <application>Privoxy</application>
1101  will look for a file named <filename>config</filename> in the current
1102  directory. Except on Win32 where it will try <filename>config.txt</filename>.
1103 </para>
1104
1105 <sect2 id="start-redhat">
1106 <title>Red Hat and Conectiva</title>
1107 <para>
1108  We use a script. Note that Red Hat does not start Privoxy upon booting per
1109  default. It will use the file <filename>/etc/privoxy/config</filename> as
1110  its main configuration file.
1111 </para>
1112 <para>
1113  <screen>
1114  # /etc/rc.d/init.d/privoxy start
1115 </screen>
1116 </para>
1117 </sect2>
1118
1119 <sect2 id="start-debian">
1120 <title>Debian</title>
1121 <para>
1122  We use a script. Note that Debian starts Privoxy upon booting per
1123  default.  It will use the file
1124  <filename>/etc/privoxy/config</filename> as its main configuration
1125  file.
1126 </para>
1127 <para>
1128  <screen>
1129  # /etc/init.d/privoxy start
1130 </screen>
1131 </para>
1132 </sect2>
1133
1134 <sect2 id="start-suse">
1135 <title>SuSE</title>
1136 <para>
1137 We use a script. It will use the file <filename>/etc/privoxy/config</filename>
1138 as its main configuration file. Note that SuSE starts Privoxy upon booting
1139 your PC.
1140 </para>
1141 <para>
1142  <screen>
1143  # rcprivoxy start
1144 </screen>
1145 </para>
1146 </sect2>
1147
1148 <sect2 id="start-windows">
1149 <title>Windows</title>
1150 <para>
1151 Click on the Privoxy Icon to start <application>Privoxy</application>. If no configuration file is
1152  specified on the command line, <application>Privoxy</application> will look
1153  for a file named <filename>config.txt</filename>. Note that Windows will
1154  automatically start Privoxy when the system starts if you chose that option
1155  when installing.
1156 </para>
1157 <para>
1158  <application>Privoxy</application> can run with full Windows service functionality.
1159  On Windows only, the Privoxy program has two new command line arguments
1160  to install and uninstall Privoxy as a service. See the
1161  <link linkend="installation-pack-win">Windows Installation
1162  instructions</link> for details.
1163 </para>
1164 </sect2>
1165
1166 <sect2 id="start-unices">
1167 <title>Solaris, NetBSD, FreeBSD, HP-UX and others</title>
1168 <para>
1169 Example Unix startup command:
1170 </para>
1171 <para>
1172  <screen>
1173  # /usr/sbin/privoxy /etc/privoxy/config
1174 </screen>
1175 </para>
1176 </sect2>
1177
1178 <sect2 id="start-os2">
1179 <title>OS/2</title>
1180 <para>
1181  During installation, <application>Privoxy</application> is configured to
1182  start automatically when the system restarts. You can start it manually by
1183  double-clicking on the <application>Privoxy</application> icon in the
1184  <application>Privoxy</application> folder.
1185 </para>
1186 </sect2>
1187
1188 <sect2 id="start-macosx">
1189 <title>Mac OSX</title>
1190 <para>
1191  During installation, <application>Privoxy</application> is configured to
1192  start automatically when the system restarts.  To start Privoxy by hand,
1193  double-click on the <literal>StartPrivoxy.command</literal> icon in the
1194  <literal>/Library/Privoxy</literal> folder.  Or, type this command
1195  in the Terminal:
1196 </para>
1197 <para>
1198   <screen>
1199   /Library/Privoxy/StartPrivoxy.command
1200   </screen>
1201 </para>
1202 <para>
1203  You will be prompted for the administrator password.
1204 </para>
1205 </sect2>
1206
1207
1208 <sect2 id="start-amigaos">
1209 <title>AmigaOS</title>
1210 <para>
1211  Start <application>Privoxy</application> (with RUN &lt;&gt;NIL:) in your
1212  <filename>startnet</filename> script (AmiTCP), in
1213  <filename>s:user-startup</filename> (RoadShow), as startup program in your
1214  startup script (Genesis), or as startup action (Miami and MiamiDx).
1215  <application>Privoxy</application> will automatically quit when you quit your
1216  TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
1217  <application>Privoxy</application> is still running).
1218 </para>
1219 </sect2>
1220
1221 <sect2 id="start-gentoo">
1222 <title>Gentoo</title>
1223 <para>
1224  A script is again used. It will use the file <filename>/etc/privoxy/config
1225  </filename> as its main configuration file.
1226 </para>
1227 <para>
1228  <screen>
1229  /etc/init.d/privoxy start
1230  </screen>
1231 </para>
1232 <para>
1233  Note that <application>Privoxy</application> is not automatically started at
1234  boot time by default. You can change this with the <literal>rc-update</literal>
1235  command.
1236 </para>
1237 <para>
1238  <screen>
1239  rc-update add privoxy default
1240  </screen>
1241 </para>
1242 </sect2>
1243
1244 <!--
1245
1246 <para>
1247  See the section <link linkend="cmdoptions">Command line options</link> for
1248  further info.
1249 </para>
1250
1251 must find a better place for this paragraph
1252
1253 <para>
1254  The included default configuration files should give a reasonable starting
1255  point. Most of the per site configuration is done in the
1256  <ulink url="actions-file.html"><quote>actions</quote></ulink> files. These are
1257  where various cookie actions are defined, ad and banner blocking, and other
1258  aspects of <application>Privoxy</application> configuration. There are several
1259  such files included, with varying levels of aggressiveness.
1260 </para>
1261
1262 <para>
1263  You will probably want to keep an eye out for sites for which you may prefer
1264  persistent cookies, and add these to your actions configuration as needed. By
1265  default, most of these will be accepted only during the current browser
1266  session (aka <quote>session cookies</quote>), unless you add them to the
1267  configuration. If you want the browser to handle this instead, you will need
1268  to edit <filename>user.action</filename> (or through the web based interface)
1269  and disable this feature. If you use more than one browser, it would make
1270  more sense to let <application>Privoxy</application> handle this. In which
1271  case, the browser(s) should be set to accept all cookies.
1272 </para>
1273
1274 <para>
1275  Another feature where you will probably want to define exceptions for trusted
1276  sites is the popup-killing (through the <ulink
1277  url="actions-file.html#KILL-POPUPS"><quote>+kill-popups</quote></ulink> and
1278  <ulink
1279  url="actions-file.html#FILTER-POPUPS"><quote>+filter{popups}</quote></ulink>
1280  actions), because your favorite shopping, banking, or leisure site may need
1281  popups (explained below).
1282 </para>
1283
1284 <para>
1285  <application>Privoxy</application> is HTTP/1.1 compliant,  but not all of
1286  the optional 1.1 features are as yet supported. In the unlikely event that
1287  you experience inexplicable problems with browsers that use HTTP/1.1 per default
1288  (like <application>Mozilla</application> or recent versions of I.E.), you might
1289  try to force HTTP/1.0 compatibility. For Mozilla, look under <literal>Edit -&gt;
1290  Preferences -&gt; Debug -&gt; Networking</literal>.
1291  Alternatively, set the <quote>+downgrade-http-version</quote> config option in
1292  <filename>default.action</filename> which will downgrade your browser's HTTP
1293  requests from HTTP/1.1 to HTTP/1.0 before processing them.
1294 </para>
1295
1296 <para>
1297  After running <application>Privoxy</application> for a while, you can
1298  start to fine tune the configuration to suit your personal, or site,
1299  preferences and requirements. There are many, many aspects that can
1300  be customized. <quote>Actions</quote>
1301  can be adjusted by pointing your browser to
1302  <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
1303  (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
1304  and then follow the link to <quote>View &#38; Change the Current Configuration</quote>.
1305  (This is an internal page and does not require Internet access.)
1306 </para>
1307
1308 <para>
1309  In fact, various aspects of <application>Privoxy</application>
1310  configuration can be viewed from this page, including
1311  current configuration parameters, source code version numbers,
1312  the browser's request headers, and <quote>actions</quote> that apply
1313  to a given URL. In addition to the actions file
1314  editor mentioned above, <application>Privoxy</application> can also
1315  be turned <quote>on</quote> and <quote>off</quote> (toggled) from this page.
1316 </para>
1317
1318 <para>
1319  If you encounter problems, try loading the page without
1320  <application>Privoxy</application>. If that helps, enter the URL where
1321  you have the problems into <ulink url="http://p.p/show-url-info">the browser
1322  based rule tracing utility</ulink>. See which rules apply and why, and
1323  then try turning them off for that site one after the other, until the problem
1324  is gone. When you have found the culprit, you might want to turn the rest on
1325  again.
1326 </para>
1327
1328 <para>
1329  If the above paragraph sounds gibberish to you, you might want to <link
1330  linkend="actions-file">read more about the actions concept</link>
1331  or even dive deep into the <link linkend="actionsanat">Appendix
1332  on actions</link>.
1333 </para>
1334
1335 <para>
1336  If you can't get rid of the problem at all, think you've found a bug in
1337  Privoxy, want to propose a new feature or smarter rules, please see the
1338  section <link linkend="contact"><quote>Contacting the
1339  Developers</quote></link> below.
1340 </para>
1341
1342 -->
1343
1344 <!--   ~~~~~       New section      ~~~~~     -->
1345 <sect2 id="cmdoptions">
1346 <title>Command Line Options</title>
1347 <para>
1348  <application>Privoxy</application> may be invoked with the following
1349  command-line options:
1350 </para>
1351
1352 <para>
1353  <itemizedlist>
1354
1355  <listitem>
1356   <para>
1357     <emphasis>--version</emphasis>
1358   </para>
1359   <para>
1360      Print version info and exit. Unix only.
1361   </para>
1362  </listitem>
1363  <listitem>
1364   <para>
1365     <emphasis>--help</emphasis>
1366   </para>
1367   <para>
1368    Print short usage info and exit. Unix only.
1369   </para>
1370  </listitem>
1371  <listitem>
1372   <para>
1373    <emphasis>--no-daemon</emphasis>
1374   </para>
1375   <para>
1376    Don't become a daemon, i.e. don't fork and become process group
1377    leader, and don't detach from controlling tty. Unix only.
1378   </para>
1379  </listitem>
1380  <listitem>
1381   <para>
1382    <emphasis>--pidfile FILE</emphasis>
1383
1384   </para>
1385   <para>
1386    On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
1387    <emphasis>FILE</emphasis> on exit. Failure to create or delete the
1388    <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
1389    option is given, no PID file will be used. Unix only.
1390   </para>
1391  </listitem>
1392  <listitem>
1393   <para>
1394    <emphasis>--user USER[.GROUP]</emphasis>
1395
1396   </para>
1397   <para>
1398    After (optionally) writing the PID file, assume the user  ID  of
1399    <emphasis>USER</emphasis>, and if included the GID of GROUP.  Exit if the
1400    privileges are not sufficient to do so. Unix only.
1401   </para>
1402  </listitem>
1403   <listitem>
1404   <para>
1405    <emphasis>--chroot</emphasis>
1406
1407   </para>
1408   <para>
1409    Before changing to the user ID given in the <emphasis>--user</emphasis> option,
1410    chroot to that user's home directory, i.e. make the kernel pretend to the Privoxy
1411    process that the directory tree starts there. If set up carefully, this can limit
1412    the impact of possible vulnerabilities in Privoxy to the files contained in that hierarchy.
1413    Unix only.
1414   </para>
1415  </listitem>
1416  <listitem>
1417   <para>
1418     <emphasis>configfile</emphasis>
1419   </para>
1420   <para>
1421     If no <emphasis>configfile</emphasis> is included on the command line,
1422     <application>Privoxy</application> will look for a file named
1423     <quote>config</quote> in the current directory (except on Win32
1424     where it will look for <quote>config.txt</quote> instead). Specify
1425     full path to avoid confusion. If no config file is found,
1426     <application>Privoxy</application> will fail to start.
1427   </para>
1428  </listitem>
1429
1430  </itemizedlist>
1431 </para>
1432
1433 <para>
1434  On <application>MS Windows</application> only there are two addition
1435  options to allow <application>Privoxy</application> to install and
1436  run as a <emphasis>service</emphasis>. See the
1437 <link linkend="installation-pack-win">Window Installation section</link>
1438 for details.
1439 </para>
1440
1441 </sect2>
1442
1443 </sect1>
1444
1445 <!--  ~  End section  ~  -->
1446
1447
1448 <!--   ~~~~~       New section      ~~~~~     -->
1449 <sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
1450  <para>
1451   All <application>Privoxy</application> configuration is stored
1452   in text files. These files can be edited with a text editor.
1453   Many important aspects of <application>Privoxy</application> can
1454   also be controlled easily with a web browser.
1455  </para>
1456
1457
1458 <!--   ~~~~~       New section      ~~~~~     -->
1459
1460 <sect2>
1461 <title>Controlling <application>Privoxy</application> with Your Web Browser</title>
1462 <para>
1463  <application>Privoxy</application>'s user interface can be reached through the special
1464  URL <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
1465  (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
1466  which is a built-in page and works without Internet access.
1467  You will see the following section:
1468
1469 </para>
1470
1471 <!-- Needs to be put in a table and colorized  -->
1472 <screen>
1473  <msgtext>
1474  <bridgehead renderas="sect2">&nbsp;&nbsp;&nbsp;&nbsp;Privoxy Menu</bridgehead>
1475
1476  <simplelist>
1477  <member>
1478   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://config.privoxy.org/show-status">View & change the current configuration</ulink>
1479  </member>
1480  <member>
1481   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://config.privoxy.org/show-version">View the source code version numbers</ulink>
1482  </member>
1483  <member>
1484   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://config.privoxy.org/show-request">View the request headers.</ulink>
1485  </member>
1486  <member>
1487   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://config.privoxy.org/show-url-info">Look up which actions apply to a URL and why</ulink>
1488  </member>
1489  <member>
1490   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://config.privoxy.org/toggle">Toggle Privoxy on or off</ulink>
1491  </member>
1492  <member>
1493   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://www.privoxy.org/
1494   &p-version;/user-manual/">Documentation</ulink>
1495  </member>
1496  </simplelist>
1497  </msgtext>
1498 </screen>
1499
1500
1501 <para>
1502  This should be self-explanatory. Note the first item leads to an editor for the
1503  <link linkend="actions-file">actions files</link>, which is where the ad, banner,
1504  cookie, and URL blocking magic is configured as well as other advanced features of
1505  <application>Privoxy</application>. This is an easy way to adjust various
1506  aspects of <application>Privoxy</application> configuration. The actions
1507  file, and other configuration files, are explained in detail below.
1508 </para>
1509
1510 <para>
1511  <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
1512  have problems with your current actions and filters. You can in fact use
1513  it as a test to see whether it is <application>Privoxy</application>
1514  causing the problem or not. <application>Privoxy</application> continues
1515  to run as a proxy in this case, but all manipulation is disabled, i.e.
1516  <application>Privoxy</application> acts like a normal forwarding proxy. There
1517  is even a toggle <link linkend="bookmarklets">Bookmarklet</link> offered, so
1518  that you can toggle <application>Privoxy</application> with one click from
1519  your browser.
1520 </para>
1521
1522 </sect2>
1523
1524 <!--  ~  End section  ~  -->
1525
1526
1527
1528
1529 <!--   ~~~~~       New section      ~~~~~     -->
1530
1531 <sect2 id="confoverview">
1532 <title>Configuration Files Overview</title>
1533 <para>
1534  For Unix, *BSD and Linux, all configuration files are located in
1535  <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
1536  AmigaOS these are all in the same directory as the
1537  <application>Privoxy</application> executable. <![%p-not-stable;[ The name
1538  and number of configuration files has changed from previous versions, and is
1539  subject to change as development progresses.]]>
1540 </para>
1541
1542 <para>
1543  The installed defaults provide a reasonable starting point, though
1544  some settings may be aggressive by some standards. For the time being, the
1545  principle configuration files are:
1546 </para>
1547
1548 <para>
1549  <itemizedlist>
1550
1551   <listitem>
1552    <para>
1553      The <link linkend="config">main configuration file</link> is named <filename>config</filename>
1554      on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
1555      on Windows. This is a required file.
1556    </para>
1557   </listitem>
1558
1559   <listitem>
1560    <para>
1561     <filename>default.action</filename> (the main <link linkend="actions-file">actions file</link>)
1562     is used to define which <quote>actions</quote> relating to banner-blocking, images, pop-ups,
1563     content modification, cookie handling etc should be applied by default. It also defines many
1564     exceptions (both positive and negative) from this default set of actions that enable
1565     <application>Privoxy</application> to selectively eliminate the junk, and only the junk, on
1566     as many websites as possible.
1567    </para>
1568    <para>
1569     Multiple actions files may be defined in <filename>config</filename>. These
1570     are processed in the order they are defined. Local customizations and locally
1571     preferred exceptions to the default policies  as defined in
1572     <filename>default.action</filename> (which you will most probably want
1573     to define sooner or later) are probably best applied in
1574     <filename>user.action</filename>, where you can preserve them across
1575     upgrades. <filename>standard.action</filename> is for
1576     <application>Privoxy's</application> internal use.
1577    </para>
1578    <para>
1579     There is also a web based editor that can be accessed from
1580     <ulink
1581     url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
1582     (Shortcut: <ulink
1583     url="http://p.p/show-status">http://p.p/show-status</ulink>) for the
1584     various actions files.
1585    </para>
1586   </listitem>
1587
1588   <listitem>
1589    <para>
1590     <quote>Filter files</quote> (the <link linkend="filter-file">filter
1591     file</link>) can be used to re-write the raw page content, including
1592     viewable text as well as embedded HTML and JavaScript, and whatever else
1593     lurks on any given web page. The filtering jobs are only pre-defined here;
1594     whether to apply them or not is up to the actions files.
1595     <filename>default.filter</filename> includes various filters made
1596     available for use by the developers. Some are much more intrusive than
1597     others, and all should be used with caution. You may define additional
1598     filter files in <filename>config</filename> as you can with
1599     actions files. We suggest <filename>user.filter</filename> for any
1600     locally defined filters or customizations.
1601    </para>
1602   </listitem>
1603
1604  </itemizedlist>
1605 </para>
1606
1607 <para>
1608  The syntax of all configuration files has remained the same throughout the
1609  3.x series. There have been enhancements, but no changes that would preclude
1610  the use of any configuration file from one version to the next.
1611 </para>
1612
1613 <para>
1614  All files use the <quote><literal>#</literal></quote> character to denote a
1615  comment (the rest of the line will be ignored) and understand line continuation
1616  through placing a backslash ("<literal>\</literal>") as the very last character
1617  in a line. If the <literal>#</literal> is preceded by a backslash, it looses
1618  its special function. Placing a <literal>#</literal> in front of an otherwise
1619  valid configuration line to prevent it from being interpreted is called "commenting
1620  out" that line.
1621 </para>
1622
1623 <para>
1624  The actions files and filter files
1625  can use Perl style <link linkend="regex">regular expressions</link> for
1626  maximum flexibility.
1627 </para>
1628
1629 <para>
1630  After making any changes, there is no need to restart
1631  <application>Privoxy</application> in order for the changes to take
1632  effect. <application>Privoxy</application> detects such changes
1633  automatically. Note, however, that it may take one or two additional
1634  requests for the change to take effect. When changing the listening address
1635  of <application>Privoxy</application>, these <quote>wake up</quote> requests
1636  must obviously be sent to the <emphasis>old</emphasis> listening address.
1637 </para>
1638
1639 <![%p-not-stable;[
1640 <para>
1641  While under development, the configuration content is subject to change.
1642  The below documentation may not be accurate by the time you read this.
1643  Also, what constitutes a <quote>default</quote> setting, may change, so
1644  please check all your configuration files on important issues.
1645 </para>
1646 ]]>
1647
1648 </sect2>
1649 </sect1>
1650 <!--  ~  End section  ~  -->
1651
1652
1653 <!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
1654
1655 <!-- **************************************************** -->
1656 <!-- Include config.sgml here -->
1657 <!-- This is where the entire config file is detailed. -->
1658  &config;
1659 <!-- end include  -->
1660
1661
1662 <!--  ~  End section  ~  -->
1663
1664
1665
1666 <!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
1667
1668 <sect1 id="actions-file"><title>Actions Files</title>
1669
1670 <para>
1671  The actions files are used to define what <emphasis>actions</emphasis>
1672  <application>Privoxy</application> takes for which URLs, and thus determines
1673  how ad images, cookies and various other aspects of HTTP content and
1674  transactions are handled, and on which sites (or even parts thereof).
1675  There are a number of such actions, with a wide range of functionality.
1676  Each action does something a little different.
1677  These actions give us a veritable arsenal of tools with which to exert
1678  our control, preferences and independence.
1679 </para>
1680 <para>
1681  There
1682  are three action files included with <application>Privoxy</application> with
1683  differing purposes:
1684  </para>
1685
1686  <para>
1687   <itemizedlist>
1688    <listitem>
1689     <para>
1690      <filename>default.action</filename> - is the primary action file
1691      that sets the initial values for all actions. It is intended to
1692      provide a base level of functionality for
1693      <application>Privoxy's</application> array of features. So it is
1694      a set of broad rules that should work reasonably well for users everywhere.
1695      This is the file that the developers are keeping updated, and <link
1696      linkend="installation-keepupdated">making available to users</link>.
1697     </para>
1698    </listitem>
1699    <listitem>
1700     <para>
1701      <filename>user.action</filename> - is intended to be for local site
1702      preferences and exceptions. As an example, if your ISP or your bank
1703      has specific requirements, and need special handling, this kind of
1704      thing should go here. This file will not be upgraded.
1705     </para>
1706   </listitem>
1707    <listitem>
1708     <para>
1709      <filename>standard.action</filename> - is used by the web based editor,
1710      to set various pre-defined sets of rules for the default actions section
1711      in <filename>default.action</filename>. These have increasing levels of
1712      aggressiveness <emphasis>and have no influence on your browsing unless
1713      you select them explicitly in the editor</emphasis>. It is not recommend
1714      to edit this file.
1715     </para>
1716     <para>
1717      The default profiles, and their associated actions, as pre-defined in
1718      <filename>standard.action</filename> are:
1719     </para>
1720     <para>
1721     <table frame=all><title>Default Configurations</title>
1722     <tgroup cols=4 align=left colsep=1 rowsep=1>
1723     <colspec colname=c1>
1724     <colspec colname=c2>
1725     <colspec colname=c3>
1726     <colspec colname=c4>
1727     <thead>
1728     <row>
1729       <entry>Feature</entry>
1730       <entry>Cautious</entry>
1731       <entry>Medium</entry>
1732       <entry>Adventuresome</entry>
1733     </row>
1734     </thead>
1735     <!--  <tfoot> -->
1736     <!--  <row> -->
1737     <!--    <entry>f1</entry> -->
1738     <!--    <entry>f2</entry> -->
1739     <!--    <entry>f3</entry> -->
1740     <!--    <entry>f4</entry> -->
1741     <!--  </row> -->
1742     <!--  </tfoot> -->
1743     <tbody>
1744
1745     <row>
1746       <entry>Ad-blocking by URL</entry>
1747       <entry>yes</entry>
1748       <entry>yes</entry>
1749       <entry>yes</entry>
1750     </row>
1751
1752     <row>
1753       <entry>Ad-filtering by size</entry>
1754       <entry>yes</entry>
1755       <entry>yes</entry>
1756       <entry>yes</entry>
1757     </row>
1758
1759     <row>
1760       <entry>GIF de-animation</entry>
1761       <entry>no</entry>
1762       <entry>yes</entry>
1763       <entry>yes</entry>
1764     </row>
1765
1766     <row>
1767       <entry>Referer forging</entry>
1768       <entry>no</entry>
1769       <entry>yes</entry>
1770       <entry>yes</entry>
1771     </row>
1772
1773     <row>
1774       <entry>Cookie handling</entry>
1775       <entry>none</entry>
1776       <entry>session-only</entry>
1777       <entry>kill</entry>
1778     </row>
1779
1780     <row>
1781       <entry>Pop-up killing</entry>
1782       <entry>unsolicited</entry>
1783       <entry>unsolicited</entry>
1784       <entry>all</entry>
1785     </row>
1786
1787     <row>
1788       <entry>Fast redirects</entry>
1789       <entry>no</entry>
1790       <entry>no</entry>
1791       <entry>yes</entry>
1792     </row>
1793
1794     <row>
1795       <entry>HTML taming</entry>
1796       <entry>yes</entry>
1797       <entry>yes</entry>
1798       <entry>yes</entry>
1799     </row>
1800
1801     <row>
1802       <entry>JavaScript taming</entry>
1803       <entry>yes</entry>
1804       <entry>yes</entry>
1805       <entry>yes</entry>
1806     </row>
1807
1808     <row>
1809       <entry>Web-bug killing</entry>
1810       <entry>yes</entry>
1811       <entry>yes</entry>
1812       <entry>yes</entry>
1813     </row>
1814
1815     <row>
1816       <entry>Fun text replacements</entry>
1817       <entry>no</entry>
1818       <entry>no</entry>
1819       <entry>yes</entry>
1820     </row>
1821
1822     <row>
1823       <entry>Image tag reordering</entry>
1824       <entry>no</entry>
1825       <entry>no</entry>
1826       <entry>yes</entry>
1827     </row>
1828
1829     <row>
1830       <entry>Ad-filtering by link</entry>
1831       <entry>no</entry>
1832       <entry>no</entry>
1833       <entry>yes</entry>
1834     </row>
1835
1836     <row>
1837       <entry>Demoronizer</entry>
1838       <entry>no</entry>
1839       <entry>no</entry>
1840       <entry>yes</entry>
1841     </row>
1842
1843
1844     </tbody>
1845     </tgroup>
1846     </table>
1847     </para>
1848
1849    </listitem>
1850   </itemizedlist>
1851  </para>
1852
1853 <para>
1854  The list of actions files to be used are defined in the main configuration
1855  file, and are processed in the order they are defined (e.g.
1856  <filename>default.action</filename> is typically process before
1857  <filename>user.action</filename>). The content of these can all be viewed and
1858  edited from <ulink
1859  url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
1860 </para>
1861
1862 <para>
1863  An actions file typically has multiple sections. If you want to use
1864  <quote>aliases</quote> in an actions file, you have to place the (optional)
1865  <link linkend="aliases">alias section</link> at the top of that file.
1866  Then comes the default set of rules which will apply universally to all
1867  sites and pages (be <emphasis>very careful</emphasis> with using such a
1868  universal set in <filename>user.action</filename> or any other actions file after
1869  <filename>default.action</filename>, because it will override the result
1870  from consulting any previous file). And then below that,
1871  exceptions to the defined universal policies. You can regard
1872  <filename>user.action</filename> as an appendix to <filename>default.action</filename>,
1873  with the advantage that is a separate file, which makes preserving your
1874  personal settings across <application>Privoxy</application> upgrades easier.
1875 </para>
1876
1877 <para>
1878  Actions can be used to block anything you want, including ads, banners, or
1879  just some obnoxious URL that you would rather not see. Cookies can be accepted
1880  or rejected, or accepted only during the current browser session (i.e. not
1881  written to disk), content can be modified, JavaScripts tamed, user-tracking
1882  fooled, and much more. See below for a <link linkend="actions">complete list
1883  of actions</link>.
1884 </para>
1885
1886 <!--   ~~~~~       New section      ~~~~~     -->
1887 <sect2>
1888 <title>Finding the Right Mix</title>
1889 <para>
1890  Note that some <link linkend="actions">actions</link>, like cookie suppression
1891  or script disabling, may render some sites unusable that rely on these
1892  techniques to work properly. Finding the right mix of actions is not always easy and
1893  certainly a matter of personal taste. In general, it can be said that the more
1894  <quote>aggressive</quote> your default settings (in the top section of the
1895  actions file) are, the more exceptions for <quote>trusted</quote> sites you
1896  will have to make later. If, for example, you want to crunch all cookies per
1897  default, you'll have to make exceptions from that rule for sites that you
1898  regularly use and that require cookies for actually useful puposes, like maybe
1899  your bank, favorite shop, or newspaper.
1900 </para>
1901
1902 <para>
1903  We have tried to provide you with reasonable rules to start from in the
1904  distribution actions files. But there is no general rule of thumb on these
1905  things. There just are too many variables, and sites are constantly changing.
1906  Sooner or later you will want to change the rules (and read this chapter again :).
1907 </para>
1908 </sect2>
1909
1910 <!--   ~~~~~       New section      ~~~~~     -->
1911 <sect2>
1912 <title>How to Edit</title>
1913 <para>
1914  The easiest way to edit the actions files is with a browser by
1915  using our browser-based editor, which can be reached from <ulink
1916  url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
1917  The editor allows both fine-grained control over every single feature on a
1918  per-URL basis, and easy choosing from wholesale sets of defaults like
1919  <quote>Cautious</quote>, <quote>Medium</quote> or <quote>Adventuresome</quote>.
1920  Warning: the <quote>Adventuresome</quote> setting is not only more aggressive,
1921  but includes settings that are fun and subversive, and which some may find of
1922  dubious merit!
1923 </para>
1924
1925 <para>
1926  If you prefer plain text editing to GUIs, you can of course also directly edit the
1927  the actions files. Look at <filename>default.action</filename> which is richly
1928  commented.
1929 </para>
1930 </sect2>
1931
1932
1933 <sect2 id="actions-apply">
1934 <title>How Actions are Applied to URLs</title>
1935 <para>
1936  Actions files are divided into sections. There are special sections,
1937  like the <quote><link linkend="aliases">alias</link></quote> sections which will
1938  be discussed later. For now let's concentrate on regular sections: They have a
1939  heading line (often split up to multiple lines for readability) which consist
1940  of a list of actions, separated by whitespace and enclosed in curly braces.
1941  Below that, there is a list of URL patterns, each on a separate line.
1942 </para>
1943
1944 <para>
1945  To determine which actions apply to a request, the URL of the request is
1946  compared to all patterns in each <quote>action file</quote> file. Every time it matches, the list of
1947  applicable actions for the URL is incrementally updated, using the heading
1948  of the section in which the pattern is located. If multiple matches for
1949  the same URL set the same action differently, the last match wins. If not,
1950  the effects are aggregated. E.g. a URL might match a regular section with
1951  a heading line of <literal>{
1952  +<link linkend="handle-as-image">handle-as-image</link> }</literal>,
1953  then later another one with just <literal>{
1954  +<link linkend="block">block</link> }</literal>, resulting
1955  in <emphasis>both</emphasis> actions to apply.
1956 </para>
1957
1958 <para>
1959  You can trace this process for any given URL by visiting <ulink
1960  url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>.
1961 </para>
1962
1963 <para>
1964  More detail on this is provided in the Appendix, <link linkend="ACTIONSANAT">
1965  Anatomy of an Action</link>.
1966 </para>
1967 </sect2>
1968
1969 <!--   ~~~~~       New section      ~~~~~     -->
1970 <sect2 id="af-patterns">
1971 <title>Patterns</title>
1972 <para>
1973  As mentioned, <application>Privoxy</application> uses <quote>patterns</quote>
1974  to determine what actions might apply to which sites and pages your browser
1975  attempts to access. These <quote>patterns</quote> use wild card type
1976  <emphasis>pattern</emphasis> matching to achieve a high degree of
1977  flexibility. This allows one expression to be expanded and potentially match
1978  against many similar patterns.
1979 </para>
1980
1981 <para>
1982  Generally, a <application>Privoxy</application> pattern has the form
1983  <literal>&lt;domain&gt;/&lt;path&gt;</literal>, where both the
1984  <literal>&lt;domain&gt;</literal> and <literal>&lt;path&gt;</literal> are
1985  optional. (This is why the special <literal>/</literal> pattern matches all
1986  URLs). Note that the protocol portion of the URL pattern (e.g.
1987  <literal>http://</literal>) should <emphasis>not</emphasis> be included in
1988  the pattern. This is assumed already!
1989 </para>
1990
1991 <variablelist>
1992  <varlistentry>
1993   <term><literal>www.example.com/</literal></term>
1994   <listitem>
1995    <para>
1996     is a domain-only pattern and will match any request to <literal>www.example.com</literal>,
1997     regardless of which document on that server is requested.
1998    </para>
1999   </listitem>
2000  </varlistentry>
2001  <varlistentry>
2002   <term><literal>www.example.com</literal></term>
2003   <listitem>
2004    <para>
2005     means exactly the same. For domain-only patterns, the trailing <literal>/</literal> may
2006     be omitted.
2007    </para>
2008   </listitem>
2009  </varlistentry>
2010  <varlistentry>
2011   <term><literal>www.example.com/index.html</literal></term>
2012   <listitem>
2013    <para>
2014     matches only the single document <literal>/index.html</literal>
2015     on <literal>www.example.com</literal>.
2016    </para>
2017   </listitem>
2018  </varlistentry>
2019  <varlistentry>
2020   <term><literal>/index.html</literal></term>
2021   <listitem>
2022    <para>
2023     matches the document <literal>/index.html</literal>, regardless of the domain,
2024     i.e. on <emphasis>any</emphasis> web server.
2025    </para>
2026   </listitem>
2027  </varlistentry>
2028  <varlistentry>
2029   <term><literal>index.html</literal></term>
2030   <listitem>
2031    <para>
2032     matches nothing, since it would be  interpreted as a domain name and
2033     there is no top-level domain called <literal>.html</literal>.
2034    </para>
2035   </listitem>
2036  </varlistentry>
2037 </variablelist>
2038
2039
2040 <!--   ~~~~~       New section      ~~~~~     -->
2041 <sect3><title>The Domain Pattern</title>
2042
2043 <para>
2044  The matching of the domain part offers some flexible options: if the
2045  domain starts or ends with a dot, it becomes unanchored at that end.
2046  For example:
2047 </para>
2048
2049 <variablelist>
2050  <varlistentry>
2051   <term><literal>.example.com</literal></term>
2052   <listitem>
2053    <para>
2054     matches any domain that <emphasis>ENDS</emphasis> in
2055     <literal>.example.com</literal>
2056    </para>
2057   </listitem>
2058  </varlistentry>
2059  <varlistentry>
2060   <term><literal>www.</literal></term>
2061   <listitem>
2062    <para>
2063     matches any domain that <emphasis>STARTS</emphasis> with
2064     <literal>www.</literal>
2065    </para>
2066   </listitem>
2067  </varlistentry>
2068  <varlistentry>
2069   <term><literal>.example.</literal></term>
2070   <listitem>
2071    <para>
2072     matches any domain that <emphasis>CONTAINS</emphasis> <literal>.example.</literal>
2073     (Correctly speaking: It matches any FQDN that contains <literal>example</literal> as a domain.)
2074    </para>
2075   </listitem>
2076  </varlistentry>
2077 </variablelist>
2078
2079 <para>
2080  Additionally, there are wild-cards that you can use in the domain names
2081  themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
2082  stands for zero or more arbitrary characters, <quote>?</quote> stands for
2083  any single character, you can define character classes in square
2084  brackets and all of that can be freely mixed:
2085 </para>
2086
2087 <variablelist>
2088  <varlistentry>
2089   <term><literal>ad*.example.com</literal></term>
2090   <listitem>
2091    <para>
2092     matches <quote>adserver.example.com</quote>,
2093     <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>
2094    </para>
2095   </listitem>
2096  </varlistentry>
2097  <varlistentry>
2098   <term><literal>*ad*.example.com</literal></term>
2099   <listitem>
2100    <para>
2101     matches all of the above, and then some.
2102    </para>
2103   </listitem>
2104  </varlistentry>
2105  <varlistentry>
2106   <term><literal>.?pix.com</literal></term>
2107   <listitem>
2108    <para>
2109     matches <literal>www.ipix.com</literal>,
2110     <literal>pictures.epix.com</literal>, <literal>a.b.c.d.e.upix.com</literal> etc.
2111    </para>
2112   </listitem>
2113  </varlistentry>
2114  <varlistentry>
2115   <term><literal>www[1-9a-ez].example.c*</literal></term>
2116   <listitem>
2117    <para>
2118      matches <literal>www1.example.com</literal>,
2119      <literal>www4.example.cc</literal>, <literal>wwwd.example.cy</literal>,
2120      <literal>wwwz.example.com</literal> etc., but <emphasis>not</emphasis>
2121      <literal>wwww.example.com</literal>.
2122    </para>
2123   </listitem>
2124  </varlistentry>
2125 </variablelist>
2126
2127 </sect3>
2128
2129 <!--  ~  End section  ~  -->
2130
2131
2132 <!--   ~~~~~       New section      ~~~~~     -->
2133 <sect3><title>The Path Pattern</title>
2134
2135 <para>
2136  <application>Privoxy</application> uses Perl compatible regular expressions
2137  (through the <ulink url="http://www.pcre.org/">PCRE</ulink> library) for
2138  matching the path.
2139 </para>
2140
2141 <para>
2142  There is an <link linkend="regex">Appendix</link> with a brief quick-start into regular
2143  expressions, and full (very technical) documentation on PCRE regex syntax is available on-line
2144  at <ulink url="http://www.pcre.org/man.txt">http://www.pcre.org/man.txt</ulink>.
2145  You might also find the Perl man page on regular expressions (<literal>man perlre</literal>)
2146  useful, which is available on-line at <ulink
2147  url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>.
2148 </para>
2149
2150 <para>
2151  Note that the path pattern is automatically left-anchored at the <quote>/</quote>,
2152  i.e. it matches as if it would start with a <quote>^</quote> (regular expression speak
2153  for the beginning of a line).
2154 </para>
2155
2156 <para>
2157  Please also note that matching in the path is <emphasis>CASE INSENSITIVE</emphasis>
2158  by default, but you can switch to case sensitive at any point in the pattern by using the
2159  <quote>(?-i)</quote> switch: <literal>www.example.com/(?-i)PaTtErN.*</literal> will match
2160  only documents whose path starts with <literal>PaTtErN</literal> in
2161  <emphasis>exactly</emphasis> this capitalization.
2162 </para>
2163 </sect3>
2164
2165 </sect2>
2166
2167 <!--  ~  End section  ~  -->
2168
2169
2170 <!--   ~~~~~       New section      ~~~~~     -->
2171
2172 <sect2 id="actions">
2173 <title>Actions</title>
2174 <para>
2175  All actions are disabled by default, until they are explicitly enabled
2176  somewhere in an actions file. Actions are turned on if preceded with a
2177  <quote>+</quote>, and turned off if preceded with a <quote>-</quote>. So a
2178  <literal>+action</literal> means <quote>do that action</quote>, e.g.
2179  <literal>+block</literal> means <quote>please block URLs that match the
2180  following patterns</quote>, and <literal>-block</literal> means <quote>don't
2181  block URLs that match the following patterns, even if <literal>+block</literal>
2182  previously applied.</quote>
2183
2184 </para>
2185
2186 <para>
2187  Again, actions are invoked by placing them on a line, enclosed in curly braces and
2188  separated by whitespace, like in
2189  <literal>{+some-action -some-other-action{some-parameter}}</literal>,
2190  followed by a list of URL patterns, one per line, to which they apply.
2191  Together, the actions line and the following pattern lines make up a section
2192  of the actions file.
2193 </para>
2194
2195 <para>
2196  There are three classes of actions:
2197 </para>
2198
2199 <para>
2200  <itemizedlist>
2201  <listitem>
2202   <para>
2203    Boolean, i.e the action can only be <quote>enabled</quote> or
2204    <quote>disabled</quote>. Syntax:
2205   </para>
2206   <para>
2207    <screen>
2208   +<replaceable class="function">name</replaceable>        # enable action <replaceable class="parameter">name</replaceable>
2209   -<replaceable class="function">name</replaceable>        # disable action <replaceable class="parameter">name</replaceable></screen>
2210   </para>
2211   <para>
2212    Example: <literal>+block</literal>
2213   </para>
2214  </listitem>
2215
2216
2217  <listitem>
2218   <para>
2219    Parameterized, where some value is required in order to enable this type of action.
2220    Syntax:
2221   </para>
2222   <para>
2223    <screen>
2224   +<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>}  # enable action and set parameter to <replaceable class="parameter">param</replaceable>,
2225                # overwriting parameter from previous match if necessary
2226   -<replaceable class="function">name</replaceable>         # disable action. The parameter can be omitted</screen>
2227   </para>
2228   <para>
2229    Note that if the URL matches multiple positive forms of a parameterized action,
2230    the last match wins, i.e. the params from earlier matches are simply ignored.
2231   </para>
2232   <para>
2233    Example: <literal>+hide-user-agent{ Mozilla 1.0 }</literal>
2234   </para>
2235  </listitem>
2236
2237  <listitem>
2238   <para>
2239    Multi-value. These look exactly like parameterized actions,
2240    but they behave differently: If the action applies multiple times to the
2241    same URL, but with different parameters, <emphasis>all</emphasis> the parameters
2242    from <emphasis>all</emphasis> matches are remembered. This is used for actions
2243    that can be executed for the same request repeatedly, like adding multiple
2244    headers, or filtering through multiple filters. Syntax:
2245   </para>
2246   <para>
2247    <screen>
2248   +<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>}   # enable action and add <replaceable class="parameter">param</replaceable> to the list of parameters
2249   -<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>}   # remove the parameter <replaceable class="parameter">param</replaceable> from the list of parameters
2250                 # If it was the last one left, disable the action.
2251   <replaceable class="parameter">-name</replaceable>          # disable this action completely and remove all parameters from the list</screen>
2252   </para>
2253   <para>
2254    Examples: <literal>+add-header{X-Fun-Header: Some text}</literal> and
2255    <literal>+filter{html-annoyances}</literal>
2256   </para>
2257  </listitem>
2258
2259  </itemizedlist>
2260 </para>
2261
2262 <para>
2263  If nothing is specified in any actions file, no <quote>actions</quote> are
2264  taken. So in this case <application>Privoxy</application> would just be a
2265  normal, non-blocking, non-anonymizing proxy. You must specifically enable the
2266  privacy and blocking features you need (although the provided default actions
2267  files will give a good starting point).
2268 </para>
2269
2270 <para>
2271  Later defined actions always over-ride earlier ones.  So exceptions
2272  to any rules you make, should come in the latter part of the file (or
2273  in a file that is processed later when using multiple actions files). For
2274  multi-valued actions, the actions are applied in the order they are specified.
2275  Actions files are processed in the order they are defined in
2276  <filename>config</filename> (the default installation has three actions
2277  files). It also quite possible for any given URL pattern to match more than
2278  one pattern and thus more than one set of actions!
2279 </para>
2280
2281 <!-- start actions listing -->
2282 <para>
2283  The list of valid <application>Privoxy</application> actions are:
2284 </para>
2285
2286
2287 <!-- ********************************************************** -->
2288 <!-- Please note the below defined actions use id's that are    -->
2289 <!-- probably linked from other places, so please don't change. -->
2290 <!--                                                            -->
2291 <!-- ********************************************************** -->
2292
2293
2294 <!--   ~~~~~       New section      ~~~~~     -->
2295
2296 <sect3 renderas="sect4" id="add-header">
2297 <title>add-header</title>
2298
2299 <variablelist>
2300  <varlistentry>
2301   <term>Typical use:</term>
2302   <listitem>
2303    <para>Confuse log analysis, custom applications</para>
2304   </listitem>
2305  </varlistentry>
2306
2307  <varlistentry>
2308   <term>Effect:</term>
2309   <listitem>
2310    <para>
2311     Sends a user defined HTTP header to the web server.
2312    </para>
2313   </listitem>
2314  </varlistentry>
2315
2316  <varlistentry>
2317   <term>Type:</term>
2318   <!-- boolean, parameterized, Multi-value -->
2319   <listitem>
2320    <para>Multi-value.</para>
2321   </listitem>
2322  </varlistentry>
2323
2324  <varlistentry>
2325   <term>Parameter:</term>
2326   <listitem>
2327    <para>
2328     Any string value is possible. Validity of the defined HTTP headers is not checked.
2329     It is recommended that you use the <quote><literal>X-</literal></quote> prefix
2330     for custom headers.
2331    </para>
2332   </listitem>
2333  </varlistentry>
2334
2335 <varlistentry>
2336   <term>Notes:</term>
2337   <listitem>
2338    <para>
2339     This action may be specified multiple times, in order to define multiple
2340     headers. This is rarely needed for the typical user. If you don't know what
2341     <quote>HTTP headers</quote> are, you definitely don't need to worry about this
2342     one.
2343    </para>
2344   </listitem>
2345  </varlistentry>
2346
2347  <varlistentry>
2348   <term>Example usage:</term>
2349   <listitem>
2350     <para>
2351      <screen>+add-header{X-User-Tracking: sucks}</screen>
2352    </para>
2353   </listitem>
2354  </varlistentry>
2355 </variablelist>
2356 </sect3>
2357
2358
2359 <!--   ~~~~~       New section      ~~~~~     -->
2360 <sect3 renderas="sect4" id="block">
2361 <title>block</title>
2362
2363 <variablelist>
2364  <varlistentry>
2365   <term>Typical use:</term>
2366   <listitem>
2367    <para>Block ads or other obnoxious content</para>
2368   </listitem>
2369  </varlistentry>
2370
2371  <varlistentry>
2372   <term>Effect:</term>
2373   <listitem>
2374    <para>
2375     Requests for URLs to which this action applies are blocked, i.e. the requests are not
2376     forwarded to the remote server, but answered locally with a substitute page or image,
2377     as determined by the <literal><link linkend="handle-as-image">handle-as-image</link></literal>
2378     and <literal><link linkend="set-image-blocker">set-image-blocker</link></literal> actions.
2379    </para>
2380   </listitem>
2381  </varlistentry>
2382
2383  <varlistentry>
2384   <term>Type:</term>
2385   <!-- boolean, parameterized, Multi-value -->
2386   <listitem>
2387    <para>Boolean.</para>
2388   </listitem>
2389  </varlistentry>
2390
2391  <varlistentry>
2392   <term>Parameter:</term>
2393   <listitem>
2394    <para>N/A</para>
2395   </listitem>
2396  </varlistentry>
2397
2398 <varlistentry>
2399   <term>Notes:</term>
2400   <listitem>
2401    <para>
2402     <application>Privoxy</application> sends a special <quote>BLOCKED</quote> page
2403     for requests to blocked pages. This page contains links to find out why the request
2404     was blocked, and a click-through to the blocked content (the latter only if compiled with the
2405     force feature enabled). The <quote>BLOCKED</quote> page adapts to the available
2406     screen space -- it displays full-blown if space allows, or miniaturized and text-only
2407     if loaded into a small frame or window. If you are using <application>Privoxy</application>
2408     right now, you can take a look at the
2409     <ulink url="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"><quote>BLOCKED</quote>
2410     page</ulink>.
2411    </para>
2412    <para>
2413     A very important exception occurs if <emphasis>both</emphasis>
2414     <literal>block</literal> and <literal><link linkend="handle-as-image">handle-as-image</link></literal>,
2415     apply to the same request: it will then be replaced by an image. If
2416     <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>
2417     (see below) also applies, the type of image will be determined by its parameter,
2418     if not, the standard checkerboard pattern is sent.
2419    </para>
2420    <para>
2421     It is important to understand this process, in order
2422     to understand how <application>Privoxy</application> deals with
2423     ads and other unwanted content.
2424    </para>
2425    <para>
2426     The <literal><link linkend="filter">filter</link></literal>
2427     action can perform a very similar task, by <quote>blocking</quote>
2428     banner images and other content through rewriting the relevant URLs in the
2429     document's HTML source, so they don't get requested in the first place.
2430     Note that this is a totally different technique, and it's easy to confuse the two.
2431    </para>
2432   </listitem>
2433  </varlistentry>
2434
2435  <varlistentry>
2436   <term>Example usage (section):</term>
2437   <listitem>
2438     <para>
2439      <screen>{+block}      # Block and replace with "blocked" page
2440 .nasty-stuff.example.com
2441
2442 {+block +handle-as-image} # Block and replace with image
2443 .ad.doubleclick.net
2444 .ads.r.us</screen>
2445     </para>
2446   </listitem>
2447  </varlistentry>
2448
2449
2450 </variablelist>
2451 </sect3>
2452
2453
2454 <!--   ~~~~~       New section      ~~~~~     -->
2455 <sect3 renderas="sect4" id="content-type-overwrite">
2456 <!--
2457 new action
2458 -->
2459 <title>content-type-overwrite</title>
2460
2461 <variablelist>
2462  <varlistentry>
2463   <term>Typical use:</term>
2464   <listitem>
2465    <para>Stop useless download menus from popping up, or change the browser's rendering mode</para>
2466   </listitem>
2467  </varlistentry>
2468
2469  <varlistentry>
2470   <term>Effect:</term>
2471   <listitem>
2472    <para>
2473     Replaces the <quote>Content-Type:</quote> HTTP server header.
2474    </para>
2475   </listitem>
2476  </varlistentry>
2477
2478  <varlistentry>
2479   <term>Type:</term>
2480   <!-- Boolean, Parameterized, Multi-value -->
2481   <listitem>
2482    <para>Parameterized.</para>
2483   </listitem>
2484  </varlistentry>
2485
2486  <varlistentry>
2487   <term>Parameter:</term>
2488   <listitem>
2489    <para>
2490     Any string.
2491    </para>
2492   </listitem>
2493  </varlistentry>
2494
2495  <varlistentry>
2496   <term>Notes:</term>
2497   <listitem>
2498    <para>
2499     The <quote>Content-Type:</quote> HTTP server header is used by the
2500     browser to decide what to do with the document. The value of this
2501     header can cause the browser to open a download menu instead of
2502     displaying the document by itself, even if the document's format is
2503     supported by the browser.
2504    </para>
2505    <para>
2506     The declared content type can also affect which rendering mode
2507     the browser chooses. If XHTML is delivered as <quote>text/html</quote>,
2508     many browsers treat it as yet another broken HTML document.
2509     If it is send as <quote>application/xml</quote>, browsers with
2510     XHTML support will only display it, if the syntax is correct.
2511    </para>
2512    <para>
2513     If you see a web site that proudly uses XHTML buttons, but sets
2514     <quote>Content-Type: text/html</quote>, you can use Privoxy
2515     to overwrite it with <quote>application/xml</quote> and validate
2516     the web master's claim inside your XHTML-supporting browser.
2517     If the syntax is incorrect, the browser will complain loudly.
2518    </para>
2519    <para>
2520     You can also go the opposite direction: if your browser prints
2521     error messages instead of rendering a document falsely declared
2522     as XHTML, you can overwrite the content type with
2523     <quote>text/html</quote> and have it rendered as broken HTML document.
2524    </para>
2525    <para>
2526     By default <literal>content-type-overwrite</literal> only replaces
2527     <quote>Content-Type:</quote> headers that look like some kind of text.
2528     If you want to overwrite it unconditionally, you have to combine it with
2529     <literal><link linkend="force-text-mode">force-text-mode</link></literal>.
2530     This limitation exists for a reason, think twice before circumventing it.
2531    </para>
2532    <para>
2533     Most of the time it's easier to enable
2534     <literal><link linkend="filter-server-headers">filter-server-headers</link></literal>
2535     and replace this action with a custom regular expression. It allows you
2536     to activate it for every document of a certain site and it will still
2537     only replace the content types you aimed at.
2538    </para>
2539    <para>
2540     Of course you can apply <literal>content-type-overwrite</literal>
2541     to a whole site and then make URL based exceptions, but it's a lot
2542     more work to get the same precision.
2543    </para>
2544   </listitem>
2545  </varlistentry>
2546
2547  <varlistentry>
2548   <term>Example usage (sections):</term>
2549   <listitem>
2550     <para>
2551      <screen># Check if www.example.net/ really uses valid XHTML
2552 {+content-type-overwrite {application/xml}}
2553 www.example.net/
2554 # but leave the content type unmodified if the URL looks like a style sheet
2555 {-content-type-overwrite}
2556 www.example.net/*.\.css$
2557 www.example.net/*.style
2558 </screen>
2559    </para>
2560   </listitem>
2561  </varlistentry>
2562 </variablelist>
2563 </sect3>
2564
2565
2566 <!--   ~~~~~       New section      ~~~~~     -->
2567 <sect3 renderas="sect4" id="crunch-client-header">
2568 <!--
2569 new action
2570 -->
2571 <title>crunch-client-header</title>
2572
2573 <variablelist>
2574  <varlistentry>
2575   <term>Typical use:</term>
2576   <listitem>
2577    <para>Remove a client header <application>Privoxy</application> has no dedicated action for.</para>
2578   </listitem>
2579  </varlistentry>
2580
2581  <varlistentry>
2582   <term>Effect:</term>
2583   <listitem>
2584    <para>
2585     Deletes every header sent by the client that contains the string the user supplied as parameter.
2586    </para>
2587   </listitem>
2588  </varlistentry>
2589
2590  <varlistentry>
2591   <term>Type:</term>
2592   <!-- Boolean, Parameterized, Multi-value -->
2593   <listitem>
2594    <para>Parameterized.</para>
2595   </listitem>
2596  </varlistentry>
2597
2598  <varlistentry>
2599   <term>Parameter:</term>
2600   <listitem>
2601    <para>
2602     Any string.
2603    </para>
2604   </listitem>
2605  </varlistentry>
2606
2607  <varlistentry>
2608   <term>Notes:</term>
2609   <listitem>
2610    <para>
2611     This action allows you to block client headers for which no dedicated
2612     <application>Privoxy</application> action exists.
2613     <application>Privoxy</application> will remove every client header that
2614     contains the string you supplied as parameter.
2615    </para>
2616    <para>
2617     Regular expressions are <emphasis>not supported</emphasis> and you can't
2618     use this action to block different headers in the same request, unless
2619     they contain the same string.
2620    </para>
2621    <para>
2622     <literal>crunch-client-header</literal> is only meant for quick tests.
2623     If you have to block several different headers, or only want to modify
2624     parts of them, you should enable
2625     <literal><link linkend="filter-client-headers">filter-client-headers</link></literal>
2626     and create your own filter.
2627    </para>
2628     <warning>
2629      <para>
2630       Don't block any header without understanding the consequences.
2631      </para>
2632     </warning>
2633   </listitem>
2634  </varlistentry>
2635
2636  <varlistentry>
2637   <term>Example usage (section):</term>
2638   <listitem>
2639     <para>
2640      <screen># Block the non-existent "Privacy-Violation:" client header
2641 {+crunch-client-header {Privacy-Violation:}}
2642 /
2643     </screen>
2644    </para>
2645   </listitem>
2646  </varlistentry>
2647 </variablelist>
2648 </sect3>
2649
2650
2651 <!--   ~~~~~       New section      ~~~~~     -->
2652 <sect3 renderas="sect4" id="crunch-if-none-match">
2653 <title>crunch-if-none-match</title>
2654 <!--
2655 new action
2656 -->
2657 <variablelist>
2658  <varlistentry>
2659   <term>Typical use:</term>
2660   <listitem>
2661    <para>Prevent yet another way to track the user's steps between sessions.</para>
2662   </listitem>
2663  </varlistentry>
2664
2665  <varlistentry>
2666   <term>Effect:</term>
2667   <listitem>
2668    <para>
2669     Deletes the <quote>If-None-Match:</quote> HTTP client header.
2670    </para>
2671   </listitem>
2672  </varlistentry>
2673
2674  <varlistentry>
2675   <term>Type:</term>
2676   <!-- Boolean, Parameterized, Multi-value -->
2677   <listitem>
2678    <para>Boolean.</para>
2679   </listitem>
2680  </varlistentry>
2681
2682  <varlistentry>
2683   <term>Parameter:</term>
2684   <listitem>
2685    <para>
2686     N/A
2687    </para>
2688   </listitem>
2689  </varlistentry>
2690
2691  <varlistentry>
2692   <term>Notes:</term>
2693   <listitem>
2694    <para>
2695     Removing the <quote>If-None-Match:</quote> HTTP client header
2696     is useful for filter testing, where you want to force a real
2697     reload instead of getting status code <quote>304</quote> which
2698     would cause the browser to use a cached copy of the page.
2699    </para>
2700    <para>
2701     It is also useful to make sure the header isn't used as a cookie
2702     replacement.
2703    </para>
2704    <para>
2705     Blocking the <quote>If-None-Match:</quote> header shouldn't cause any
2706     caching problems, as long as the <quote>If-Modified-Since:</quote> header
2707     isn't blocked as well.
2708    </para>
2709    <para>
2710     It is recommended to use this action together with
2711     <literal><link linkend="hide-if-modified-since">hide-if-modified-since</link></literal>
2712     and
2713     <literal><link linkend="overwrite-last-modified">overwrite-last-modified</link></literal>.
2714    </para>
2715   </listitem>
2716  </varlistentry>
2717
2718  <varlistentry>
2719   <term>Example usage (section):</term>
2720   <listitem>
2721     <para>
2722      <screen># Let the browser revalidate cached documents without being tracked across sessions
2723 {+hide-if-modified-since {-1} \
2724 +overwrite-last-modified {randomize} \
2725 +crunch-if-none-match}
2726 /   </screen>
2727    </para>
2728   </listitem>
2729  </varlistentry>
2730 </variablelist>
2731 </sect3>
2732
2733
2734 <!--   ~~~~~       New section      ~~~~~     -->
2735 <sect3 renderas="sect4" id="crunch-incoming-cookies">
2736 <title>crunch-incoming-cookies</title>
2737
2738 <variablelist>
2739  <varlistentry>
2740   <term>Typical use:</term>
2741   <listitem>
2742    <para>
2743     Prevent the web server from setting any cookies on your system
2744    </para>
2745   </listitem>
2746  </varlistentry>
2747
2748  <varlistentry>
2749   <term>Effect:</term>
2750   <listitem>
2751    <para>
2752     Deletes any <quote>Set-Cookie:</quote> HTTP headers from server replies.
2753    </para>
2754   </listitem>
2755  </varlistentry>
2756
2757  <varlistentry>
2758   <term>Type:</term>
2759   <!-- Boolean, Parameterized, Multi-value -->
2760   <listitem>
2761    <para>Boolean.</para>
2762   </listitem>
2763  </varlistentry>
2764
2765  <varlistentry>
2766   <term>Parameter:</term>
2767   <listitem>
2768    <para>
2769     N/A
2770    </para>
2771   </listitem>
2772  </varlistentry>
2773
2774  <varlistentry>
2775   <term>Notes:</term>
2776   <listitem>
2777    <para>
2778     This action is only concerned with <emphasis>incoming</emphasis> cookies. For
2779     <emphasis>outgoing</emphasis> cookies, use
2780     <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>.
2781     Use <emphasis>both</emphasis> to disable cookies completely.
2782    </para>
2783    <para>
2784     It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
2785     with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
2786     since it would prevent the session cookies from being set. See also
2787     <literal><link linkend="filter-content-cookies">filter-content-cookies</link></literal>.
2788    </para>
2789   </listitem>
2790  </varlistentry>
2791
2792  <varlistentry>
2793   <term>Example usage:</term>
2794   <listitem>
2795    <para>
2796     <screen>+crunch-incoming-cookies</screen>
2797    </para>
2798   </listitem>
2799  </varlistentry>
2800 </variablelist>
2801 </sect3>
2802
2803
2804 <!--   ~~~~~       New section      ~~~~~     -->
2805 <sect3 renderas="sect4" id="crunch-server-header">
2806 <title>crunch-server-header</title>
2807 <!--
2808 new action
2809 -->
2810 <variablelist>
2811  <varlistentry>
2812   <term>Typical use:</term>
2813   <listitem>
2814    <para>Remove a server header <application>Privoxy</application> has no dedicated action for.</para>
2815   </listitem>
2816  </varlistentry>
2817
2818  <varlistentry>
2819   <term>Effect:</term>
2820   <listitem>
2821    <para>
2822     Deletes every header sent by the server that contains the string the user supplied as parameter.
2823    </para>
2824   </listitem>
2825  </varlistentry>
2826
2827  <varlistentry>
2828   <term>Type:</term>
2829   <!-- Boolean, Parameterized, Multi-value -->
2830   <listitem>
2831    <para>Parameterized.</para>
2832   </listitem>
2833  </varlistentry>
2834
2835  <varlistentry>
2836   <term>Parameter:</term>
2837   <listitem>
2838    <para>
2839     Any string.
2840    </para>
2841   </listitem>
2842  </varlistentry>
2843
2844  <varlistentry>
2845   <term>Notes:</term>
2846   <listitem>
2847    <para>
2848     This action allows you to block server headers for which no dedicated
2849     <application>Privoxy</application> action exists. <application>Privoxy</application>
2850     will remove every server header that contains the string you supplied as parameter.
2851    </para>
2852    <para>
2853     Regular expressions are <emphasis>not supported</emphasis> and you can't
2854     use this action to block different headers in the same request, unless
2855     they contain the same string.
2856    </para>
2857    <para>
2858     <literal>crunch-server-header</literal> is only meant for quick tests.
2859     If you have to block several different headers, or only want to modify
2860     parts of them, you should enable
2861     <literal><link linkend="filter-server-headers">filter-server-headers</link></literal>
2862     and create your own filter.
2863    </para>
2864     <warning>
2865      <para>
2866      Don't block any header without understanding the consequences.
2867      </para>
2868     </warning>
2869   </listitem>
2870  </varlistentry>
2871
2872  <varlistentry>
2873   <term>Example usage (section):</term>
2874   <listitem>
2875     <para>
2876      <screen># Crunch server headers that try to prevent caching
2877 {+crunch-server-header {no-cache}}
2878 /   </screen>
2879    </para>
2880   </listitem>
2881  </varlistentry>
2882 </variablelist>
2883 </sect3>
2884
2885
2886 <!--   ~~~~~       New section      ~~~~~     -->
2887 <sect3 renderas="sect4" id="crunch-outgoing-cookies">
2888 <title>crunch-outgoing-cookies</title>
2889
2890 <variablelist>
2891  <varlistentry>
2892   <term>Typical use:</term>
2893   <listitem>
2894    <para>
2895     Prevent the web server from reading any cookies from your system
2896    </para>
2897   </listitem>
2898  </varlistentry>
2899
2900  <varlistentry>
2901   <term>Effect:</term>
2902   <listitem>
2903    <para>
2904     Deletes any <quote>Cookie:</quote> HTTP headers from client requests.
2905    </para>
2906   </listitem>
2907  </varlistentry>
2908
2909  <varlistentry>
2910   <term>Type:</term>
2911   <!-- Boolean, Parameterized, Multi-value -->
2912   <listitem>
2913    <para>Boolean.</para>
2914   </listitem>
2915  </varlistentry>
2916
2917  <varlistentry>
2918   <term>Parameter:</term>
2919   <listitem>
2920    <para>
2921     N/A
2922    </para>
2923   </listitem>
2924  </varlistentry>
2925
2926  <varlistentry>
2927   <term>Notes:</term>
2928   <listitem>
2929    <para>
2930     This action is only concerned with <emphasis>outgoing</emphasis> cookies. For
2931     <emphasis>incoming</emphasis> cookies, use
2932     <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal>.
2933     Use <emphasis>both</emphasis> to disable cookies completely.
2934    </para>
2935    <para>
2936     It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
2937     with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
2938     since it would prevent the session cookies from being read.
2939    </para>
2940   </listitem>
2941  </varlistentry>
2942
2943  <varlistentry>
2944   <term>Example usage:</term>
2945   <listitem>
2946    <para>
2947     <screen>+crunch-outgoing-cookies</screen>
2948    </para>
2949   </listitem>
2950  </varlistentry>
2951
2952 </variablelist>
2953 </sect3>
2954
2955
2956 <!--   ~~~~~       New section      ~~~~~     -->
2957 <sect3 renderas="sect4" id="deanimate-gifs">
2958 <title>deanimate-gifs</title>
2959
2960 <variablelist>
2961  <varlistentry>
2962   <term>Typical use:</term>
2963   <listitem>
2964    <para>Stop those annoying, distracting animated GIF images.</para>
2965   </listitem>
2966  </varlistentry>
2967
2968  <varlistentry>
2969   <term>Effect:</term>
2970   <listitem>
2971    <para>
2972     De-animate GIF animations, i.e. reduce them to their first or last image.
2973    </para>
2974   </listitem>
2975  </varlistentry>
2976
2977  <varlistentry>
2978   <term>Type:</term>
2979   <!-- boolean, parameterized, Multi-value -->
2980   <listitem>
2981    <para>Parameterized.</para>
2982   </listitem>
2983  </varlistentry>
2984
2985  <varlistentry>
2986   <term>Parameter:</term>
2987   <listitem>
2988    <para>
2989     <quote>last</quote> or <quote>first</quote>
2990    </para>
2991   </listitem>
2992  </varlistentry>
2993
2994  <varlistentry>
2995   <term>Notes:</term>
2996   <listitem>
2997    <para>
2998     This will also shrink the images considerably (in bytes, not pixels!). If
2999     the option <quote>first</quote> is given, the first frame of the animation
3000     is used as the replacement. If <quote>last</quote> is given, the last
3001     frame of the animation is used instead, which probably makes more sense for
3002     most banner animations, but also has the risk of not showing the entire
3003     last frame (if it is only a delta to an earlier frame).
3004    </para>
3005    <para>
3006     You can safely use this action with patterns that will also match non-GIF
3007     objects, because no attempt will be made at anything that doesn't look like
3008     a GIF.
3009    </para>
3010   </listitem>
3011  </varlistentry>
3012
3013  <varlistentry>
3014   <term>Example usage:</term>
3015   <listitem>
3016     <para>
3017       <screen>+deanimate-gifs{last}</screen>
3018     </para>
3019   </listitem>
3020  </varlistentry>
3021 </variablelist>
3022 </sect3>
3023
3024 <!--   ~~~~~       New section      ~~~~~     -->
3025 <sect3 renderas="sect4" id="downgrade-http-version">
3026 <title>downgrade-http-version</title>
3027
3028 <variablelist>
3029  <varlistentry>
3030   <term>Typical use:</term>
3031   <listitem>
3032    <para>Work around (very rare) problems with HTTP/1.1</para>
3033   </listitem>
3034  </varlistentry>
3035
3036  <varlistentry>
3037   <term>Effect:</term>
3038   <listitem>
3039    <para>
3040     Downgrades HTTP/1.1 client requests and server replies to HTTP/1.0.
3041    </para>
3042   </listitem>
3043  </varlistentry>
3044
3045  <varlistentry>
3046   <term>Type:</term>
3047   <!-- boolean, parameterized, Multi-value -->
3048   <listitem>
3049    <para>Boolean.</para>
3050   </listitem>
3051  </varlistentry>
3052
3053  <varlistentry>
3054   <term>Parameter:</term>
3055   <listitem>
3056    <para>
3057     N/A
3058    </para>
3059   </listitem>
3060  </varlistentry>
3061
3062 <varlistentry>
3063   <term>Notes:</term>
3064   <listitem>
3065    <para>
3066     This is a left-over from the time when <application>Privoxy</application>
3067     didn't support important HTTP/1.1 features well. It is left here for the
3068     unlikely case that you experience HTTP/1.1 related problems with some server
3069     out there. Not all (optional) HTTP/1.1 features are supported yet, so there
3070     is a chance you might need this action.
3071    </para>
3072   </listitem>
3073  </varlistentry>
3074
3075  <varlistentry>
3076   <term>Example usage (section):</term>
3077   <listitem>
3078     <para>
3079      <screen>{+downgrade-http-version}
3080 problem-host.example.com</screen>
3081     </para>
3082   </listitem>
3083  </varlistentry>
3084
3085 </variablelist>
3086 </sect3>
3087
3088 <!--   ~~~~~       New section      ~~~~~     -->
3089 <sect3 renderas="sect4" id="fast-redirects">
3090 <title>fast-redirects</title>
3091
3092 <variablelist>
3093  <varlistentry>
3094   <term>Typical use:</term>
3095   <listitem>
3096    <para>Fool some click-tracking scripts and speed up indirect links.</para>
3097   </listitem>
3098  </varlistentry>
3099
3100  <varlistentry>
3101   <term>Effect:</term>
3102   <listitem>
3103    <para>
3104     Detects redirection URLs and redirects the browser without contacting
3105     the redirection server first.
3106    </para>
3107   </listitem>
3108  </varlistentry>
3109
3110  <varlistentry>
3111   <term>Type:</term>
3112   <!-- boolean, parameterized, Multi-value -->
3113   <listitem>
3114    <para>Parameterized.</para>
3115   </listitem>
3116  </varlistentry>
3117
3118  <varlistentry>
3119   <term>Parameter:</term>
3120   <listitem>
3121    <itemizedlist>
3122     <listitem>
3123      <para>
3124       <quote>simple-check</quote> to just search for the string <quote>http://</quote>
3125       to detect redirection URLs.
3126      </para>
3127     </listitem>
3128     <listitem>
3129      <para>
3130       <quote>check-decoded-url</quote> to decode URLs (if necessary) before searching
3131       for redirection URLs.
3132      </para>
3133     </listitem>
3134    </itemizedlist>
3135   </listitem>
3136  </varlistentry>
3137
3138  <varlistentry>
3139   <term>Notes:</term>
3140   <listitem>
3141    <para>
3142     Many sites, like yahoo.com, don't just link to other sites. Instead, they
3143     will link to some script on their own servers, giving the destination as a
3144     parameter, which will then redirect you to the final target. URLs
3145     resulting from this scheme typically look like:
3146     <quote>http://www.example.org/click-tracker.cgi?target=http%3a//www.example.net/</quote>.
3147   </para>
3148    <para>
3149     Sometimes, there are even multiple consecutive redirects encoded in the
3150     URL. These redirections via scripts make your web browsing more traceable,
3151     since the server from which you follow such a link can see where you go
3152     to. Apart from that, valuable bandwidth and time is wasted, while your
3153     browser asks the server for one redirect after the other. Plus, it feeds
3154     the advertisers.
3155    </para>
3156    <para>
3157     This feature is currently not very smart and is scheduled for improvement.
3158     If it is enabled by default, you will have to create some exceptions to
3159     this action. It can lead to failures in several ways:
3160    </para>
3161    <para>
3162     Not every URLs with other URLs as parameters is evil.
3163     Some sites offer a real service that requires this information to work.
3164     For example a validation service needs to know, which document to validate.
3165     <literal>fast-redirects</literal> assumes that every URL parameter that
3166     looks like another URL is a redirection target, and will always redirect to
3167     the last one. Most of the time the assumption is correct, but if it isn't,
3168     the user gets redirected anyway.
3169    </para>
3170    <para>
3171     Another failure occurs if the URL contains other parameters after the URL parameter.
3172     The URL:
3173     <quote>http://www.example.org/?redirect=http%3a//www.example.net/&amp;foo=bar</quote>.
3174     contains the redirection URL <quote>http://www.example.net/</quote>,
3175     followed by another parameter. <literal>fast-redirects</literal> doesn't know that
3176     and will cause a redirect to <quote>http://www.example.net/&amp;foo=bar</quote>.
3177     Depending on the target server configuration, the parameter will be silently ignored
3178     or lead to a <quote>page not found</quote> error. It is possible to fix these redirected
3179     requests with <literal><link linkend="filter-client-headers">filter-client-headers</link></literal>
3180     but it requires a little effort.
3181    </para>
3182    <para>
3183     To detect a redirection URL, <literal>fast-redirects</literal> only
3184     looks for the string <quote>http://</quote>, either in plain text
3185     (invalid but often used) or encoded as <quote>http%3a//</quote>.
3186     Some sites use their own URL encoding scheme, encrypt the address
3187     of the target server or replace it with a database id. In theses cases
3188     <literal>fast-redirects</literal> is fooled and the request reaches the
3189     redirection server where it probably gets logged.
3190    </para>
3191   </listitem>
3192  </varlistentry>
3193
3194  <varlistentry>
3195   <term>Example usage:</term>
3196   <listitem>
3197     <para>
3198      <screen>+fast-redirects{simple-check}</screen>
3199     </para>
3200     <para>
3201      <screen>+fast-redirects{check-decoded-url}</screen>
3202     </para>
3203   </listitem>
3204  </varlistentry>
3205
3206 </variablelist>
3207 </sect3>
3208
3209
3210 <!--   ~~~~~       New section      ~~~~~     -->
3211 <sect3 renderas="sect4" id="filter">
3212 <title>filter</title>
3213
3214 <variablelist>
3215  <varlistentry>
3216   <term>Typical use:</term>
3217   <listitem>
3218    <para>Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements, etc.</para>
3219   </listitem>
3220  </varlistentry>
3221
3222  <varlistentry>
3223   <term>Effect:</term>
3224   <listitem>
3225    <para>
3226     All files of text-based type, most notably HTML and JavaScript, to which this
3227     action applies, are filtered on-the-fly through the specified regular expression
3228     based substitutions. (Note: as of version 3.0.3 plain text documents
3229     are exempted from filtering, because web servers often use the
3230     <literal>text/plain</literal> MIME type for all files whose type they
3231     don't know.) By default, filtering works only on the document content
3232     itself, not the headers.
3233    </para>
3234   </listitem>
3235  </varlistentry>
3236
3237  <varlistentry>
3238   <term>Type:</term>
3239   <!-- boolean, parameterized, Multi-value -->
3240   <listitem>
3241    <para>Parameterized.</para>
3242   </listitem>
3243  </varlistentry>
3244
3245  <varlistentry>
3246   <term>Parameter:</term>
3247   <listitem>
3248    <para>
3249     The name of a filter, as defined in the <link linkend="filter-file">filter file</link>.
3250     Filters can be defined in one or more  files as defined by the
3251     <literal><link linkend="filterfile">filterfile</link></literal>
3252     option in the <link linkend="config">config file</link>.
3253     <filename>default.filter</filename> is the collection of filters
3254     supplied by the developers. Locally defined filters should go
3255     in their own file, such as <filename>user.filter</filename>.
3256    </para>
3257    <para>
3258      When used in its negative form,
3259      and without parameters, filtering is completely disabled.
3260   </para>
3261   </listitem>
3262  </varlistentry>
3263
3264  <varlistentry>
3265   <term>Notes:</term>
3266   <listitem>
3267    <para>
3268     For your convenience, there are a number of pre-defined filters available
3269     in the distribution filter file that you can use. See the examples below for
3270     a list.
3271    </para>
3272    <para>
3273     Filtering requires buffering the page content, which may appear to
3274     slow down page rendering since nothing is displayed until all content has
3275     passed the filters. (It does not really take longer, but seems that way
3276     since the page is not incrementally displayed.) This effect will be more
3277     noticeable on slower connections.
3278    </para>
3279    <para>
3280     This is very powerful feature, and <quote>rolling your own</quote>
3281     filters requires a knowledge of regular expressions and HTML.
3282    </para>
3283    <para>
3284     The amount of data that can be filtered is limited to the
3285     <literal><link linkend="buffer-limit">buffer-limit</link></literal>
3286     option in the main <link linkend="config">config file</link>. The
3287     default is 4096 KB (4 Megs). Once this limit is exceeded, the buffered
3288     data, and all pending data, is passed through unfiltered.
3289    </para>
3290    <para>
3291     Inadequate MIME types, such as zipped files, are not filtered at all.
3292     (Again, only text-based types except plain text). Encrypted SSL data
3293     (from HTTPS servers) cannot be filtered either, since this would violate
3294     the integrity of the secure transaction. In some situations it might
3295     be necessary to protect certain text, like source code, from filtering
3296     by defining appropriate <literal>-filter</literal> sections.
3297    </para>
3298    <para>
3299     At this time, <application>Privoxy</application> cannot (yet!) uncompress compressed
3300     documents. If you want filtering to work on all documents, even those that
3301     would normally be sent compressed, use the
3302     <literal><link linkend="prevent-compression">prevent-compression</link></literal>
3303     action in conjunction with <literal>filter</literal>.
3304    </para>
3305    <para>
3306     Filtering can achieve some of the same effects as the
3307     <literal><link linkend="block">block</link></literal>
3308     action, i.e. it can be used to block ads and banners. But the mechanism
3309     works quite differently. One effective use, is to block ad banners
3310     based on their size (see below), since many of these seem to be somewhat
3311     standardized.
3312    </para>
3313    <para>
3314     <link linkend="contact">Feedback</link> with suggestions for new or
3315     improved filters is particularly welcome!
3316    </para>
3317    <para>
3318     The below list has only the names and a one-line description of each
3319     predefined filter. There are <link linkend="predefined-filters">more
3320     verbose explanations</link> of what these filters do in the <link
3321     linkend="filter-file">filter file chapter</link>.
3322    </para>
3323   </listitem>
3324  </varlistentry>
3325
3326  <varlistentry>
3327   <term>Example usage (with filters from the distribution <filename>default.filter</filename> file).
3328   See <link linkend="PREDEFINED-FILTERS">the Predefined Filters section</link> for
3329   more explanation on each:</term>
3330   <listitem>
3331    <para>
3332     <anchor id="filter-js-annoyances">
3333     <screen>+filter{js-annoyances}       # Get rid of particularly annoying JavaScript abuse</screen>
3334    </para>
3335    <para>
3336     <anchor id="filter-js-events">
3337     <screen>+filter{js-events}           # Kill all JS event bindings (Radically destructive! Only for extra nasty sites)</screen>
3338    </para>
3339    <para>
3340     <anchor id="filter-html-annoyances">
3341     <screen>+filter{html-annoyances}     # Get rid of particularly annoying HTML abuse</screen>
3342    </para>
3343    <para>
3344     <anchor id="filter-content-cookies">
3345     <screen>+filter{content-cookies}     # Kill cookies that come in the HTML or JS content</screen>
3346    </para>
3347    <para>
3348     <anchor id="filter-refresh-tags">
3349     <screen>+filter{refresh-tags}        # Kill automatic refresh tags (for dial-on-demand setups)</screen>
3350    </para>
3351    <para>
3352     <anchor id="filter-unsolicited-popups">
3353     <screen>+filter{unsolicited-popups}  # Disable only unsolicited pop-up windows</screen>
3354    </para>
3355    <para>
3356     <anchor id="filter-all-popups">
3357     <screen>+filter{all-popups}          # Kill all popups in JavaScript and HTML</screen>
3358    </para>
3359    <para>
3360     <anchor id="filter-img-reorder">
3361     <screen>+filter{img-reorder}         # Reorder attributes in &lt;img&gt; tags to make the banners-by-* filters more effective</screen>
3362    </para>
3363    <para>
3364     <anchor id="filter-banners-by-size">
3365     <screen>+filter{banners-by-size}     # Kill banners by size</screen>
3366    </para>
3367    <para>
3368     <anchor id="filter-banners-by-link">
3369     <screen>+filter{banners-by-link}     # Kill banners by their links to known clicktrackers</screen>
3370    </para>
3371    <para>
3372     <anchor id="filter-webbugs">
3373     <screen>+filter{webbugs}             # Squish WebBugs (1x1 invisible GIFs used for user tracking)</screen>
3374    </para>
3375    <para>
3376     <anchor id="filter-tiny-textforms">
3377     <screen>+filter{tiny-textforms}      # Extend those tiny textareas up to 40x80 and kill the hard wrap</screen>
3378    </para>
3379    <para>
3380     <anchor id="filter-jumping-windows">
3381     <screen>+filter{jumping-windows}     # Prevent windows from resizing and moving themselves</screen>
3382    </para>
3383    <para>
3384     <anchor id="filter-frameset-borders">
3385     <screen>+filter{frameset-borders}    # Give frames a border and make them resizable</screen>
3386    </para>
3387    <para>
3388     <anchor id="filter-demoronizer">
3389     <screen>+filter{demoronizer}         # Fix MS's non-standard use of standard charsets</screen>
3390    </para>
3391    <para>
3392     <anchor id="filter-shockwave-flash">
3393     <screen>+filter{shockwave-flash}     # Kill embedded Shockwave Flash objects</screen>
3394    </para>
3395    <para>
3396     <anchor id="filter-quicktime-kioskmode">
3397     <screen>+filter{quicktime-kioskmode} # Make Quicktime movies saveable</screen>
3398    </para>
3399    <para>
3400     <anchor id="filter-fun">
3401     <screen>+filter{fun}                 # Text replacements for subversive browsing fun!</screen>
3402    </para>
3403    <para>
3404     <anchor id="filter-crude-parental">
3405     <screen>+filter{crude-parental}      # Crude parental filtering (demo only)</screen>
3406    </para>
3407    <para>
3408     <anchor id="filter-ie-exploits">
3409     <screen>+filter{ie-exploits}         # Disable some known Internet Explorer bug exploits</screen>
3410    </para>
3411   </listitem>
3412  </varlistentry>
3413 </variablelist>
3414 </sect3>
3415
3416
3417 <!--   ~~~~~       New section      ~~~~~     -->
3418 <sect3 renderas="sect4" id="filter-client-headers">
3419 <title>filter-client-headers</title>
3420
3421 <variablelist>
3422  <varlistentry>
3423   <term>Typical use:</term>
3424   <listitem>
3425    <para>
3426    To apply filtering to the client's (browser's) headers
3427    </para>
3428   </listitem>
3429  </varlistentry>
3430
3431  <varlistentry>
3432   <term>Effect:</term>
3433   <listitem>
3434    <para>
3435     By default, <application>Privoxy's</application> filters only apply
3436     to the document content itself. This will extend those filters to
3437     include the client's headers as well.
3438    </para>
3439   </listitem>
3440  </varlistentry>
3441
3442  <varlistentry>
3443   <term>Type:</term>
3444   <!-- boolean, parameterized, Multi-value -->
3445   <listitem>
3446    <para>Boolean.</para>
3447   </listitem>
3448  </varlistentry>
3449
3450  <varlistentry>
3451   <term>Parameter:</term>
3452   <listitem>
3453    <para>
3454     N/A
3455    </para>
3456   </listitem>
3457  </varlistentry>
3458
3459 <varlistentry>
3460   <term>Notes:</term>
3461   <listitem>
3462    <para>
3463     Regular expressions can be used to filter headers as well. Check your
3464     filters closely before activating this action, as it can easily lead to broken
3465     requests.
3466    </para>
3467    <para>
3468     These filters are applied to each header on its own, not to them
3469     all at once. This makes it easier to diagnose problems, but on the downside
3470     you can't write filters that only change header x if header y's value is
3471     z.
3472    </para>
3473    <para>
3474     The filters are used after the other header actions have finished and can
3475     use their output as input.
3476    </para>
3477
3478    <para>
3479     Whenever possible one should specify <literal>^</literal>,
3480     <literal>$</literal>, the whole header name and the colon, to make sure
3481     the filter doesn't cause havoc to other headers or the
3482     page itself. For example if you want to transform
3483     <application>Galeon</application> User-Agents to
3484     <application>Firefox</application> User-Agents you
3485     shouldn't use:
3486 </para>
3487 <para>
3488 <screen>
3489 s@Galeon/\d\.\d\.\d @@
3490 </screen>
3491 </para><para>
3492     but:
3493 </para><para>
3494 <screen>
3495 s@^(User-Agent:.*) Galeon/\d\.\d\.\d (Firefox/\d\.\d\.\d\.\d)$@$1 $2@
3496 </screen>
3497 </para>
3498   </listitem>
3499  </varlistentry>
3500
3501  <varlistentry>
3502   <term>Example usage (section):</term>
3503   <listitem>
3504     <para>
3505      <screen>
3506 {+filter-client-headers +filter{test_filter}}
3507 problem-host.example.com
3508     </screen>
3509     </para>
3510   </listitem>
3511  </varlistentry>
3512
3513 </variablelist>
3514 </sect3>
3515
3516
3517 <!--   ~~~~~       New section      ~~~~~     -->
3518 <sect3 renderas="sect4" id="filter-server-headers">
3519 <title>filter-server-headers</title>
3520
3521 <variablelist>
3522  <varlistentry>
3523   <term>Typical use:</term>
3524   <listitem>
3525    <para>
3526    To apply filtering to the server's headers
3527    </para>
3528   </listitem>
3529  </varlistentry>
3530
3531  <varlistentry>
3532   <term>Effect:</term>
3533   <listitem>
3534    <para>
3535     By default, <application>Privoxy's</application> filters only apply
3536     to the document content itself. This will extend those filters to
3537     include the server's headers as well.
3538    </para>
3539   </listitem>
3540  </varlistentry>
3541
3542  <varlistentry>
3543   <term>Type:</term>
3544   <!-- boolean, parameterized, Multi-value -->
3545   <listitem>
3546    <para>Boolean.</para>
3547   </listitem>
3548  </varlistentry>
3549
3550  <varlistentry>
3551   <term>Parameter:</term>
3552   <listitem>
3553    <para>
3554     N/A
3555    </para>
3556   </listitem>
3557  </varlistentry>
3558
3559 <varlistentry>
3560   <term>Notes:</term>
3561   <listitem>
3562    <para>
3563     Similar to <literal>filter-client-headers</literal>, but works on
3564     the server instead. To filter both server and client, use both.
3565    </para>
3566    <para>
3567     As with <literal>filter-client-headers</literal>, check your
3568     filters before activating this action, as it can easily lead to broken
3569     requests.
3570    </para>
3571    <para>
3572     These filters are applied to each header on its own, not to them
3573     all at once. This makes it easier to diagnose problems, but on the downside
3574     you can't write filters that only change header x if header y's value is
3575     z.
3576    </para>
3577    <para>
3578     The filters are used after the other header actions have finished and can
3579     use their output as input.
3580    </para>
3581    <para>
3582     Remember too, whenever possible one should specify <literal>^</literal>,
3583     <literal>$</literal>, the whole header name and the colon, to make sure
3584     the filter doesn't cause havoc to other headers or the
3585     page itself. See above for example.
3586    </para>
3587
3588   </listitem>
3589  </varlistentry>
3590
3591  <varlistentry>
3592   <term>Example usage (section):</term>
3593   <listitem>
3594     <para>
3595      <screen>
3596 {+filter-server-headers +filter{test_filter}}
3597 problem-host.example.com
3598     </screen>
3599     </para>
3600   </listitem>
3601  </varlistentry>
3602
3603 </variablelist>
3604 </sect3>
3605
3606
3607 <!--   ~~~~~       New section      ~~~~~     -->
3608 <sect3 renderas="sect4" id="force-text-mode">
3609 <title>force-text-mode</title>
3610 <!--
3611 new action
3612 -->
3613 <variablelist>
3614  <varlistentry>
3615   <term>Typical use:</term>
3616   <listitem>
3617    <para>Force <application>Privoxy</application> to treat a document as if it was in some kind of <emphasis>text</emphasis> format.   </para>
3618   </listitem>
3619  </varlistentry>
3620
3621  <varlistentry>
3622   <term>Effect:</term>
3623   <listitem>
3624    <para>
3625     Declares a document as text, even if the <quote>Content-Type:</quote> isn't detected as such.
3626    </para>
3627   </listitem>
3628  </varlistentry>
3629
3630  <varlistentry>
3631   <term>Type:</term>
3632   <!-- Boolean, Parameterized, Multi-value -->
3633   <listitem>
3634    <para>Boolean.</para>
3635   </listitem>
3636  </varlistentry>
3637
3638  <varlistentry>
3639   <term>Parameter:</term>
3640   <listitem>
3641    <para>
3642     N/A
3643    </para>
3644   </listitem>
3645  </varlistentry>
3646
3647  <varlistentry>
3648   <term>Notes:</term>
3649   <listitem>
3650    <para>
3651     As explained <literal><link linkend="filter">above</link></literal>,
3652     <application>Privoxy</application> tries to only filter files that are
3653     in some kind of text format. The same restrictions apply to
3654     <literal><link linkend="content-type-overwrite">content-type-overwrite</link></literal>.
3655     <literal>force-text-mode</literal> declares a document as text,
3656     without looking at the <quote>Content-Type:</quote> first.
3657    </para>
3658    <warning>
3659     <para>
3660      Think twice before activating this action. Filtering binary data
3661      with regular expressions can cause file damage.
3662     </para>
3663    </warning>
3664   </listitem>
3665  </varlistentry>
3666
3667  <varlistentry>
3668   <term>Example usage:</term>
3669   <listitem>
3670    <para>
3671      <screen>
3672 +force-text-mode
3673      </screen>
3674    </para>
3675   </listitem>
3676  </varlistentry>
3677 </variablelist>
3678 </sect3>
3679
3680
3681 <!--   ~~~~~       New section      ~~~~~     -->
3682 <sect3 renderas="sect4" id="handle-as-empty-document">
3683 <title>handle-as-empty-document</title>
3684 <!--
3685 new action
3686 -->
3687 <variablelist>
3688  <varlistentry>
3689   <term>Typical use:</term>
3690   <listitem>
3691    <para>Mark URLs that should be replaced by empty documents <emphasis>if they get blocked</emphasis></para>
3692   </listitem>
3693  </varlistentry>
3694
3695  <varlistentry>
3696   <term>Effect:</term>
3697   <listitem>
3698    <para>
3699     This action alone doesn't do anything noticeable. It just marks URLs.
3700     If the <literal><link linkend="block">block</link></literal> action <emphasis>also applies</emphasis>,
3701     the presence or absence of this mark decides whether an HTML <quote>blocked</quote>
3702     page, or an empty document will be sent to the client as a substitute for the blocked content.
3703     The <emphasis>empty</emphasis> document isn't literally empty, but actually contains a single space.
3704    </para>
3705   </listitem>
3706  </varlistentry>
3707
3708  <varlistentry>
3709   <term>Type:</term>
3710   <!-- Boolean, Parameterized, Multi-value -->
3711   <listitem>
3712    <para>Boolean.</para>
3713   </listitem>
3714  </varlistentry>
3715
3716  <varlistentry>
3717   <term>Parameter:</term>
3718   <listitem>
3719    <para>
3720     N/A
3721    </para>
3722   </listitem>
3723  </varlistentry>
3724
3725  <varlistentry>
3726   <term>Notes:</term>
3727   <listitem>
3728    <para>
3729     Some browsers complain about syntax errors if JavaScript documents
3730     are blocked with <application>Privoxy's</application>
3731     default HTML page; this option can be used to silence them.
3732    </para>
3733    <para>
3734     The content type for the empty document can be specified with
3735     <literal><link linkend="content-type-overwrite">content-type-overwrite{}</link></literal>,
3736     but usually this isn't necessary.
3737    </para>
3738   </listitem>
3739  </varlistentry>
3740
3741  <varlistentry>
3742   <term>Example usage:</term>
3743   <listitem>
3744    <para>
3745      <screen># Block all documents on example.org that end with ".js",
3746 # but send an empty document instead of the usual HTML message.
3747 {+block +handle-as-empty-document}
3748 example.org/.*\.js$
3749      </screen>
3750    </para>
3751   </listitem>
3752  </varlistentry>
3753 </variablelist>
3754 </sect3>
3755
3756
3757 <!--   ~~~~~       New section      ~~~~~     -->
3758 <sect3 renderas="sect4" id="handle-as-image">
3759 <title>handle-as-image</title>
3760
3761 <variablelist>
3762  <varlistentry>
3763   <term>Typical use:</term>
3764   <listitem>
3765    <para>Mark URLs as belonging to images (so they'll be replaced by imagee <emphasis>if they get blocked</emphasis>)</para>
3766   </listitem>
3767  </varlistentry>
3768
3769  <varlistentry>
3770   <term>Effect:</term>
3771   <listitem>
3772    <para>
3773     This action alone doesn't do anything noticeable. It just marks URLs as images.
3774     If the <literal><link linkend="block">block</link></literal> action <emphasis>also applies</emphasis>,
3775     the presence or absence of this mark decides whether an HTML <quote>blocked</quote>
3776     page, or a replacement image (as determined by the <literal><link
3777     linkend="set-image-blocker">set-image-blocker</link></literal> action) will be sent to the
3778     client as a substitute for the blocked content.
3779    </para>
3780   </listitem>
3781  </varlistentry>
3782
3783  <varlistentry>
3784   <term>Type:</term>
3785   <!-- Boolean, Parameterized, Multi-value -->
3786   <listitem>
3787    <para>Boolean.</para>
3788   </listitem>
3789  </varlistentry>
3790
3791  <varlistentry>
3792   <term>Parameter:</term>
3793   <listitem>
3794    <para>
3795     N/A
3796    </para>
3797   </listitem>
3798  </varlistentry>
3799
3800  <varlistentry>
3801   <term>Notes:</term>
3802   <listitem>
3803    <para>
3804     The below generic example section is actually part of <filename>default.action</filename>.
3805     It marks all URLs with well-known image file name extensions as images and should
3806     be left intact.
3807    </para>
3808    <para>
3809     Users will probably only want to use the handle-as-image action in conjunction with
3810     <literal><link linkend="block">block</link></literal>, to block sources of banners, whose URLs don't
3811     reflect the file type, like in the second example section.
3812    </para>
3813    <para>
3814     Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad
3815     frames require an HTML page to be sent, or they won't display properly.
3816     Forcing <literal>handle-as-image</literal> in this situation will not replace the
3817     ad frame with an image, but lead to error messages.
3818    </para>
3819   </listitem>
3820  </varlistentry>
3821
3822  <varlistentry>
3823   <term>Example usage (sections):</term>
3824   <listitem>
3825    <para>
3826      <screen># Generic image extensions:
3827 #
3828 {+handle-as-image}
3829 /.*\.(gif|jpg|jpeg|png|bmp|ico)$
3830
3831 # These don't look like images, but they're banners and should be
3832 # blocked as images:
3833 #
3834 {+block +handle-as-image}
3835 some.nasty-banner-server.com/junk.cgi?output=trash
3836
3837 # Banner source! Who cares if they also have non-image content?
3838 ad.doubleclick.net
3839 </screen>
3840    </para>
3841   </listitem>
3842  </varlistentry>
3843 </variablelist>
3844 </sect3>
3845
3846
3847 <!--   ~~~~~       New section      ~~~~~     -->
3848 <sect3 renderas="sect4" id="hide-accept-language">
3849 <title>hide-accept-language</title>
3850 <!--
3851 new action
3852 -->
3853 <variablelist>
3854  <varlistentry>
3855   <term>Typical use:</term>
3856   <listitem>
3857    <para>Pretend to use different language settings.</para>
3858   </listitem>
3859  </varlistentry>
3860
3861  <varlistentry>
3862   <term>Effect:</term>
3863   <listitem>
3864    <para>
3865     Deletes or replaces the <quote>Accept-Language:</quote> HTTP header in client requests.
3866    </para>
3867   </listitem>
3868  </varlistentry>
3869
3870  <varlistentry>
3871   <term>Type:</term>
3872   <!-- Boolean, Parameterized, Multi-value -->
3873   <listitem>
3874    <para>Parameterized.</para>
3875   </listitem>
3876  </varlistentry>
3877
3878  <varlistentry>
3879   <term>Parameter:</term>
3880   <listitem>
3881    <para>
3882     Keyword: <quote>block</quote>, or any user defined value.
3883    </para>
3884   </listitem>
3885  </varlistentry>
3886
3887  <varlistentry>
3888   <term>Notes:</term>
3889   <listitem>
3890    <para>
3891     Faking the browser's language settings can be useful to make a
3892     foreign User-Agent set with
3893     <literal><link linkend="hide-user-agent">hide-user-agent</link></literal>
3894     more believable.
3895    </para>
3896    <para>
3897     However some sites with content in different languages check the
3898     <quote>Accept-Language:</quote> to decide which one to take by default.
3899     Sometimes it isn't possible to later switch to another language without
3900     changing the <quote>Accept-Language:</quote> header first.
3901    </para>
3902    <para>
3903     Therefore it's a good idea to either only change the
3904     <quote>Accept-Language:</quote> header to languages you understand,
3905     or to languages that aren't wide spread.
3906    </para>
3907    <para>
3908     Before setting the <quote>Accept-Language:</quote> header
3909     to a rare language, you should consider that it helps to
3910     make your requests unique and thus easier to trace.
3911     If you don't plan to change this header frequently,
3912     you should stick to a common language.
3913    </para>
3914   </listitem>
3915  </varlistentry>
3916
3917  <varlistentry>
3918   <term>Example usage (section):</term>
3919   <listitem>
3920     <para>
3921      <screen># Pretend to use Canadian language settings.
3922 {+hide-accept-language{en-ca} \
3923 +hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv:1.8.0.4) Gecko/20060628 Firefox/1.5.0.4} \
3924 }
3925 /   </screen>
3926    </para>
3927   </listitem>
3928  </varlistentry>
3929 </variablelist>
3930 </sect3>
3931
3932
3933 <!--   ~~~~~       New section      ~~~~~     -->
3934 <sect3 renderas="sect4" id="hide-content-disposition">
3935 <title>hide-content-disposition</title>
3936 <!--
3937 new action
3938 -->
3939 <variablelist>
3940  <varlistentry>
3941   <term>Typical use:</term>
3942   <listitem>
3943    <para>Prevent download menus for content you prefer to view inside the browser.</para>
3944   </listitem>
3945  </varlistentry>
3946
3947  <varlistentry>
3948   <term>Effect:</term>
3949   <listitem>
3950    <para>
3951     Deletes or replaces the <quote>Content-Disposition:</quote> HTTP header set by some servers.
3952    </para>
3953   </listitem>
3954  </varlistentry>
3955
3956  <varlistentry>
3957   <term>Type:</term>
3958   <!-- Boolean, Parameterized, Multi-value -->
3959   <listitem>
3960    <para>Parameterized.</para>
3961   </listitem>
3962  </varlistentry>
3963
3964  <varlistentry>
3965   <term>Parameter:</term>
3966   <listitem>
3967    <para>
3968     Keyword: <quote>block</quote>, or any user defined value.
3969    </para>
3970   </listitem>
3971  </varlistentry>
3972
3973  <varlistentry>
3974   <term>Notes:</term>
3975   <listitem>
3976    <para>
3977     Some servers set the <quote>Content-Disposition:</quote> HTTP header for
3978     documents they assume you want to save locally before viewing them.
3979     The <quote>Content-Disposition:</quote> header contains the file name
3980     the browser is supposed to use by default.
3981    </para>
3982    <para>
3983     In most browsers that understand this header, it makes it impossible to
3984     <emphasis>just view</emphasis> the document, without downloading it first,
3985     even if it's just a simple text file or an image.
3986    </para>
3987    <para>
3988     Removing the <quote>Content-Disposition:</quote> header helps
3989     to prevent this annoyance, but some browsers additionally check the
3990     <quote>Content-Type:</quote> header, before they decide if they can
3991     display a document without saving it first. In these cases, you have
3992     to change this header as well, before the browser stops displaying
3993     download menus.
3994    </para>
3995    <para>
3996     It is also possible to change the server's file name suggestion
3997     to another one, but in most cases it isn't worth the time to set
3998     it up.
3999    </para>
4000   </listitem>
4001  </varlistentry>
4002
4003  <varlistentry>
4004   <term>Example usage:</term>
4005   <listitem>
4006     <para>
4007      <screen># Disarm the download link in Sourceforge's patch tracker
4008 {-filter\
4009 +content-type-overwrite {text/plain}\
4010 +hide-content-disposition {block} }
4011 .sourceforge.net/tracker/download.php</screen>
4012    </para>
4013   </listitem>
4014  </varlistentry>
4015 </variablelist>
4016 </sect3>
4017
4018
4019 <!--   ~~~~~       New section      ~~~~~     -->
4020 <sect3 renderas="sect4" id="hide-if-modified-since">
4021 <title>hide-if-modified-since</title>
4022 <!--
4023 new action
4024 -->
4025 <variablelist>
4026  <varlistentry>
4027   <term>Typical use:</term>
4028   <listitem>
4029    <para>Prevent yet another way to track the user's steps between sessions.</para>
4030   </listitem>
4031  </varlistentry>
4032
4033  <varlistentry>
4034   <term>Effect:</term>
4035   <listitem>
4036    <para>
4037     Deletes the <quote>If-Modified-Since:</quote> HTTP client header or modifies its value.
4038    </para>
4039   </listitem>
4040  </varlistentry>
4041
4042  <varlistentry>
4043   <term>Type:</term>
4044   <!-- Boolean, Parameterized, Multi-value -->
4045   <listitem>
4046    <para>Parameterized.</para>
4047   </listitem>
4048  </varlistentry>
4049
4050  <varlistentry>
4051   <term>Parameter:</term>
4052   <listitem>
4053    <para>
4054     Keyword: <quote>block</quote>, or a user defined value that specifies a range of hours.
4055    </para>
4056   </listitem>
4057  </varlistentry>
4058
4059  <varlistentry>
4060   <term>Notes:</term>
4061   <listitem>
4062    <para>
4063     Removing this header is useful for filter testing, where you want to force a real
4064     reload instead of getting status code <quote>304</quote>, which would cause the
4065     browser to use a cached copy of the page.
4066    </para>
4067    <para>
4068     Instead of removing the header, <literal>hide-if-modified-since</literal> can
4069     also add or substract a random amount of time to/from the headers value.
4070     You specify a range of hours were the random factor should be chosen from and
4071     <application>Privoxy</application> does the rest. A negative value means
4072     subtracting, a positive value adding.
4073    </para>
4074    <para>
4075     Randomizing the value of the <quote>If-Modified-Since:</quote> makes
4076     sure it isn't used as a cookie replacement, but you will run into
4077     caching problems if the random range is too high.
4078    </para>
4079    <para>
4080     It is a good idea to only use a small negative value and let
4081     <literal><link linkend="overwrite-last-modified">overwrite-last-modified</link></literal>
4082     handle the greater changes.
4083    </para>
4084    <para>
4085     It is also recommended to use this action together with
4086     <literal><link linkend="crunch-if-none-match">crunch-if-none-match</link></literal>.
4087    </para>
4088   </listitem>
4089  </varlistentry>
4090
4091  <varlistentry>
4092   <term>Example usage (section):</term>
4093   <listitem>
4094     <para>
4095      <screen># Let the browser revalidate without being tracked across sessions
4096 {+hide-if-modified-since {-1}\
4097 +overwrite-last-modified {randomize}\
4098 +crunch-if-none-match}
4099 /</screen>
4100    </para>
4101   </listitem>
4102  </varlistentry>
4103 </variablelist>
4104 </sect3>
4105
4106
4107 <!--   ~~~~~       New section      ~~~~~     -->
4108 <sect3 renderas="sect4" id="hide-forwarded-for-headers">
4109 <title>hide-forwarded-for-headers</title>
4110 <!--
4111 new action
4112 -->
4113 <variablelist>
4114  <varlistentry>
4115   <term>Typical use:</term>
4116   <listitem>
4117    <para>Improve privacy by hiding the true source of the request</para>
4118   </listitem>
4119  </varlistentry>
4120
4121  <varlistentry>
4122   <term>Effect:</term>
4123   <listitem>
4124    <para>
4125     Deletes any existing <quote>X-Forwarded-for:</quote> HTTP header from client requests,
4126     and prevents adding a new one.
4127    </para>
4128   </listitem>
4129  </varlistentry>
4130
4131  <varlistentry>
4132   <term>Type:</term>
4133   <!-- Boolean, Parameterized, Multi-value -->
4134   <listitem>
4135    <para>Boolean.</para>
4136   </listitem>
4137  </varlistentry>
4138
4139  <varlistentry>
4140   <term>Parameter:</term>
4141   <listitem>
4142    <para>
4143     N/A
4144    </para>
4145   </listitem>
4146  </varlistentry>
4147
4148  <varlistentry>
4149   <term>Notes:</term>
4150   <listitem>
4151    <para>
4152     It is fairly safe to leave this on.
4153    </para>
4154    <para>
4155     This action is scheduled for improvement: It should be able to generate forged
4156     <quote>X-Forwarded-for:</quote> headers using random IP addresses from a specified network,
4157     to make successive requests from the same client look like requests from a pool of different
4158     users sharing the same proxy.
4159    </para>
4160   </listitem>
4161  </varlistentry>
4162
4163  <varlistentry>
4164   <term>Example usage:</term>
4165   <listitem>
4166     <para>
4167      <screen>+hide-forwarded-for-headers</screen>
4168    </para>
4169   </listitem>
4170  </varlistentry>
4171 </variablelist>
4172 </sect3>
4173
4174
4175 <!--   ~~~~~       New section      ~~~~~     -->
4176 <sect3 renderas="sect4" id="hide-from-header">
4177 <title>hide-from-header</title>
4178
4179 <variablelist>
4180  <varlistentry>
4181   <term>Typical use:</term>
4182   <listitem>
4183    <para>Keep your (old and ill) browser from telling web servers your email address</para>
4184   </listitem>
4185  </varlistentry>
4186
4187  <varlistentry>
4188   <term>Effect:</term>
4189   <listitem>
4190    <para>
4191     Deletes any existing <quote>From:</quote> HTTP header, or replaces it with the
4192     specified string.
4193    </para>
4194   </listitem>
4195  </varlistentry>
4196
4197  <varlistentry>
4198   <term>Type:</term>
4199   <!-- Boolean, Parameterized, Multi-value -->
4200   <listitem>
4201    <para>Parameterized.</para>
4202   </listitem>
4203  </varlistentry>
4204
4205  <varlistentry>
4206   <term>Parameter:</term>
4207   <listitem>
4208    <para>
4209     Keyword: <quote>block</quote>, or any user defined value.
4210    </para>
4211   </listitem>
4212  </varlistentry>
4213
4214  <varlistentry>
4215   <term>Notes:</term>
4216   <listitem>
4217    <para>
4218     The keyword <quote>block</quote> will completely remove the header
4219     (not to be confused with the <literal><link linkend="block">block</link></literal>
4220     action).
4221    </para>
4222    <para>
4223     Alternately, you can specify any value you prefer to be sent to the web
4224     server. If you do, it is a matter of fairness not to use any address that
4225     is actually used by a real person.
4226    </para>
4227    <para>
4228     This action is rarely needed, as modern web browsers don't send
4229     <quote>From:</quote> headers anymore.
4230    </para>
4231   </listitem>
4232  </varlistentry>
4233
4234  <varlistentry>
4235   <term>Example usage:</term>
4236   <listitem>
4237    <para>
4238     <screen>+hide-from-header{block}</screen> or
4239     <screen>+hide-from-header{spam-me-senseless@sittingduck.example.com}</screen>
4240    </para>
4241   </listitem>
4242  </varlistentry>
4243 </variablelist>
4244 </sect3>
4245
4246
4247 <!--   ~~~~~       New section      ~~~~~     -->
4248 <sect3 renderas="sect4" id="hide-referrer">
4249 <title>hide-referrer</title>
4250 <anchor id="hide-referer">
4251 <variablelist>
4252  <varlistentry>
4253   <term>Typical use:</term>
4254   <listitem>
4255    <para>Conceal which link you followed to get to a particular site</para>
4256   </listitem>
4257  </varlistentry>
4258
4259  <varlistentry>
4260   <term>Effect:</term>
4261   <listitem>
4262    <para>
4263     Deletes the <quote>Referer:</quote> (sic) HTTP header from the client request,
4264     or replaces it with a forged one.
4265    </para>
4266   </listitem>
4267  </varlistentry>
4268
4269  <varlistentry>
4270   <term>Type:</term>
4271   <!-- Boolean, Parameterized, Multi-value -->
4272   <listitem>
4273    <para>Parameterized.</para>
4274   </listitem>
4275  </varlistentry>
4276
4277  <varlistentry>
4278   <term>Parameter:</term>
4279   <listitem>
4280    <itemizedlist>
4281     <listitem>
4282      <para><quote>conditional-block</quote> to delete the header completely if the host has changed.</para>
4283     </listitem>
4284     <listitem>
4285      <para><quote>block</quote> to delete the header unconditionally.</para>
4286     </listitem>
4287     <listitem>
4288      <para><quote>forge</quote> to pretend to be coming from the homepage of the server we are talking to.</para>
4289     </listitem>
4290     <listitem>
4291      <para>Any other string to set a user defined referrer.</para>
4292     </listitem>
4293    </itemizedlist>
4294   </listitem>
4295  </varlistentry>
4296
4297  <varlistentry>
4298   <term>Notes:</term>
4299   <listitem>
4300    <para>
4301     <literal>conditional-block</literal> is the only parameter,
4302     that isn't easily detected in the server's log file. If it blocks the
4303     referrer, the request will look like the visitor used a bookmark or
4304     typed in the address directly.
4305    </para>
4306    <para>
4307     Leaving the referrer unmodified for requests on the same host
4308     allows the server owner to see the visitor's <quote>click path</quote>,
4309     but in most cases she could also get that information by comparing
4310     other parts of the log file: for example the User-Agent if it isn't
4311     a very common one, or the user's IP address if it doesn't change between
4312     different requests.
4313    </para>
4314    <para>
4315     Always blocking the referrer, or using a custom one, can lead to
4316     failures on servers that check the referrer before they answer any
4317     requests, in an attempt to prevent their valuable content from being
4318     embedded or linked to elsewhere.
4319    </para>
4320    <para>
4321     Both <literal>conditional-block</literal> and <literal>forge</literal>
4322     will work with referrer checks, as long as content and valid referring page
4323     are on the same host. Most of the time that's the case.
4324    </para>
4325    <para>
4326     <literal>hide-referer</literal> is an alternate spelling of
4327     <literal>hide-referrer</literal> and the two can be can be freely
4328     substituted with each other. (<quote>referrer</quote> is the
4329     correct English spelling, however the HTTP specification has a bug - it
4330     requires it to be spelled as <quote>referer</quote>.)
4331    </para>
4332   </listitem>
4333  </varlistentry>
4334
4335  <varlistentry>
4336   <term>Example usage:</term>
4337   <listitem>
4338    <para>
4339      <screen>+hide-referrer{forge}</screen> or
4340      <screen>+hide-referrer{http://www.yahoo.com/}</screen>
4341    </para>
4342   </listitem>
4343  </varlistentry>
4344 </variablelist>
4345 </sect3>
4346
4347
4348 <!--   ~~~~~       New section      ~~~~~     -->
4349 <sect3 renderas="sect4" id="hide-user-agent">
4350 <title>hide-user-agent</title>
4351
4352 <variablelist>
4353  <varlistentry>
4354   <term>Typical use:</term>
4355   <listitem>
4356    <para>Conceal your type of browser and client operating system</para>
4357   </listitem>
4358  </varlistentry>
4359
4360  <varlistentry>
4361   <term>Effect:</term>
4362   <listitem>
4363    <para>
4364     Replaces the value of the <quote>User-Agent:</quote> HTTP header
4365     in client requests with the specified value.
4366    </para>
4367   </listitem>
4368  </varlistentry>
4369
4370  <varlistentry>
4371   <term>Type:</term>
4372   <!-- Boolean, Parameterized, Multi-value -->
4373   <listitem>
4374    <para>Parameterized.</para>
4375   </listitem>
4376  </varlistentry>
4377
4378  <varlistentry>
4379   <term>Parameter:</term>
4380   <listitem>
4381    <para>
4382     Any user-defined string.
4383    </para>
4384   </listitem>
4385  </varlistentry>
4386
4387  <varlistentry>
4388   <term>Notes:</term>
4389   <listitem>
4390    <warning>
4391     <para>
4392      This can lead to problems on web sites that depend on looking at this header in
4393      order to customize their content for different browsers (which, by the
4394      way, is <emphasis>NOT</emphasis> the right thing to do: good web sites
4395      work browser-independently).
4396      <!--
4397      <ulink url="http://www.javascriptkit.com/javaindex.shtml">smart way to do
4398      that</ulink>!).
4399      -->
4400     </para>
4401    </warning>
4402    <para>
4403     Using this action in multi-user setups or wherever different types of
4404     browsers will access the same <application>Privoxy</application> is
4405     <emphasis>not recommended</emphasis>. In single-user, single-browser
4406     setups, you might use it to delete your OS version information from
4407     the headers, because it is an invitation to exploit known bugs for your
4408     OS. It is also occasionally useful to forge this in order to access
4409     sites that won't let you in otherwise (though there may be a good
4410     reason in some cases). Example of this: some MSN sites will not
4411     let <application>Mozilla</application> enter, yet forging to a
4412     <application>Netscape 6.1</application> user-agent works just fine.
4413     (Must be just a silly MS goof, I'm sure :-).
4414    </para>
4415    <para>
4416     This action is scheduled for improvement.
4417    </para>
4418    </listitem>
4419  </varlistentry>
4420
4421  <varlistentry>
4422   <term>Example usage:</term>
4423   <listitem>
4424    <para>
4425      <screen>+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}</screen>
4426    </para>
4427   </listitem>
4428  </varlistentry>
4429 </variablelist>
4430 </sect3>
4431
4432
4433 <!--   ~~~~~       New section      ~~~~~     -->
4434 <sect3 renderas="sect4" id="inspect-jpegs">
4435 <title>inspect-jpegs</title>
4436 <!--
4437 new action
4438 -->
4439 <variablelist>
4440  <varlistentry>
4441   <term>Typical use:</term>
4442   <listitem>
4443    <para>To protect against the MS buffer over-run in JPEG processing</para>
4444   </listitem>
4445  </varlistentry>
4446
4447  <varlistentry>
4448   <term>Effect:</term>
4449   <listitem>
4450    <para>
4451     Protect against a known exploit
4452    </para>
4453   </listitem>
4454  </varlistentry>
4455
4456  <varlistentry>
4457   <term>Type:</term>
4458   <!-- Boolean, Parameterized, Multi-value -->
4459   <listitem>
4460    <para>Boolean.</para>
4461   </listitem>
4462  </varlistentry>
4463
4464  <varlistentry>
4465   <term>Parameter:</term>
4466   <listitem>
4467    <para>
4468     N/A
4469    </para>
4470   </listitem>
4471  </varlistentry>
4472
4473  <varlistentry>
4474   <term>Notes:</term>
4475   <listitem>
4476    <para>
4477     See Microsoft Security Bulletin MS04-028. JPEG images are one of the most
4478     common image types found across the Internet. The exploit as described can
4479     allow execution of code on the target system, giving an attacker access
4480     to the system in question by merely planting an altered JPEG image, which
4481     would have no obvious indications of what lurks inside. This action
4482     prevents unwanted intrusion.
4483    </para>
4484
4485   </listitem>
4486  </varlistentry>
4487
4488  <varlistentry>
4489   <term>Example usage:</term>
4490   <listitem>
4491    <para><screen>+inspect-jpegs</screen></para>
4492   </listitem>
4493  </varlistentry>
4494 </variablelist>
4495 </sect3>
4496
4497
4498
4499
4500 <!--   ~~~~~       New section      ~~~~~     -->
4501 <sect3 renderas="sect4" id="kill-popups">
4502 <title>kill-popups<anchor id="kill-popup"></title>
4503
4504 <variablelist>
4505  <varlistentry>
4506   <term>Typical use:</term>
4507   <listitem>
4508    <para>Eliminate those annoying pop-up windows (deprecated)</para>
4509   </listitem>
4510  </varlistentry>
4511
4512  <varlistentry>
4513   <term>Effect:</term>
4514   <listitem>
4515    <para>
4516     While loading the document, replace JavaScript code that opens
4517     pop-up windows with (syntactically neutral) dummy code on the fly.
4518    </para>
4519   </listitem>
4520  </varlistentry>
4521
4522  <varlistentry>
4523   <term>Type:</term>
4524   <!-- Boolean, Parameterized, Multi-value -->
4525   <listitem>
4526    <para>Boolean.</para>
4527   </listitem>
4528  </varlistentry>
4529
4530  <varlistentry>
4531   <term>Parameter:</term>
4532   <listitem>
4533    <para>
4534     N/A
4535    </para>
4536   </listitem>
4537  </varlistentry>
4538
4539  <varlistentry>
4540   <term>Notes:</term>
4541   <listitem>
4542    <para>
4543     This action is basically a built-in, hardwired special-purpose filter
4544     action, but there are important differences: For <literal>kill-popups</literal>,
4545     the document need not be buffered, so it can be incrementally rendered while
4546     downloading. But <literal>kill-popups</literal> doesn't catch as many pop-ups as
4547     <literal><link
4548     linkend="FILTER-ALL-POPUPS">filter{<replaceable>all-popups</replaceable>}</link></literal>
4549     does and is not as smart as <literal><link
4550     linkend="FILTER-UNSOLICITED-POPUPS">filter{<replaceable>unsolicited-popups</replaceable>}</link>
4551     </literal>is.
4552    </para>
4553    <para>
4554     Think of it as a fast and efficient replacement for a filter that you
4555     can use if you don't want any filtering at all. Note that it doesn't make
4556     sense to combine it with any <literal><link linkend="filter">filter</link></literal> action,
4557     since as soon as one <literal><link linkend="filter">filter</link></literal> applies,
4558     the whole document needs to be buffered anyway, which destroys the advantage of
4559     the <literal>kill-popups</literal> action over its filter equivalent.
4560    </para>
4561    <para>
4562     Killing all pop-ups unconditionally is problematic. Many shops and banks rely on
4563     pop-ups to display forms, shopping carts etc, and the <literal><link
4564     linkend="FILTER-UNSOLICITED-POPUPS">filter{<replaceable>unsolicited-popups</replaceable>}</link>
4565     </literal> does a fairly good job of catching only the unwanted ones.
4566    </para>
4567    <para>
4568     If the only kind of pop-ups that you want to kill are exit consoles (those
4569     <emphasis>really nasty</emphasis> windows that appear when you close an other
4570     one), you might want to use
4571     <literal><link
4572     linkend="filter">filter</link>{<replaceable>js-annoyances</replaceable>}</literal>
4573     instead.
4574    </para>
4575
4576   <!--
4577    <para>
4578     An alternate spelling is <literal>+kill-popup</literal>, which is
4579     interchangeable.
4580    </para>
4581  -->
4582   </listitem>
4583  </varlistentry>
4584
4585  <varlistentry>
4586   <term>Example usage:</term>
4587   <listitem>
4588    <para><screen>+kill-popups</screen></para>
4589   </listitem>
4590  </varlistentry>
4591 </variablelist>
4592 </sect3>
4593
4594
4595 <!--   ~~~~~       New section      ~~~~~     -->
4596 <sect3 renderas="sect4" id="limit-connect">
4597 <title>limit-connect</title>
4598
4599 <variablelist>
4600  <varlistentry>
4601   <term>Typical use:</term>
4602   <listitem>
4603    <para>Prevent abuse of <application>Privoxy</application> as a TCP proxy relay or disable SSL for untrusted sites</para>
4604   </listitem>
4605  </varlistentry>
4606
4607  <varlistentry>
4608   <term>Effect:</term>
4609   <listitem>
4610    <para>
4611     Specifies to which ports HTTP CONNECT requests are allowable.
4612    </para>
4613   </listitem>
4614  </varlistentry>
4615
4616  <varlistentry>
4617   <term>Type:</term>
4618   <!-- Boolean, Parameterized, Multi-value -->
4619   <listitem>
4620    <para>Parameterized.</para>
4621   </listitem>
4622  </varlistentry>
4623
4624  <varlistentry>
4625   <term>Parameter:</term>
4626   <listitem>
4627    <para>
4628     A comma-separated list of ports or port ranges (the latter using dashes, with the minimum
4629     defaulting to 0 and the maximum to 65K).
4630    </para>
4631   </listitem>
4632  </varlistentry>
4633
4634  <varlistentry>
4635   <term>Notes:</term>
4636   <listitem>
4637    <para>
4638     By default, i.e. if no <literal>limit-connect</literal> action applies,
4639     <application>Privoxy</application> only allows HTTP CONNECT
4640     requests to port 443 (the standard, secure HTTPS port). Use
4641     <literal>limit-connect</literal> if more fine-grained control is desired
4642     for some or all destinations.
4643    </para>
4644    <para>
4645     The CONNECT methods exists in HTTP to allow access to secure websites
4646     (<quote>https://</quote> URLs) through proxies. It works very simply:
4647     the proxy connects to the server on the specified port, and then
4648     short-circuits its connections to the client and to the remote server.
4649     This can be a big security hole, since CONNECT-enabled proxies can be
4650     abused as TCP relays very easily.
4651   </para>
4652   <para>
4653    <application>Privoxy</application> relays HTTPS traffic without seeing
4654    the decoded content. Websites can leverage this limitation to circumvent Privoxy's
4655    filters. By specifying an invalid port range you can disable HTTPS entirely.
4656    If you plan to disable SSL by default, consider enabling
4657    <literal><link linkend="treat-forbidden-connects-like-blocks ">treat-forbidden-connects-like-blocks</link></literal>
4658    as well, to be able to quickly create exceptions.
4659   </para>
4660   </listitem>
4661  </varlistentry>
4662
4663  <varlistentry>
4664   <term>Example usages:</term>
4665   <listitem>
4666    <!-- I had trouble getting the spacing to look right in my browser -->
4667    <!-- I probably have the wrong font setup, bollocks. -->
4668    <!-- Apparently the emphasis tag uses a proportional font no matter what -->
4669     <para>
4670      <screen>+limit-connect{443}                   # This is the default and need not be specified.
4671 +limit-connect{80,443}                # Ports 80 and 443 are OK.
4672 +limit-connect{-3, 7, 20-100, 500-}   # Ports less than 3, 7, 20 to 100 and above 500 are OK.
4673 +limit-connect{-}                     # All ports are OK
4674 +limit-connect{,}                     # No HTTPS traffic is allowed</screen>
4675    </para>
4676   </listitem>
4677  </varlistentry>
4678 </variablelist>
4679 </sect3>
4680
4681 <!--   ~~~~~       New section      ~~~~~     -->
4682 <sect3 renderas="sect4" id="prevent-compression">
4683 <title>prevent-compression</title>
4684
4685 <variablelist>
4686  <varlistentry>
4687   <term>Typical use:</term>
4688   <listitem>
4689    <para>
4690     Ensure that servers send the content uncompressed, so it can be
4691     passed through <literal><link linkend="filter">filter</link></literal>s.
4692    </para>
4693   </listitem>
4694  </varlistentry>
4695
4696  <varlistentry>
4697   <term>Effect:</term>
4698   <listitem>
4699    <para>
4700     Removes the Accept-Encoding header which can be used to ask for compressed transfer.
4701    </para>
4702   </listitem>
4703  </varlistentry>
4704
4705  <varlistentry>
4706   <term>Type:</term>
4707   <!-- Boolean, Parameterized, Multi-value -->
4708   <listitem>
4709    <para>Boolean.</para>
4710   </listitem>
4711  </varlistentry>
4712
4713  <varlistentry>
4714   <term>Parameter:</term>
4715   <listitem>
4716    <para>
4717     N/A
4718    </para>
4719   </listitem>
4720  </varlistentry>
4721
4722  <varlistentry>
4723   <term>Notes:</term>
4724   <listitem>
4725    <para>
4726     More and more websites send their content compressed by default, which
4727     is generally a good idea and saves bandwidth. But for the <literal><link
4728     linkend="filter">filter</link></literal>, <literal><link linkend="deanimate-gifs">deanimate-gifs</link></literal>
4729     and <literal><link linkend="kill-popups">kill-popups</link></literal> actions to work,
4730     <application>Privoxy</application> needs access to the  uncompressed data.
4731     Unfortunately, <application>Privoxy</application> can't yet(!)  uncompress, filter, and
4732     re-compress the content on the fly. So if you want to ensure that all websites, including
4733     those that normally compress, can be filtered, you need to use this action.
4734    </para>
4735    <para>
4736     This will slow down transfers from those websites, though. If you use any of the above-mentioned
4737     actions, you will typically want to use <literal>prevent-compression</literal> in conjunction
4738     with them.
4739    </para>
4740    <para>
4741     Note that some (rare) ill-configured sites don't handle requests for uncompressed
4742     documents correctly (they send an empty document body). If you use <literal>prevent-compression</literal>
4743     per default, you'll have to add exceptions for those sites. See the example for how to do that.
4744    </para>
4745   </listitem>
4746  </varlistentry>
4747
4748  <varlistentry>
4749   <term>Example usage (sections):</term>
4750   <listitem>
4751    <para>
4752     <screen># Set default:
4753 #
4754 {+prevent-compression}
4755 / # Match all sites
4756
4757 # Make exceptions for ill sites:
4758 #
4759 {-prevent-compression}
4760 www.debianhelp.org
4761 www.pclinuxonline.com</screen>
4762    </para>
4763   </listitem>
4764  </varlistentry>
4765
4766 </variablelist>
4767 </sect3>
4768
4769
4770 <!--   ~~~~~       New section      ~~~~~     -->
4771 <sect3 renderas="sect4" id="overwrite-last-modified">
4772 <title>overwrite-last-modified</title>
4773 <!--
4774 new action
4775 -->
4776 <variablelist>
4777  <varlistentry>
4778   <term>Typical use:</term>
4779   <listitem>
4780    <para>Prevent yet another way to track the user's steps between sessions.</para>
4781   </listitem>
4782  </varlistentry>
4783
4784  <varlistentry>
4785   <term>Effect:</term>
4786   <listitem>
4787    <para>
4788     Deletes the <quote>Last-Modified:</quote> HTTP server header or modifies its value.
4789    </para>
4790   </listitem>
4791  </varlistentry>
4792
4793  <varlistentry>
4794   <term>Type:</term>
4795   <!-- Boolean, Parameterized, Multi-value -->
4796   <listitem>
4797    <para>Parameterized.</para>
4798   </listitem>
4799  </varlistentry>
4800
4801  <varlistentry>
4802   <term>Parameter:</term>
4803   <listitem>
4804    <para>
4805     One of the keywords: <quote>block</quote>, <quote>reset-to-request-time</quote>
4806     and <quote>randomize</quote>
4807    </para>
4808   </listitem>
4809  </varlistentry>
4810
4811  <varlistentry>
4812   <term>Notes:</term>
4813   <listitem>
4814    <para>
4815     Removing the <quote>Last-Modified:</quote> header is useful for filter
4816     testing, where you want to force a real reload instead of getting status
4817     code <quote>304</quote>, which would cause the browser to reuse the old
4818     version of the page.
4819    </para>
4820    <para>
4821     The <quote>randomize</quote> option overwrites the value of the
4822     <quote>Last-Modified:</quote> header with a randomly chosen time
4823     between the original value and the current time. In theory the server
4824     could send each document with a different <quote>Last-Modified:</quote>
4825     header to track visits without using cookies. <quote>Randomize</quote>
4826     makes it impossible and the browser can still revalidate cached documents.
4827    </para>
4828    <para>
4829     <quote>reset-to-request-time</quote> overwrites the value of the
4830     <quote>Last-Modified:</quote> header with the current time. You could use
4831     this option together with
4832     <literal><link linkend="hide-if-modified-since">hided-if-modified-since</link></literal>
4833     to further customize your random range.
4834    </para>
4835    <para>
4836     The preferred parameter here is <quote>randomize</quote>. It is safe
4837     to use, as long as the time settings are more or less correct.
4838     If the server sets the <quote>Last-Modified:</quote> header to the time
4839     of the request, the random range becomes zero and the value stays the same.
4840     Therefore you should later randomize it a second time with
4841     <literal><link linkend="hide-if-modified-since">hided-if-modified-since</link></literal>,
4842     just to be sure.
4843    </para>
4844    <para>
4845     It is also recommended to use this action together with
4846     <literal><link linkend="crunch-if-none-match">crunch-if-none-match</link></literal>.
4847    </para>
4848   </listitem>
4849  </varlistentry>
4850
4851  <varlistentry>
4852   <term>Example usage:</term>
4853   <listitem>
4854     <para>
4855      <screen># Let the browser revalidate without being tracked across sessions
4856 {+hide-if-modified-since {-1}\
4857 +overwrite-last-modified {randomize}\
4858 +crunch-if-none-match}
4859 /</screen>
4860    </para>
4861   </listitem>
4862  </varlistentry>
4863 </variablelist>
4864 </sect3>
4865
4866
4867 <!--   ~~~~~       New section      ~~~~~     -->
4868 <sect3 renderas="sect4" id="redirect">
4869 <title>redirect</title>
4870 <!--
4871 new action
4872 -->
4873 <variablelist>
4874  <varlistentry>
4875   <term>Typical use:</term>
4876   <listitem>
4877    <para>
4878     Redirect requests to other sites.
4879    </para>
4880   </listitem>
4881  </varlistentry>
4882
4883  <varlistentry>
4884   <term>Effect:</term>
4885   <listitem>
4886    <para>
4887     Convinces the browser that the requested document has been moved
4888     to another location and the browser should get it from there.
4889    </para>
4890   </listitem>
4891  </varlistentry>
4892
4893  <varlistentry>
4894   <term>Type:</term>
4895   <!-- Boolean, Parameterized, Multi-value -->
4896   <listitem>
4897    <para>Parameterized</para>
4898   </listitem>
4899  </varlistentry>
4900
4901  <varlistentry>
4902   <term>Parameter:</term>
4903   <listitem>
4904    <para>
4905     Any URL.
4906    </para>
4907   </listitem>
4908  </varlistentry>
4909
4910  <varlistentry>
4911   <term>Notes:</term>
4912   <listitem>
4913    <para>
4914     This action is useful to replace whole documents with your own
4915     ones. For that to work, they have to be available on another server,
4916     and both should resolve.
4917    </para>
4918    <para>
4919     You can do the same by combining the actions
4920     <literal><link linkend="block">block</link></literal>,
4921     <literal><link linkend="handle-as-image">handle-as-image</link></literal> and
4922     <literal><link linkend="set-image-blocker">set-image-blocker{URL}</link></literal>.
4923     It doesn't sound right for non-image documents, and that's why this action
4924     was created.
4925    </para>
4926    <para>
4927     This action will be ignored if you use it together with
4928     <literal><link linkend="block">block</link></literal>.
4929    </para>
4930   </listitem>
4931  </varlistentry>
4932
4933  <varlistentry>
4934   <term>Example usage:</term>
4935   <listitem>
4936    <para>
4937     <screen># Replace example.com's style sheet with another one
4938 {+redirect{http://localhost/css-replacements/example.com.css}}
4939 example.com/stylesheet.css</screen>
4940    </para>
4941   </listitem>
4942  </varlistentry>
4943
4944 </variablelist>
4945 </sect3>
4946
4947
4948 <!--   ~~~~~       New section      ~~~~~     -->
4949 <sect3 renderas="sect4" id="send-vanilla-wafer">
4950 <title>send-vanilla-wafer</title>
4951
4952 <variablelist>
4953  <varlistentry>
4954   <term>Typical use:</term>
4955   <listitem>
4956    <para>
4957     Feed log analysis scripts with useless data.
4958    </para>
4959   </listitem>
4960  </varlistentry>
4961
4962  <varlistentry>
4963   <term>Effect:</term>
4964   <listitem>
4965    <para>
4966     Sends a cookie with each request stating that you do not accept any copyright
4967     on cookies sent to you, and asking the site operator not to track you.
4968    </para>
4969   </listitem>
4970  </varlistentry>
4971
4972  <varlistentry>
4973   <term>Type:</term>
4974   <!-- Boolean, Parameterized, Multi-value -->
4975   <listitem>
4976    <para>Boolean.</para>
4977   </listitem>
4978  </varlistentry>
4979
4980  <varlistentry>
4981   <term>Parameter:</term>
4982   <listitem>
4983    <para>
4984     N/A
4985    </para>
4986   </listitem>
4987  </varlistentry>
4988
4989  <varlistentry>
4990   <term>Notes:</term>
4991   <listitem>
4992    <para>
4993     The vanilla wafer is a (relatively) unique header and could conceivably be used to track you.
4994    </para>
4995    <para>
4996     This action is rarely used and not enabled in the default configuration.
4997    </para>
4998   </listitem>
4999  </varlistentry>
5000
5001  <varlistentry>
5002   <term>Example usage:</term>
5003   <listitem>
5004    <para>
5005      <screen>+send-vanilla-wafer</screen>
5006    </para>
5007   </listitem>
5008  </varlistentry>
5009
5010 </variablelist>
5011 </sect3>
5012
5013
5014 <!--   ~~~~~       New section      ~~~~~     -->
5015 <sect3 renderas="sect4" id="send-wafer">
5016 <title>send-wafer</title>
5017
5018 <variablelist>
5019  <varlistentry>
5020   <term>Typical use:</term>
5021   <listitem>
5022    <para>
5023     Send custom cookies or feed log analysis scripts with even more useless data.
5024    </para>
5025   </listitem>
5026  </varlistentry>
5027
5028  <varlistentry>
5029   <term>Effect:</term>
5030   <listitem>
5031    <para>
5032     Sends a custom, user-defined cookie with each request.
5033    </para>
5034   </listitem>
5035  </varlistentry>
5036
5037  <varlistentry>
5038   <term>Type:</term>
5039   <!-- Boolean, Parameterized, Multi-value -->
5040   <listitem>
5041    <para>Multi-value.</para>
5042   </listitem>
5043  </varlistentry>
5044
5045  <varlistentry>
5046   <term>Parameter:</term>
5047   <listitem>
5048    <para>
5049     A string of the form <quote><replaceable class="option">name</replaceable>=<replaceable
5050     class="parameter">value</replaceable></quote>.
5051    </para>
5052   </listitem>
5053  </varlistentry>
5054
5055  <varlistentry>
5056   <term>Notes:</term>
5057   <listitem>
5058    <para>
5059     Being multi-valued, multiple instances of this action can apply to the same request,
5060     resulting in multiple cookies being sent.
5061    </para>
5062    <para>
5063     This action is rarely used and not enabled in the default configuration.
5064    </para>
5065   </listitem>
5066  </varlistentry>
5067  <varlistentry>
5068   <term>Example usage (section):</term>
5069   <listitem>
5070    <para>
5071     <screen>{+send-wafer{UsingPrivoxy=true}}
5072 my-internal-testing-server.void</screen>
5073    </para>
5074   </listitem>
5075  </varlistentry>
5076 </variablelist>
5077 </sect3>
5078
5079
5080 <!--   ~~~~~       New section      ~~~~~     -->
5081 <sect3 renderas="sect4" id="session-cookies-only">
5082 <title>session-cookies-only</title>
5083
5084 <variablelist>
5085  <varlistentry>
5086   <term>Typical use:</term>
5087   <listitem>
5088    <para>
5089     Allow only temporary <quote>session</quote> cookies (for the current
5090     browser session <emphasis>only</emphasis>).
5091    </para>
5092   </listitem>
5093  </varlistentry>
5094
5095  <varlistentry>
5096   <term>Effect:</term>
5097   <listitem>
5098    <para>
5099     Deletes the <quote>expires</quote> field from <quote>Set-Cookie:</quote>
5100     server headers. Most browsers will not store such cookies permanently and
5101     forget them in between sessions.
5102    </para>
5103   </listitem>
5104  </varlistentry>
5105
5106 <varlistentry>
5107   <term>Type:</term>
5108   <!-- Boolean, Parameterized, Multi-value -->
5109   <listitem>
5110    <para>Boolean.</para>
5111   </listitem>
5112  </varlistentry>
5113
5114  <varlistentry>
5115   <term>Parameter:</term>
5116   <listitem>
5117    <para>
5118     N/A
5119    </para>
5120   </listitem>
5121  </varlistentry>
5122
5123  <varlistentry>
5124   <term>Notes:</term>
5125   <listitem>
5126    <para>
5127     This is less strict than <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal> /
5128     <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal> and allows you to browse
5129     websites that insist or rely on setting cookies, without compromising your privacy too badly.
5130    </para>
5131    <para>
5132     Most browsers will not permanently store cookies that have been processed by
5133     <literal>session-cookies-only</literal> and will forget about them between sessions.
5134     This makes profiling cookies useless, but won't break sites which require cookies so
5135     that you can log in for transactions. This is generally turned on for all
5136     sites, and is the recommended setting.
5137    </para>
5138    <para>
5139     It makes <emphasis>no sense at all</emphasis> to use <literal>session-cookies-only</literal>
5140     together with <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal> or
5141     <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>. If you do, cookies
5142     will be plainly killed.
5143    </para>
5144    <para>
5145     Note that it is up to the browser how it handles such cookies without an <quote>expires</quote>
5146     field. If you use an exotic browser, you might want to try it out to be sure.
5147    </para>
5148    <para>
5149     This setting also has no effect on cookies that may have been stored
5150     previously by the browser before starting <application>Privoxy</application>.
5151     These would have to be removed manually.
5152    </para>
5153    <para>
5154      <application>Privoxy</application> also uses
5155      the <link linkend="filter-content-cookies">content-cookies filter</link>
5156      to block some types of cookies. Content cookies are not effected by
5157      <literal>session-cookies-only</literal>.
5158    </para>
5159   </listitem>
5160  </varlistentry>
5161
5162  <varlistentry>
5163   <term>Example usage:</term>
5164   <listitem>
5165    <para>
5166      <screen>+session-cookies-only</screen>
5167    </para>
5168   </listitem>
5169  </varlistentry>
5170 </variablelist>
5171 </sect3>
5172
5173
5174 <!--   ~~~~~       New section      ~~~~~     -->
5175 <sect3 renderas="sect4" id="set-image-blocker">
5176 <title>set-image-blocker</title>
5177
5178 <variablelist>
5179  <varlistentry>
5180   <term>Typical use:</term>
5181   <listitem>
5182    <para>Choose the replacement for blocked images</para>
5183   </listitem>
5184  </varlistentry>
5185
5186  <varlistentry>
5187   <term>Effect:</term>
5188   <listitem>
5189    <para>
5190      This action alone doesn't do anything noticeable. If <emphasis>both</emphasis>
5191      <literal><link linkend="block">block</link></literal> <emphasis>and</emphasis> <literal><link
5192      linkend="handle-as-image">handle-as-image</link></literal> <emphasis>also</emphasis>
5193      apply, i.e. if the request is to be blocked as an image,
5194      <emphasis>then</emphasis> the parameter of this action decides what will be
5195      sent as a replacement.
5196    </para>
5197   </listitem>
5198  </varlistentry>
5199
5200  <varlistentry>
5201   <term>Type:</term>
5202   <!-- Boolean, Parameterized, Multi-value -->
5203   <listitem>
5204    <para>Parameterized.</para>
5205   </listitem>
5206  </varlistentry>
5207
5208  <varlistentry>
5209   <term>Parameter:</term>
5210   <listitem>
5211    <itemizedlist>
5212     <listitem>
5213      <para>
5214       <quote>pattern</quote> to send a built-in checkerboard pattern image. The image is visually
5215       decent, scales very well, and makes it obvious where banners were busted.
5216      </para>
5217     </listitem>
5218     <listitem>
5219      <para>
5220       <quote>blank</quote> to send a built-in transparent image. This makes banners disappear
5221       completely, but makes it hard to detect where <application>Privoxy</application> has blocked
5222       images on a given page and complicates troubleshooting if <application>Privoxy</application>
5223       has blocked innocent images, like navigation icons.
5224      </para>
5225     </listitem>
5226     <listitem>
5227      <para>
5228       <quote><replaceable class="parameter">target-url</replaceable></quote> to
5229       send a redirect to <replaceable class="parameter">target-url</replaceable>. You can redirect
5230       to any image anywhere, even in your local filesystem via <quote>file:///</quote> URL.
5231       (But note that not all browsers support redirecting to a local file system).
5232      </para>
5233      <para>
5234       A good application of redirects is to use special <application>Privoxy</application>-built-in
5235       URLs, which send the built-in images, as <replaceable class="parameter">target-url</replaceable>.
5236       This has the same visual effect as specifying <quote>blank</quote> or <quote>pattern</quote> in
5237       the first place, but enables your browser to cache the replacement image, instead of requesting
5238       it over and over again.
5239      </para>
5240     </listitem>
5241    </itemizedlist>
5242   </listitem>
5243  </varlistentry>
5244
5245  <varlistentry>
5246   <term>Notes:</term>
5247   <listitem>
5248    <para>
5249     The URLs for the built-in images are <quote>http://config.privoxy.org/send-banner?type=<replaceable
5250     class="parameter">type</replaceable></quote>, where <replaceable class="parameter">type</replaceable> is
5251     either <quote>blank</quote> or <quote>pattern</quote>.
5252    </para>
5253    <para>
5254     There is a third (advanced) type, called <quote>auto</quote>. It is <emphasis>NOT</emphasis> to be
5255     used in <literal>set-image-blocker</literal>, but meant for use from <link linkend="filter-file">filters</link>.
5256     Auto will select the type of image that would have applied to the referring page, had it been an image.
5257    </para>
5258   </listitem>
5259  </varlistentry>
5260
5261  <varlistentry>
5262   <term>Example usage:</term>
5263   <listitem>
5264    <para>
5265     Built-in pattern:
5266    </para>
5267    <para>
5268     <screen>+set-image-blocker{pattern}</screen>
5269    </para>
5270    <para>
5271     Redirect to the BSD devil:
5272    </para>
5273    <para>
5274     <screen>+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</screen>
5275    </para>
5276    <para>
5277     Redirect to the built-in pattern for better caching:
5278    </para>
5279    <para>
5280     <screen>+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</screen>
5281    </para>
5282   </listitem>
5283  </varlistentry>
5284 </variablelist>
5285 </sect3>
5286
5287
5288 <!--   ~~~~~       New section      ~~~~~     -->
5289 <sect3 renderas="sect4" id="treat-forbidden-connects-like-blocks">
5290 <title>treat-forbidden-connects-like-blocks</title>
5291 <!--
5292 new action
5293 -->
5294 <variablelist>
5295  <varlistentry>
5296   <term>Typical use:</term>
5297   <listitem>
5298    <para>Block forbidden connects with an easy to find error message.</para>
5299   </listitem>
5300  </varlistentry>
5301
5302  <varlistentry>
5303   <term>Effect:</term>
5304   <listitem>
5305    <para>
5306     If this action is enabled, <application>Privoxy</application> no longer
5307     makes a difference between forbidden connects and ordinary blocks.
5308    </para>
5309   </listitem>
5310  </varlistentry>
5311
5312  <varlistentry>
5313   <term>Type:</term>
5314   <!-- Boolean, Parameterized, Multi-value -->
5315   <listitem>
5316    <para>Boolean</para>
5317   </listitem>
5318  </varlistentry>
5319
5320  <varlistentry>
5321   <term>Parameter:</term>
5322   <listitem>
5323    <para>N/A</para>
5324   </listitem>
5325  </varlistentry>
5326
5327  <varlistentry>
5328   <term>Notes:</term>
5329   <listitem>
5330    <para>
5331     By default <application>Privoxy</application> answers
5332     <link linkend="limit-connect">forbidden <quote>Connect</quote> requests</link>
5333     with a short error message inside the headers. If the browser doesn't display
5334     headers (most don't), you just see an empty page.
5335    </para>
5336    <para>
5337     With this action enabled, <application>Privoxy</application> displays
5338     the message that is used for ordinary blocks instead. If you decide
5339     to make an exception for the page in question, you can do so by
5340     following the <quote>See why</quote> link.
5341    </para>
5342    <para>
5343     For <quote>Connect</quote> requests the clients tell
5344     <application>Privoxy</application> which host they are interested
5345     in, but not which document they plan to get later. As a result, the
5346     <quote>Go there anyway</quote> link becomes rather useless:
5347     it lets the client request the home page of the forbidden host
5348     through unencrypted HTTP, still using the port of the last request.
5349    </para>
5350    <para>
5351     If you previously configured <application>Privoxy</application> to do the
5352     request through a SSL tunnel, everything will work. Most likely you haven't
5353     and the server will respond with an error message because it is expecting
5354     HTTPS.
5355    </para>
5356   </listitem>
5357  </varlistentry>
5358
5359  <varlistentry>
5360   <term>Example usage:</term>
5361   <listitem>
5362    <para>
5363     <screen>+treat-forbidden-connects-like-blocks</screen>
5364    </para>
5365   </listitem>
5366  </varlistentry>
5367 </variablelist>
5368 </sect3>
5369
5370
5371 <!--   ~~~~~       New section      ~~~~~     -->
5372 <sect3>
5373 <title>Summary</title>
5374 <para>
5375  Note that many of these actions have the potential to cause a page to
5376  misbehave, possibly even not to display at all. There are many ways
5377  a site designer may choose to design his site, and what HTTP header
5378  content, and other criteria, he may depend on. There is no way to have hard
5379  and fast rules for all sites. See the <link
5380  linkend="ACTIONSANAT">Appendix</link> for a brief example on troubleshooting
5381  actions.
5382 </para>
5383 </sect3>
5384 </sect2>
5385
5386 <!--   ~~~~~       New section      ~~~~~     -->
5387 <sect2 id="aliases">
5388 <title>Aliases</title>
5389 <para>
5390  Custom <quote>actions</quote>, known to <application>Privoxy</application>
5391  as <quote>aliases</quote>, can be defined by combining other actions.
5392  These can in turn be invoked just like the built-in actions.
5393  Currently, an alias name can contain any character except space, tab,
5394  <quote>=</quote>,
5395  <quote>{</quote> and <quote>}</quote>, but we <emphasis>strongly
5396  recommend</emphasis> that you only use <quote>a</quote> to <quote>z</quote>,
5397  <quote>0</quote> to <quote>9</quote>, <quote>+</quote>, and <quote>-</quote>.
5398  Alias names are not case sensitive, and are not required to start with a
5399  <quote>+</quote> or <quote>-</quote> sign, since they are merely textually
5400  expanded.
5401 </para>
5402 <para>
5403  Aliases can be used throughout the actions file, but they <emphasis>must be
5404  defined in a special section at the top of the file!</emphasis>
5405  And there can only be one such section per actions file. Each actions file may
5406  have its own alias section, and the aliases defined in it are only visible
5407  within that file.
5408 </para>
5409 <para>
5410  There are two main reasons to use aliases: One is to save typing for frequently
5411  used combinations of actions, the other one is a gain in flexibility: If you
5412  decide once how you want to handle shops by defining an alias called
5413  <quote>shop</quote>, you can later change your policy on shops in
5414  <emphasis>one</emphasis> place, and your changes will take effect everywhere
5415  in the actions file where the <quote>shop</quote> alias is used. Calling aliases
5416  by their purpose also makes your actions files more readable.
5417 </para>
5418 <para>
5419  Currently, there is one big drawback to using aliases, though:
5420  <application>Privoxy</application>'s built-in web-based action file
5421  editor honors aliases when reading the actions files, but it expands
5422  them before writing. So the effects of your aliases are of course preserved,
5423  but the aliases themselves are lost when you edit sections that use aliases
5424  with it.
5425  This is likely to change in future versions of <application>Privoxy</application>.
5426 </para>
5427
5428 <para>
5429  Now let's define some aliases...
5430 </para>
5431
5432 <para>
5433  <screen>
5434  # Useful custom aliases we can use later.
5435  #
5436  # Note the (required!) section header line and that this section
5437  # must be at the top of the actions file!
5438  #
5439  {{alias}}
5440
5441  # These aliases just save typing later:
5442  # (Note that some already use other aliases!)
5443  #
5444  +crunch-all-cookies = +<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> +<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link>
5445  -crunch-all-cookies = -<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> -<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link>
5446  block-as-image      = +block +handle-as-image
5447  mercy-for-cookies   = -crunch-all-cookies -<link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> -<link linkend="FILTER-CONTENT-COOKIES">filter{content-cookies}</link>
5448
5449  # These aliases define combinations of actions
5450  # that are useful for certain types of sites:
5451  #
5452  fragile     = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link> -<link linkend="KILL-POPUPS">kill-popups</link>
5453  shop        = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link> -<link linkend="KILL-POPUPS">kill-popups</link>
5454
5455  # Short names for other aliases, for really lazy people ;-)
5456  #
5457  c0 = +crunch-all-cookies
5458  c1 = -crunch-all-cookies</screen>
5459 </para>
5460
5461 <para>
5462  ...and put them to use. These sections would appear in the lower part of an
5463  actions file and define exceptions to the default actions (as specified further
5464  up for the <quote>/</quote> pattern):
5465 </para>
5466
5467 <para>
5468  <screen>
5469  # These sites are either very complex or very keen on
5470  # user data and require minimal interference to work:
5471  #
5472  {fragile}
5473  .office.microsoft.com
5474  .windowsupdate.microsoft.com
5475  .nytimes.com
5476
5477  # Shopping sites:
5478  # Allow cookies (for setting and retrieving your customer data)
5479  #
5480  {shop}
5481  .quietpc.com
5482  .worldpay.com   # for quietpc.com
5483  .scan.co.uk
5484
5485  # These shops require pop-ups:
5486  #
5487  {shop -kill-popups -filter{all-popups}}
5488   .dabs.com
5489   .overclockers.co.uk</screen>
5490 </para>
5491
5492 <para>
5493  Aliases like <quote>shop</quote> and <quote>fragile</quote> are often used for
5494  <quote>problem</quote> sites that require some actions to be disabled
5495  in order to function properly.
5496 </para>
5497 </sect2>
5498 <!--
5499 hal stop here
5500 -->
5501 <!--   ~~~~~       New section      ~~~~~     -->
5502 <sect2 id="act-examples">
5503 <title>Actions Files Tutorial</title>
5504 <para>
5505  The above chapters have shown <link linkend="actions-file">which actions files
5506  there are and how they are organized</link>, how actions are <link
5507  linkend="actions">specified</link> and <link linkend="actions-apply">applied
5508  to URLs</link>, how <link linkend="af-patterns">patterns</link> work, and how to
5509  define and use <link linkend="aliases">aliases</link>. Now, let's look at an
5510  example <filename>default.action</filename> and <filename>user.action</filename>
5511  file and see how all these pieces come together:
5512 </para>
5513
5514 <sect3><title>default.action</title>
5515
5516 <para>
5517 Every config file should start with a short comment stating its purpose:
5518 </para>
5519
5520 <para>
5521  <screen># Sample default.action file &lt;ijbswa-developers@lists.sourceforge.net&gt;</screen>
5522 </para>
5523
5524 <para>
5525 Then, since this is the <filename>default.action</filename> file, the
5526 first section is a special section for internal use that you needn't
5527 change or worry about:
5528 </para>
5529
5530 <para>
5531  <screen>
5532 ##########################################################################
5533 # Settings -- Don't change! For internal Privoxy use ONLY.
5534 ##########################################################################
5535
5536 {{settings}}
5537 for-privoxy-version=3.0</screen>
5538 </para>
5539
5540 <para>
5541 After that comes the (optional) alias section. We'll use the example
5542 section from the above <link linkend="aliases">chapter on aliases</link>,
5543 that also explains why and how aliases are used:
5544 </para>
5545
5546 <para>
5547  <screen>
5548 ##########################################################################
5549 # Aliases
5550 ##########################################################################
5551 {{alias}}
5552
5553  # These aliases just save typing later:
5554  # (Note that some already use other aliases!)
5555  #
5556  +crunch-all-cookies = +<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> +<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link>
5557  -crunch-all-cookies = -<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> -<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link>
5558  block-as-image      = +block +handle-as-image
5559  mercy-for-cookies   = -crunch-all-cookies -<link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> -<link linkend="FILTER-CONTENT-COOKIES">filter{content-cookies}</link>
5560
5561  # These aliases define combinations of actions
5562  # that are useful for certain types of sites:
5563  #
5564  fragile     = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link> -<link linkend="KILL-POPUPS">kill-popups</link>
5565  shop        = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link> -<link linkend="KILL-POPUPS">kill-popups</link></screen>
5566 </para>
5567
5568 <para>
5569  Now come the regular sections, i.e. sets of actions, accompanied
5570  by URL patterns to which they apply. Remember <emphasis>all actions
5571  are disabled when matching starts</emphasis>, so we have to explicitly
5572  enable the ones we want.
5573 </para>
5574
5575 <para>
5576  The first regular section is probably the most important. It has only
5577  one pattern, <quote><literal>/</literal></quote>, but this pattern
5578  <link linkend="af-patterns">matches all URLs</link>. Therefore, the
5579  set of actions used in this <quote>default</quote> section <emphasis>will
5580  be applied to all requests as a start</emphasis>. It can  be partly or
5581  wholly overridden by later matches further down this file, or in user.action,
5582  but it will still be largely responsible for your overall browsing
5583  experience.
5584 </para>
5585
5586 <para>
5587  Again, at the start of matching, all actions are disabled, so there is
5588  no real need to disable any actions here, but we will do that nonetheless,
5589  to have a complete listing for your reference. (Remember: a <quote>+</quote>
5590  preceding the action name enables the action, a <quote>-</quote> disables!).
5591  Also note how this long line has been made more readable by splitting it into
5592  multiple lines with line continuation.
5593 </para>
5594
5595 <para>
5596  <screen>
5597 ##########################################################################
5598 # "Defaults" section:
5599 ##########################################################################
5600  { \
5601  -<link linkend="ADD-HEADER">add-header</link> \
5602  -<link linkend="BLOCK">block</link> \
5603  -<link linkend="CONTENT-TYPE-OVERWRITE">content-type-overwrite</link> \
5604  -<link linkend="CRUNCH-CLIENT-HEADER">crunch-client-header</link> \
5605  -<link linkend="CRUNCH-IF-NONE-MATCH">crunch-if-none-match</link> \
5606  -<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> \
5607  -<link linkend="CRUNCH-SERVER-HEADER">crunch-server-header</link> \
5608  -<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link> \
5609  +<link linkend="DEANIMATE-GIFS">deanimate-gifs</link> \
5610  -<link linkend="DOWNGRADE-HTTP-VERSION">downgrade-http-version</link> \
5611  +<link linkend="FAST-REDIRECTS">fast-redirects{check-decoded-url}</link> \
5612  +<link linkend="FILTER-JS-ANNOYANCES">filter{js-annoyances}</link> \
5613  -<link linkend="FILTER-JS-EVENTS">filter{js-events}</link> \
5614  +<link linkend="FILTER-HTML-ANNOYANCES">filter{html-annoyances}</link> \
5615  -<link linkend="FILTER-CONTENT-COOKIES">filter{content-cookies}</link> \
5616  +<link linkend="FILTER-REFRESH-TAGS">filter{refresh-tags}</link> \
5617  +<link linkend="FILTER-UNSOLICITED-POPUPS">filter{unsolicited-popups}</link> \
5618  -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link> \
5619  +<link linkend="FILTER-IMG-REORDER">filter{img-reorder}</link> \
5620  +<link linkend="FILTER-BANNERS-BY-SIZE">filter{banners-by-size}</link> \
5621  -<link linkend="FILTER-BANNERS-BY-LINK">filter{banners-by-link}</link> \
5622  +<link linkend="FILTER-WEBBUGS">filter{webbugs}</link> \
5623  -<link linkend="FILTER-TINY-TEXTFORMS">filter{tiny-textforms}</link> \
5624  +<link linkend="FILTER-JUMPING-WINDOWS">filter{jumping-windows}</link> \
5625  -<link linkend="FILTER-FRAMESET-BORDERS">filter{frameset-borders}</link> \
5626  -<link linkend="FILTER-DEMORONIZER">filter{demoronizer}</link> \
5627  -<link linkend="FILTER-SHOCKWAVE-FLASH">filter{shockwave-flash}</link> \
5628  -<link linkend="FILTER-QUICKTIME-KIOSKMODE">filter{quicktime-kioskmode}</link> \
5629  -<link linkend="FILTER-FUN">filter{fun}</link> \
5630  -<link linkend="FILTER-CRUDE-PARENTAL">filter{crude-parental}</link> \
5631  +<link linkend="FILTER-IE-EXPLOITS">filter{ie-exploits}</link> \
5632  -<link linkend="FILTER-CLIENT-HEADERS">filter-client-headers</link> \
5633  -<link linkend="FILTER-SERVER-HEADERS">filter-server-headers</link> \
5634  -<link linkend="FORCE-TEXT-MODE">force-text-mode</link> \
5635  -<link linkend="HANDLE-AS-EMPTY-DOCUMENT">handle-as-empty-document</link> \
5636  -<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> \
5637  -<link linkend="HIDE-ACCEPT-LANGUAGE">hide-accept-language</link> \
5638  -<link linkend="HIDE-CONTENT-DISPOSITION">hide-content-disposition</link> \
5639  -<link linkend="HIDE-IF-MODIFIED-SINCE">hide-if-modified-since</link> \
5640  +<link linkend="HIDE-FORWARDED-FOR-HEADERS">hide-forwarded-for-headers</link> \
5641  +<link linkend="HIDE-FROM-HEADER">hide-from-header{block}</link> \
5642  +<link linkend="HIDE-REFERER">hide-referrer{forge}</link> \
5643  -<link linkend="HIDE-USER-AGENT">hide-user-agent</link> \
5644  -<link linkend="INSPECT-JPEGS">inspect-jpegs</link> \
5645  -<link linkend="KILL-POPUPS">kill-popups</link> \
5646  -<link linkend="LIMIT-CONNECT">limit-connect</link> \
5647  +<link linkend="PREVENT-COMPRESSION">prevent-compression</link> \
5648  -<link linkend="OVERWRITE-LAST-MODIFIED">overwrite-last-modified</link> \
5649  -<link linkend="REDIRECT">redirect</link> \
5650  -<link linkend="SEND-VANILLA-WAFER">send-vanilla-wafer</link> \
5651  -<link linkend="SEND-WAFER">send-wafer</link> \
5652  +<link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> \
5653  +<link linkend="SET-IMAGE-BLOCKER">set-image-blocker{pattern}</link> \
5654  -<link linkend="TREAT-FORBIDDEN-CONNECTS-LIKE-BLOCKS">treat-forbidden-connects-like-blocks</link> \
5655  }
5656  / # forward slash will match *all* potential URL patterns.</screen>
5657 </para>
5658
5659 <para>
5660  The default behavior is now set. Note that some actions, like not hiding
5661  the user agent, are part of a <quote>general policy</quote> that applies
5662  universally and won't get any exceptions defined later. Other choices,
5663  like not blocking (which is <emphasis>understandably</emphasis> the
5664  default!) need exceptions, i.e. we need to specify explicitly what we
5665  want to block in later sections.
5666 </para>
5667
5668 <para>
5669  The first of our specialized sections is concerned with <quote>fragile</quote>
5670  sites, i.e. sites that require minimum interference, because they are either
5671  very complex or very keen on tracking you (and have mechanisms in place that
5672  make them unusable for people who avoid being tracked). We will simply use
5673  our pre-defined <literal>fragile</literal> alias instead of stating the list
5674  of actions explicitly:
5675 </para>
5676
5677 <para>
5678  <screen>
5679 ##########################################################################
5680 # Exceptions for sites that'll break under the default action set:
5681 ##########################################################################
5682
5683 # "Fragile" Use a minimum set of actions for these sites (see alias above):
5684 #
5685 { fragile }
5686 .office.microsoft.com           # surprise, surprise!
5687 .windowsupdate.microsoft.com</screen>
5688 </para>
5689
5690 <para>
5691  Shopping sites are not as fragile, but they typically
5692  require cookies to log in, and pop-up windows for shopping
5693  carts or item details. Again, we'll use a pre-defined alias:
5694 </para>
5695
5696 <para>
5697  <screen>
5698 # Shopping sites:
5699 #
5700 { shop }
5701 .quietpc.com
5702 .worldpay.com   # for quietpc.com
5703 .jungle.com
5704 .scan.co.uk</screen>
5705 </para>
5706
5707 <!-- No longer needed BEGIN OF COMMENTED OUT BLOCK
5708
5709 <para>
5710  Then, there are sites which rely on pop-up windows (yuck!) to work.
5711  Since we made pop-up-killing our default above, we need to make exceptions
5712  now. <ulink url="http://www.mozilla.org/">Mozilla</ulink> users, who
5713  can turn on smart handling of unwanted pop-ups in their browsers, can
5714  safely choose
5715  -<literal><link linkend="FILTER-ALL-POPUPS">filter{popups}</link></literal> (and
5716  -<literal><link linkend="KILL-POPUPS">kill-popups</link></literal>) above
5717  and hence don't need this section. Anyway, disabling an already disabled
5718  action doesn't hurt, so we'll define our exceptions regardless of what was
5719  chosen in the defaults section:
5720 </para>
5721
5722 <para>
5723  <screen>
5724 # These sites require pop-ups too :(
5725 #
5726 { -<link linkend="KILL-POPUPS">kill-popups</link> -<link linkend="FILTER-ALL-POPUPS">filter{popups}</link> }
5727 .dabs.com
5728 .overclockers.co.uk
5729 .deutsche-bank-24.de</screen>
5730 </para>
5731
5732  END OF COMMENTED OUT BLOCK -->
5733
5734 <para>
5735  The <literal><link linkend="FAST-REDIRECTS">fast-redirects</link></literal>
5736  action, which we enabled per default above,  breaks some sites. So disable
5737  it for popular sites where we know it misbehaves:
5738 </para>
5739
5740 <para>
5741  <screen>
5742 { -<link linkend="FAST-REDIRECTS">fast-redirects</link> }
5743 login.yahoo.com
5744 edit.*.yahoo.com
5745 .google.com
5746 .altavista.com/.*(like|url|link):http
5747 .altavista.com/trans.*urltext=http
5748 .nytimes.com</screen>
5749 </para>
5750
5751 <para>
5752  It is important that <application>Privoxy</application> knows which
5753  URLs belong to images, so that <emphasis>if</emphasis> they are to
5754  be blocked, a substitute image can be sent, rather than an HTML page.
5755  Contacting the remote site to find out is not an option, since it
5756  would destroy the loading time advantage of banner blocking, and it
5757  would feed the advertisers (in terms of money <emphasis>and</emphasis>
5758  information). We can mark any URL as an image with the <literal><link
5759  linkend="handle-as-image">handle-as-image</link></literal> action,
5760  and marking all URLs that end in a known image file extension is a
5761  good start:
5762 </para>
5763
5764 <para>
5765  <screen>
5766 ##########################################################################
5767 # Images:
5768 ##########################################################################
5769
5770 # Define which file types will be treated as images, in case they get
5771 # blocked further down this file:
5772 #
5773 { +<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> }
5774 /.*\.(gif|jpe?g|png|bmp|ico)$</screen>
5775 </para>
5776
5777 <para>
5778  And then there are known banner sources. They often use scripts to
5779  generate the banners, so it won't be visible from the URL that the
5780  request is for an image. Hence we block them <emphasis>and</emphasis>
5781  mark them as images in one go, with the help of our
5782  <literal>block-as-image</literal> alias defined above. (We could of
5783  course just as well use <literal>+<link linkend="block">block</link>
5784  +<link linkend="handle-as-image">handle-as-image</link></literal> here.)
5785  Remember that the type of the replacement image is chosen by the
5786  <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>
5787  action. Since all URLs have matched the default section with its
5788  <literal>+<link linkend="set-image-blocker">set-image-blocker</link>{pattern}</literal>
5789  action before, it still applies and needn't be repeated:
5790 </para>
5791
5792 <para>
5793  <screen>
5794 # Known ad generators:
5795 #
5796 { block-as-image }
5797 ar.atwola.com
5798 .ad.doubleclick.net
5799 .ad.*.doubleclick.net
5800 .a.yimg.com/(?:(?!/i/).)*$
5801 .a[0-9].yimg.com/(?:(?!/i/).)*$
5802 bs*.gsanet.com
5803 bs*.einets.com
5804 .qkimg.net</screen>
5805 </para>
5806
5807 <para>
5808  One of the most important jobs of <application>Privoxy</application>
5809  is to block banners. A huge bunch of them can be <quote>blocked</quote>
5810  by the <literal><link linkend="filter">filter</link>{banners-by-size}</literal>
5811  action, which we enabled above, and which deletes the references to banner
5812  images from the pages while they are loaded, so the browser doesn't request
5813  them anymore, and hence they don't need to be blocked here. But this naturally
5814  doesn't catch all banners, and some people choose not to use filters, so we
5815  need a comprehensive list of patterns for banner URLs here, and apply the
5816  <literal><link linkend="block">block</link></literal> action to them.
5817 </para>
5818 <para>
5819  First comes a bunch of generic patterns, which do most of the work, by
5820  matching typical domain and path name components of banners. Then comes
5821  a list of individual patterns for specific sites, which is omitted here
5822  to keep the example short:
5823 </para>
5824
5825 <para>
5826  <screen>
5827 ##########################################################################
5828 # Block these fine banners:
5829 ##########################################################################
5830 { <link linkend="BLOCK">+block</link> }
5831
5832 # Generic patterns:
5833 #
5834 ad*.
5835 .*ads.
5836 banner?.
5837 count*.
5838 /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
5839 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/
5840
5841 # Site-specific patterns (abbreviated):
5842 #
5843 .hitbox.com</screen>
5844 </para>
5845
5846 <para>
5847  You wouldn't believe how many advertisers actually call their banner
5848  servers ads.<replaceable>company</replaceable>.com, or call the directory
5849  in which the banners are stored simply <quote>banners</quote>. So the above
5850  generic patterns are surprisingly effective.
5851 </para>
5852 <para>
5853  But being very generic, they necessarily also catch URLs that we don't want
5854  to block. The pattern <literal>.*ads.</literal> e.g. catches
5855  <quote>nasty-<emphasis>ads</emphasis>.nasty-corp.com</quote> as intended,
5856  but also <quote>downlo<emphasis>ads</emphasis>.sourcefroge.net</quote> or
5857  <quote><emphasis>ads</emphasis>l.some-provider.net.</quote> So here come some
5858  well-known exceptions to the <literal>+<link linkend="BLOCK">block</link></literal>
5859  section above.
5860 </para>
5861 <para>
5862  Note that these are exceptions to exceptions from the default! Consider the URL
5863  <quote>downloads.sourcefroge.net</quote>: Initially, all actions are deactivated,
5864  so it wouldn't get blocked. Then comes the defaults section, which matches the
5865  URL, but just deactivates the <literal><link linkend="BLOCK">block</link></literal>
5866  action once again. Then it matches <literal>.*ads.</literal>, an exception to the
5867  general non-blocking policy, and suddenly
5868  <literal><link linkend="BLOCK">+block</link></literal> applies. And now, it'll match
5869  <literal>.*loads.</literal>, where <literal><link linkend="BLOCK">-block</link></literal>
5870  applies, so (unless it matches <emphasis>again</emphasis> further down) it ends up
5871  with no <literal><link linkend="BLOCK">block</link></literal> action applying.
5872 </para>
5873
5874 <para>
5875  <screen>
5876 ##########################################################################
5877 # Save some innocent victims of the above generic block patterns:
5878 ##########################################################################
5879
5880 # By domain:
5881 #
5882 { -<link linkend="BLOCK">block</link> }
5883 adv[io]*.  # (for advogato.org and advice.*)
5884 adsl.      # (has nothing to do with ads)
5885 ad[ud]*.   # (adult.* and add.*)
5886 .edu       # (universities don't host banners (yet!))
5887 .*loads.   # (downloads, uploads etc)
5888
5889 # By path:
5890 #
5891 /.*loads/
5892
5893 # Site-specific:
5894 #
5895 www.globalintersec.com/adv # (adv = advanced)
5896 www.ugu.com/sui/ugu/adv</screen>
5897 </para>
5898
5899 <para>
5900  Filtering source code can have nasty side effects,
5901  so make an exception for our friends at sourceforge.net,
5902  and all paths with <quote>cvs</quote> in them. Note that
5903  <literal>-<link linkend="FILTER">filter</link></literal>
5904  disables <emphasis>all</emphasis> filters in one fell swoop!
5905 </para>
5906
5907 <para>
5908  <screen>
5909 # Don't filter code!
5910 #
5911 { -<link linkend="FILTER">filter</link> }
5912 /.*cvs
5913 .sourceforge.net</screen>
5914 </para>
5915
5916 <para>
5917  The actual <filename>default.action</filename> is of course much more
5918  comprehensive, but we hope this example made clear how it works.
5919 </para>
5920
5921 </sect3>
5922
5923 <sect3><title>user.action</title>
5924
5925 <para>
5926  So far we are painting with a broad brush by setting general policies,
5927  which would be a reasonable starting point for many people. Now,
5928  you might want to be more specific and have customized rules that
5929  are more suitable to your personal habits and preferences. These would
5930  be for narrowly defined situations like your ISP or your bank, and should
5931  be placed in <filename>user.action</filename>, which is parsed after all other
5932  actions files and hence has the last word, over-riding any previously
5933  defined actions. <filename>user.action</filename> is also a
5934  <emphasis>safe</emphasis> place for your personal settings, since
5935  <filename>default.action</filename> is actively maintained by the
5936  <application>Privoxy</application> developers and you'll probably want
5937  to install updated versions from time to time.
5938 </para>
5939
5940 <para>
5941  So let's look at a few examples of things that one might typically do in
5942  <filename>user.action</filename>:
5943 </para>
5944
5945
5946 <!-- brief sample user.action here -->
5947
5948 <para>
5949  <screen>
5950 # My user.action file. &lt;fred@foobar.com&gt;</screen>
5951 </para>
5952
5953 <para>
5954  As <link linkend="aliases">aliases</link> are local to the actions
5955  file that they are defined in, you can't use the ones from
5956  <filename>default.action</filename>, unless you repeat them here:
5957 </para>
5958
5959 <para>
5960  <screen>
5961 # Aliases are local to the file they are defined in.
5962 # (Re-)define aliases for this file:
5963 #
5964 {{alias}}
5965 #
5966 # These aliases just save typing later, and the alias names should
5967 # be self explanatory.
5968 #
5969 +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
5970 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
5971  allow-all-cookies  = -crunch-all-cookies -session-cookies-only
5972  allow-popups       = -filter{all-popups} -kill-popups
5973 +block-as-image     = +block +handle-as-image
5974 -block-as-image     = -block
5975
5976 # These aliases define combinations of actions that are useful for
5977 # certain types of sites:
5978 #
5979 fragile     = -block -crunch-all-cookies -filter -fast-redirects -hide-referrer -kill-popups
5980 shop        = -crunch-all-cookies allow-popups
5981
5982 # Allow ads for selected useful free sites:
5983 #
5984 allow-ads   = -block -filter{banners-by-size} -filter{banners-by-link}
5985
5986 # Alias for specific file types that are text, but might have conflicting
5987 # MIME types. We want the browser to force these to be text documents.
5988 handle-as-text = -<link linkend="FILTER">filter</link> +-<link linkend="content-type-overwrite">content-type-overwrite{text/plain}</link> +-<link linkend="FORCE-TEXT-MODE">force-text-mode</link> -<link linkend="HIDE-CONTENT-DISPOSITION">hide-content-disposition</link></screen>
5989
5990 </para>
5991
5992 <para>
5993  Say you have accounts on some sites that you visit regularly, and
5994  you don't want to have to log in manually each time. So you'd like
5995  to allow persistent cookies for these sites. The
5996  <literal>allow-all-cookies</literal> alias defined above does exactly
5997  that, i.e. it disables crunching of cookies in any direction, and the
5998  processing of cookies to make them only temporary.
5999 </para>
6000
6001 <para>
6002  <screen>
6003 { allow-all-cookies }
6004 sourceforge.net
6005 sunsolve.sun.com
6006 .slashdot.org
6007 .yahoo.com
6008 .msdn.microsoft.com
6009 .redhat.com</screen>
6010 </para>
6011
6012 <para>
6013  Your bank is allergic to some filter, but you don't know which, so you disable them all:
6014 </para>
6015
6016 <para>
6017  <screen>
6018 { -<link linkend="FILTER">filter</link> }
6019 .your-home-banking-site.com</screen>
6020 </para>
6021
6022 <para>
6023  Some file types you may not want to filter for various reasons:
6024 </para>
6025
6026 <para>
6027  <screen>
6028 # Technical documentation is likely to contain strings that might
6029 # erroneously get altered by the JavaScript-oriented filters:
6030 #
6031 .tldp.org
6032 /(.*/)?selfhtml/
6033
6034 # And this stupid host sends streaming video with a wrong MIME type,
6035 # so that Privoxy thinks it is getting HTML and starts filtering:
6036 #
6037 stupid-server.example.com/</screen>
6038 </para>
6039
6040 <para>
6041  Example of a simple <link linkend="BLOCK">block</link> action. Say you've
6042  seen an ad on your favourite page on example.com that you want to get rid of.
6043  You have right-clicked the image, selected <quote>copy image location</quote>
6044  and pasted the URL below while removing the leading http://, into a
6045  <literal>{ +block }</literal> section. Note that <literal>{ +handle-as-image
6046  }</literal> need not be specified, since all URLs ending in
6047  <literal>.gif</literal> will be tagged as images by the general rules as set
6048  in default.action anyway:
6049 </para>
6050
6051 <para>
6052  <screen>
6053 { +<link linkend="BLOCK">block</link> }
6054 www.example.com/nasty-ads/sponsor.gif
6055 another.popular.site.net/more/junk/here/</screen>
6056 </para>
6057
6058 <para>
6059  The URLs of dynamically generated banners, especially from large banner
6060  farms, often don't use the well-known image file name extensions, which
6061  makes it impossible for <application>Privoxy</application> to guess
6062  the file type just by looking at the URL.
6063  You can use the <literal>+block-as-image</literal> alias defined above for
6064  these cases.
6065  Note that objects which match this rule but then turn out NOT to be an
6066  image are typically rendered as a <quote>broken image</quote> icon by the
6067  browser. Use cautiously.
6068 </para>
6069
6070 <para>
6071  <screen>
6072 { +block-as-image }
6073 .doubleclick.net
6074 /Realmedia/ads/
6075 ar.atwola.com/</screen>
6076 </para>
6077
6078 <para>
6079  Now you noticed that the default configuration breaks Forbes Magazine,
6080  but you were too lazy to find out which action is the culprit, and you
6081  were again too lazy to give <link linkend="contact">feedback</link>, so
6082  you just used the <literal>fragile</literal> alias on the site, and
6083  -- <emphasis>whoa!</emphasis> -- it worked. The <literal>fragile</literal>
6084  aliases disables those actions that are most likely to break a site. Also,
6085  good for testing purposes to see if it is <application>Privoxy</application>
6086  that is causing the problem or not.
6087 </para>
6088
6089 <para>
6090 <screen>
6091 { fragile }
6092 .forbes.com</screen>
6093 </para>
6094
6095 <para>
6096  You like the <quote>fun</quote> text replacements in <filename>default.filter</filename>,
6097  but it is disabled in the distributed actions file. (My colleagues on the team just
6098  don't have a sense of humour, that's why! ;-). So you'd like to turn it on in your private,
6099  update-safe config, once and for all:
6100 </para>
6101
6102 <para>
6103 <screen>
6104 { +<link linkend="filter-fun">filter{fun}</link> }
6105 / # For ALL sites!</screen>
6106 </para>
6107
6108 <para>
6109  Note that the above is not really a good idea: There are exceptions
6110  to the filters in <filename>default.action</filename> for things that
6111  really shouldn't be filtered, like code on CVS->Web interfaces. Since
6112  <filename>user.action</filename> has the last word, these exceptions
6113  won't be valid for the <quote>fun</quote> filtering specified here.
6114 </para>
6115
6116 <para>
6117  You might also worry about how your favourite free websites are
6118  funded, and find that they rely on displaying banner advertisements
6119  to survive. So you might want to specifically allow banners for those
6120  sites that you feel provide value to you:
6121 </para>
6122
6123 <para>
6124 <screen>
6125 { allow-ads }
6126 .sourceforge.net
6127 .slashdot.org
6128 .osdn.net</screen>
6129 </para>
6130
6131 <para>
6132  Note that <literal>allow-ads</literal> has been aliased to
6133  <literal>-<link linkend="block">block</link></literal>,
6134  <literal>-<link linkend="filter-banners-by-size">filter{banners-by-size}</link></literal>, and
6135  <literal>-<link linkend="filter-banners-by-link">filter{banners-by-link}</link></literal> above.
6136 </para>
6137
6138 <para>
6139  Invoke another alias here to force an over-ride of the MIME type <literal>
6140  application/x-sh</literal> which typically would open a download type
6141  dialog. In my case, I want to look at the shell script, and then I can save
6142  it should I choose to.
6143 </para>
6144
6145 <para>
6146 <screen>
6147 { handle-as-text }
6148 /.*\.sh$</screen>
6149 </para>
6150
6151 <para>
6152  <filename>user.action</filename> is generally the best place to define
6153  exceptions and additions to the default policies of
6154  <filename>default.action</filename>. Some actions are safe to have their
6155  default policies set here though. So let's set a default policy to have a
6156  <quote>blank</quote> image as opposed to the checkerboard pattern for
6157  <emphasis>ALL</emphasis> sites. <quote>/</quote> of course matches all URL
6158  paths and patterns:
6159 </para>
6160
6161 <para>
6162 <screen>
6163 { +<link linkend="set-image-blocker">set-image-blocker{blank}</link> }
6164 / # ALL sites</screen>
6165 </para>
6166
6167 </sect3>
6168 </sect2>
6169
6170 <!--  ~  End section  ~  -->
6171
6172 </sect1>
6173
6174 <!--  ~  End section  ~  -->
6175
6176 <!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
6177
6178 <sect1 id="filter-file">
6179 <title>Filter Files</title>
6180
6181 <para>
6182  On-the-fly text substitutions that can be invoked through the
6183  <literal><link linkend="filter">filter</link></literal> action need
6184  to be defined in a <quote>filter file</quote>. Once defined, they
6185  can then be invoked as an <quote>action</quote>. Mulitple filter files can be
6186  defined through the <literal> <link
6187  linkend="filterfile">filterfile</link></literal> config directive. The filters
6188  as supplied by the developers will be found in
6189  <filename>default.filter</filename>. It is recommended that any locally
6190  defined or modified filters go in a separately defined file such as
6191  <filename>user.filter</filename>.
6192
6193 </para>
6194
6195 <para>
6196  Typical reasons for doing these kinds of substitutions are to eliminate
6197  common annoyances in HTML and JavaScript, such as pop-up windows,
6198  exit consoles, crippled windows without navigation tools, the
6199  infamous &lt;BLINK&gt; tag etc, to suppress images with certain
6200  width and height attributes (standard banner sizes or web-bugs),
6201  or just to have fun. The possibilities are endless.
6202 </para>
6203
6204 <para>
6205  Filtering works on any text-based document type, including
6206  HTML, JavaScript, CSS etc. (all <literal>text/*</literal>
6207  MIME types, <emphasis>except</emphasis> <literal>text/plain</literal>).
6208  Substitutions are made at the source level, so if you want to <quote>roll
6209  your own</quote> filters, you should first be familiar with HTML syntax,
6210  and, of course, regular expressions. By default, filters are only applied
6211  to the document content, but can be extended to the headers with
6212  the supplemental actions:
6213  <link linkend="filter-client-headers">filter-client-headers</link>  and
6214  <link linkend="filter-server-headers">filter-server-headers</link>.
6215 </para>
6216
6217 <para>
6218  Just like the <link linkend="actions-file">actions files</link>, the
6219  filter file is organized in sections, which are called <emphasis>filters</emphasis>
6220  here. Each filter consists of a heading line, that starts with the
6221  <emphasis>keyword</emphasis> <literal>FILTER:</literal>, followed by
6222  the filter's <emphasis>name</emphasis>, and a short (one line)
6223  <emphasis>description</emphasis> of what it does. Below that line
6224  come the <emphasis>jobs</emphasis>, i.e. lines that define the actual
6225  text substitutions. By convention, the name of a filter
6226  should describe what the filter <emphasis>eliminates</emphasis>. The
6227  comment is used in the <ulink url="http://config.privoxy.org/">web-based
6228  user interface</ulink>.
6229 </para>
6230
6231 <para>
6232  Once a filter called <replaceable>name</replaceable> has been defined
6233  in the filter file, it can be invoked by using an action of the form
6234  +<literal><link linkend="filter">filter</link>{<replaceable>name</replaceable>}</literal>
6235  in any <link linkend="actions-file">actions file</link>.
6236 </para>
6237
6238 <para>
6239  A filter header line for a filter called <quote>foo</quote> could look
6240  like this:
6241 </para>
6242
6243 <para>
6244  <screen>FILTER: foo Replace all "foo" with "bar"</screen>
6245 </para>
6246
6247 <para>
6248  Below that line, and up to the next header line, come the jobs that
6249  define what text replacements the filter executes. They are specified
6250  in a syntax that imitates <ulink url="http://www.perl.org/">Perl</ulink>'s
6251  <literal>s///</literal> operator. If you are familiar with Perl, you
6252  will find this to be quite intuitive, and may want to look at the
6253  PCRS documentation for the subtle differences to Perl behaviour. Most
6254  notably, the non-standard option letter <literal>U</literal> is supported,
6255  which turns the default to ungreedy matching.
6256 </para>
6257
6258 <para>
6259  If you are new to regular expressions, you might want to take a look at
6260  the <link linkend="regex">Appendix on regular expressions</link>, and
6261  see the <ulink url="http://perldoc.perl.org/perlre.html">Perl
6262  manual</ulink> for
6263  <ulink url="http://perldoc.perl.org/perlop.html">the
6264  <literal>s///</literal> operator's syntax</ulink> and <ulink
6265  url="http://perldoc.perl.org/perlre.html">Perl-style regular
6266  expressions</ulink> in general.
6267  The below examples might also help to get you started.
6268 </para>
6269
6270
6271 <!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
6272
6273 <sect2><title>Filter File Tutorial</title>
6274 <para>
6275  Now, let's complete our <quote>foo</quote> filter. We have already defined
6276  the heading, but the jobs are still missing. Since all it does is to replace
6277  <quote>foo</quote> with <quote>bar</quote>, there is only one (trivial) job
6278  needed:
6279 </para>
6280
6281 <para>
6282  <screen>s/foo/bar/</screen>
6283 </para>
6284
6285 <para>
6286  But wait! Didn't the comment say that <emphasis>all</emphasis> occurrences
6287  of <quote>foo</quote> should be replaced? Our current job will only take
6288  care of the first <quote>foo</quote> on each page. For global substitution,
6289  we'll need to add the <literal>g</literal> option:
6290 </para>
6291
6292 <para>
6293  <screen>s/foo/bar/g</screen>
6294 </para>
6295
6296 <para>
6297  Our complete filter now looks like this:
6298 </para>
6299 <para>
6300  <screen>FILTER: foo Replace all "foo" with "bar"
6301 s/foo/bar/g</screen>
6302 </para>
6303
6304 <para>
6305  Let's look at some real filters for more interesting examples. Here you see
6306  a filter that protects against some common annoyances that arise from JavaScript
6307  abuse. Let's look at its jobs one after the other:
6308 </para>
6309
6310
6311 <para>
6312  <screen>
6313 FILTER: js-annoyances Get rid of particularly annoying JavaScript abuse
6314
6315 # Get rid of JavaScript referrer tracking. Test page: http://www.randomoddness.com/untitled.htm
6316 #
6317 s|(&lt;script.*)document\.referrer(.*&lt;/script&gt;)|$1"Not Your Business!"$2|Usg</screen>
6318 </para>
6319
6320 <para>
6321  Following the header line and a comment, you see the job. Note that it uses
6322  <literal>|</literal> as the delimiter instead of <literal>/</literal>, because
6323  the pattern contains a forward slash, which would otherwise have to be escaped
6324  by a backslash (<literal>\</literal>).
6325 </para>
6326
6327 <para>
6328  Now, let's examine the pattern: it starts with the text <literal>&lt;script.*</literal>
6329  enclosed in parentheses. Since the dot matches any character, and <literal>*</literal>
6330  means: <quote>Match an arbitrary number of the element left of myself</quote>, this
6331  matches <quote>&lt;script</quote>, followed by <emphasis>any</emphasis> text, i.e.
6332  it matches the whole page, from the start of the first &lt;script&gt; tag.
6333 </para>
6334
6335 <para>
6336  That's more than we want, but the pattern continues: <literal>document\.referrer</literal>
6337  matches only the exact string <quote>document.referrer</quote>. The dot needed to
6338  be <emphasis>escaped</emphasis>, i.e. preceded by a backslash, to take away its
6339  special meaning as a joker, and make it just a regular dot. So far, the meaning is:
6340  Match from the start of the first &lt;script&gt; tag in a the page, up to, and including,
6341  the text <quote>document.referrer</quote>, if <emphasis>both</emphasis> are present
6342  in the page (and appear in that order).
6343 </para>
6344
6345 <para>
6346  But there's still more pattern to go. The next element, again enclosed in parentheses,
6347  is <literal>.*&lt;/script&gt;</literal>. You already know what <literal>.*</literal>
6348  means, so the whole pattern translates to: Match from the start of the first  &lt;script&gt;
6349  tag in a page to the end of the last &lt;script&gt; tag, provided that the text
6350  <quote>document.referrer</quote> appears somewhere in between.
6351 </para>
6352
6353 <para>
6354  This is still not the whole story, since we have ignored the options and the parentheses:
6355  The portions of the page matched by sub-patterns that are enclosed in parentheses, will be
6356  remembered and be available through the variables <literal>$1, $2, ...</literal> in
6357  the substitute. The <literal>U</literal> option switches to ungreedy matching, which means
6358  that the first <literal>.*</literal> in the pattern will only <quote>eat up</quote> all
6359  text in between <quote>&lt;script</quote> and the <emphasis>first</emphasis> occurrence
6360  of <quote>document.referrer</quote>, and that the second <literal>.*</literal> will
6361  only span the text up to the <emphasis>first</emphasis> <quote>&lt;/script&gt;</quote>
6362  tag. Furthermore, the <literal>s</literal> option says that the match may span
6363  multiple lines in the page, and the <literal>g</literal> option again means that the
6364  substitution is global.
6365 </para>
6366
6367 <para>
6368  So, to summarize, the pattern means: Match all scripts that contain the text
6369  <quote>document.referrer</quote>. Remember the parts of the script from
6370  (and including) the start tag up to (and excluding) the string
6371  <quote>document.referrer</quote> as <literal>$1</literal>, and the part following
6372  that string, up to and including the closing tag, as <literal>$2</literal>.
6373 </para>
6374
6375 <para>
6376  Now the pattern is deciphered, but wasn't this about substituting things? So
6377  lets look at the substitute: <literal>$1"Not Your Business!"$2</literal> is
6378  easy to read: The text remembered as <literal>$1</literal>, followed by
6379  <literal>"Not Your Business!"</literal> (<emphasis>including</emphasis>
6380  the quotation marks!), followed by the text remembered as <literal>$2</literal>.
6381  This produces an exact copy of the original string, with the middle part
6382  (the <quote>document.referrer</quote>) replaced by <literal>"Not Your
6383  Business!"</literal>.
6384 </para>
6385
6386 <para>
6387  The whole job now reads: Replace <quote>document.referrer</quote> by
6388  <literal>"Not Your Business!"</literal> wherever it appears inside a
6389  &lt;script&gt tag. Note that this job won't break JavaScript syntax,
6390  since both the original and the replacement are syntactically valid
6391  string objects. The script just won't have access to the referrer
6392  information anymore.
6393 </para>
6394
6395 <para>
6396  We'll show you two other jobs from the JavaScript taming department, but
6397  this time only point out the constructs of special interest:
6398 </para>
6399
6400 <para>
6401  <screen>
6402 # The status bar is for displaying link targets, not pointless blahblah
6403 #
6404 s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig</screen>
6405 </para>
6406
6407 <para>
6408  <literal>\s</literal> stands for whitespace characters (space, tab, newline,
6409  carriage return, form feed), so that <literal>\s*</literal> means: <quote>zero
6410  or more whitespace</quote>. The <literal>?</literal> in <literal>.*?</literal>
6411  makes this matching of arbitrary text ungreedy. (Note that the <literal>U</literal>
6412  option is not set). The <literal>['"]</literal> construct means: <quote>a single
6413  <emphasis>or</emphasis> a double quote</quote>. Finally, <literal>\1</literal> is
6414  a backreference to the first parenthesis just like <literal>$1</literal> above,
6415  with the difference that in the <emphasis>pattern</emphasis>, a backslash indicates
6416  a backreference, whereas in the <emphasis>substitute</emphasis>, it's the dollar.
6417 </para>
6418
6419 <para>
6420  So what does this job do? It replaces assignments of single- or double-quoted
6421  strings to the <quote>window.status</quote> object with a dummy assignment
6422  (using a variable name that is hopefully odd enough not to conflict with
6423  real variables in scripts). Thus, it catches many cases where e.g. pointless
6424  descriptions are displayed in the status bar instead of the link target when
6425  you move your mouse over links.
6426 </para>
6427
6428 <para>
6429  <screen>
6430 # Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
6431 #
6432 s/(&lt;body [^&gt;]*)onunload(.*&gt;)/$1never$2/iU</screen>
6433 </para>
6434
6435 <para>
6436  Including the
6437  <ulink url="http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Events-eventgroupings-htmlevents">OnUnload
6438  event binding</ulink> in the HTML DOM was a <emphasis>CRIME</emphasis>.
6439  When I close a browser window, I want it to close and die. Basta.
6440  This job replaces the <quote>onunload</quote> attribute in
6441  <quote>&lt;body&gt</quote> tags with the dummy word <literal>never</literal>.
6442  Note that the <literal>i</literal> option makes the pattern matching
6443  case-insensitive. Also note that ungreedy matching alone doesn't always guarantee
6444  a minimal match: In the first parenthesis, we had to use <literal>[^&gt;]*</literal>
6445  instead of <literal>.*</literal> to prevent the match from exceeding the
6446  &lt;body&gt tag if it doesn't contain <quote>OnUnload</quote>, but the page's
6447  content does.
6448 </para>
6449
6450 <para>
6451  The last example is from the fun department:
6452 </para>
6453
6454 <para>
6455  <screen>
6456 FILTER: fun Fun text replacements
6457
6458 # Spice the daily news:
6459 #
6460 s/microsoft(?!\.com)/MicroSuck/ig</screen>
6461 </para>
6462
6463 <para>
6464  Note the <literal>(?!\.com)</literal> part (a so-called negative lookahead)
6465  in the job's pattern, which means: Don't match, if the string
6466  <quote>.com</quote> appears directly following <quote>microsoft</quote>
6467  in the page. This prevents links to microsoft.com from being trashed, while
6468  still replacing the word everywhere else.
6469 </para>
6470
6471 <para>
6472  <screen>
6473 # Buzzword Bingo (example for extended regex syntax)
6474 #
6475 s* industry[ -]leading \
6476 |  cutting[ -]edge \
6477 |  customer[ -]focused \
6478 |  market[ -]driven \
6479 |  award[ -]winning # Comments are OK, too! \
6480 |  high[ -]performance \
6481 |  solutions[ -]based \
6482 |  unmatched \
6483 |  unparalleled \
6484 |  unrivalled \
6485 *&lt;font color="red"&gt;&lt;b&gt;BINGO!&lt;/b&gt;&lt;/font&gt; \
6486 *igx</screen>
6487 </para>
6488
6489 <para>
6490  The <literal>x</literal> option in this job turns on extended syntax, and allows for
6491  e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting.
6492 </para>
6493
6494 <para>
6495  You get the idea?
6496 </para>
6497 </sect2>
6498
6499 <!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
6500
6501 <sect2 id="predefined-filters"><title>The Pre-defined Filters</title>
6502
6503 <!--
6504
6505  Note each filter is also listed in the +filter action section above. Please
6506  keep these listings in sync.
6507
6508 -->
6509
6510 <para>
6511 The distribution <filename>default.filter</filename> file contains a selection of
6512 pre-defined filters for your convenience:
6513 </para>
6514
6515 <variablelist>
6516  <varlistentry>
6517   <term><emphasis>js-annoyances</emphasis></term>
6518   <listitem>
6519    <para>
6520     The purpose of this filter is to get rid of particularly annoying JavaScript abuse.
6521     To that end, it
6522    <itemizedlist>
6523     <listitem>
6524      <para>
6525       replaces JavaScript references to the browser's referrer information
6526       with the string "Not Your Business!". This compliments the <literal><link
6527       linkend="hide-referrer">hide-referrer</link></literal> action on the content level.
6528      </para>
6529     </listitem>
6530     <listitem>
6531      <para>
6532       removes the bindings to the DOM's
6533       <ulink url="http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Events-eventgroupings-htmlevents">unload
6534       event</ulink> which we feel has no right to exist and is responsible for most <quote>exit consoles</quote>, i.e.
6535       nasty windows that pop up when you close another one.
6536      </para>
6537     </listitem>
6538     <listitem>
6539      <para>
6540       removes code that causes new windows to be opened with undesired properties, such as being
6541       full-screen, non-resizable, without location, status or menu bar etc.
6542      </para>
6543     </listitem>
6544    </itemizedlist>
6545    </para>
6546   </listitem>
6547  </varlistentry>
6548
6549  <varlistentry>
6550   <term><emphasis>js-events</emphasis></term>
6551   <listitem>
6552    <para>
6553     This is a very radical measure. It removes virtually all JavaScript event bindings, which
6554     means that scripts can not react to user actions such as mouse movements or clicks, window
6555     resizing etc, anymore.
6556    </para>
6557    <para>
6558     We <emphasis>strongly discourage</emphasis> using this filter as a default since it breaks
6559     many legitimate scripts. It is meant for use only on extra-nasty sites (should you really
6560     need to go there).
6561    </para>
6562   </listitem>
6563  </varlistentry>
6564
6565 <varlistentry>
6566   <term><emphasis>html-annoyances</emphasis></term>
6567   <listitem>
6568    <para>
6569     This filter will undo many common instances of HTML based abuse.
6570    </para>
6571    <para>
6572     The <literal>BLINK</literal> and <literal>MARQUEE</literal> tags
6573     are neutralized (yeah baby!), and browser windows will be created as
6574     resizable (as of course they should be!), and will have location,
6575     scroll and menu bars -- even if specified otherwise.
6576    </para>
6577   </listitem>
6578  </varlistentry>
6579
6580  <varlistentry>
6581   <term><emphasis>content-cookies</emphasis></term>
6582   <listitem>
6583    <para>
6584     Most cookies are set in the HTTP dialogue, where they can be intercepted
6585     by the
6586     <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal>
6587     and <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>
6588     actions. But web sites increasingly make use of HTML meta tags and JavaScript
6589     to sneak cookies to the browser on the content level.
6590    </para>
6591    <para>
6592     This filter disables HTML and JavaScript code that reads or sets cookies. Use
6593     it wherever you would also use the cookie crunch actions.
6594    </para>
6595   </listitem>
6596  </varlistentry>
6597
6598  <varlistentry>
6599   <term><emphasis>refresh tags</emphasis></term>
6600   <listitem>
6601    <para>
6602     Disable any refresh tags if the interval is greater than nine seconds (so
6603     that redirections done via refresh tags are not destroyed). This is useful
6604     for dial-on-demand setups, or for those who find this HTML feature
6605     annoying.
6606    </para>
6607   </listitem>
6608  </varlistentry>
6609
6610  <varlistentry>
6611   <term><emphasis>unsolicited-popups</emphasis></term>
6612   <listitem>
6613    <para>
6614     This filter attempts to prevent only <quote>unsolicited</quote> pop-up
6615     windows from opening, yet still allow pop-up windows that the user
6616     has explicitly chosen to open. It was added in version 3.0.1,
6617     as an improvement over earlier such filters.
6618    </para>
6619    <para>
6620     Technical note: The filter works by redefining the window.open JavaScript
6621     function to a dummy function during the loading and rendering phase of each
6622     HTML page access, and restoring the function afterwards.
6623    </para>
6624   </listitem>
6625  </varlistentry>
6626
6627  <varlistentry>
6628   <term><emphasis>all-popups</emphasis></term>
6629   <listitem>
6630    <para>
6631     Attempt to prevent <emphasis>all</emphasis> pop-up windows from opening.
6632     Note this should be used with more discretion than the above, since it is
6633     more likely to break some sites that require pop-ups for normal usage. Use
6634     with caution.
6635    </para>
6636   </listitem>
6637  </varlistentry>
6638
6639  <varlistentry>
6640   <term><emphasis>img-reorder</emphasis></term>
6641   <listitem>
6642    <para>
6643     This is a helper filter that has no value if used alone. It makes the
6644     <literal>banners-by-size</literal> and <literal>banners-by-link</literal>
6645     (see below) filters more effective and should be enabled together with them.
6646    </para>
6647   </listitem>
6648  </varlistentry>
6649
6650  <varlistentry>
6651   <term><emphasis>banners-by-size</emphasis></term>
6652   <listitem>
6653    <para>
6654     This filter removes image tags purely based on what size they are. Fortunately
6655     for us, many ads and banner images tend to conform to certain standardized
6656     sizes, which makes this filter quite effective for ad stripping purposes.
6657    </para>
6658    <para>
6659     Occasionally this filter will cause false positives on images that are not ads,
6660     but just happen to be of one of the standard banner sizes.
6661    </para>
6662   </listitem>
6663  </varlistentry>
6664
6665  <varlistentry>
6666   <term><emphasis>banners-by-link</emphasis></term>
6667   <listitem>
6668    <para>
6669     This is an experimental filter that attempts to kill any banners if
6670     their URLs seem to point to known or suspected click trackers. It is currently
6671     not of much value and is not recommended for use by default.
6672    </para>
6673   </listitem>
6674  </varlistentry>
6675
6676  <varlistentry>
6677   <term><emphasis>webbugs</emphasis></term>
6678   <listitem>
6679    <para>
6680     Webbugs are small, invisible images (technically 1X1 GIF images), that
6681     are used to track users across websites, and collect information on them.
6682     As an HTML page is loaded by the browser, an embedded image tag causes the
6683     browser to contact a third-party site, disclosing the tracking information
6684     through the requested URL and/or cookies for that third-party domain, without
6685     the use ever becoming aware of the interaction with the third-party site.
6686     HTML-ized spam also uses a similar technique to verify email addresses.
6687    </para>
6688    <para>
6689     This filter removes the HTML code that loads such <quote>webbugs</quote>.
6690    </para>
6691   </listitem>
6692  </varlistentry>
6693
6694  <varlistentry>
6695   <term><emphasis>tiny-textforms</emphasis></term>
6696   <listitem>
6697    <para>
6698     A rather special-purpose filter that can be used to enlarge textareas (those
6699     multi-line text boxes in web forms) and turn off hard word wrap in them.
6700     It was written for the sourceforge.net tracker system where such boxes are
6701     a nuisance, but it can be handy on other sites, too.
6702    </para>
6703    <para>
6704     It is not recommended to use this filter as a default.
6705    </para>
6706   </listitem>
6707  </varlistentry>
6708
6709  <varlistentry>
6710   <term><emphasis>jumping-windows</emphasis></term>
6711   <listitem>
6712    <para>
6713     Many consider windows that move, or resize themselves to be abusive. This filter
6714     neutralizes the related JavaScript code. Note that some sites might not display
6715     or behave as intended when using this filter.
6716    </para>
6717   </listitem>
6718  </varlistentry>
6719
6720  <varlistentry>
6721   <term><emphasis>frameset-borders</emphasis></term>
6722   <listitem>
6723    <para>
6724     Some web designers seem to assume that everyone in the world will view their
6725     web sites using the same browser brand and version, screen resolution etc,
6726     because only that assumption could explain why they'd use static frame sizes,
6727     yet prevent their frames from being resized by the user, should they be too
6728     small to show their whole content.
6729    </para>
6730    <para>
6731     This filter removes the related HTML code. It should only be applied to sites
6732     which need it.
6733    </para>
6734   </listitem>
6735  </varlistentry>
6736
6737  <varlistentry>
6738   <term><emphasis>demoronizer</emphasis></term>
6739   <listitem>
6740    <para>
6741     Many Microsoft products that generate HTML use non-standard extensions (read:
6742     violations) of the ISO 8859-1 aka Latin-1 character set. This can cause those
6743     HTML documents to display with errors on standard-compliant platforms.
6744    </para>
6745    <para>
6746     This filter translates the MS-only characters into Latin-1 equivalents.
6747     It is not necessary when using MS products, and will cause corruption of
6748     all documents that use 8-bit character sets other than Latin-1. It's mostly
6749     worthwhile for Europeans on non-MS platforms, if wierd garbage characters
6750     sometimes appear on some pages, or user agents that don't correct for this on
6751     the fly.
6752 <!--
6753     My version of Mozilla (ancient) shows litte square boxes for quote
6754     characters, and apostrophes on moronized pages. So many pages have this, I
6755     can read them fine now. HB 08/27/06
6756 -->
6757    </para>
6758   </listitem>
6759  </varlistentry>
6760
6761  <varlistentry>
6762   <term><emphasis>shockwave-flash</emphasis></term>
6763   <listitem>
6764    <para>
6765     A filter for shockwave haters. As the name suggests, this filter strips code
6766     out of web pages that is used to embed shockwave flash objects.
6767    </para>
6768    <para>
6769    </para>
6770   </listitem>
6771  </varlistentry>
6772
6773  <varlistentry>
6774   <term><emphasis>quicktime-kioskmode</emphasis></term>
6775   <listitem>
6776    <para>
6777     Change HTML code that embeds Quicktime objects so that kioskmode, which
6778     prevents saving, is disabled.
6779    </para>
6780   </listitem>
6781  </varlistentry>
6782
6783  <varlistentry>
6784   <term><emphasis>fun</emphasis></term>
6785   <listitem>
6786    <para>
6787     Text replacements for subversive browsing fun. Make fun of your favorite
6788     Monopolist or play buzzword bingo.
6789    </para>
6790   </listitem>
6791  </varlistentry>
6792
6793  <varlistentry>
6794   <term><emphasis>crude-parental</emphasis></term>
6795   <listitem>
6796    <para>
6797     A demonstration-only filter that shows how <application>Privoxy</application>
6798     can be used to delete web content on a keyword basis.
6799    </para>
6800   </listitem>
6801  </varlistentry>
6802
6803  <varlistentry>
6804   <term><emphasis>ie-exploits</emphasis></term>
6805   <listitem>
6806    <para>
6807     A collection of text replacements to disable malicious HTML and JavaScript
6808     code that exploits known security holes in Internet Explorer.
6809    </para>
6810    <para>
6811     Presently, it only protects against Nimda and a cross-site scripting bug, and
6812     would need active maintenance to provide more substantial protection.
6813    </para>
6814   </listitem>
6815  </varlistentry>
6816
6817  <varlistentry>
6818   <term><emphasis>site-specifics</emphasis></term>
6819   <listitem>
6820    <para>
6821     Some web sites have very specific problems, the cure for which doesn't apply
6822     anywhere else, or could even cause damage on other sites.
6823    </para>
6824    <para>
6825     This is a collection of such site-specific cures which should only be applied
6826     to the sites they were intended for, which is what the supplied
6827     <filename>default.action</filename> file does. Users shouldn't need to change
6828     anything regarding this filter.
6829    </para>
6830   </listitem>
6831  </varlistentry>
6832
6833 <!--
6834  <varlistentry>
6835   <term><emphasis> </emphasis></term>
6836   <listitem>
6837    <para>
6838    </para>
6839    <para>
6840    </para>
6841   </listitem>
6842  </varlistentry>
6843 -->
6844 </variablelist>
6845
6846 </sect2>
6847 </sect1>
6848
6849 <!--  ~  End section  ~  -->
6850
6851
6852
6853 <!--   ~~~~~       New section      ~~~~~     -->
6854
6855 <sect1 id="templates">
6856 <title>Templates</title>
6857 <para>
6858  All <application>Privoxy</application> built-in pages, i.e. error pages such as the
6859  <ulink url="http://show-the-404-error.page"><quote>404 - No Such Domain</quote>
6860  error page</ulink>, the <ulink
6861  url="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"><quote>BLOCKED</quote>
6862  page</ulink>
6863  and all pages of its <ulink url="http://config.privoxy.org/">web-based
6864  user interface</ulink>, are generated from <emphasis>templates</emphasis>.
6865  (<application>Privoxy</application> must be running for the above links to work as
6866  intended.)
6867 </para>
6868
6869 <para>
6870  These templates are stored in a subdirectory of the <link linkend="confdir">configuration
6871  directory</link> called <filename>templates</filename>. On Unixish platforms,
6872  this is typically
6873  <ulink url="file:///etc/privoxy/templates/"><filename>/etc/privoxy/templates/</filename></ulink>.
6874 </para>
6875
6876 <para>
6877  The templates are basically normal HTML files, but with place-holders (called symbols
6878  or exports), which <application>Privoxy</application> fills at run time. You can
6879  edit the templates with a normal text editor, should you want to customize them.
6880  (<emphasis>Not recommended for the casual user</emphasis>). Note that
6881  just like in configuration files, lines starting with <literal>#</literal> are
6882  ignored when the templates are filled in.
6883 </para>
6884
6885 <para>
6886  The place-holders are of the form <literal>@name@</literal>, and you will
6887  find a list of available symbols, which vary from template to template,
6888  in the comments at the start of each file. Note that these comments are not
6889  always accurate, and that it's probably best to look at the existing HTML
6890  code to find out which symbols are supported and what they are filled in with.
6891 </para>
6892
6893 <para>
6894  A special application of this substitution mechanism is to make whole
6895  blocks of HTML code disappear when a specific symbol is set. We use this
6896  for many purposes, one of them being to include the beta warning in all
6897  our user interface (CGI) pages when <application>Privoxy</application>
6898  is in an alpha or beta development stage:
6899 </para>
6900
6901 <para>
6902  <screen>
6903 &lt;!-- @if-unstable-start --&gt;
6904
6905   ... beta warning HTML code goes here ...
6906
6907 &lt;!-- if-unstable-end@ --&gt;</screen>
6908 </para>
6909
6910 <para>
6911  If the "unstable" symbol is set, everything in between and including
6912  <literal>@if-unstable-start</literal> and <literal>if-unstable-end@</literal>
6913  will disappear, leaving nothing but an empty comment:
6914 </para>
6915
6916 <para>
6917  <screen>&lt;!--  --&gt;</screen>
6918 </para>
6919
6920 <para>
6921  There's also an if-then-else construct and an <literal>#include</literal>
6922  mechanism, but you'll sure find out if you are inclined to edit the
6923  templates ;-)
6924 </para>
6925
6926 <para>
6927  All templates refer to a style located at
6928  <ulink url="http://config.privoxy.org/send-stylesheet"><literal>http://config.privoxy.org/send-stylesheet</literal></ulink>.
6929  This is, of course, locally served by <application>Privoxy</application>
6930  and the source for it can be found and edited in the
6931  <filename>cgi-style.css</filename> template.
6932 </para>
6933
6934 </sect1>
6935
6936 <!--  ~  End section  ~  -->
6937
6938
6939
6940 <!--   ~~~~~       New section      ~~~~~     -->
6941
6942 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
6943 Requests</title>
6944
6945 <!-- Include contacting.sgml boilerplate: -->
6946  &contacting;
6947 <!-- end boilerplate -->
6948
6949 </sect1>
6950
6951 <!--  ~  End section  ~  -->
6952
6953
6954 <!--   ~~~~~       New section      ~~~~~     -->
6955 <sect1 id="copyright"><title><application>Privoxy</application> Copyright, License and History</title>
6956
6957 <!-- Include copyright.sgml: -->
6958  &copyright;
6959 <!-- end copyright -->
6960
6961 <!--   ~~~~~       New section      ~~~~~     -->
6962 <sect2><title>License</title>
6963 <!-- Include copyright.sgml: -->
6964  &license;
6965 <!-- end copyright -->
6966 </sect2>
6967 <!--  ~  End section  ~  -->
6968
6969
6970 <!--   ~~~~~       New section      ~~~~~     -->
6971
6972 <sect2 id="history"><title>History</title>
6973 <!-- Include history.sgml: -->
6974  &history;
6975 <!-- end history -->
6976 </sect2>
6977
6978 <sect2 id="authors"><title>Authors</title>
6979 <!-- Include p-authors.sgml: -->
6980  &p-authors;
6981 <!-- end authors -->
6982 </sect2>
6983
6984 </sect1>
6985
6986 <!--  ~  End section  ~  -->
6987
6988
6989 <!--   ~~~~~       New section      ~~~~~     -->
6990 <sect1 id="seealso"><title>See Also</title>
6991 <!-- Include seealso.sgml: -->
6992  &seealso;
6993 <!-- end seealso -->
6994 </sect1>
6995
6996
6997
6998 <!--   ~~~~~       New section      ~~~~~     -->
6999 <sect1 id="appendix"><title>Appendix</title>
7000
7001
7002 <!--   ~~~~~       New section      ~~~~~     -->
7003 <sect2 id="regex">
7004 <title>Regular Expressions</title>
7005 <para>
7006  <application>Privoxy</application> uses Perl-style <quote>regular
7007  expressions</quote> in its <link linkend="actions-file">actions
7008  files</link> and <link linkend="filter-file">filter file</link>,
7009  through the <ulink url="http://www.pcre.org/">PCRE</ulink> and
7010 <!--
7011  dead 08/27/06
7012  <ulink url="http://www.oesterhelt.org/pcrs/">PCRS</ulink> libraries.
7013 -->
7014  <application>PCRS</application> libraries.
7015 </para>
7016
7017 <para>
7018  If you are reading this, you probably don't understand what <quote>regular
7019  expressions</quote> are, or what they can do. So this will be a very brief
7020  introduction only. A full explanation would require a <ulink
7021  url="http://www.oreilly.com/catalog/regex/">book</ulink> ;-)
7022 </para>
7023
7024 <para>
7025  Regular expressions provide a language to describe patterns that can be
7026  run against strings of characters (letter, numbers, etc), to see if they
7027  match the string or not. The  patterns are themselves (sometimes complex)
7028  strings of literal characters, combined with  wild-cards, and other special
7029  characters, called meta-characters. The <quote>meta-characters</quote> have
7030  special meanings and are used to build complex patterns to be matched against.
7031  Perl Compatible Regular Expressions are an especially convenient
7032  <quote>dialect</quote> of the regular expression language.
7033 </para>
7034
7035 <para>
7036  To make a simple analogy, we do something similar when we use wild-card
7037  characters when listing files with the <command>dir</command> command in DOS.
7038  <literal>*.*</literal> matches all filenames. The <quote>special</quote>
7039  character here is the asterisk which matches any and all characters. We can be
7040  more specific and use <literal>?</literal> to match just individual
7041  characters. So <quote>dir file?.text</quote> would match
7042  <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
7043  matching, using a similar technique to <quote>regular expressions</quote>!
7044 </para>
7045
7046 <para>
7047  Regular expressions do essentially the same thing, but are much, much more
7048  powerful. There are many more <quote>special characters</quote> and ways of
7049  building complex patterns however. Let's look at a few of the common ones,
7050  and then some examples:
7051 </para>
7052
7053 <para><simplelist>
7054  <member>
7055   <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
7056   <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
7057  </member>
7058 </simplelist></para>
7059
7060 <para><simplelist>
7061  <member>
7062   <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
7063   times. Either/or.
7064  </member>
7065 </simplelist></para>
7066
7067 <para><simplelist>
7068  <member>
7069   <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
7070   times.
7071  </member>
7072 </simplelist></para>
7073
7074 <para><simplelist>
7075  <member>
7076   <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
7077   times.
7078  </member>
7079 </simplelist></para>
7080
7081 <para><simplelist>
7082  <member>
7083   <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
7084   the following character should be taken literally. This is used where one of the
7085   special characters (e.g. <quote>.</quote>) needs to be taken literally and
7086   not as a special meta-character. Example: <quote>example\.com</quote>, makes
7087   sure the period is recognized only as a period (and not expanded to its
7088   meta-character meaning of any single character).
7089  </member>
7090 </simplelist></para>
7091
7092 <para><simplelist>
7093  <member>
7094   <emphasis>[ ]</emphasis> - Characters enclosed in brackets will be matched if
7095   any of the enclosed characters are encountered. For instance, <quote>[0-9]</quote>
7096   matches any numeric digit (zero through nine). As an example, we can combine
7097   this with <quote>+</quote> to match any digit one of more times: <quote>[0-9]+</quote>.
7098  </member>
7099 </simplelist></para>
7100
7101 <para><simplelist>
7102  <member>
7103   <emphasis>( )</emphasis> - parentheses are used to group a sub-expression,
7104   or multiple sub-expressions.
7105  </member>
7106 </simplelist></para>
7107
7108 <para><simplelist>
7109  <member>
7110   <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
7111   <quote>or</quote> conditional statement. A match is successful if the
7112   sub-expression on either side of <quote>|</quote> matches. As an example:
7113   <quote>/(this|that) example/</quote> uses grouping and the bar character
7114   and would match either <quote>this example</quote> or <quote>that
7115   example</quote>, and nothing else.
7116  </member>
7117 </simplelist></para>
7118
7119 <para>
7120  These are just some of the ones you are likely to use when matching URLs with
7121  <application>Privoxy</application>, and is a long way from a definitive
7122  list. This is enough to get us started with a few simple examples which may
7123  be more illuminating:
7124 </para>
7125
7126 <para>
7127  <emphasis><literal>/.*/banners/.*</literal></emphasis> - A  simple example
7128  that uses the common combination of <quote>.</quote> and <quote>*</quote> to
7129  denote any character, zero or more times. In other words, any string at all.
7130  So we start with a literal forward slash, then our regular expression pattern
7131  (<quote>.*</quote>) another literal forward slash, the string
7132  <quote>banners</quote>, another forward slash, and lastly another
7133  <quote>.*</quote>. We are building
7134  a directory path here. This will match any file with the path that has a
7135  directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
7136  any characters, and this could conceivably be more forward slashes, so it
7137  might expand into a much longer looking path. For example, this could match:
7138  <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
7139  <quote>/banners/annoying.html</quote>, or almost an infinite number of other
7140  possible combinations, just so it has <quote>banners</quote> in the path
7141  somewhere.
7142 </para>
7143
7144 <para>
7145  And now something a little more complex:
7146 </para>
7147
7148 <para>
7149  <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
7150  We have several literal forward slashes again (<quote>/</quote>), so we are
7151  building another expression that is a file path statement. We have another
7152  <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
7153  it matches our expression. The only true literal that <emphasis>must
7154  match</emphasis> our pattern is <application>adv</application>, together with
7155  the forward slashes. What comes after the <quote>adv</quote> string is the
7156  interesting part.
7157 </para>
7158
7159 <para>
7160  Remember the <quote>?</quote> means the preceding expression (either a
7161  literal character or anything grouped with <quote>(...)</quote> in this case)
7162  can exist or not, since this means either zero or one match. So
7163  <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
7164  individual sub-expressions: <quote>(er)</quote>,
7165  <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
7166  means <quote>or</quote>. We have two of those. For instance,
7167  <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
7168  <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
7169  attempt at matching as many variations of <quote>advertisement</quote>, and
7170  similar, as possible. So this would expand to match just <quote>adv</quote>,
7171  or <quote>advert</quote>, or <quote>adverts</quote>, or
7172  <quote>advertising</quote>, or <quote>advertisement</quote>, or
7173  <quote>advertisements</quote>. You get the idea. But it would not match
7174  <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
7175  changing our regular expression to:
7176  <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
7177  either spelling.
7178 </para>
7179
7180 <para>
7181  <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
7182  another path statement with forward slashes. Anything in the square brackets
7183  <quote>[ ]</quote> can be matched. This is using <quote>0-9</quote> as a
7184  shorthand expression to mean any digit one through nine. It is the same as
7185  saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
7186  means one or more of the preceding expression must be included. The preceding
7187  expression here is what is in the square brackets -- in this case, any digit
7188  one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
7189  This includes a <quote>|</quote>, so this needs to match the expression on
7190  either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
7191  side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
7192  since the <quote>?</quote> means the letter <quote>e</quote> is optional and
7193  can be matched once or not at all. So we are building an expression here to
7194  match image GIF or JPEG type image file. It must include the literal
7195  string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
7196  (which is now a literal, and not a special character, since it is escaped
7197  with <quote>\</quote>), and lastly either <quote>gif</quote>, or
7198  <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
7199  include: <quote>//advert1.jpg</quote>,
7200  <quote>/nasty/ads/advert1234.gif</quote>,
7201  <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
7202  <quote>advert1.gif</quote> (no leading slash), or
7203  <quote>/adverts232.jpg</quote> (the expression does not include an
7204  <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
7205  in the expression anywhere).
7206 </para>
7207
7208 <para>
7209  We are barely scratching the surface of regular expressions here so that you
7210  can understand the default <application>Privoxy</application>
7211  configuration files, and maybe use this knowledge to customize your own
7212  installation. There is much, much more that can be done with regular
7213  expressions. Now that you know enough to get started, you can learn more on
7214  your own :/
7215 </para>
7216
7217 <para>
7218  More reading on Perl Compatible Regular expressions:
7219  <ulink url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>
7220 </para>
7221
7222 <para>
7223  For information on regular expression based substitutions and their applications
7224  in filters, please see the <link linkend="filter-file">filter file tutorial</link>
7225  in this manual.
7226 </para>
7227 </sect2>
7228
7229 <!--  ~  End section  ~  -->
7230
7231
7232 <!--   ~~~~~       New section      ~~~~~     -->
7233 <sect2>
7234 <title><application>Privoxy</application>'s Internal Pages</title>
7235
7236 <para>
7237  Since <application>Privoxy</application> proxies each requested
7238  web page, it is easy for <application>Privoxy</application> to
7239  trap certain special URLs. In this way, we can talk directly to
7240  <application>Privoxy</application>, and see how it is
7241  configured, see how our rules are being applied, change these
7242  rules and other configuration options, and even turn
7243  <application>Privoxy's</application> filtering off, all with
7244  a web browser.
7245
7246 </para>
7247
7248 <para>
7249  The URLs listed below are the special ones that allow direct access
7250  to <application>Privoxy</application>. Of course,
7251  <application>Privoxy</application> must be running to access these. If
7252  not, you will get a friendly error message. Internet access is not
7253  necessary either.
7254 </para>
7255
7256 <para>
7257  <itemizedlist>
7258
7259  <listitem>
7260   <para>
7261    Privoxy main page:
7262   </para>
7263   <blockquote>
7264    <para>
7265      <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
7266    </para>
7267   </blockquote>
7268   <para>
7269    There is a shortcut: <ulink url="http://p.p/">http://p.p/</ulink> (But it
7270    doesn't provide a fall-back to a real page, in case the request is not
7271    sent through <application>Privoxy</application>)
7272   </para>
7273  </listitem>
7274
7275  <listitem>
7276   <para>
7277     Show information about the current configuration, including viewing and
7278     editing of actions files:
7279   </para>
7280    <blockquote>
7281    <para>
7282     <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
7283    </para>
7284   </blockquote>
7285  </listitem>
7286
7287  <listitem>
7288   <para>
7289     Show the source code version numbers:
7290   </para>
7291   <blockquote>
7292    <para>
7293     <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
7294    </para>
7295   </blockquote>
7296  </listitem>
7297
7298  <listitem>
7299   <para>
7300    Show the browser's request headers:
7301   </para>
7302   <blockquote>
7303    <para>
7304     <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
7305    </para>
7306   </blockquote>
7307  </listitem>
7308
7309  <listitem>
7310   <para>
7311    Show which actions apply to a URL and why:
7312   </para>
7313    <blockquote>
7314    <para>
7315     <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
7316    </para>
7317   </blockquote>
7318  </listitem>
7319
7320  <listitem>
7321   <para>
7322    Toggle Privoxy on or off. In this case, <quote>Privoxy</quote> continues
7323    to run, but only as a pass-through proxy, with no actions taking place:
7324   </para>
7325    <blockquote>
7326    <para>
7327     <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
7328    </para>
7329   </blockquote>
7330   <para>
7331    Short cuts. Turn off, then on:
7332   </para>
7333    <blockquote>
7334    <para>
7335      <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
7336    </para>
7337   </blockquote>
7338    <blockquote>
7339    <para>
7340      <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
7341    </para>
7342   </blockquote>
7343  </listitem>
7344
7345  </itemizedlist>
7346 </para>
7347
7348 <para>
7349  These may be bookmarked for quick reference. See next.
7350
7351 </para>
7352
7353 <sect3 id="bookmarklets">
7354 <title>Bookmarklets</title>
7355 <para>
7356  Below are some <quote>bookmarklets</quote> to allow you to easily access a
7357  <quote>mini</quote> version of some of <application>Privoxy's</application>
7358  special pages. They are designed for MS Internet Explorer, but should work
7359  equally well in Netscape, Mozilla, and other browsers which support
7360  JavaScript. They are designed to run directly from your bookmarks - not by
7361  clicking the links below (although that should work for testing).
7362 </para>
7363 <para>
7364  To save them, right-click the link and choose <quote>Add to Favorites</quote>
7365  (IE) or <quote>Add Bookmark</quote> (Netscape). You will get a warning that
7366  the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
7367  Bookmarklet directly from your favorites/bookmarks. For even faster access,
7368  you can put them on the <quote>Links</quote> bar (IE) or the <quote>Personal
7369  Toolbar</quote> (Netscape), and run them with a single click.
7370 </para>
7371
7372 <para>
7373  <itemizedlist>
7374
7375   <listitem>
7376    <para>
7377     <ulink
7378     url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&#38;set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Enable</ulink>
7379    </para>
7380   </listitem>
7381
7382   <listitem>
7383    <para>
7384     <ulink
7385     url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&#38;set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Disable</ulink>
7386    </para>
7387   </listitem>
7388
7389   <listitem>
7390    <para>
7391     <ulink
7392     url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&#38;set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Toggle Privoxy</ulink> (Toggles between enabled and disabled)
7393    </para>
7394   </listitem>
7395
7396   <listitem>
7397    <para>
7398     <ulink
7399     url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y','ijbstatus','width=250,height=2,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy- View Status</ulink>
7400    </para>
7401   </listitem>
7402 <!--
7403   <listitem>
7404    <para>
7405     <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions/index.php?url='+escape(location.href),'Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Submit Actions File Feedback</ulink>
7406    </para>
7407   </listitem>
7408  -->
7409   <listitem>
7410    <para>
7411     <ulink url="javascript:void(window.open('http://config.privoxy.org/show-url-info?url='+escape(location.href),'Why').focus());">Privoxy - Why?</ulink>
7412    </para>
7413   </listitem>
7414  </itemizedlist>
7415 </para>
7416
7417 <para>
7418  Credit: The site which gave us the general idea for these bookmarklets is
7419  <ulink url="http://www.bookmarklets.com/">www.bookmarklets.com</ulink>. They
7420  have more information about bookmarklets.
7421 </para>
7422
7423
7424 </sect3>
7425
7426 </sect2>
7427
7428
7429 <!--   ~~~~~       New section      ~~~~~     -->
7430 <sect2 id="chain">
7431 <title>Chain of Events</title>
7432 <para>
7433  Let's take a quick look at the basic sequence of events when a web page is
7434  requested by your browser and <application>Privoxy</application> is on duty:
7435 </para>
7436
7437 <para>
7438  <itemizedlist>
7439  <listitem>
7440   <para>
7441    First, your web browser requests a web page. The browser knows to send
7442    the request to <application>Privoxy</application>, which will in turn,
7443    relay the request to the remote web server after passing the following
7444    tests:
7445   </para>
7446  </listitem>
7447  <listitem>
7448   <para>
7449    <application>Privoxy</application> traps any request for its own internal CGI
7450    pages (e.g <ulink url="http://p.p/">http://p.p/</ulink>) and sends the CGI page back to the browser.
7451   </para>
7452  </listitem>
7453  <listitem>
7454   <para>
7455    Next, <application>Privoxy</application> checks to see if the URL
7456    matches any <link
7457    linkend="BLOCK"><quote>+block</quote></link> patterns. If
7458    so, the URL is then blocked, and the remote web server will not be contacted.
7459    <link linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>
7460    is then checked and if it does not match, an
7461    HTML <quote>BLOCKED</quote> page is sent back. Otherwise, if it does match,
7462    an image is returned. The type of image depends on the setting of <link
7463    linkend="SET-IMAGE-BLOCKER"><quote>+set-image-blocker</quote></link>
7464    (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere).
7465   </para>
7466  </listitem>
7467  <listitem>
7468   <para>
7469    Untrusted URLs are blocked. If URLs are being added to the
7470    <filename>trust</filename> file, then that is done.
7471   </para>
7472  </listitem>
7473  <listitem>
7474   <para>
7475    If the URL pattern matches the <link
7476    linkend="FAST-REDIRECTS"><quote>+fast-redirects</quote></link> action,
7477    it is then processed. Unwanted parts of the requested URL are stripped.
7478   </para>
7479  </listitem>
7480  <listitem>
7481   <para>
7482    Now the rest of the client browser's request headers are processed. If any
7483    of these match any of the relevant actions (e.g. <link
7484    linkend="HIDE-USER-AGENT"><quote>+hide-user-agent</quote></link>,
7485    etc.), headers are suppressed or forged as determined by these actions and
7486    their parameters.
7487   </para>
7488  </listitem>
7489  <listitem>
7490   <para>
7491    Now the web server starts sending its response back (i.e. typically a web page and related
7492    data).
7493   </para>
7494  </listitem>
7495  <listitem>
7496   <para>
7497    First, the server headers are read and processed to determine, among other
7498    things, the MIME type (document type) and encoding. The headers are then
7499    filtered as determined by the
7500    <link linkend="CRUNCH-INCOMING-COOKIES"><quote>+crunch-incoming-cookies</quote></link>,
7501    <link linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>,
7502    and <link linkend="DOWNGRADE-HTTP-VERSION"><quote>+downgrade-http-version</quote></link>
7503    actions.
7504   </para>
7505  </listitem>
7506  <listitem>
7507   <para>
7508    If the <link linkend="KILL-POPUPS"><quote>+kill-popups</quote></link>
7509    action applies, and it is an HTML or JavaScript document, the popup-code in the
7510    response is filtered on-the-fly as it is received.
7511   </para>
7512  </listitem>
7513  <listitem>
7514   <para>
7515    If a <link linkend="FILTER"><quote>+filter</quote></link>
7516    or <link
7517    linkend="DEANIMATE-GIFS"><quote>+deanimate-gifs</quote></link>
7518    action applies (and the document type fits the action), the rest of the page is
7519    read into memory (up to a configurable limit). Then the filter rules (from
7520    <filename>default.filter</filename> and any other filter files) are
7521    processed against the buffered content. Filters are applied in the order
7522    they are specified in one of the filter files. Animated GIFs, if present,
7523    are reduced to either the first or last frame, depending on the action
7524    setting.The entire page, which is now filtered, is then sent by
7525    <application>Privoxy</application> back to your browser.
7526   </para>
7527   <para>
7528    If neither <link linkend="FILTER"><quote>+filter</quote></link>
7529    or <link
7530    linkend="DEANIMATE-GIFS"><quote>+deanimate-gifs</quote></link>
7531    matches, then <application>Privoxy</application> passes the raw data through
7532    to the client browser as it becomes available.
7533   </para>
7534  </listitem>
7535  <listitem>
7536   <para>
7537    As the browser receives the now (possibly filtered) page content, it
7538    reads and then requests any URLs that may be embedded within the page
7539    source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
7540    frames), sounds, etc. For each of these objects, the browser issues a new
7541    request. And each such request is in turn processed as above. Note that a
7542    complex web page may have many such embedded URLs.
7543   </para>
7544  </listitem>
7545
7546  </itemizedlist>
7547 </para>
7548
7549 </sect2>
7550
7551
7552 <!--   ~~~~~       New section      ~~~~~     -->
7553 <sect2 id="actionsanat">
7554 <title>Anatomy of an Action</title>
7555
7556 <para>
7557  The way <application>Privoxy</application> applies
7558  <link linkend="ACTIONS">actions</link> and <link linkend="FILTER">filters</link>
7559  to any given URL can be complex, and not always so
7560  easy to understand what is happening. And sometimes we need to be able to
7561  <emphasis>see</emphasis> just what <application>Privoxy</application> is
7562  doing. Especially, if something <application>Privoxy</application> is doing
7563  is causing us a problem inadvertently. It can be a little daunting to look at
7564  the actions and filters files themselves, since they tend to be filled with
7565  <link linkend="regex">regular expressions</link> whose consequences are not
7566  always so obvious.
7567 </para>
7568
7569 <para>
7570  One quick test to see if <application>Privoxy</application> is causing a problem
7571  or not, is to disable it temporarily. This should be the first troubleshooting
7572  step. See <link linkend="bookmarklets">the Bookmarklets</link> section on a quick
7573  and easy way to do this (be sure to flush caches afterward!). Looking at the
7574  logs is a good idea too.
7575 </para>
7576
7577 <para>
7578  <application>Privoxy</application> also provides the
7579  <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
7580  page that can show us very specifically how <application>actions</application>
7581  are being applied to any given URL. This is a big help for troubleshooting.
7582 </para>
7583
7584 <para>
7585  First, enter one URL (or partial URL) at the prompt, and then
7586  <application>Privoxy</application> will tell us
7587  how the current configuration will handle it. This will not
7588  help with filtering effects (i.e. the <link
7589  linkend="FILTER"><quote>+filter</quote></link> action) from
7590  one of the filter files since this is handled very
7591  differently and not so easy to trap! It also will not tell you about any other
7592  URLs that may be embedded within the URL you are testing. For instance, images
7593  such as ads are expressed as URLs within the raw page source of HTML pages. So
7594  you will only get info for the actual URL that is pasted into the prompt area
7595  -- not any sub-URLs. If you want to know about embedded URLs like ads, you
7596  will have to dig those out of the HTML source. Use your browser's <quote>View
7597  Page Source</quote> option for this. Or right click on the ad, and grab the
7598  URL.
7599 </para>
7600
7601 <para>
7602  Let's try an example, <ulink url="http://google.com">google.com</ulink>,
7603  and look at it one section at a time in a sample configuration (your real
7604  configuration may vary):
7605 </para>
7606
7607 <para>
7608  <screen>
7609  Matches for http://google.com:
7610
7611  In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
7612
7613  {-add-header
7614  -block
7615  -content-type-overwrite
7616  -crunch-client-header
7617  -crunch-if-none-match
7618  -crunch-incoming-cookies
7619  -crunch-outgoing-cookies
7620  -crunch-server-header
7621  +deanimate-gifs {last}
7622  -downgrade-http-version
7623  +fast-redirects {check-decoded-url}
7624  -filter {js-events}
7625  -filter {content-cookies}
7626  -filter {all-popups}
7627  -filter {banners-by-link}
7628  -filter {tiny-textforms}
7629  -filter {frameset-borders}
7630  -filter {demoronizer}
7631  -filter {shockwave-flash}
7632  -filter {quicktime-kioskmode}
7633  -filter {fun}
7634  -filter {crude-parental}
7635  -filter {site-specifics}
7636  +filter {js-annoyances}
7637  +filter {html-annoyances}
7638  +filter {refresh-tags}
7639  +filter {unsolicited-popups}
7640  +filter {img-reorder}
7641  +filter {banners-by-size}
7642  +filter {webbugs}
7643  +filter {jumping-windows}
7644  +filter {ie-exploits}
7645  -filter-client-headers
7646  -filter-server-headers
7647  -force-text-mode
7648  -handle-as-empty-document
7649  -handle-as-image
7650  -hide-accept-language
7651  -hide-content-disposition
7652  +hide-forwarded-for-headers
7653  +hide-from-header {block}
7654  -hide-if-modified-since
7655  +hide-referrer {forge}
7656  -hide-user-agent
7657  -inspect-jpegs
7658  -kill-popups
7659  -limit-connect
7660  -overwrite-last-modified
7661  +prevent-compression
7662  -redirect
7663  -send-vanilla-wafer
7664  -send-wafer
7665  +session-cookies-only
7666  +set-image-blocker {pattern}
7667  -treat-forbidden-connects-like-blocks }
7668 /
7669
7670  { -session-cookies-only }
7671  .google.com
7672
7673  { -fast-redirects }
7674  .google.com
7675
7676 In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
7677 (no matches in this file)
7678 </screen>
7679 </para>
7680
7681 <para>
7682  This is telling us how we have defined our
7683  <link linkend="ACTIONS"><quote>actions</quote></link>, and
7684  which ones match for our test case, <quote>google.com</quote>.
7685  Displayed is all the actions that are available to us. Remember,
7686  the <literal>+</literal> sign denotes <quote>on</quote>. <literal>-</literal>
7687  denotes <quote>off</quote>. So some are <quote>on</quote> here, but many
7688  are <quote>off</quote>. Each example we try may provide a slightly different
7689  end result, depending on our configuration directives.
7690 </para>
7691 <para>
7692  The first listing
7693  is any matches for the <filename>standard.action</filename> file. No hits at
7694  all here on <quote>standard</quote>. Then next is <quote>default</quote>, or
7695  our <filename>default.action</filename> file. The large, multi-line listing,
7696  is how the actions are set to match for all URLs, i.e. our default settings.
7697  If you look at your <quote>actions</quote> file, this would be the section
7698  just below the <quote>aliases</quote> section near the top. This will apply to
7699  all URLs as signified by the single forward slash at the end of the listing
7700  -- <quote>/</quote>.
7701 </para>
7702
7703 <para>
7704  But we can define additional actions that would be exceptions to these general
7705  rules, and then list specific URLs (or patterns) that these exceptions would
7706  apply to. Last match wins. Just below this then are two explicit matches for
7707  <quote>.google.com</quote>. The first is negating our previous cookie setting,
7708  which was for <link
7709  linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>
7710  (i.e. not persistent). So we will allow persistent cookies for google, at
7711  least that is how it is in this example. The second turns
7712  <emphasis>off</emphasis> any
7713  <link
7714  linkend="FAST-REDIRECTS"><quote>+fast-redirects</quote></link>
7715  action, allowing this to take place unmolested. Note that there is a leading
7716  dot here -- <quote>.google.com</quote>. This will match any hosts and
7717  sub-domains, in the google.com domain also, such as
7718  <quote>www.google.com</quote>. So, apparently, we have these two actions
7719  defined somewhere in the lower part of our <filename>default.action</filename>
7720  file, and <quote>google.com</quote> is referenced somewhere in these latter
7721  sections.
7722 </para>
7723
7724 <para>
7725  Then, for our <filename>user.action</filename> file, we again have no hits.
7726  So there is nothing google-specific that we might have added to our own, local
7727  configuration.
7728 </para>
7729
7730 <para>
7731  And finally we pull it all together in the bottom section and summarize how
7732  <application>Privoxy</application> is applying all its <quote>actions</quote>
7733  to <quote>google.com</quote>:
7734
7735 </para>
7736
7737 <para>
7738  <screen>
7739
7740  Final results:
7741
7742  -add-header
7743  -block
7744  -content-type-overwrite
7745  -crunch-client-header
7746  -crunch-if-none-match
7747  -crunch-incoming-cookies
7748  -crunch-outgoing-cookies
7749  -crunch-server-header
7750  +deanimate-gifs {last}
7751  -downgrade-http-version
7752  -fast-redirects
7753  +filter {js-annoyances}
7754  +filter {html-annoyances}
7755  +filter {refresh-tags}
7756  +filter {unsolicited-popups}
7757  +filter {img-reorder}
7758  +filter {banners-by-size}
7759  +filter {webbugs}
7760  +filter {jumping-windows}
7761  +filter {ie-exploits}
7762  -filter-client-headers
7763  -filter-server-headers
7764  -force-text-mode
7765  -handle-as-empty-document
7766  -handle-as-image
7767  -hide-accept-language
7768  -hide-content-disposition
7769  +hide-forwarded-for-headers
7770  +hide-from-header {block}
7771  -hide-if-modified-since
7772  +hide-referrer {forge}
7773  -hide-user-agent
7774  -inspect-jpegs
7775  -kill-popups
7776  -limit-connect
7777  -overwrite-last-modified
7778  +prevent-compression
7779  -redirect
7780  -send-vanilla-wafer
7781  -send-wafer
7782  -session-cookies-only
7783  +set-image-blocker {pattern}
7784  -treat-forbidden-connects-like-blocks </screen>
7785 </para>
7786
7787 <para>
7788  Notice the only difference here to the previous listing, is to
7789  <quote>fast-redirects</quote> and <quote>session-cookies-only</quote>,
7790  which are activated specifically for this site in our configuration,
7791  and thus show in the <quote>Final Results</quote>.
7792 </para>
7793
7794 <para>
7795  Now another example, <quote>ad.doubleclick.net</quote>:
7796 </para>
7797
7798 <para>
7799  <screen>
7800
7801  { +block +handle-as-image }
7802   .ad.doubleclick.net
7803
7804  { +block +handle-as-image }
7805   ad*.
7806
7807  { +block +handle-as-image }
7808   .doubleclick.net
7809 </screen>
7810 </para>
7811
7812 <para>
7813  We'll just show the interesting part here, the explicit matches. It is
7814  matched three different times. Each as an <quote>+block +handle-as-image</quote>,
7815  which is the expanded form of one of our aliases that had been defined as:
7816  <quote>+imageblock</quote>. (<link
7817  linkend="ALIASES"><quote>Aliases</quote></link> are defined in
7818  the first section of the actions file and typically used to combine more
7819  than one action.)
7820 </para>
7821
7822 <para>
7823  Any one of these would have done the trick and blocked this as an unwanted
7824  image. This is unnecessarily redundant since the last case effectively
7825  would also cover the first. No point in taking chances with these guys
7826  though ;-) Note that if you want an ad or obnoxious
7827  URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
7828  is done here -- as both a <link
7829  linkend="BLOCK"><quote>+block</quote></link>
7830  <emphasis>and</emphasis> an
7831  <link
7832  linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>.
7833  The custom alias <quote>+imageblock</quote> just simplifies the process and make
7834  it more readable.
7835 </para>
7836
7837 <para>
7838  One last example. Let's try <quote>http://www.example.net/adsl/HOWTO/</quote>.
7839  This one is giving us problems. We are getting a blank page. Hmmm ...
7840 </para>
7841
7842 <para>
7843  <screen>
7844
7845  Matches for http://www.example.net/adsl/HOWTO/:
7846
7847  In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
7848
7849  {-add-header
7850   -block
7851   -content-type-overwrite
7852   -crunch-client-header
7853   -crunch-if-none-match
7854   -crunch-incoming-cookies
7855   -crunch-outgoing-cookies
7856   -crunch-server-header
7857   +deanimate-gifs
7858   -downgrade-http-version
7859   +fast-redirects{check-decoded-url}
7860   +filter{html-annoyances}
7861   +filter{js-annoyances}
7862   +filter{kill-popups}
7863   +filter{webbugs}
7864   +filter{nimda}
7865   +filter{banners-by-size}
7866   +filter{hal}
7867   +filter{fun}
7868   -filter-client-headers
7869   -filter-server-headers
7870   -force-text-mode
7871   -handle-as-empty-document
7872   -handle-as-image
7873   -hide-accept-language
7874   -hide-content-disposition
7875   +hide-forwarded-for-headers
7876   +hide-from-header{block}
7877   +hide-referer{forge}
7878   -hide-user-agent
7879   -inspect-jpegs
7880   +kill-popups
7881   -overwrite-last-modified
7882   +prevent-compression
7883   -redirect
7884   -send-vanilla-wafer
7885   -send-wafer
7886   +session-cookies-only
7887   +set-image-blocker{blank}
7888   -treat-forbidden-connects-like-blocks }
7889    /
7890
7891  { +block +handle-as-image }
7892   /ads
7893 </screen>
7894 </para>
7895
7896 <para>
7897  Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote> in our
7898  configuration! But we did not want this at all! Now we see why we get the
7899  blank page. We could now add a new action below this that explicitly
7900  <emphasis>un</emphasis> blocks (<quote>{-block}</quote>) paths with
7901  <quote>adsl</quote> in them (remember, last match in the configuration wins).
7902  There are various ways to handle such exceptions. Example:
7903 </para>
7904
7905 <para>
7906  <screen>
7907
7908  { -block }
7909   /adsl
7910 </screen>
7911 </para>
7912
7913 <para>
7914  Now the page displays ;-) Be sure to flush your browser's caches when
7915  making such changes. Or, try using <literal>Shift+Reload</literal>.
7916 </para>
7917
7918 <para>
7919  But now what about a situation where we get no explicit matches like
7920  we did with:
7921 </para>
7922
7923 <para>
7924  <screen>
7925
7926  { +block +handle-as-image }
7927  /ads
7928 </screen>
7929 </para>
7930
7931 <para>
7932  That actually was very telling and pointed us quickly to where the problem
7933  was. If you don't get this kind of match, then it means one of the default
7934  rules in the first section is causing the problem. This would require some
7935  guesswork, and maybe a little trial and error to isolate the offending rule.
7936  One likely cause would be one of the <quote>{+filter}</quote> actions. These
7937  tend to be harder to troubleshoot. Try adding the URL for the site to one of
7938  aliases that turn off <quote>+filter</quote>:
7939 </para>
7940
7941 <para>
7942  <screen>
7943
7944  {shop}
7945  .quietpc.com
7946  .worldpay.com   # for quietpc.com
7947  .jungle.com
7948  .scan.co.uk
7949  .forbes.com
7950 </screen>
7951 </para>
7952
7953 <para>
7954  <quote>{shop}</quote> is an <quote>alias</quote> that expands to
7955  <quote>{ -filter -session-cookies-only }</quote>.
7956  Or you could do your own exception to negate filtering:
7957
7958 </para>
7959
7960 <para>
7961  <screen>
7962
7963  {-filter}
7964  .forbes.com
7965 </screen>
7966 </para>
7967
7968 <para>
7969  This would turn off all filtering for that site. This would probably be most
7970  appropriately put in <filename>user.action</filename>, for local site
7971  exceptions.
7972 </para>
7973
7974 <para>
7975  Images that are inexplicably being blocked, may well be hitting the
7976  <quote>+filter{banners-by-size}</quote> rule, which assumes
7977  that images of certain sizes are ad banners (works well most of the time
7978  since these tend to be standardized).
7979 </para>
7980
7981 <para>
7982  <quote>{fragile}</quote> is an alias that disables most actions. This can be
7983  used as a last resort for problem sites. Remember to flush caches! If this
7984  still does not work, you will have to go through the remaining actions one by
7985  one to find which one(s) is causing the problem.
7986 </para>
7987
7988 </sect2>
7989
7990 </sect1>
7991
7992  <!--
7993
7994  This program is free software; you can redistribute it
7995  and/or modify it under the terms of the GNU General
7996  Public License as published by the Free Software
7997  Foundation; either version 2 of the License, or (at
7998  your option) any later version.
7999
8000  This program is distributed in the hope that it will
8001  be useful, but WITHOUT ANY WARRANTY; without even the
8002  implied warranty of MERCHANTABILITY or FITNESS FOR A
8003  PARTICULAR PURPOSE.  See the GNU General Public
8004  License for more details.
8005
8006  The GNU General Public License should be included with
8007  this file.  If not, you can view it at
8008  http://www.gnu.org/copyleft/gpl.html
8009  or write to the Free Software Foundation, Inc., 59
8010  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
8011
8012  $Log: user-manual.sgml,v $
8013  Revision 2.17  2006/09/05 13:25:12  david__schmidt
8014  Add Windows service invocation stuff (duplicated) in FAQ and in user manual under Windows startup.  One probably ought to reference the other.
8015
8016  Revision 2.16  2006/09/02 12:49:37  hal9
8017  Various small updates for new actions, filterfiles, etc.
8018
8019  Revision 2.15  2006/08/30 11:15:22  hal9
8020  More work on the new actions, especially filter-*-headers, and What's New
8021  section. User Manual is close to final form for 3.0.4 release. Some tinkering
8022  and proof reading left to do.
8023
8024  Revision 2.14  2006/08/29 10:59:36  hal9
8025  Add a "Whats New in this release" Section. Further work on multiple filter
8026  files, and assorted other minor changes.
8027
8028  Revision 2.13  2006/08/22 11:04:59  hal9
8029  Silence warnings and errors. This should build now. New filters were only
8030  stubbed in. More to be done.
8031
8032  Revision 2.12  2006/08/14 08:40:39  fabiankeil
8033  Documented new actions that were part of
8034  the "minor Privoxy improvements".
8035
8036  Revision 2.11  2006/07/18 14:48:51  david__schmidt
8037  Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
8038  with what was really the latest development (the v_3_0_branch branch)
8039
8040  Revision 1.123.2.43  2005/05/23 09:59:10  hal9
8041  Fix typo 'loose'
8042
8043  Revision 1.123.2.42  2004/12/04 14:39:57  hal9
8044  Fix two minor typos per bug SF report.
8045
8046  Revision 1.123.2.41  2004/03/23 12:58:42  oes
8047  Fixed an inaccuracy
8048
8049  Revision 1.123.2.40  2004/02/27 12:48:49  hal9
8050  Add comment re: redirecting to local file system for set-image-blocker may
8051  is dependent on browser.
8052
8053  Revision 1.123.2.39  2004/01/30 22:31:40  oes
8054  Added a hint re bookmarklets to Quickstart section
8055
8056  Revision 1.123.2.38  2004/01/30 16:47:51  oes
8057  Some minor clarifications
8058
8059  Revision 1.123.2.37  2004/01/29 22:36:11  hal9
8060  Updates for no longer filtering text/plain, and demoronizer default settings,
8061  and copyright notice dates.
8062
8063  Revision 1.123.2.36  2003/12/10 02:26:26  hal9
8064  Changed the demoronizer filter description.
8065
8066  Revision 1.123.2.35  2003/11/06 13:36:37  oes
8067  Updated link to nightly CVS tarball
8068
8069  Revision 1.123.2.34  2003/06/26 23:50:16  hal9
8070  Add a small bit on filtering and problems re: source code being corrupted.
8071
8072  Revision 1.123.2.33  2003/05/08 18:17:33  roro
8073  Use apt-get instead of dpkg to install Debian package, which is more
8074  solid, uses the correct and most recent Debian version automatically.
8075
8076  Revision 1.123.2.32  2003/04/11 03:13:57  hal9
8077  Add small note about only one filterfile (as opposed to multiple actions
8078  files).
8079
8080  Revision 1.123.2.31  2003/03/26 02:03:43  oes
8081  Updated hard-coded copyright dates
8082
8083  Revision 1.123.2.30  2003/03/24 12:58:56  hal9
8084  Add new section on Predefined Filters.
8085
8086  Revision 1.123.2.29  2003/03/20 02:45:29  hal9
8087  More problems with \-\-chroot causing markup problems :(
8088
8089  Revision 1.123.2.28  2003/03/19 00:35:24  hal9
8090  Manual edit of revision log because 'chroot' (even inside a comment) was
8091  causing Docbook to hang here (due to double hyphen and the processor thinking
8092  it was a comment).
8093
8094  Revision 1.123.2.27  2003/03/18 19:37:14  oes
8095  s/Advanced|Radical/Adventuresome/g to avoid complaints re fun filter
8096
8097  Revision 1.123.2.26  2003/03/17 16:50:53  oes
8098  Added documentation for new chroot option
8099
8100  Revision 1.123.2.25  2003/03/15 18:36:55  oes
8101  Adapted to the new filters
8102
8103  Revision 1.123.2.24  2002/11/17 06:41:06  hal9
8104  Move default profiles table from FAQ to U-M, and other minor related changes.
8105  Add faq on cookies.
8106
8107  Revision 1.123.2.23  2002/10/21 02:32:01  hal9
8108  Updates to the user.action examples section. A few new ones.
8109
8110  Revision 1.123.2.22  2002/10/12 00:51:53  hal9
8111  Add demoronizer to filter section.
8112
8113  Revision 1.123.2.21  2002/10/10 04:09:35  hal9
8114  s/Advanced/Radical/ and added very brief note.
8115
8116  Revision 1.123.2.20  2002/10/10 03:49:21  hal9
8117  Add notes to session-cookies-only and Quickstart about pre-existing
8118  cookies. Also, note content-cookies work differently.
8119
8120  Revision 1.123.2.19  2002/09/26 01:25:36  hal9
8121  More explanation on Privoxy patterns, more on content-cookies and SSL.
8122
8123  Revision 1.123.2.18  2002/08/22 23:47:58  hal9
8124  Add 'Documentation' to Privoxy Menu shot in Configuration section to match
8125  CGIs.
8126
8127  Revision 1.123.2.17  2002/08/18 01:13:05  hal9
8128  Spell checked (only one typo this time!).
8129
8130  Revision 1.123.2.16  2002/08/09 19:20:54  david__schmidt
8131  Update to Mac OSX startup script name
8132
8133  Revision 1.123.2.15  2002/08/07 17:32:11  oes
8134  Converted some internal links from ulink to link for PDF creation; no content changed
8135
8136  Revision 1.123.2.14  2002/08/06 09:16:13  oes
8137  Nits re: actions file download
8138
8139  Revision 1.123.2.13  2002/08/02 18:23:19  g_sauthoff
8140  Just 2 small corrections to the Gentoo sections
8141
8142  Revision 1.123.2.12  2002/08/02 18:17:21  g_sauthoff
8143  Added 2 Gentoo sections
8144
8145  Revision 1.123.2.11  2002/07/26 15:20:31  oes
8146  - Added version info to title
8147  - Added info on new filters
8148  - Revised parts of the filter file tutorial
8149  - Added info on where to get updated actions files
8150
8151  Revision 1.123.2.10  2002/07/25 21:42:29  hal9
8152  Add brief notes on not proxying non-HTTP protocols.
8153
8154  Revision 1.123.2.9  2002/07/11 03:40:28  david__schmidt
8155
8156  Updated Mac OSX sections due to installation location change
8157
8158  Revision 1.123.2.8  2002/06/09 16:36:32  hal9
8159  Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
8160
8161  Revision 1.123.2.7  2002/06/09 00:29:34  hal9
8162  Touch ups on filtering, in actions section and Anatomy.
8163
8164  Revision 1.123.2.6  2002/06/06 23:11:03  hal9
8165  Fix broken link. Linkchecked all docs.
8166
8167  Revision 1.123.2.5  2002/05/29 02:01:02  hal9
8168  This is break out of the entire config section from u-m, so it can
8169  eventually be used to generate the comments, etc in the main config file
8170  so that these are in sync with each other.
8171
8172  Revision 1.123.2.4  2002/05/27 03:28:45  hal9
8173  Ooops missed something from David.
8174
8175  Revision 1.123.2.3  2002/05/27 03:23:17  hal9
8176  Fix FIXMEs for OS2 and OSX startup. Fix Redhat typos (should be Red Hat).
8177  That's a wrap, I think.
8178
8179  Revision 1.123.2.2  2002/05/26 19:02:09  hal9
8180  Move Amiga stuff around to take of FIXME in start up section.
8181
8182  Revision 1.123.2.1  2002/05/26 17:04:25  hal9
8183  -Spellcheck, very minor edits, and sync across branches
8184
8185  Revision 1.123  2002/05/24 23:19:23  hal9
8186  Include new image (Proxy setup). More fun with guibutton.
8187  Minor corrections/clarifications here and there.
8188
8189  Revision 1.122  2002/05/24 13:24:08  oes
8190  Added Bookmarklet for one-click pre-filled access to show-url-info
8191
8192  Revision 1.121  2002/05/23 23:20:17  oes
8193   - Changed more (all?) references to actions to the
8194     <literal><link> style.
8195   - Small fixes in the actions chapter
8196   - Small clarifications in the quickstart to ad blocking
8197   - Removed <emphasis> from <title>s since the new doc CSS
8198     renders them red (bad in TOC).
8199
8200  Revision 1.120  2002/05/23 19:16:43  roro
8201  Correct Debian specials (installation and startup).
8202
8203  Revision 1.119  2002/05/22 17:17:05  oes
8204  Added Security hint
8205
8206  Revision 1.118  2002/05/21 04:54:55  hal9
8207  -New Section: Quickstart to Ad Blocking
8208  -Reformat Actions Anatomy to match new CGI layout
8209
8210  Revision 1.117  2002/05/17 13:56:16  oes
8211   - Reworked & extended Templates chapter
8212   - Small changes to Regex appendix
8213   - #included authors.sgml into (C) and hist chapter
8214
8215  Revision 1.116  2002/05/17 03:23:46  hal9
8216  Fixing merge conflict in Quickstart section.
8217
8218  Revision 1.115  2002/05/16 16:25:00  oes
8219  Extended the Filter File chapter & minor fixes
8220
8221  Revision 1.114  2002/05/16 09:42:50  oes
8222  More ulink->link, added some hints to Quickstart section
8223
8224  Revision 1.113  2002/05/15 21:07:25  oes
8225  Extended and further commented the example actions files
8226
8227  Revision 1.112  2002/05/15 03:57:14  hal9
8228  Spell check. A few minor edits here and there for better syntax and
8229  clarification.
8230
8231  Revision 1.111  2002/05/14 23:01:36  oes
8232  Fixing the fixes
8233
8234  Revision 1.110  2002/05/14 19:10:45  oes
8235  Restored alphabetical order of actions
8236
8237  Revision 1.109  2002/05/14 17:23:11  oes
8238  Renamed the prevent-*-cookies actions, extended aliases section and moved it before the example AFs
8239
8240  Revision 1.108  2002/05/14 15:29:12  oes
8241  Completed proofreading the actions chapter
8242
8243  Revision 1.107  2002/05/12 03:20:41  hal9
8244  Small clarifications for 127.0.0.1 vs localhost for listen-address since this
8245  apparently an important distinction for some OS's.
8246
8247  Revision 1.106  2002/05/10 01:48:20  hal9
8248  This is mostly proposed copyright/licensing additions and changes. Docs
8249  are still GPL, but licensing and copyright are more visible. Also, copyright
8250  changed in doc header comments (eliminate references to JB except FAQ).
8251
8252  Revision 1.105  2002/05/05 20:26:02  hal9
8253  Sorting out license vs copyright in these docs.
8254
8255  Revision 1.104  2002/05/04 08:44:45  swa
8256  bumped version
8257
8258  Revision 1.103  2002/05/04 00:40:53  hal9
8259  -Remove the TOC first page kludge. It's fixed proper now in ldp.dsl.in.
8260  -Some minor additions to Quickstart.
8261
8262  Revision 1.102  2002/05/03 17:46:00  oes
8263  Further proofread & reactivated short build instructions
8264
8265  Revision 1.101  2002/05/03 03:58:30  hal9
8266  Move the user-manual config directive to top of section. Add note about
8267  Privoxy needing read permissions for configs, and write for logs.
8268
8269  Revision 1.100  2002/04/29 03:05:55  hal9
8270  Add clarification on differences of new actions files.
8271
8272  Revision 1.99  2002/04/28 16:59:05  swa
8273  more structure in starting section
8274
8275  Revision 1.98  2002/04/28 05:43:59  hal9
8276  This is the break up of configuration.html into multiple files. This
8277  will probably break links elsewhere :(
8278
8279  Revision 1.97  2002/04/27 21:04:42  hal9
8280  -Rewrite of Actions File example.
8281  -Add section for user-manual directive in config.
8282
8283  Revision 1.96  2002/04/27 05:32:00  hal9
8284  -Add short section to Filter Files to tie in with +filter action.
8285  -Start rewrite of examples in Actions Examples (not finished).
8286
8287  Revision 1.95  2002/04/26 17:23:29  swa
8288  bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
8289
8290  Revision 1.94  2002/04/26 05:24:36  hal9
8291  -Add most of Andreas suggestions to Chain of Events section.
8292  -A few other minor corrections and touch up.
8293
8294  Revision 1.92  2002/04/25 18:55:13  hal9
8295  More catchups on new actions files, and new actions names.
8296  Other assorted cleanups, and minor modifications.
8297
8298  Revision 1.91  2002/04/24 02:39:31  hal9
8299  Add 'Chain of Events' section.
8300
8301  Revision 1.90  2002/04/23 21:41:25  hal9
8302  Linuxconf is deprecated on RH, substitute chkconfig.
8303
8304  Revision 1.89  2002/04/23 21:05:28  oes
8305  Added hint for startup on Red Hat
8306
8307  Revision 1.88  2002/04/23 05:37:54  hal9
8308  Add AmigaOS install stuff.
8309
8310  Revision 1.87  2002/04/23 02:53:15  david__schmidt
8311  Updated OSX installation section
8312  Added a few English tweaks here an there
8313
8314  Revision 1.86  2002/04/21 01:46:32  hal9
8315  Re-write actions section.
8316
8317  Revision 1.85  2002/04/18 21:23:23  hal9
8318  Fix ugly typo (mine).
8319
8320  Revision 1.84  2002/04/18 21:17:13  hal9
8321  Spell Redhat correctly (ie Red Hat). A few minor grammar corrections.
8322
8323  Revision 1.83  2002/04/18 18:21:12  oes
8324  Added RPM install detail
8325
8326  Revision 1.82  2002/04/18 12:04:50  oes
8327  Cosmetics
8328
8329  Revision 1.81  2002/04/18 11:50:24  oes
8330  Extended Install section - needs fixing by packagers
8331
8332  Revision 1.80  2002/04/18 10:45:19  oes
8333  Moved text to buildsource.sgml, renamed some filters, details
8334
8335  Revision 1.79  2002/04/18 03:18:06  hal9
8336  Spellcheck, and minor touchups.
8337
8338  Revision 1.78  2002/04/17 18:04:16  oes
8339  Proofreading part 2
8340
8341  Revision 1.77  2002/04/17 13:51:23  oes
8342  Proofreading, part one
8343
8344  Revision 1.76  2002/04/16 04:25:51  hal9
8345  -Added 'Note to Upgraders' and re-ordered the 'Quickstart' section.
8346  -Note about proxy may need requests to re-read config files.
8347
8348  Revision 1.75  2002/04/12 02:08:48  david__schmidt
8349  Remove OS/2 building info... it is already in the developer-manual
8350
8351  Revision 1.74  2002/04/11 00:54:38  hal9
8352  Add small section on submitting actions.
8353
8354  Revision 1.73  2002/04/10 18:45:15  swa
8355  generated
8356
8357  Revision 1.72  2002/04/10 04:06:19  hal9
8358  Added actions feedback  to Bookmarklets section
8359
8360  Revision 1.71  2002/04/08 22:59:26  hal9
8361  Version update. Spell chkconfig correctly :)
8362
8363  Revision 1.70  2002/04/08 20:53:56  swa
8364  ?
8365
8366  Revision 1.69  2002/04/06 05:07:29  hal9
8367  -Add privoxy-man-page.sgml, for man page.
8368  -Add authors.sgml for AUTHORS (and p-authors.sgml)
8369  -Reworked various aspects of various docs.
8370  -Added additional comments to sub-docs.
8371
8372  Revision 1.68  2002/04/04 18:46:47  swa
8373  consistent look. reuse of copyright, history et. al.
8374
8375  Revision 1.67  2002/04/04 17:27:57  swa
8376  more single file to be included at multiple points. make maintaining easier
8377
8378  Revision 1.66  2002/04/04 06:48:37  hal9
8379  Structural changes to allow for conditional inclusion/exclusion of content
8380  based on entity toggles, e.g. 'entity % p-not-stable  "INCLUDE"'. And
8381  definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
8382  eventually be set by Makefile.
8383  More boilerplate text for use across multiple docs.
8384
8385  Revision 1.65  2002/04/03 19:52:07  swa
8386  enhance squid section due to user suggestion
8387
8388  Revision 1.64  2002/04/03 03:53:43  hal9
8389  A few minor bug fixes, and touch ups. Ready for review.
8390
8391  Revision 1.63  2002/04/01 16:24:49  hal9
8392  Define entities to include boilerplate text. See doc/source/*.
8393
8394  Revision 1.62  2002/03/30 04:15:53  hal9
8395  - Fix privoxy.org/config links.
8396  - Paste in Bookmarklets from Toggle page.
8397  - Move Quickstart nearer top, and minor rework.
8398
8399  Revision 1.61  2002/03/29 01:31:08  hal9
8400  Minor update.
8401
8402  Revision 1.60  2002/03/27 01:57:34  hal9
8403  Added more to Anatomy section.
8404
8405  Revision 1.59  2002/03/27 00:54:33  hal9
8406  Touch up intro for new name.
8407
8408  Revision 1.58  2002/03/26 22:29:55  swa
8409  we have a new homepage!
8410
8411  Revision 1.57  2002/03/24 20:33:30  hal9
8412  A few minor catch ups with name change.
8413
8414  Revision 1.56  2002/03/24 16:17:06  swa
8415  configure needs to be generated.
8416
8417  Revision 1.55  2002/03/24 16:08:08  swa
8418  we are too lazy to make a block-built
8419  privoxy logo. hence removed the option.
8420
8421  Revision 1.54  2002/03/24 15:46:20  swa
8422  name change related issue.
8423
8424  Revision 1.53  2002/03/24 11:51:00  swa
8425  name change. changed filenames.
8426
8427  Revision 1.52  2002/03/24 11:01:06  swa
8428  name change
8429
8430  Revision 1.51  2002/03/23 15:13:11  swa
8431  renamed every reference to the old name with foobar.
8432  fixed "application foobar application" tag, fixed
8433  "the foobar" with "foobar". left junkbustser in cvs
8434  comments and remarks to history untouched.
8435
8436  Revision 1.50  2002/03/23 05:06:21  hal9
8437  Touch up.
8438
8439  Revision 1.49  2002/03/21 17:01:05  hal9
8440  New section in Appendix.
8441
8442  Revision 1.48  2002/03/12 06:33:01  hal9
8443  Catching up to Andreas and re_filterfile changes.
8444
8445  Revision 1.47  2002/03/11 13:13:27  swa
8446  correct feedback channels
8447
8448  Revision 1.46  2002/03/10 00:51:08  hal9
8449  Added section on JB internal pages in Appendix.
8450
8451  Revision 1.45  2002/03/09 17:43:53  swa
8452  more distros
8453
8454  Revision 1.44  2002/03/09 17:08:48  hal9
8455  New section on Jon's actions file editor, and move some stuff around.
8456
8457  Revision 1.43  2002/03/08 00:47:32  hal9
8458  Added imageblock{pattern}.
8459
8460  Revision 1.42  2002/03/07 18:16:55  swa
8461  looks better
8462
8463  Revision 1.41  2002/03/07 16:46:43  hal9
8464  Fix a few markup problems for jade.
8465
8466  Revision 1.40  2002/03/07 16:28:39  swa
8467  provide correct feedback channels
8468
8469  Revision 1.39  2002/03/06 16:19:28  hal9
8470  Note on perceived filtering slowdown per FR.
8471
8472  Revision 1.38  2002/03/05 23:55:14  hal9
8473  Stupid I did it again. Double hyphen in comment breaks jade.
8474
8475  Revision 1.37  2002/03/05 23:53:49  hal9
8476  jade barfs on '- -' embedded in comments. - -user option broke it.
8477
8478  Revision 1.36  2002/03/05 22:53:28  hal9
8479  Add new - - user option.
8480
8481  Revision 1.35  2002/03/05 00:17:27  hal9
8482  Added section on command line options.
8483
8484  Revision 1.34  2002/03/04 19:32:07  oes
8485  Changed default port to 8118
8486
8487  Revision 1.33  2002/03/03 19:46:13  hal9
8488  Emphasis on where/how to report bugs, etc
8489
8490  Revision 1.32  2002/03/03 09:26:06  joergs
8491  AmigaOS changes, config is now loaded from PROGDIR: instead of
8492  AmiTCP:db/junkbuster/ if no configuration file is specified on the
8493  command line.
8494
8495  Revision 1.31  2002/03/02 22:45:52  david__schmidt
8496  Just tweaking
8497
8498  Revision 1.30  2002/03/02 22:00:14  hal9
8499  Updated 'New Features' list. Ran through spell-checker.
8500
8501  Revision 1.29  2002/03/02 20:34:07  david__schmidt
8502  Update OS/2 build section
8503
8504  Revision 1.28  2002/02/24 14:34:24  jongfoster
8505  Formatting changes.  Now changing the doctype to DocBook XML 4.1
8506  will work - no other changes are needed.
8507
8508  Revision 1.27  2002/01/11 14:14:32  hal9
8509  Added a very short section on Templates
8510
8511  Revision 1.26  2002/01/09 20:02:50  hal9
8512  Fix bug re: auto-detect config file changes.
8513
8514  Revision 1.25  2002/01/09 18:20:30  hal9
8515  Touch ups for *.action files.
8516
8517  Revision 1.24  2001/12/02 01:13:42  hal9
8518  Fix typo.
8519
8520  Revision 1.23  2001/12/02 00:20:41  hal9
8521  Updates for recent changes.
8522
8523  Revision 1.22  2001/11/05 23:57:51  hal9
8524  Minor update for startup now daemon mode.
8525
8526  Revision 1.21  2001/10/31 21:11:03  hal9
8527  Correct 2 minor errors
8528
8529  Revision 1.18  2001/10/24 18:45:26  hal9
8530  *** empty log message ***
8531
8532  Revision 1.17  2001/10/24 17:10:55  hal9
8533  Catching up with Jon's recent work, and a few other things.
8534
8535  Revision 1.16  2001/10/21 17:19:21  swa
8536  wrong url in documentation
8537
8538  Revision 1.15  2001/10/14 23:46:24  hal9
8539  Various minor changes. Fleshed out SEE ALSO section.
8540
8541  Revision 1.13  2001/10/10 17:28:33  hal9
8542  Very minor changes.
8543
8544  Revision 1.12  2001/09/28 02:57:04  hal9
8545  Ditto :/
8546
8547  Revision 1.11  2001/09/28 02:25:20  hal9
8548  Ditto.
8549
8550  Revision 1.9  2001/09/27 23:50:29  hal9
8551  A few changes. A short section on regular expression in appendix.
8552
8553  Revision 1.8  2001/09/25 00:34:59  hal9
8554  Some additions, and re-arranging.
8555
8556  Revision 1.7  2001/09/24 14:31:36  hal9
8557  Diddling.
8558
8559  Revision 1.6  2001/09/24 14:10:32  hal9
8560  Including David's OS/2 installation instructions.
8561
8562  Revision 1.2  2001/09/13 15:27:40  swa
8563  cosmetics
8564
8565  Revision 1.1  2001/09/12 15:36:41  swa
8566  source files for junkbuster documentation
8567
8568  Revision 1.3  2001/09/10 17:43:59  swa
8569  first proposal of a structure.
8570
8571  Revision 1.2  2001/06/13 14:28:31  swa
8572  docs should have an author.
8573
8574  Revision 1.1  2001/06/13 14:20:37  swa
8575  first import of project's documentation for the webserver.
8576
8577  -->
8578
8579 </article>