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