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