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