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