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