Stop advertising the show-version CGI page which no longer exists
[privoxy.git] / doc / source / user-manual.sgml
1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "IGNORE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity seealso SYSTEM "seealso.sgml">
7 <!entity buildsource SYSTEM "buildsource.sgml">
8 <!entity contacting SYSTEM "contacting.sgml">
9 <!entity history SYSTEM "history.sgml">
10 <!entity copyright SYSTEM "copyright.sgml">
11 <!entity license SYSTEM "license.sgml">
12 <!entity GPLv2 SYSTEM "../../LICENSE">
13 <!entity p-authors SYSTEM "p-authors.sgml">
14 <!entity config SYSTEM "p-config.sgml">
15 <!entity changelog SYSTEM "changelog.sgml">
16 <!entity p-version "3.0.28">
17 <!entity p-status "stable">
18 <!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc  -->
19 <!entity % p-not-stable "IGNORE">
20 <!entity % p-stable "INCLUDE">
21 <!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
22 <!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
23 <!entity % p-readme "IGNORE">
24 <!entity % user-man "IGNORE">
25 <!entity % config-file "IGNORE">
26 <!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml    -->
27 <!entity  my-copy "&copy;">         <!-- kludge for docbook2man           -->
28 <!entity % draft "IGNORE">          <!-- WIP stuff    -->
29 <!entity % seealso-extra "INCLUDE"> <!-- extra stuff from seealso.sgml    -->
30 <!entity  my-app "<application>Privoxy</application>">
31 ]>
32 <!--
33  File        :  doc/source/user-manual.sgml
34
35  Purpose     :  user manual
36
37  Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/
38  See LICENSE.
39
40  ========================================================================
41  NOTE: Please read developer-manual/documentation.html before touching
42  anything in this, or other Privoxy documentation.
43  ========================================================================
44
45 -->
46
47 <article id="index">
48 <artheader>
49
50 <title>Privoxy &p-version; User Manual</title>
51
52 <pubdate>
53  <subscript>
54 <!-- Completely the wrong markup, but very little is allowed  -->
55 <!-- in this part of an article. FIXME -->
56  <link linkend="copyright">Copyright</link> &my-copy; 2001-2018 by
57  <ulink url="https://www.privoxy.org/">Privoxy Developers</ulink>
58  </subscript>
59 </pubdate>
60
61 <!--
62
63 Note: the following should generate a separate page, and a live link to it,
64 all nicely done. But it doesn't for some mysterious reason. Please leave
65 commented unless it can be fixed proper. For the time being, the
66 copyright/license declarations will be in their own sgml.
67
68 Hal.
69
70
71 -->
72
73
74 <abstract>
75
76 <![%dummy;[
77  <para>
78  <comment>
79   This is here to keep vim syntax file from breaking :/
80   If I knew enough to fix it, I would.
81   PLEASE DO NOT REMOVE! HB: hal@foobox.net
82  </comment>
83  </para>
84 ]]>
85
86  <para>
87   The <citetitle>Privoxy User Manual</citetitle> gives users information on how to
88   install, configure and use <ulink
89   url="https://www.privoxy.org/">Privoxy</ulink>.
90  </para>
91
92 <!-- Include privoxy.sgml boilerplate: -->
93  &p-intro;
94 <!-- end privoxy.sgml -->
95
96  <para>
97   You can find the latest version of the <citetitle>Privoxy User Manual</citetitle> at  <ulink
98   url="https://www.privoxy.org/user-manual/">https://www.privoxy.org/user-manual/</ulink>.
99   Please see the <link linkend="contact">Contact section</link> on how to
100   contact the developers.
101  </para>
102
103 </abstract>
104
105 </artheader>
106
107 <!--   ~~~~~       New section      ~~~~~     -->
108 <sect1 label="1" id="introduction"><title>Introduction</title>
109 <para>
110  This documentation is included with the current &p-status; version of
111  <application>Privoxy</application>, &p-version;<![%p-not-stable;[,
112  and is mostly complete at this point. The most up to date reference for the
113  time being is still the comments in the source files and in the individual
114  configuration files. Development of a new version is currently nearing
115  completion, and includes significant changes and enhancements over
116  earlier versions]]>.
117 </para>
118
119 <!-- include only in non-stable versions -->
120 <![%p-not-stable;[
121 <para>
122  Since this is a &p-status; version, not all new features are well tested. This
123  documentation may be slightly out of sync as a result (especially with
124  <ulink url="https://www.privoxy.org/gitweb/?p=privoxy.git;a=summary">git sources</ulink>).
125  And there <emphasis>may be</emphasis> bugs, though hopefully
126  not many!
127 </para>
128 ]]>
129
130 <!--   ~~~~~       New section      ~~~~~     -->
131 <sect2 id="features"><title>Features</title>
132 <para>
133  In addition to the core
134  features of ad blocking and
135  <ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookie</ulink> management,
136  <application>Privoxy</application> provides many supplemental
137  features<![%p-not-stable;[, some of them currently under development]]>,
138  that give the end-user more control, more privacy and more freedom:
139 </para>
140 <!-- Include newfeatures.sgml boilerplate here: -->
141  &newfeatures;
142 <!-- end boilerplate -->
143 </sect2>
144
145 </sect1>
146
147 <!--  ~  End section  ~  -->
148
149
150 <!--   ~~~~~       New section      ~~~~~     -->
151 <sect1 id="installation"><title>Installation</title>
152
153 <para>
154  <application>Privoxy</application> is available both in convenient pre-compiled
155  packages for a wide range of operating systems, and as raw source code.
156  For most users, we recommend using the packages, which can be downloaded from our
157  <ulink url="https://sourceforge.net/projects/ijbswa/">Privoxy Project
158  Page</ulink>.
159 </para>
160
161 <para>
162  Note:
163  On some platforms, the installer may remove previously installed versions, if
164  found. (See below for your platform). In any case <emphasis>be sure to backup
165  your old configuration if it is valuable to you.</emphasis> See the <link
166  linkend="upgradersnote">note to upgraders</link> section below.
167 </para>
168
169 <!--   ~~~~~       New section      ~~~~~     -->
170 <sect2 id="installation-packages"><title>Binary Packages</title>
171 <para>
172 How to install the binary packages depends on your operating system:
173 </para>
174
175 <!-- XXX: The installation sections should be sorted -->
176
177 <!--   ~~~~~       New section      ~~~~~     -->
178 <sect3 id="installation-deb"><title>Debian and Ubuntu</title>
179 <para>
180  DEBs can be installed with <literal>apt-get install privoxy</literal>,
181  and will use <filename>/etc/privoxy</filename> for the location of
182  configuration files.
183 </para>
184 </sect3>
185
186 <!--   ~~~~~       New section      ~~~~~     -->
187 <sect3 id="installation-pack-win"><title>Windows</title>
188
189 <para>
190  Just double-click the installer, which will guide you through
191  the installation process. You will find the configuration files
192  in the same directory as you installed <application>Privoxy</application> in.
193 </para>
194 <para>
195  Version 3.0.5 beta introduced full <application>Windows</application> service
196  functionality. On Windows only, the <application>Privoxy</application>
197  program has two new command line arguments to install and uninstall
198  <application>Privoxy</application> as a <emphasis>service</emphasis>.
199 </para>
200  <variablelist>
201   <varlistentry>
202    <term>Arguments:</term>
203    <listitem>
204     <para>
205      <replaceable class="parameter">--install</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
206     </para>
207     <para>
208      <replaceable class="parameter">--uninstall</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
209     </para>
210    </listitem>
211   </varlistentry>
212  </variablelist>
213  <para>
214  After invoking <application>Privoxy</application> with
215  <command>--install</command>, you will need to bring up the
216  <application>Windows</application> service console to assign the user you
217  want <application>Privoxy</application> to run under, and whether or not you
218  want it to run whenever the system starts. You can start the
219  <application>Windows</application> services console with the following
220  command: <command>services.msc</command>.  If you do not take the manual step
221  of modifying <application>Privoxy's</application> service settings, it will
222  not start.  Note too that you will need to give Privoxy a user account that
223  actually exists, or it will not be permitted to
224  write to its log and configuration files.
225 </para>
226
227 </sect3>
228
229 <!--   ~~~~~       New section      ~~~~~     -->
230 <sect3 id="installation-os2"><title>OS/2</title>
231
232 <para>
233  First, make sure that no previous installations of
234  <application>Junkbuster</application> and / or
235  <application>Privoxy</application> are left on your
236  system. Check that no <application>Junkbuster</application>
237  or <application>Privoxy</application> objects are in
238  your startup folder.
239 </para>
240
241 <para>
242  Then, just double-click the WarpIN self-installing archive, which will
243  guide you through the installation process. A shadow of the
244  <application>Privoxy</application> executable will be placed in your
245  startup folder so it will start automatically whenever OS/2 starts.
246 </para>
247
248 <para>
249  The directory you choose to install <application>Privoxy</application>
250  into will contain all of the configuration files.
251 </para>
252 </sect3>
253
254 <!--   ~~~~~       New section      ~~~~~     -->
255 <sect3 id="installation-mac"><title>Mac OS X</title>
256 <para>
257  Installation instructions for the OS X platform depend upon whether
258  you downloaded a ready-built installation package (.pkg or .mpkg) or have
259  downloaded the source code.
260 </para>
261 </sect3>
262 <sect3 renderas="sect4" id="OS-X-install-from-package">
263 <title>Installation from ready-built package</title>
264 <para>
265  The downloaded file will either be a .pkg (for OS X 10.5 upwards) or a bzipped
266  .mpkg file (for OS X 10.4). The former can be double-clicked as is and the
267  installation will start; double-clicking the latter will unzip the .mpkg file
268  which can then be double-clicked to commence the installation.
269 </para>
270 <para>
271  The privoxy service will automatically start after a successful installation
272  (and thereafter every time your computer starts up) however you will need to
273  configure your web browser(s) to use it. To do so, configure them to use a
274  proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
275 </para>
276 <para>
277  To prevent the privoxy service from automatically starting when your computer
278  starts up, remove or rename the file <literal>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</literal>
279  (on OS X 10.5 and higher) or the folder named
280  <literal>/Library/StartupItems/Privoxy</literal> (on OS X 10.4 'Tiger').
281 </para>
282 <para>
283  To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
284  and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
285  administrator account, using sudo.
286 </para>
287 <para>
288  To uninstall, run /Applications/Privoxy/uninstall.command as sudo from an
289  administrator account.
290 </para>
291 </sect3>
292 <sect3 renderas="sect4" id="OS-X-install-from-source">
293 <title>Installation from source</title>
294 <para>
295  To build and install the Privoxy source code on OS X you will need to obtain
296  the macsetup module from the Privoxy Sourceforge CVS repository (refer to
297  Sourceforge help for details of how to set up a CVS client to have read-only
298  access to the repository). This module contains scripts that leverage the usual
299  open-source tools (available as part of Apple's free of charge Xcode
300  distribution or via the usual open-source software package managers for OS X
301  (MacPorts, Homebrew, Fink etc.) to build and then install the privoxy binary
302  and associated files. The macsetup module's README file contains complete
303  instructions for its use.
304 </para>
305 <para>
306  The privoxy service will automatically start after a successful installation
307  (and thereafter every time your computer starts up) however you will need to
308  configure your web browser(s) to use it. To do so, configure them to use a
309  proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
310 </para>
311 <para>
312  To prevent the privoxy service from automatically starting when your computer
313  starts up, remove or rename the file <literal>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</literal>
314  (on OS X 10.5 and higher) or the folder named
315  <literal>/Library/StartupItems/Privoxy</literal> (on OS X 10.4 'Tiger').
316 </para>
317 <para>
318  To manually start or stop the privoxy service, use the Privoxy Utility
319  for Mac OS X (also part of the macsetup module).  This application can start
320  and stop the privoxy service and display its log and configuration files.
321 </para>
322 <para>
323  To uninstall, run the macsetup module's uninstall.sh as sudo from an
324  administrator account.
325 </para>
326 </sect3>
327
328 <!--   ~~~~~       New section      ~~~~~     -->
329 <sect3 id="installation-freebsd"><title>FreeBSD</title>
330
331 <para>
332  Privoxy is part of FreeBSD's Ports Collection, you can build and install
333  it with <literal>cd /usr/ports/www/privoxy; make install clean</literal>.
334 </para>
335 </sect3>
336
337 </sect2>
338
339 <!--   ~~~~~       New section      ~~~~~     -->
340 <sect2 id="installation-source"><title>Building from Source</title>
341
342 <para>
343  The most convenient way to obtain the <application>Privoxy</application> source
344  code is to download the source tarball from our
345  <ulink url="https://sourceforge.net/projects/ijbswa/files/Sources/">
346     project download page</ulink>,
347  or you can get the up-to-the-minute, possibly unstable, development version from
348  <ulink url="https://www.privoxy.org/">https://www.privoxy.org/</ulink>.
349 </para>
350
351 <!-- include buildsource.sgml boilerplate: -->
352 &buildsource;
353 <!-- end boilerplate -->
354
355
356     <sect3 id="WINBUILD-CYGWIN"><title>Windows</title>
357
358     <sect4 id="WINBUILD-SETUP"><title>Setup</title>
359       <para>
360         Install the Cygwin utilities needed to build <application>Privoxy</application>.
361         If you have a 64 bit CPU (which most people do by now), get the
362         Cygwin setup-x86_64.exe program <ulink url="https://cygwin.com/setup-x86_64.exe">here</ulink>
363         (the .sig file is <ulink url="https://cygwin.com/setup-x86_64.exe.sig">here</ulink>).
364       </para>
365       <para>
366         Run the setup program and from View / Category select:
367       </para>
368       <screen>
369   Devel
370     autoconf 2.5
371     automake 1.15
372     binutils
373     cmake
374     gcc-core
375     gcc-g++
376     git
377     make
378     mingw64-i686-gcc-core
379     mingw64-i686-zlib
380   Editors
381     vim
382   Libs
383     libxslt: GNOME XSLT library (runtime)
384   Net
385     curl
386     openssh
387   Text
388     docbook-dssl
389     docbook-sgml31
390     docbook-utils
391     openjade
392   Utils
393     gnupg
394   Web
395     w3m
396 </screen>
397
398       <para>
399         If you haven't already downloaded the Privoxy source code, get it now:
400       </para>
401       <screen>
402   mkdir &lt;root-dir>
403   cd &lt;root-dir>
404   git clone https://www.privoxy.org/git/privoxy.git
405 </screen>
406
407       <para>
408         Get the source code (.zip or .tar.gz) for tidy from
409         <ulink url="https://github.com/htacg/tidy-html5/releases">
410                     https://github.com/htacg/tidy-html5/releases</ulink>,
411         unzip into &lt;root-dir> and build the software:
412       </para>
413       <screen>
414   cd &lt;root-dir>
415   cd tidy-html5-x.y.z/build/cmake
416   cmake ../.. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIB:BOOL=OFF -DCMAKE_INSTALL_PREFIX=/usr/local
417   make && make install
418 </screen>
419
420       <para>
421         If you want to be able to make a Windows release package, get the NSIS .zip file from
422             <!-- FIXME:  which version(s) are known to work? -->
423         <ulink url="https://sourceforge.net/projects/nsis/files/NSIS%203/">
424                     https://sourceforge.net/projects/nsis/files/NSIS%203/</ulink>
425         and extract the NSIS directory to <literal>privoxy/windows</literal>.
426         Then edit the windows/GNUmakefile to set the location of the NSIS executable - eg:
427       </para>
428       <screen>
429 # Path to NSIS
430 MAKENSIS = ./nsis/makensis.exe
431 </screen>
432
433       </sect4>
434
435       <sect4 id="WINBUILD-BUILD"><title>Build</title>
436
437       <para>
438         To build just the Privoxy executable and not the whole installation package, do:
439       </para>
440       <programlisting>
441   cd &lt;root-dir>/privoxy
442   ./windows/MYconfigure && make
443 </programlisting>
444
445       <para>
446         Privoxy uses the <ulink url="https://en.wikipedia.org/wiki/GNU_build_system">GNU Autotools</ulink>
447         for building software, so the process is:
448       </para>
449       <programlisting>
450   $ autoheader              # creates config.h.in
451   $ autoconf                # uses config.h.in to create the configure shell script
452   $ ./configure [options]   # creates GNUmakefile
453   $ make        [options]   # builds the program
454 </programlisting>
455
456       <para>
457         The usual <literal>configure</literal> options for building a native Windows application under cygwin are
458       </para>
459
460       <literallayout class="Monospaced">
461   --host=i686-w64-mingw32
462   --enable-mingw32
463   --enable-zlib
464   --enable-static-linking
465   --disable-pthread
466   --disable-dynamic-pcre
467 </literallayout>
468
469       <para>
470         You can set the <literal>CFLAGS</literal> and <literal>LDFLAGS</literal> envars before
471         running <literal>configure</literal> to set compiler and linker flags.  For example:
472       </para>
473
474       <programlisting>
475   $ export CFLAGS="-O2"              # set gcc optimization level
476   $ export LDFLAGS="-Wl,--nxcompat"  # Enable DEP
477   $ ./configure --host=i686-w64-mingw32 --enable-mingw32  --enable-zlib \
478   >             --enable-static-linking --disable-pthread --disable-dynamic-pcre
479   $ make                             # build Privoxy
480 </programlisting>
481
482       <para>
483         See the <ulink url="../developer-manual/newrelease.html#NEWRELEASE-WINDOWS">Developer's Manual</ulink>
484         for building a Windows release package.
485       </para>
486
487     </sect4>
488     </sect3>
489 </sect2>
490
491
492 <!--   ~~~~~       New section      ~~~~~     -->
493 <sect2 id="installation-keepupdated"><title>Keeping your Installation Up-to-Date</title>
494
495 <para>
496  If you wish to receive an email notification whenever we release updates of
497  <application>Privoxy</application> or the actions file, <ulink
498  url="https://lists.privoxy.org/mailman/listinfo/privoxy-announce">subscribe
499  to our announce mailing list</ulink>, privoxy-announce@lists.privoxy.org.
500 </para>
501
502 <para>
503  In order not to lose your personal changes and adjustments when updating
504  to the latest <literal>default.action</literal> file we <emphasis>strongly
505  recommend</emphasis> that you use <literal>user.action</literal> and
506  <literal>user.filter</literal> for your local
507  customizations of <application>Privoxy</application>. See the <link
508  linkend="actions-file">Chapter on actions files</link> for details.
509 </para>
510
511 </sect2>
512
513
514 </sect1>
515
516 <!--  ~  End section  ~  -->
517
518 <!--   ~~~~~       New section      ~~~~~     -->
519 <sect1 id="whatsnew">
520 <title>What's New in this Release</title>
521
522 &changelog;
523
524 <!--   ~~~~~       New section      ~~~~~     -->
525
526 <sect2 id="upgradersnote">
527 <title>Note to Upgraders</title>
528
529 <para>
530  A quick list of things to be aware of before upgrading from earlier
531  versions of <application>Privoxy</application>:
532 </para>
533
534  <itemizedlist>
535
536  <listitem>
537   <para>
538    The recommended way to upgrade &my-app; is to backup your old
539    configuration files, install the new ones, verify that &my-app;
540    is working correctly and finally merge back your changes using
541    <application>diff</application> and maybe <application>patch</application>.
542   </para>
543   <para>
544    There are a number of new features in each &my-app; release and
545    most of them have to be explicitly enabled in the configuration
546    files. Old configuration files obviously don't do that and due
547    to syntax changes using old configuration files with a new
548    &my-app; isn't always possible anyway.
549   </para>
550  </listitem>
551  <listitem>
552   <para>
553     Note that some installers remove earlier versions completely,
554     including configuration files, therefore you should really save
555     any important configuration files!
556   </para>
557  </listitem>
558  <listitem>
559   <para>
560    On the other hand, other installers don't overwrite existing configuration
561    files, thinking you will want to do that yourself.
562   </para>
563  </listitem>
564  <listitem>
565   <para>
566    In the default configuration only fatal errors are logged now.
567    You can change that in the <link linkend="DEBUG">debug section</link>
568    of the configuration file. You may also want to enable more verbose
569    logging until you verified that the new &my-app; version is working
570    as expected.
571   </para>
572  </listitem>
573
574  <listitem>
575     <para>
576      Three other config file settings are now off by default:
577      <link linkend="enable-remote-toggle">enable-remote-toggle</link>,
578      <link linkend="enable-remote-http-toggle">enable-remote-http-toggle</link>,
579      and  <link linkend="enable-edit-actions">enable-edit-actions</link>.
580      If you use or want these, you will need to explicitly enable them, and
581      be aware of the security issues involved.
582     </para>
583   </listitem>
584
585 <!--
586  <listitem>
587   <para>
588    What constitutes a <quote>default</quote> configuration has changed,
589    and you may want to review which actions are <quote>on</quote> by
590    default. This is primarily a matter of emphasis, but some features
591    you may have been used to, may now be <quote>off</quote> by default.
592    There are also a number of new actions and filters you may want to
593    consider, most of which are not fully incorporated into the default
594    settings as yet (see above).
595   </para>
596  </listitem>
597 -->
598 <!--
599   <listitem>
600    <para>
601     The default actions setting is now <literal>Cautious</literal>. Previous
602     releases had a default setting of <literal>Medium</literal>. Experienced
603     users may want to adjust this, as it is fairly conservative by &my-app;
604     standards and past practices. See <ulink
605     url="http://config.privoxy.org/edit-actions-list?f=default">
606     http://config.privoxy.org/edit-actions-list?f=default</ulink>. New users
607     should try the default settings for a while before turning up the volume.
608    </para>
609   </listitem>
610
611   <listitem>
612    <para>
613     The default setting has filtering turned <emphasis>off</emphasis>, which
614     subsequently means that compression is <emphasis>on</emphasis>. Remember
615     that filtering does not work on compressed pages, so if you use, or want to
616     use, filtering, you will need to force compression off. Example:
617    </para>
618  <screen>
619   { +<link linkend="filter">filter</link>{google}  +<link linkend="prevent-compression">prevent-compression</link> }
620    .google.</screen>
621    <para>
622     Or if you use a number of filters, or filter many sites, you may just want
623     to turn off compression for all sites in
624     <filename>default.action</filename> (or
625     <filename>user.action</filename>).
626    </para>
627
628   </listitem>
629
630   <listitem>
631   <para>
632    Also, <link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> is
633    off by default now. If you've liked this feature in the past, you may want
634    to turn it back on in <filename>user.action</filename> now.
635   </para>
636   </listitem>
637
638
639   <listitem>
640   <para>
641    Some installers may not automatically start
642    <application>Privoxy</application> after installation.
643   </para>
644  </listitem>
645 -->
646
647  </itemizedlist>
648
649 </sect2>
650 </sect1>
651
652 <!--   ~~~~~       New section      ~~~~~     -->
653 <sect1 id="quickstart"><title>Quickstart to Using Privoxy</title>
654
655  <itemizedlist>
656
657  <listitem>
658   <para>
659   Install <application>Privoxy</application>. See the <link
660   linkend="installation">Installation Section</link> below for platform specific
661   information.
662  </para>
663  </listitem>
664
665  <listitem>
666   <para>
667    Advanced users and those who want to offer <application>Privoxy</application>
668    service to more than just their local machine should check the <link
669    linkend="config">main config file</link>, especially the <link
670    linkend="access-control">security-relevant</link> options. These are
671    off by default.
672   </para>
673  </listitem>
674
675  <listitem>
676   <para>
677   Start <application>Privoxy</application>, if the installation program has
678   not done this already (may vary according to platform). See the section
679   <link linkend="startup">Starting <application>Privoxy</application></link>.
680   </para>
681  </listitem>
682
683  <listitem>
684   <para>
685    Set your browser to use <application>Privoxy</application> as HTTP and
686    HTTPS (SSL)  <ulink url="http://en.wikipedia.org/wiki/Proxy_server">proxy</ulink>
687    by setting the proxy configuration for address of
688    <literal>127.0.0.1</literal> and port <literal>8118</literal>.
689    <emphasis>DO NOT</emphasis> activate proxying for <literal>FTP</literal> or
690    any protocols besides HTTP and HTTPS (SSL) unless you intend to prevent your
691    browser from using these protocols.
692   </para>
693  </listitem>
694
695  <listitem>
696   <para>
697     Flush your browser's disk and memory caches, to remove any cached ad images.
698     If using <application>Privoxy</application> to manage
699     <ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookies</ulink>,
700     you should remove any currently stored cookies too.
701   </para>
702  </listitem>
703
704  <listitem>
705   <para>
706    A default installation should provide a reasonable starting point for
707    most. There will undoubtedly be occasions where you will want to adjust the
708    configuration, but that can be dealt with as the need arises. Little
709    to no initial configuration is required in most cases, you may want
710    to enable the
711    <ulink url="config.html#ENABLE-EDIT-ACTIONS">web-based action editor</ulink> though.
712    Be sure to read the warnings first.
713   </para>
714   <para>
715    See the <link linkend="configuration">Configuration section</link> for more
716    configuration options, and how to customize your installation.
717    You might also want to look at the <link
718    linkend="quickstart-ad-blocking">next section</link> for a quick
719    introduction to how <application>Privoxy</application> blocks ads and
720    banners.
721 </para>
722  </listitem>
723
724  <listitem>
725   <para>
726     If you experience ads that slip through, innocent images that are
727     blocked, or otherwise feel the need to fine-tune
728     <application>Privoxy's</application> behavior, take a look at the <link
729     linkend="actions-file">actions files</link>. As a quick start, you might
730     find the <link linkend="act-examples">richly commented examples</link>
731     helpful. You can also view and edit the actions files through the <ulink
732     url="http://config.privoxy.org">web-based user interface</ulink>. The
733     Appendix <quote><link linkend="actionsanat">Troubleshooting: Anatomy of an
734     Action</link></quote> has hints on how to understand and debug actions that
735     <quote>misbehave</quote>.
736   </para>
737  </listitem>
738
739  <listitem>
740   <para>
741    Please see the section <link linkend="contact">Contacting the
742    Developers</link> on how to report bugs, problems with websites or to get
743    help.
744   </para>
745  </listitem>
746
747  <listitem>
748   <para>
749    Now enjoy surfing with enhanced control, comfort and privacy!
750   </para>
751  </listitem>
752
753  </itemizedlist>
754
755
756 <!--   ~~~~~       New section      ~~~~~     -->
757
758 <sect2 id="quickstart-ad-blocking">
759 <title>Quickstart to Ad Blocking</title>
760 <!--
761  NOTE:  This section is deliberately redundant for those that don't
762  want to read the whole thing (which is getting lengthy).
763 -->
764 <para>
765  Ad blocking is but one of <application>Privoxy's</application>
766  array of features. Many of these features are for the technically minded advanced
767  user. But, ad and banner blocking is surely common ground for everybody.
768 </para>
769 <para>
770  This section will provide a quick summary of ad blocking so
771  you can get up to speed quickly without having to read the more extensive
772  information provided below, though this is highly recommended.
773 </para>
774 <para>
775  First a bit of a warning ... blocking ads is much like blocking SPAM: the
776  more aggressive you are about it, the more likely you are to block
777  things that were not intended. And the more likely that some things
778  may not work as intended. So there is a trade off here. If you want
779  extreme ad free browsing, be prepared to deal with more
780  <quote>problem</quote> sites, and to spend more time adjusting the
781  configuration to solve these unintended consequences. In short, there is
782  not an easy way to eliminate <emphasis>all</emphasis> ads. Either take
783  the easy way and settle for <emphasis>most</emphasis> ads blocked with the
784  default configuration, or jump in and tweak it for your personal surfing
785  habits and preferences.
786 </para>
787 <para>
788  Secondly, a brief explanation of <application>Privoxy's </application>
789  <quote>actions</quote>. <quote>Actions</quote> in this context, are
790  the directives we use to tell <application>Privoxy</application> to perform
791  some task relating to HTTP transactions (i.e. web browsing). We tell
792  <application>Privoxy</application> to take some <quote>action</quote>. Each
793  action has a unique name and function. While there are many potential
794  <application>actions</application> in <application>Privoxy's</application>
795  arsenal, only a few are used for ad blocking. <link
796  linkend="actions">Actions</link>, and <link linkend="actions-file">action
797  configuration files</link>, are explained in depth below.
798 </para>
799 <para>
800  Actions are specified in <application>Privoxy's</application> configuration,
801  followed by one or more URLs to which the action should apply. URLs
802  can actually be URL type <link linkend="af-patterns">patterns</link> that use
803  wildcards so they can apply potentially to a range of similar URLs. The
804  actions, together with the URL patterns are called a section.
805 </para>
806 <para>
807  When you connect to a website, the full URL will either match one or more
808  of the sections as defined in <application>Privoxy's</application> configuration,
809  or not. If so, then <application>Privoxy</application> will perform the
810  respective actions. If not, then nothing special happens. Furthermore, web
811  pages may contain embedded, secondary URLs that your web browser will
812  use to load additional components of the page, as it parses the
813  original page's HTML content. An ad image for instance, is just an URL
814  embedded in the page somewhere. The image itself may be on the same server,
815  or a server somewhere else on the Internet. Complex web pages will have many
816  such embedded URLs. &my-app; can deal with each URL individually, so, for
817  instance, the main page text is not touched, but images from such-and-such
818  server are blocked.
819 </para>
820
821 <para>
822  The most important actions for basic ad blocking are:  <literal><link
823  linkend="block">block</link></literal>, <literal><link
824  linkend="handle-as-image">handle-as-image</link></literal>,
825  <literal><link
826  linkend="handle-as-empty-document">handle-as-empty-document</link></literal>,and
827  <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>:
828 </para>
829
830  <itemizedlist>
831
832  <listitem>
833   <para>
834    <literal><link linkend="block">block</link></literal> - this is perhaps
835    the single most used action, and is particularly important for ad blocking.
836    This action stops any contact between your browser and any URL patterns
837    that match this action's configuration. It can be used for blocking ads,
838    but also anything that is determined to be unwanted. By itself, it simply
839    stops any communication with the remote server and sends
840    <application>Privoxy</application>'s own built-in BLOCKED page instead to
841    let you now what has happened (with some exceptions, see below).
842   </para>
843  </listitem>
844
845  <listitem>
846   <para>
847    <literal><link linkend="handle-as-image">handle-as-image</link></literal> -
848    tells <application>Privoxy</application> to treat this URL as an image.
849    <application>Privoxy</application>'s default configuration already does this
850    for all common image types (e.g. GIF), but there are many situations where this
851    is not so easy to determine. So we'll force it in these cases. This is particularly
852    important for ad blocking, since  only if we know that it's an image of
853    some kind, can we replace it with an image of our choosing, instead of the
854    <application>Privoxy</application> BLOCKED page (which would only result in
855    a <quote>broken image</quote> icon). There are some limitations to this
856    though. For instance, you can't just brute-force an image substitution for
857    an entire HTML page in most situations.
858   </para>
859  </listitem>
860
861  <listitem>
862   <para>
863    <literal><link linkend="handle-as-empty-document">handle-as-empty-document</link></literal> -
864    sends an empty document instead of <application>Privoxy's</application>
865    normal BLOCKED HTML page. This is useful for file types that are neither
866    HTML nor images, such as blocking JavaScript files.
867   </para>
868  </listitem>
869
870  <listitem>
871   <para>
872    <literal><link
873    linkend="set-image-blocker">set-image-blocker</link></literal> - tells
874    <application>Privoxy</application> what to display in place of an ad image that
875    has hit a block rule. For this to come into play, the URL must match a
876    <literal><link linkend="block">block</link></literal> action somewhere in the
877    configuration, <emphasis>and</emphasis>, it must also match an
878    <literal><link linkend="handle-as-image">handle-as-image</link></literal> action.
879   </para>
880   <para>
881    The configuration options on what to display instead of the ad are:
882   </para>
883   <simplelist>
884    <member>
885     &nbsp;&nbsp;&nbsp;<emphasis>pattern</emphasis> - a checkerboard pattern, so that an ad
886     replacement is obvious. This is the default.
887    </member>
888   </simplelist>
889   <simplelist>
890    <member>
891     &nbsp;&nbsp;&nbsp;<emphasis>blank</emphasis> - A very small empty GIF image is displayed.
892     This is the so-called <quote>invisible</quote> configuration option.
893    </member>
894   </simplelist>
895   <simplelist>
896    <member>
897     &nbsp;&nbsp;&nbsp;<emphasis>http://&lt;URL&gt;</emphasis> - A redirect to any image anywhere
898     of the user's choosing (advanced usage).
899    </member>
900   </simplelist>
901   </listitem>
902
903 </itemizedlist>
904
905 <para>
906  Advanced users will eventually want to explore &my-app;
907  <literal><link linkend="filter">filters</link></literal> as well. Filters
908  are very different from <literal><link
909  linkend="block">blocks</link></literal>.
910  A <quote>block</quote> blocks a site, page, or unwanted contented. Filters
911  are a way of filtering or modifying what is actually on the page. An example
912  filter usage: a text replacement of <quote>no-no</quote> for
913  <quote>nasty-word</quote>. That is a very simple example. This process can be
914  used for ad blocking, but it is more in the realm of advanced usage and has
915  some pitfalls to be wary off.
916 </para>
917
918 <para>
919  The quickest way to adjust any of these settings is with your browser through
920  the special <application>Privoxy</application> editor at <ulink
921  url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
922  (shortcut: <ulink url="http://p.p/">http://p.p/show-status</ulink>). This
923  is an internal page, and does not require Internet access.
924 </para>
925
926 <para>
927  Note that as of <application>Privoxy</application> 3.0.7 beta the
928  action editor is disabled by default. Check the
929  <ulink url="config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions
930   section in the configuration file</ulink> to learn why and in which
931  cases it's safe to enable again.
932 </para>
933
934 <para>
935  If you decided to enable the action editor, select the appropriate
936  <quote>actions</quote> file, and click
937  <quote><guibutton>Edit</guibutton></quote>. It is best to put personal or
938  local preferences in <filename>user.action</filename> since this is not
939  meant to be overwritten during upgrades, and will over-ride the settings in
940  other files. Here you can insert new <quote>actions</quote>, and URLs for ad
941  blocking or other purposes, and make other adjustments to the configuration.
942  <application>Privoxy</application> will detect these changes automatically.
943 </para>
944
945 <para>
946  A quick and simple step by step example:
947 </para>
948
949  <itemizedlist>
950
951   <listitem>
952    <para>
953      Right click on the ad image to be blocked, then select
954      <quote><guimenuitem>Copy Link Location</guimenuitem></quote> from the
955      pop-up menu.
956    </para>
957   </listitem>
958   <listitem>
959    <para>
960     Set your browser to
961     <ulink
962  url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
963    </para>
964   </listitem>
965   <listitem>
966    <para>
967     Find <filename>user.action</filename> in the top section, and click
968     on <quote><guibutton>Edit</guibutton></quote>:
969    </para>
970
971  <!-- image of editor and actions files selections -->
972   <figure pgwide="0" float="0"><title>Actions Files in Use</title>
973    <mediaobject>
974      <imageobject>
975       <imagedata  fileref="files-in-use.jpg" format="jpg">
976        </imageobject>
977        <textobject>
978         <phrase>[ Screenshot of Actions Files in Use ]</phrase>
979       </textobject>
980    </mediaobject>
981   </figure>
982  </listitem>
983
984  <listitem>
985   <para>
986    You should have a section with only
987    <literal><link linkend="block">block</link></literal> listed under
988    <quote>Actions:</quote>.
989    If not, click a <quote><guibutton>Insert new section below</guibutton></quote>
990    button, and in the new section that just appeared, click the
991    <guibutton>Edit</guibutton> button right under the word <quote>Actions:</quote>.
992    This will bring up a list of all actions. Find
993    <literal><link linkend="block">block</link></literal> near the top, and click
994    in the <quote>Enabled</quote> column, then <quote><guibutton>Submit</guibutton></quote>
995    just below the list.
996   </para>
997  </listitem>
998  <listitem>
999   <para>
1000    Now, in the <literal><link linkend="block">block</link></literal> actions section,
1001    click the <quote><guibutton>Add</guibutton></quote> button, and paste the URL the
1002    browser got from <quote><guimenuitem>Copy Link Location</guimenuitem></quote>.
1003    Remove the <literal>http://</literal> at the beginning of the URL. Then, click
1004    <quote><guibutton>Submit</guibutton></quote> (or
1005    <quote><guibutton>OK</guibutton></quote> if in a pop-up window).
1006   </para>
1007  </listitem>
1008  <listitem>
1009   <para>
1010    Now go back to the original page, and press <keycap>SHIFT-Reload</keycap>
1011    (or flush all browser caches). The image should be gone now.
1012   </para>
1013  </listitem>
1014
1015  </itemizedlist>
1016
1017 <para>
1018  This is a very crude and simple example. There might be good reasons to use a
1019  wildcard pattern match to include potentially similar images from the same
1020  site. For a more extensive explanation of <quote>patterns</quote>, and
1021  the entire actions concept, see <link linkend="actions-file">the Actions
1022  section</link>.
1023 </para>
1024
1025 <para>
1026  For advanced users who want to hand edit their config files, you might want
1027  to now go to the <link linkend="act-examples">Actions Files Tutorial</link>.
1028  The ideas explained therein also apply to the web-based editor.
1029 </para>
1030 <para>
1031  There are also various
1032  <link linkend="filter">filters</link> that can be used for ad blocking
1033  (filters are a special subset of actions). These
1034  fall into the <quote>advanced</quote> usage category, and are explained in
1035  depth in later sections.
1036 </para>
1037
1038 </sect2>
1039
1040 </sect1>
1041
1042 <!--  ~  End section  ~  -->
1043
1044
1045 <!--   ~~~~~       New section      ~~~~~     -->
1046 <sect1 id="startup">
1047 <title>Starting Privoxy</title>
1048 <para>
1049  Before launching <application>Privoxy</application> for the first time, you
1050  will want to configure your browser(s) to use
1051  <application>Privoxy</application> as a HTTP and HTTPS (SSL)
1052  <ulink url="http://en.wikipedia.org/wiki/Proxy_server">proxy</ulink>. The default is
1053  127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions
1054  used port 8000). This is the one configuration step <emphasis>that must be done
1055 </emphasis>!
1056 </para>
1057 <para>
1058  Please note that <application>Privoxy</application> can only proxy HTTP and
1059  HTTPS traffic. It will not work with FTP or other protocols.
1060 </para>
1061
1062  <!-- image of Mozilla Proxy configuration -->
1063   <figure pgwide="0" float="0"><title>Proxy Configuration Showing
1064   Mozilla/Netscape HTTP and HTTPS (SSL) Settings</title>
1065    <mediaobject>
1066      <imageobject>
1067       <imagedata  fileref="proxy_setup.jpg" format="jpg">
1068        </imageobject>
1069        <textobject>
1070         <phrase>[ Screenshot of Mozilla Proxy Configuration ]</phrase>
1071       </textobject>
1072    </mediaobject>
1073   </figure>
1074
1075
1076 <para>
1077  With <application>Firefox</application>, this is typically set under:
1078 </para>
1079
1080 <literallayout>
1081  <guibutton>Tools</guibutton> -> <guibutton>Options</guibutton> ->  <guibutton>Advanced</guibutton> -> <guibutton>Network</guibutton> -><guibutton>Connection</guibutton> -> <guibutton>Settings</guibutton>
1082 </literallayout>
1083
1084 <para>
1085  Or optionally on some platforms:
1086 </para>
1087
1088 <literallayout>
1089  <guibutton>Edit</guibutton> -> <guibutton>Preferences</guibutton> -> <guibutton>General</guibutton> -> <guibutton>Connection Settings</guibutton> -> <guibutton>Manual Proxy Configuration</guibutton>
1090 </literallayout>
1091
1092
1093 <para>
1094  With <application>Netscape</application> (and
1095  <application>Mozilla</application>), this can be set under:
1096 </para>
1097
1098
1099 <literallayout>
1100 <!-- Mix ascii and gui art, something for everybody -->
1101 <!-- spacing on this is tricky -->
1102  <guibutton>Edit</guibutton> -> <guibutton>Preferences</guibutton> -> <guibutton>Advanced</guibutton> -> <guibutton>Proxies</guibutton> -> <guibutton>HTTP Proxy</guibutton>
1103 </literallayout>
1104
1105 <para>
1106  For <application>Internet Explorer v.5-7</application>:
1107 </para>
1108
1109 <literallayout>
1110  <guibutton>Tools</guibutton> -> <guibutton>Internet Options</guibutton> -> <guibutton>Connections</guibutton> -> <guibutton>LAN Settings</guibutton>
1111 </literallayout>
1112
1113 <para>
1114  Then, check <quote>Use Proxy</quote> and fill in the appropriate info
1115  (Address: 127.0.0.1, Port: 8118). Include HTTPS (SSL), if you want HTTPS
1116  proxy support too (sometimes labeled <quote>Secure</quote>). Make sure any
1117  checkboxes like <quote>Use the same proxy server for all protocols</quote> is
1118  <emphasis>UNCHECKED</emphasis>. You want only HTTP and HTTPS (SSL)!
1119 </para>
1120
1121  <!-- image of IE Proxy configuration -->
1122   <figure pgwide="0" float="0"><title>Proxy Configuration Showing
1123   Internet Explorer HTTP and HTTPS (Secure) Settings</title>
1124    <mediaobject>
1125      <imageobject>
1126       <imagedata  fileref="proxy2.jpg" format="jpg">
1127        </imageobject>
1128        <textobject>
1129         <phrase>[ Screenshot of IE Proxy Configuration ]</phrase>
1130       </textobject>
1131    </mediaobject>
1132   </figure>
1133
1134
1135 <para>
1136  After doing this, flush your browser's disk and memory caches to force a
1137  re-reading of all pages and to get rid of any ads that may be cached. Remove
1138  any <ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookies</ulink>,
1139  if you want <application>Privoxy</application> to manage that. You are now
1140  ready to start enjoying the benefits of using
1141  <application>Privoxy</application>!
1142 </para>
1143
1144 <para>
1145  <application>Privoxy</application> itself is typically started by specifying the
1146  main configuration file to be used on the command line. If no configuration
1147  file is specified on the command line, <application>Privoxy</application>
1148  will look for a file named <filename>config</filename> in the current
1149  directory. Except on Win32 where it will try <filename>config.txt</filename>.
1150 </para>
1151
1152 <sect2 id="start-debian">
1153 <title>Debian</title>
1154 <para>
1155  We use a script. Note that Debian typically starts &my-app; upon booting per
1156  default.  It will use the file
1157  <filename>/etc/privoxy/config</filename> as its main configuration
1158  file.
1159 </para>
1160  <screen>
1161  # /etc/init.d/privoxy start
1162 </screen>
1163 </sect2>
1164
1165 <sect2 id="start-freebsd">
1166 <title>FreeBSD and ElectroBSD</title>
1167 <para>
1168  To start <application>Privoxy</application> upon booting, add
1169  "privoxy_enable='YES'" to <filename>/etc/rc.conf</filename>.
1170  <application>Privoxy</application> will use
1171  <filename>/usr/local/etc/privoxy/config</filename> as its main
1172  configuration file.
1173 </para>
1174 <para>
1175  If you installed <application>Privoxy</application> into a jail, the
1176  paths above are relative to the jail root.
1177 </para>
1178 <para>
1179  To start <application>Privoxy</application> manually, run:
1180 </para>
1181  <screen>
1182  # service privoxy onestart
1183 </screen>
1184 </sect2>
1185
1186 <sect2 id="start-windows">
1187 <title>Windows</title>
1188 <para>
1189 Click on the &my-app; Icon to start <application>Privoxy</application>. If no configuration file is
1190  specified on the command line, <application>Privoxy</application> will look
1191  for a file named <filename>config.txt</filename>. Note that Windows will
1192  automatically start &my-app; when the system starts if you chose that option
1193  when installing.
1194 </para>
1195 <para>
1196  <application>Privoxy</application> can run with full Windows service functionality.
1197  On Windows only, the &my-app; program has two new command line arguments
1198  to install and uninstall &my-app; as a service. See the
1199  <link linkend="installation-pack-win">Windows Installation
1200  instructions</link> for details.
1201 </para>
1202 </sect2>
1203
1204 <sect2 id="start-unices">
1205 <title>Generic instructions for Unix derivates (Solaris, NetBSD, HP-UX etc.)</title>
1206 <para>
1207 Example Unix startup command:
1208 </para>
1209  <screen>
1210  # /usr/sbin/privoxy --user privoxy /etc/privoxy/config
1211 </screen>
1212 <para>
1213  Note that if you installed <application>Privoxy</application> through
1214  a package manager, the package will probably contain a platform-specific
1215  script or configuration file to start <application>Privoxy</application>
1216  upon boot.
1217 </para>
1218 </sect2>
1219
1220 <sect2 id="start-os2">
1221 <title>OS/2</title>
1222 <para>
1223  During installation, <application>Privoxy</application> is configured to
1224  start automatically when the system restarts. You can start it manually by
1225  double-clicking on the <application>Privoxy</application> icon in the
1226  <application>Privoxy</application> folder.
1227 </para>
1228 </sect2>
1229
1230 <sect2 id="start-macosx">
1231 <title>Mac OS X</title>
1232 <para>
1233  The privoxy service will automatically start after a successful installation
1234  (and thereafter every time your computer starts up) however you will need to
1235  configure your web browser(s) to use it. To do so, configure them to use a
1236  proxy for HTTP and HTTPS at the address 127.0.0.1:8118.
1237 </para>
1238 <para>
1239  To prevent the privoxy service from automatically starting when your computer
1240  starts up, remove or rename the file <literal>/Library/LaunchDaemons/org.ijbswa.privoxy.plist</literal>
1241  (on OS X 10.5 and higher) or the folder named
1242  <literal>/Library/StartupItems/Privoxy</literal> (on OS X 10.4 'Tiger').
1243 </para>
1244 <para>
1245  To manually start or stop the privoxy service, use the scripts startPrivoxy.sh
1246  and stopPrivoxy.sh supplied in /Applications/Privoxy. They must be run from an
1247  administrator account, using sudo.
1248 </para>
1249 </sect2>
1250
1251
1252 <!--
1253
1254 <para>
1255  See the section <link linkend="cmdoptions">Command line options</link> for
1256  further info.
1257 </para>
1258
1259 must find a better place for this paragraph
1260
1261 <para>
1262  The included default configuration files should give a reasonable starting
1263  point. Most of the per site configuration is done in the
1264  <ulink url="actions-file.html"><quote>actions</quote></ulink> files. These are
1265  where various cookie actions are defined, ad and banner blocking, and other
1266  aspects of <application>Privoxy</application> configuration. There are several
1267  such files included, with varying levels of aggressiveness.
1268 </para>
1269
1270 <para>
1271  You will probably want to keep an eye out for sites for which you may prefer
1272  persistent cookies, and add these to your actions configuration as needed. By
1273  default, most of these will be accepted only during the current browser
1274  session (aka <quote>session cookies</quote>), unless you add them to the
1275  configuration. If you want the browser to handle this instead, you will need
1276  to edit <filename>user.action</filename> (or through the web based interface)
1277  and disable this feature. If you use more than one browser, it would make
1278  more sense to let <application>Privoxy</application> handle this. In which
1279  case, the browser(s) should be set to accept all cookies.
1280 </para>
1281
1282 <para>
1283  Another feature where you will probably want to define exceptions for trusted
1284  sites is the popup-killing (through  <ulink
1285  url="actions-file.html#FILTER-POPUPS"><quote>+filter{popups}</quote></ulink>),
1286  because your favorite shopping, banking, or leisure site may need
1287  popups (explained below).
1288 </para>
1289
1290 <para>
1291  <application>Privoxy</application> does not support all of the optional HTTP/1.1
1292  features yet. In the unlikely event that you experience inexplicable problems
1293  with browsers that use HTTP/1.1 per default
1294  (like <application>Mozilla</application> or recent versions of I.E.), you might
1295  try to force HTTP/1.0 compatibility. For Mozilla, look under <literal>Edit -&gt;
1296  Preferences -&gt; Debug -&gt; Networking</literal>.
1297  Alternatively, set the <quote>+downgrade-http-version</quote> config option in
1298  <filename>default.action</filename> which will downgrade your browser's HTTP
1299  requests from HTTP/1.1 to HTTP/1.0 before processing them.
1300 </para>
1301
1302 <para>
1303  After running <application>Privoxy</application> for a while, you can
1304  start to fine tune the configuration to suit your personal, or site,
1305  preferences and requirements. There are many, many aspects that can
1306  be customized. <quote>Actions</quote>
1307  can be adjusted by pointing your browser to
1308  <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
1309  (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
1310  and then follow the link to <quote>View &#38; Change the Current Configuration</quote>.
1311  (This is an internal page and does not require Internet access.)
1312 </para>
1313
1314 <para>
1315  In fact, various aspects of <application>Privoxy</application>
1316  configuration can be viewed from this page, including
1317  current configuration parameters, source code version numbers,
1318  the browser's request headers, and <quote>actions</quote> that apply
1319  to a given URL. In addition to the actions file
1320  editor mentioned above, <application>Privoxy</application> can also
1321  be turned <quote>on</quote> and <quote>off</quote> (toggled) from this page.
1322 </para>
1323
1324 <para>
1325  If you encounter problems, try loading the page without
1326  <application>Privoxy</application>. If that helps, enter the URL where
1327  you have the problems into <ulink url="http://p.p/show-url-info">the browser
1328  based rule tracing utility</ulink>. See which rules apply and why, and
1329  then try turning them off for that site one after the other, until the problem
1330  is gone. When you have found the culprit, you might want to turn the rest on
1331  again.
1332 </para>
1333
1334 <para>
1335  If the above paragraph sounds gibberish to you, you might want to <link
1336  linkend="actions-file">read more about the actions concept</link>
1337  or even dive deep into the <link linkend="actionsanat">Appendix
1338  on actions</link>.
1339 </para>
1340
1341 <para>
1342  If you can't get rid of the problem at all, think you've found a bug in
1343  Privoxy, want to propose a new feature or smarter rules, please see the
1344  section <link linkend="contact"><quote>Contacting the
1345  Developers</quote></link> below.
1346 </para>
1347
1348 -->
1349
1350 <!--   ~~~~~       New section      ~~~~~     -->
1351 <sect2 id="cmdoptions">
1352 <title>Command Line Options</title>
1353 <para>
1354  <application>Privoxy</application> may be invoked with the following
1355  command-line options:
1356 </para>
1357
1358  <itemizedlist>
1359
1360  <listitem>
1361   <para>
1362    <emphasis>--config-test</emphasis>
1363   </para>
1364   <para>
1365    Exit after loading the configuration files before binding to
1366    the listen address. The exit code signals whether or not the
1367    configuration files have been successfully loaded.
1368   </para>
1369   <para>
1370    If the exit code is 1, at least one of the configuration files
1371    is invalid, if it is 0, all the configuration files have been
1372    successfully loaded (but may still contain errors that can
1373    currently only be detected at run time).
1374   </para>
1375   <para>
1376    This option doesn't affect the log setting, combination with
1377    <emphasis>--no-daemon</emphasis> is recommended if a configured
1378    log file shouldn't be used.
1379   </para>
1380  </listitem>
1381  <listitem>
1382   <para>
1383     <emphasis>--version</emphasis>
1384   </para>
1385   <para>
1386      Print version info and exit. Unix only.
1387   </para>
1388  </listitem>
1389  <listitem>
1390   <para>
1391     <emphasis>--help</emphasis>
1392   </para>
1393   <para>
1394    Print short usage info and exit. Unix only.
1395   </para>
1396  </listitem>
1397  <listitem>
1398   <para>
1399    <emphasis>--no-daemon</emphasis>
1400   </para>
1401   <para>
1402    Don't become a daemon, i.e. don't fork and become process group
1403    leader, and don't detach from controlling tty. Unix only.
1404   </para>
1405  </listitem>
1406  <listitem>
1407   <para>
1408    <emphasis>--pidfile FILE</emphasis>
1409   </para>
1410   <para>
1411    On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
1412    <emphasis>FILE</emphasis> on exit. Failure to create or delete the
1413    <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
1414    option is given, no PID file will be used. Unix only.
1415   </para>
1416  </listitem>
1417  <listitem>
1418   <para>
1419    <emphasis>--user USER[.GROUP]</emphasis>
1420   </para>
1421   <para>
1422    After (optionally) writing the PID file, assume the user  ID  of
1423    <emphasis>USER</emphasis>, and if included the GID of GROUP.  Exit if the
1424    privileges are not sufficient to do so. Unix only.
1425   </para>
1426  </listitem>
1427  <listitem>
1428   <para>
1429    <emphasis>--chroot</emphasis>
1430   </para>
1431   <para>
1432    Before changing to the user ID given in the <emphasis>--user</emphasis> option,
1433    chroot to that user's home directory, i.e. make the kernel pretend to the &my-app;
1434    process that the directory tree starts there. If set up carefully, this can limit
1435    the impact of possible vulnerabilities in &my-app; to the files contained in that hierarchy.
1436    Unix only.
1437   </para>
1438  </listitem>
1439  <listitem>
1440   <para>
1441    <emphasis>--pre-chroot-nslookup hostname</emphasis>
1442   </para>
1443   <para>
1444    Specifies a hostname (for example www.privoxy.org) to look up before doing a chroot.
1445    On some systems, initializing the resolver library involves reading config files from
1446    /etc and/or loading additional shared libraries from /lib.
1447    On these systems, doing a hostname lookup before the chroot reduces
1448    the number of files that must be copied into the chroot tree.
1449   </para>
1450   <para>
1451    For fastest startup speed, a good value is a hostname that is not in /etc/hosts but that
1452    your local name server (listed in /etc/resolv.conf) can resolve without recursion
1453    (that is, without having to ask any other name servers). The hostname need not exist,
1454    but if it doesn't, an error message (which can be ignored) will be output.
1455   </para>
1456  </listitem>
1457
1458  <listitem>
1459   <para>
1460     <emphasis>configfile</emphasis>
1461   </para>
1462   <para>
1463     If no <emphasis>configfile</emphasis> is included on the command line,
1464     <application>Privoxy</application> will look for a file named
1465     <quote>config</quote> in the current directory (except on Win32
1466     where it will look for <quote>config.txt</quote> instead). Specify
1467     full path to avoid confusion. If no config file is found,
1468     <application>Privoxy</application> will fail to start.
1469   </para>
1470  </listitem>
1471
1472  </itemizedlist>
1473
1474 <para>
1475  On <application>MS Windows</application> only there are two additional
1476  command-line options to allow <application>Privoxy</application> to install and
1477  run as a <emphasis>service</emphasis>. See the
1478 <link linkend="installation-pack-win">Window Installation section</link>
1479 for details.
1480 </para>
1481
1482 </sect2>
1483
1484 </sect1>
1485
1486 <!--  ~  End section  ~  -->
1487
1488
1489 <!--   ~~~~~       New section      ~~~~~     -->
1490 <sect1 id="configuration"><title>Privoxy Configuration</title>
1491  <para>
1492   All <application>Privoxy</application> configuration is stored
1493   in text files. These files can be edited with a text editor.
1494   Many important aspects of <application>Privoxy</application> can
1495   also be controlled easily with a web browser.
1496  </para>
1497
1498
1499 <!--   ~~~~~       New section      ~~~~~     -->
1500
1501 <sect2 id="control-with-webbrowser">
1502 <title>Controlling Privoxy with Your Web Browser</title>
1503 <para>
1504  <application>Privoxy</application>'s user interface can be reached through the special
1505  URL <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
1506  (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
1507  which is a built-in page and works without Internet access.
1508  You will see the following section:
1509 </para>
1510
1511 <!-- Needs to be put in a table and colorized  -->
1512 <screen><!-- want the background color that goes with screen -->
1513  <msgtext>
1514  <bridgehead renderas="sect2">&nbsp;&nbsp;&nbsp;&nbsp;Privoxy Menu</bridgehead>
1515  <simplelist>
1516  <member>
1517   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://config.privoxy.org/show-status">View & change the current configuration</ulink>
1518  </member>
1519  <member>
1520   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://config.privoxy.org/show-request">View the request headers.</ulink>
1521  </member>
1522  <member>
1523   &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>
1524  </member>
1525  <member>
1526   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink url="http://config.privoxy.org/toggle">Toggle Privoxy on or off</ulink>
1527  </member>
1528  <member>
1529   &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&squf;&nbsp;&nbsp;<ulink
1530   url="https://www.privoxy.org/&p-version;/user-manual/">Documentation</ulink>
1531  </member>
1532  </simplelist>
1533  </msgtext>
1534 </screen>
1535
1536
1537 <para>
1538  This should be self-explanatory. Note the first item leads to an editor for the
1539  <link linkend="actions-file">actions files</link>, which is where the ad, banner,
1540  cookie, and URL blocking magic is configured as well as other advanced features of
1541  <application>Privoxy</application>. This is an easy way to adjust various
1542  aspects of <application>Privoxy</application> configuration. The actions
1543  file, and other configuration files, are explained in detail below.
1544 </para>
1545
1546 <para>
1547  <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
1548  have problems with your current actions and filters. You can in fact use
1549  it as a test to see whether it is <application>Privoxy</application>
1550  causing the problem or not. <application>Privoxy</application> continues
1551  to run as a proxy in this case, but all manipulation is disabled, i.e.
1552  <application>Privoxy</application> acts like a normal forwarding proxy.
1553 </para>
1554
1555 <para>
1556  Note that several of the features described above are disabled by default
1557  in <application>Privoxy</application> 3.0.7 beta and later.
1558  Check the
1559  <ulink url="config.html">configuration file</ulink> to learn why
1560  and in which cases it's safe to enable them again.
1561 </para>
1562
1563 </sect2>
1564
1565 <!--  ~  End section  ~  -->
1566
1567
1568
1569
1570 <!--   ~~~~~       New section      ~~~~~     -->
1571
1572 <sect2 id="confoverview">
1573 <title>Configuration Files Overview</title>
1574 <para>
1575  For Unix, *BSD and GNU/Linux, all configuration files are located in
1576  <filename>/etc/privoxy/</filename> by default. For MS Windows and OS/2
1577  these are all in the same directory as the
1578  <application>Privoxy</application> executable. <![%p-not-stable;[ The name
1579  and number of configuration files has changed from previous versions, and is
1580  subject to change as development progresses.]]>
1581 </para>
1582
1583 <para>
1584  The installed defaults provide a reasonable starting point, though
1585  some settings may be aggressive by some standards. For the time being, the
1586  principle configuration files are:
1587 </para>
1588
1589  <itemizedlist>
1590
1591   <listitem>
1592    <para>
1593      The <link linkend="config">main configuration file</link> is named <filename>config</filename>
1594      on GNU/Linux, Unix, BSD, and OS/2, and <filename>config.txt</filename>
1595      on Windows. This is a required file.
1596    </para>
1597   </listitem>
1598
1599   <listitem>
1600    <para>
1601     <filename>match-all.action</filename> is used to define which <quote>actions</quote>
1602     relating to banner-blocking, images, pop-ups, content modification, cookie handling
1603     etc should be applied by default. It should be the first actions file loaded.
1604    </para>
1605    <para>
1606     <filename>default.action</filename> defines many exceptions (both positive and negative)
1607     from the default set of actions that's configured in <filename>match-all.action</filename>.
1608     It should be the second actions file loaded and shouldn't be edited by the user.
1609    </para>
1610    <para>
1611     Multiple actions files may be defined in <filename>config</filename>. These
1612     are processed in the order they are defined. Local customizations and locally
1613     preferred exceptions to the default policies as defined in
1614     <filename>match-all.action</filename> (which you will most probably want
1615     to define sooner or later) are best applied in <filename>user.action</filename>,
1616     where you can preserve them across upgrades. The file isn't installed by all
1617     installers, but you can easily create it yourself with a text editor.
1618    </para>
1619    <para>
1620     There is also a web based editor that can be accessed from
1621     <ulink
1622     url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
1623     (Shortcut: <ulink
1624     url="http://p.p/show-status">http://p.p/show-status</ulink>) for the
1625     various actions files.
1626    </para>
1627   </listitem>
1628
1629   <listitem>
1630    <para>
1631     <quote>Filter files</quote> (the <link linkend="filter-file">filter
1632     file</link>) can be used to re-write the raw page content, including
1633     viewable text as well as embedded HTML and JavaScript, and whatever else
1634     lurks on any given web page. The filtering jobs are only pre-defined here;
1635     whether to apply them or not is up to the actions files.
1636     <filename>default.filter</filename> includes various filters made
1637     available for use by the developers. Some are much more intrusive than
1638     others, and all should be used with caution. You may define additional
1639     filter files in <filename>config</filename> as you can with
1640     actions files. We suggest <filename>user.filter</filename> for any
1641     locally defined filters or customizations.
1642    </para>
1643   </listitem>
1644
1645  </itemizedlist>
1646
1647 <para>
1648  The syntax of the configuration and filter files may change between different
1649  Privoxy versions, unfortunately some enhancements cost backwards compatibility.
1650  <!-- Add link to documentation-->
1651 </para>
1652
1653 <para>
1654  All files use the <quote><literal>#</literal></quote> character to denote a
1655  comment (the rest of the line will be ignored) and understand line continuation
1656  through placing a backslash ("<literal>\</literal>") as the very last character
1657  in a line. If the <literal>#</literal> is preceded by a backslash, it looses
1658  its special function. Placing a <literal>#</literal> in front of an otherwise
1659  valid configuration line to prevent it from being interpreted is called "commenting
1660  out" that line. Blank lines are ignored.
1661 </para>
1662
1663 <para>
1664  The actions files and filter files
1665  can use Perl style <link linkend="regex">regular expressions</link> for
1666  maximum flexibility.
1667 </para>
1668
1669 <para>
1670  After making any changes, there is no need to restart
1671  <application>Privoxy</application> in order for the changes to take
1672  effect. <application>Privoxy</application> detects such changes
1673  automatically. Note, however, that it may take one or two additional
1674  requests for the change to take effect. When changing the listening address
1675  of <application>Privoxy</application>, these <quote>wake up</quote> requests
1676  must obviously be sent to the <emphasis>old</emphasis> listening address.
1677 </para>
1678
1679 <![%p-not-stable;[
1680 <para>
1681  While under development, the configuration content is subject to change.
1682  The below documentation may not be accurate by the time you read this.
1683  Also, what constitutes a <quote>default</quote> setting, may change, so
1684  please check all your configuration files on important issues.
1685 </para>
1686 ]]>
1687
1688 </sect2>
1689 </sect1>
1690 <!--  ~  End section  ~  -->
1691
1692
1693 <!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
1694
1695 <!-- **************************************************** -->
1696 <!-- Include config.sgml here -->
1697 <!-- This is where the entire config file is detailed. -->
1698  &config;
1699 <!-- end include  -->
1700
1701
1702 <!--  ~  End section  ~  -->
1703
1704
1705
1706 <!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
1707
1708 <sect1 id="actions-file"><title>Actions Files</title>
1709
1710
1711 <!--
1712   XXX: similar descriptions are in the Configuration Files sections.
1713   We should only describe them at one place.
1714 -->
1715 <para>
1716  The actions files are used to define what <emphasis>actions</emphasis>
1717  <application>Privoxy</application> takes for which URLs, and thus determines
1718  how ad images, cookies and various other aspects of HTTP content and
1719  transactions are handled, and on which sites (or even parts thereof).
1720  There are a number of such actions, with a wide range of functionality.
1721  Each action does something a little different.
1722  These actions give us a veritable arsenal of tools with which to exert
1723  our control, preferences and independence. Actions can be combined so that
1724  their effects are aggregated when applied against a given set of URLs.
1725 </para>
1726 <para>
1727  There
1728  are three action files included with <application>Privoxy</application> with
1729  differing purposes:
1730 </para>
1731  <itemizedlist>
1732   <listitem>
1733    <para>
1734     <filename>match-all.action</filename> - is used to define which
1735     <quote>actions</quote> relating to banner-blocking, images, pop-ups,
1736     content modification, cookie handling etc should be applied by default.
1737     It should be the first actions file loaded
1738    </para>
1739   </listitem>
1740   <listitem>
1741    <para>
1742     <filename>default.action</filename> - defines many exceptions (both
1743     positive and negative) from the default set of actions that's configured
1744     in <filename>match-all.action</filename>. It is a set of rules that should
1745     work reasonably well as-is for most users. This file is only supposed to
1746     be edited by the developers. It should be the second actions file loaded.
1747    </para>
1748   </listitem>
1749   <listitem>
1750    <para>
1751     <filename>user.action</filename> - is intended to be for local site
1752     preferences and exceptions. As an example, if your ISP or your bank
1753     has specific requirements, and need special handling, this kind of
1754     thing should go here. This file will not be upgraded.
1755    </para>
1756   </listitem>
1757   <listitem>
1758    <para>
1759     <guibutton>Edit</guibutton>  <guibutton>Set to Cautious</guibutton> <guibutton>Set to Medium</guibutton>  <guibutton>Set to Advanced</guibutton>
1760    </para>
1761    <para>
1762     These have increasing levels of aggressiveness <emphasis>and have no
1763     influence on your browsing unless you select them explicitly in the
1764     editor</emphasis>. A default installation should be pre-set to
1765     <literal>Cautious</literal>. New users should try this for a while before
1766     adjusting the settings to more aggressive levels. The more aggressive
1767     the settings, then the more likelihood there is of problems such as sites
1768     not working as they should.
1769    </para>
1770    <para>
1771     The <guibutton>Edit</guibutton> button allows you to turn each
1772     action on/off individually for fine-tuning. The <guibutton>Cautious</guibutton>
1773     button changes the actions list to low/safe settings which will activate
1774     ad blocking and a minimal set of &my-app;'s features, and subsequently
1775     there will be less of a chance for accidental problems. The
1776     <guibutton>Medium</guibutton> button sets the list to a medium level of
1777     other features and a low level set of privacy features. The
1778     <guibutton>Advanced</guibutton> button sets the list to a high level of
1779     ad blocking and medium level of privacy. See the chart below. The latter
1780     three buttons over-ride any changes via with the
1781     <guibutton>Edit</guibutton> button. More fine-tuning can be done in the
1782     lower sections of this internal page.
1783    </para>
1784    <para>
1785     While the actions file editor allows to enable these settings in all
1786     actions files, they are only supposed to be enabled in the first one
1787     to make sure you don't unintentionally overrule earlier rules.
1788    </para>
1789    <para>
1790     The default profiles, and their associated actions, as pre-defined in
1791     <filename>default.action</filename> are:
1792    </para>
1793     <table frame=all><title>Default Configurations</title>
1794     <tgroup cols=4 align=left colsep=1 rowsep=1>
1795     <colspec colname=c1>
1796     <colspec colname=c2>
1797     <colspec colname=c3>
1798     <colspec colname=c4>
1799     <thead>
1800     <row>
1801       <entry>Feature</entry>
1802       <entry>Cautious</entry>
1803       <entry>Medium</entry>
1804       <entry>Advanced</entry>
1805     </row>
1806     </thead>
1807     <!--  <tfoot> -->
1808     <!--  <row> -->
1809     <!--    <entry>f1</entry> -->
1810     <!--    <entry>f2</entry> -->
1811     <!--    <entry>f3</entry> -->
1812     <!--    <entry>f4</entry> -->
1813     <!--  </row> -->
1814     <!--  </tfoot> -->
1815     <tbody>
1816
1817     <row>
1818       <entry>Ad-blocking Aggressiveness</entry>
1819       <entry>medium</entry>
1820       <entry>high</entry>
1821       <entry>high</entry>
1822     </row>
1823
1824     <row>
1825       <entry>Ad-filtering by size</entry>
1826       <entry>no</entry>
1827       <entry>yes</entry>
1828       <entry>yes</entry>
1829     </row>
1830
1831     <row>
1832       <entry>Ad-filtering by link</entry>
1833       <entry>no</entry>
1834       <entry>no</entry>
1835       <entry>yes</entry>
1836     </row>
1837     <row>
1838       <entry>Pop-up killing</entry>
1839       <entry>blocks only</entry>
1840       <entry>blocks only</entry>
1841       <entry>blocks only</entry>
1842     </row>
1843
1844     <row>
1845       <entry>Privacy Features</entry>
1846       <entry>low</entry>
1847       <entry>medium</entry>
1848       <entry>medium/high</entry>
1849     </row>
1850
1851     <row>
1852       <entry>Cookie handling</entry>
1853       <entry>none</entry>
1854       <entry>session-only</entry>
1855       <entry>kill</entry>
1856     </row>
1857
1858     <row>
1859       <entry>Referer forging</entry>
1860       <entry>no</entry>
1861       <entry>yes</entry>
1862       <entry>yes</entry>
1863     </row>
1864
1865     <row>
1866       <entry>GIF de-animation</entry>
1867       <entry>no</entry>
1868       <entry>yes</entry>
1869       <entry>yes</entry>
1870     </row>
1871
1872     <row>
1873       <entry>Fast redirects</entry>
1874       <entry>no</entry>
1875       <entry>no</entry>
1876       <entry>yes</entry>
1877     </row>
1878
1879     <row>
1880       <entry>HTML taming</entry>
1881       <entry>no</entry>
1882       <entry>no</entry>
1883       <entry>yes</entry>
1884     </row>
1885
1886     <row>
1887       <entry>JavaScript taming</entry>
1888       <entry>no</entry>
1889       <entry>no</entry>
1890       <entry>yes</entry>
1891     </row>
1892
1893     <row>
1894       <entry>Web-bug killing</entry>
1895       <entry>no</entry>
1896       <entry>yes</entry>
1897       <entry>yes</entry>
1898     </row>
1899
1900     <row>
1901       <entry>Image tag reordering</entry>
1902       <entry>no</entry>
1903       <entry>yes</entry>
1904       <entry>yes</entry>
1905     </row>
1906
1907     </tbody>
1908     </tgroup>
1909     </table>
1910
1911   </listitem>
1912  </itemizedlist>
1913
1914 <para>
1915  The list of actions files to be used are defined in the main configuration
1916  file, and are processed in the order they are defined (e.g.
1917  <filename>default.action</filename> is typically processed before
1918  <filename>user.action</filename>). The content of these can all be viewed and
1919  edited from <ulink
1920  url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
1921  The over-riding principle when applying actions, is that the last action that
1922  matches a given URL wins. The broadest, most general rules go first
1923  (defined in <filename>default.action</filename>),
1924  followed by any exceptions (typically also in
1925  <filename>default.action</filename>), which are then followed lastly by any
1926  local preferences (typically in <emphasis>user</emphasis><filename>.action</filename>).
1927  Generally, <filename>user.action</filename> has the last word.
1928  </para>
1929
1930 <para>
1931  An actions file typically has multiple sections. If you want to use
1932  <quote>aliases</quote> in an actions file, you have to place the (optional)
1933  <link linkend="aliases">alias section</link> at the top of that file.
1934  Then comes the default set of rules which will apply universally to all
1935  sites and pages (be <emphasis>very careful</emphasis> with using such a
1936  universal set in <filename>user.action</filename> or any other actions file after
1937  <filename>default.action</filename>, because it will override the result
1938  from consulting any previous file). And then below that,
1939  exceptions to the defined universal policies. You can regard
1940  <filename>user.action</filename> as an appendix to <filename>default.action</filename>,
1941  with the advantage that it is a separate file, which makes preserving your
1942  personal settings across <application>Privoxy</application> upgrades easier.
1943 </para>
1944
1945 <para>
1946  Actions can be used to block anything you want, including ads, banners, or
1947  just some obnoxious URL whose content you would rather not see. Cookies can be accepted
1948  or rejected, or accepted only during the current browser session (i.e. not
1949  written to disk), content can be modified, some JavaScripts tamed, user-tracking
1950  fooled, and much more. See below for a <link linkend="actions">complete list
1951  of actions</link>.
1952 </para>
1953
1954 <!--   ~~~~~       New section      ~~~~~     -->
1955 <sect2 id="right-mix">
1956 <title>Finding the Right Mix</title>
1957 <para>
1958  Note that some <link linkend="actions">actions</link>, like cookie suppression
1959  or script disabling, may render some sites unusable that rely on these
1960  techniques to work properly. Finding the right mix of actions is not always easy and
1961  certainly a matter of personal taste. And, things can always change, requiring
1962  refinements in the configuration. In general, it can be said that the more
1963  <quote>aggressive</quote> your default settings (in the top section of the
1964  actions file) are, the more exceptions for <quote>trusted</quote> sites you
1965  will have to make later. If, for example, you want to crunch all cookies per
1966  default, you'll have to make exceptions from that rule for sites that you
1967  regularly use and that require cookies for actually useful purposes, like maybe
1968  your bank, favorite shop, or newspaper.
1969 </para>
1970
1971 <para>
1972  We have tried to provide you with reasonable rules to start from in the
1973  distribution actions files. But there is no general rule of thumb on these
1974  things. There just are too many variables, and sites are constantly changing.
1975  Sooner or later you will want to change the rules (and read this chapter again :).
1976 </para>
1977 </sect2>
1978
1979 <!--   ~~~~~       New section      ~~~~~     -->
1980 <sect2 id="how-to-edit">
1981 <title>How to Edit</title>
1982 <para>
1983  The easiest way to edit the actions files is with a browser by
1984  using our browser-based editor, which can be reached from <ulink
1985  url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
1986  Note: the config file option <link
1987  linkend="enable-edit-actions">enable-edit-actions</link> must be enabled for
1988  this to work. The editor allows both fine-grained control over every single
1989  feature on a per-URL basis, and easy choosing from wholesale sets of defaults
1990  like <quote>Cautious</quote>, <quote>Medium</quote> or
1991  <quote>Advanced</quote>. Warning: the <quote>Advanced</quote> setting is more
1992  aggressive, and will be more likely to cause problems for some sites.
1993  Experienced users only!
1994  </para>
1995
1996 <para>
1997  If you prefer plain text editing to GUIs, you can of course also directly edit the
1998  the actions files with your favorite text editor. Look at
1999  <filename>default.action</filename> which is richly commented with many
2000  good examples.
2001 </para>
2002 </sect2>
2003
2004
2005 <sect2 id="actions-apply">
2006 <title>How Actions are Applied to Requests</title>
2007 <para>
2008  Actions files are divided into sections. There are special sections,
2009  like the <quote><link linkend="aliases">alias</link></quote> sections which will
2010  be discussed later. For now let's concentrate on regular sections: They have a
2011  heading line (often split up to multiple lines for readability) which consist
2012  of a list of actions, separated by whitespace and enclosed in curly braces.
2013  Below that, there is a list of URL and tag patterns, each on a separate line.
2014 </para>
2015
2016 <para>
2017  To determine which actions apply to a request, the URL of the request is
2018  compared to all URL patterns in each <quote>action file</quote>.
2019  Every time it matches, the list of applicable actions for the request is
2020  incrementally updated, using the heading of the section in which the
2021  pattern is located. The same is done again for tags and tag patterns later on.
2022 </para>
2023
2024 <para>
2025  If multiple applying sections set the same action differently,
2026  the last match wins. If not, the effects are aggregated.
2027  E.g. a URL might match a regular section with a heading line of <literal>{
2028  +<link linkend="handle-as-image">handle-as-image</link> }</literal>,
2029  then later another one with just <literal>{
2030  +<link linkend="block">block</link> }</literal>, resulting
2031  in <emphasis>both</emphasis> actions to apply. And there may well be
2032  cases where you will want to combine actions together. Such a section then
2033  might look like:
2034 </para>
2035
2036  <screen>
2037   { +<literal>handle-as-image</literal>  +<literal>block{Banner ads.}</literal> }
2038   # Block these as if they were images. Send no block page.
2039    banners.example.com
2040    media.example.com/.*banners
2041    .example.com/images/ads/</screen>
2042
2043 <para>
2044  You can trace this process for URL patterns and any given URL by visiting <ulink
2045  url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>.
2046 </para>
2047
2048 <para>
2049  Examples and more detail on this is provided in the Appendix, <link linkend="ACTIONSANAT">
2050  Troubleshooting: Anatomy of an Action</link> section.
2051 </para>
2052 </sect2>
2053
2054 <!--   ~~~~~       New section      ~~~~~     -->
2055 <sect2 id="af-patterns">
2056 <title>Patterns</title>
2057 <para>
2058  As mentioned, <application>Privoxy</application> uses <quote>patterns</quote>
2059  to determine what <emphasis>actions</emphasis> might apply to which sites and
2060  pages your browser attempts to access. These <quote>patterns</quote> use wild
2061  card type <emphasis>pattern</emphasis> matching to achieve a high degree of
2062  flexibility. This allows one expression to be expanded and potentially match
2063  against many similar patterns.
2064 </para>
2065
2066 <para>
2067  Generally, an URL pattern has the form
2068  <literal>&lt;host&gt;&lt;port&gt;/&lt;path&gt;</literal>, where the
2069  <literal>&lt;host&gt;</literal>, the <literal>&lt;port&gt;</literal>
2070  and the <literal>&lt;path&gt;</literal> are optional. (This is why the special
2071  <literal>/</literal> pattern matches all URLs). Note that the protocol
2072  portion of the URL pattern (e.g. <literal>http://</literal>) should
2073  <emphasis>not</emphasis> be included in the pattern. This is assumed already!
2074 </para>
2075 <para>
2076  The pattern matching syntax is different for the host and path parts of
2077  the URL. The host part uses a simple globbing type matching technique,
2078  while the path part uses more flexible
2079  <ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
2080   Expressions</quote></ulink> (POSIX 1003.2).
2081 </para>
2082 <para>
2083  The port part of a pattern is a decimal port number preceded by a colon
2084  (<literal>:</literal>). If the host part contains a numerical IPv6 address,
2085  it has to be put into angle brackets
2086  (<literal>&lt;</literal>, <literal>&gt;</literal>).
2087 </para>
2088
2089 <variablelist>
2090  <varlistentry>
2091   <term><literal>www.example.com/</literal></term>
2092   <listitem>
2093    <para>
2094     is a host-only pattern and will match any request to <literal>www.example.com</literal>,
2095     regardless of which document on that server is requested. So ALL pages in
2096     this domain would be covered by the scope of this action. Note that a
2097     simple <literal>example.com</literal> is different and would NOT match.
2098    </para>
2099   </listitem>
2100  </varlistentry>
2101  <varlistentry>
2102   <term><literal>www.example.com</literal></term>
2103   <listitem>
2104    <para>
2105     means exactly the same. For host-only patterns, the trailing <literal>/</literal> may
2106     be omitted.
2107    </para>
2108   </listitem>
2109  </varlistentry>
2110  <varlistentry>
2111   <term><literal>www.example.com/index.html</literal></term>
2112   <listitem>
2113    <para>
2114     matches all the documents on <literal>www.example.com</literal>
2115     whose name starts with <literal>/index.html</literal>.
2116    </para>
2117   </listitem>
2118  </varlistentry>
2119  <varlistentry>
2120   <term><literal>www.example.com/index.html$</literal></term>
2121   <listitem>
2122    <para>
2123     matches only the single document <literal>/index.html</literal>
2124     on <literal>www.example.com</literal>.
2125    </para>
2126   </listitem>
2127  </varlistentry>
2128  <varlistentry>
2129   <term><literal>/index.html$</literal></term>
2130   <listitem>
2131    <para>
2132     matches the document <literal>/index.html</literal>, regardless of the domain,
2133     i.e. on <emphasis>any</emphasis> web server anywhere.
2134    </para>
2135   </listitem>
2136  </varlistentry>
2137  <varlistentry>
2138   <term><literal>/</literal></term>
2139   <listitem>
2140    <para>
2141     Matches any URL because there's no requirement for either the
2142     domain or the path to match anything.
2143    </para>
2144   </listitem>
2145  </varlistentry>
2146  <varlistentry>
2147   <term><literal>:8000/</literal></term>
2148   <listitem>
2149    <para>
2150     Matches any URL pointing to TCP port 8000.
2151    </para>
2152   </listitem>
2153  </varlistentry>
2154  <varlistentry>
2155   <term><literal>10.0.0.1/</literal></term>
2156   <listitem>
2157    <para>
2158     Matches any URL with the host address <literal>10.0.0.1</literal>.
2159     (Note that the real URL uses plain brackets, not angle brackets.)
2160    </para>
2161   </listitem>
2162  </varlistentry>
2163  <varlistentry>
2164   <term><literal>&lt;2001:db8::1&gt;/</literal></term>
2165   <listitem>
2166    <para>
2167     Matches any URL with the host address <literal>2001:db8::1</literal>.
2168     (Note that the real URL uses plain brackets, not angle brackets.)
2169    </para>
2170   </listitem>
2171  </varlistentry>
2172  <varlistentry>
2173   <term><literal>index.html</literal></term>
2174   <listitem>
2175    <para>
2176     matches nothing, since it would be interpreted as a domain name and
2177     there is no top-level domain called <literal>.html</literal>. So its
2178     a mistake.
2179    </para>
2180   </listitem>
2181  </varlistentry>
2182 </variablelist>
2183
2184
2185 <!--   ~~~~~       New section      ~~~~~     -->
2186 <sect3 id="host-pattern"><title>The Host Pattern</title>
2187
2188 <para>
2189  The matching of the host part offers some flexible options: if the
2190  host pattern starts or ends with a dot, it becomes unanchored at that end.
2191  The host pattern is often referred to as domain pattern as it is usually
2192  used to match domain names and not IP addresses.
2193  For example:
2194 </para>
2195
2196 <variablelist>
2197  <varlistentry>
2198   <term><literal>.example.com</literal></term>
2199   <listitem>
2200    <para>
2201     matches any domain with first-level domain <literal>com</literal>
2202     and second-level domain <literal>example</literal>.
2203     For example <literal>www.example.com</literal>,
2204     <literal>example.com</literal> and <literal>foo.bar.baz.example.com</literal>.
2205     Note that it wouldn't match if the second-level domain was <literal>another-example</literal>.
2206    </para>
2207   </listitem>
2208  </varlistentry>
2209  <varlistentry>
2210   <term><literal>www.</literal></term>
2211   <listitem>
2212    <para>
2213     matches any domain that <emphasis>STARTS</emphasis> with
2214     <literal>www.</literal> (It also matches the domain
2215     <literal>www</literal> but most of the time that doesn't matter.)
2216    </para>
2217   </listitem>
2218  </varlistentry>
2219  <varlistentry>
2220   <term><literal>.example.</literal></term>
2221   <listitem>
2222    <para>
2223     matches any domain that <emphasis>CONTAINS</emphasis> <literal>.example.</literal>.
2224     And, by the way, also included would be any files or documents that exist
2225     within that domain since no path limitations are specified. (Correctly
2226     speaking: It matches any FQDN that contains <literal>example</literal> as
2227     a domain.) This might be <literal>www.example.com</literal>,
2228     <literal>news.example.de</literal>, or
2229     <literal>www.example.net/cgi/testing.pl</literal> for instance. All these
2230     cases are matched.
2231    </para>
2232   </listitem>
2233  </varlistentry>
2234 </variablelist>
2235
2236 <para>
2237  Additionally, there are wild-cards that you can use in the domain names
2238  themselves. These work similarly to shell globbing type wild-cards:
2239  <quote>*</quote> represents zero or more arbitrary characters (this is
2240  equivalent to the
2241  <ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
2242  Expression</quote></ulink> based syntax of <quote>.*</quote>),
2243  <quote>?</quote>  represents any single character (this is equivalent to the
2244  regular expression syntax of a simple <quote>.</quote>), and you can define
2245  <quote>character classes</quote> in square brackets which is similar to
2246  the same regular expression technique. All of this can be freely mixed:
2247 </para>
2248
2249 <variablelist>
2250  <varlistentry>
2251   <term><literal>ad*.example.com</literal></term>
2252   <listitem>
2253    <para>
2254     matches <quote>adserver.example.com</quote>,
2255     <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>
2256    </para>
2257   </listitem>
2258  </varlistentry>
2259  <varlistentry>
2260   <term><literal>*ad*.example.com</literal></term>
2261   <listitem>
2262    <para>
2263     matches all of the above, and then some.
2264    </para>
2265   </listitem>
2266  </varlistentry>
2267  <varlistentry>
2268   <term><literal>.?pix.com</literal></term>
2269   <listitem>
2270    <para>
2271     matches <literal>www.ipix.com</literal>,
2272     <literal>pictures.epix.com</literal>, <literal>a.b.c.d.e.upix.com</literal> etc.
2273    </para>
2274   </listitem>
2275  </varlistentry>
2276  <varlistentry>
2277   <term><literal>www[1-9a-ez].example.c*</literal></term>
2278   <listitem>
2279    <para>
2280      matches <literal>www1.example.com</literal>,
2281      <literal>www4.example.cc</literal>, <literal>wwwd.example.cy</literal>,
2282      <literal>wwwz.example.com</literal> etc., but <emphasis>not</emphasis>
2283      <literal>wwww.example.com</literal>.
2284    </para>
2285   </listitem>
2286  </varlistentry>
2287 </variablelist>
2288
2289 <para>
2290  While flexible, this is not the sophistication of full regular expression based syntax.
2291 </para>
2292
2293 </sect3>
2294
2295 <!--  ~  End section  ~  -->
2296
2297
2298 <!--   ~~~~~       New section      ~~~~~     -->
2299 <sect3 id="path-pattern"><title>The Path Pattern</title>
2300
2301 <para>
2302  <application>Privoxy</application> uses <quote>modern</quote> POSIX 1003.2
2303   <ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
2304   Expressions</quote></ulink> for matching the path portion (after the slash),
2305   and is thus more flexible.
2306 </para>
2307
2308 <para>
2309  There is an <link linkend="regex">Appendix</link> with a brief quick-start into regular
2310  expressions, you also might want to have a look at your operating system's documentation
2311  on regular expressions (try <literal>man re_format</literal>).
2312 </para>
2313
2314 <para>
2315  Note that the path pattern is automatically left-anchored at the <quote>/</quote>,
2316  i.e. it matches as if it would start with a <quote>^</quote> (regular expression speak
2317  for the beginning of a line).
2318 </para>
2319
2320 <para>
2321  Please also note that matching in the path is <emphasis>CASE INSENSITIVE</emphasis>
2322  by default, but you can switch to case sensitive at any point in the pattern by using the
2323  <quote>(?-i)</quote> switch: <literal>www.example.com/(?-i)PaTtErN.*</literal> will match
2324  only documents whose path starts with <literal>PaTtErN</literal> in
2325  <emphasis>exactly</emphasis> this capitalization.
2326 </para>
2327
2328 <variablelist>
2329  <varlistentry>
2330   <term><literal>.example.com/.*</literal></term>
2331   <listitem>
2332    <para>
2333      Is equivalent to just <quote>.example.com</quote>, since any documents
2334      within that domain are matched with or without the <quote>.*</quote>
2335      regular expression. This is redundant
2336    </para>
2337   </listitem>
2338  </varlistentry>
2339  <varlistentry>
2340   <term><literal>.example.com/.*/index.html$</literal></term>
2341   <listitem>
2342    <para>
2343     Will match any page in the domain of <quote>example.com</quote> that is
2344     named <quote>index.html</quote>, and that is part of some path. For
2345     example, it matches <quote>www.example.com/testing/index.html</quote> but
2346     NOT <quote>www.example.com/index.html</quote> because the regular
2347     expression called for at least two <quote>/'s</quote>, thus the path
2348     requirement. It also would match
2349     <quote>www.example.com/testing/index_html</quote>, because of the
2350     special meta-character <quote>.</quote>.
2351    </para>
2352   </listitem>
2353  </varlistentry>
2354  <varlistentry>
2355   <term><literal>.example.com/(.*/)?index\.html$</literal></term>
2356   <listitem>
2357    <para>
2358     This regular expression is conditional so it will match any page
2359     named <quote>index.html</quote> regardless of path which in this case can
2360     have one or more <quote>/'s</quote>. And this one must contain exactly
2361     <quote>.html</quote> (and end with that!).
2362    </para>
2363   </listitem>
2364  </varlistentry>
2365  <varlistentry>
2366   <term><literal>.example.com/(.*/)(ads|banners?|junk)</literal></term>
2367   <listitem>
2368    <para>
2369     This regular expression will match any path of <quote>example.com</quote>
2370     that contains any of the words <quote>ads</quote>, <quote>banner</quote>,
2371     <quote>banners</quote> (because of the <quote>?</quote>) or <quote>junk</quote>.
2372     The path does not have to end in these words, just contain them.
2373     The path has to contain at least two slashes (including the one at the beginning).
2374    </para>
2375   </listitem>
2376  </varlistentry>
2377  <varlistentry>
2378   <term><literal>.example.com/(.*/)(ads|banners?|junk)/.*\.(jpe?g|gif|png)$</literal></term>
2379   <listitem>
2380    <para>
2381     This is very much the same as above, except now it must end in either
2382     <quote>.jpg</quote>, <quote>.jpeg</quote>, <quote>.gif</quote> or <quote>.png</quote>. So this
2383     one is limited to common image formats.
2384    </para>
2385   </listitem>
2386  </varlistentry>
2387
2388 </variablelist>
2389 <para>
2390  There are many, many good examples to be found in <filename>default.action</filename>,
2391  and more tutorials below in <link linkend="regex">Appendix on regular expressions</link>.
2392 </para>
2393
2394 </sect3>
2395
2396 <!--  ~  End section  ~  -->
2397
2398
2399 <!--   ~~~~~       New section      ~~~~~     -->
2400 <sect3 id="tag-pattern"><title>The Request Tag Pattern</title>
2401
2402 <para>
2403  Request tag patterns are used to change the applying actions based on the
2404  request's tags. Tags can be created based on HTTP headers with either
2405  the <link linkend="CLIENT-HEADER-TAGGER">client-header-tagger</link>
2406  or the  <link linkend="SERVER-HEADER-TAGGER">server-header-tagger</link> action.
2407 </para>
2408
2409 <para>
2410  Request tag patterns have to start with <quote>TAG:</quote>, so &my-app;
2411  can tell them apart from other patterns. Everything after the colon
2412  including white space, is interpreted as a regular expression with
2413  path pattern syntax, except that tag patterns aren't left-anchored
2414  automatically (&my-app; doesn't silently add a <quote>^</quote>,
2415  you have to do it yourself if you need it).
2416 </para>
2417
2418 <para>
2419  To match all requests that are tagged with <quote>foo</quote>
2420  your pattern line should be <quote>TAG:^foo$</quote>,
2421  <quote>TAG:foo</quote> would work as well, but it would also
2422  match requests whose tags contain <quote>foo</quote> somewhere.
2423  <quote>TAG: foo</quote> wouldn't work as it requires white space.
2424 </para>
2425
2426 <para>
2427  Sections can contain URL and request tag patterns at the same time,
2428  but request tag patterns are checked after the URL patterns and thus
2429  always overrule them, even if they are located before the URL patterns.
2430 </para>
2431
2432 <para>
2433  Once a new request tag is added, Privoxy checks right away if it's matched by one
2434  of the request tag patterns and updates the action settings accordingly. As a result
2435  request tags can be used to activate other tagger actions, as long as these other
2436  taggers look for headers that haven't already be parsed.
2437 </para>
2438
2439 <para>
2440  For example you could tag client requests which use the
2441  <literal>POST</literal> method,
2442  then use this tag to activate another tagger that adds a tag if cookies
2443  are sent, and then use a block action based on the cookie tag. This allows
2444  the outcome of one action, to be input into a subsequent action. However if
2445  you'd reverse the position of the described taggers, and activated the
2446  method tagger based on the cookie tagger, no method tags would be created.
2447  The method tagger would look for the request line, but at the time
2448  the cookie tag is created, the request line has already been parsed.
2449 </para>
2450
2451 <para>
2452  While this is a limitation you should be aware of, this kind of
2453  indirection is seldom needed anyway and even the example doesn't
2454  make too much sense.
2455 </para>
2456
2457 </sect3>
2458
2459 <!--   ~~~~~       New section      ~~~~~     -->
2460 <sect3 id="negative-tag-patterns"><title>The Negative Request Tag Patterns</title>
2461
2462 <para>
2463  To match requests that do not have a certain request tag, specify a negative tag pattern
2464  by prefixing the tag pattern line with either <quote>NO-REQUEST-TAG:</quote>
2465  or <quote>NO-RESPONSE-TAG:</quote> instead of <quote>TAG:</quote>.
2466 </para>
2467
2468 <para>
2469  Negative request tag patterns created with <quote>NO-REQUEST-TAG:</quote> are checked
2470  after all client headers are scanned, the ones created with <quote>NO-RESPONSE-TAG:</quote>
2471  are checked after all server headers are scanned. In both cases all the created
2472  tags are considered.
2473 </para>
2474 </sect3>
2475
2476 <!--   ~~~~~       New section      ~~~~~     -->
2477 <sect3 id="client-tag-pattern"><title>The Client Tag Pattern</title>
2478
2479 <!-- XXX: This section contains duplicates content from the
2480           client-specific-tag documentation. -->
2481
2482 <warning>
2483 <para>
2484  This is an experimental feature. The syntax is likely to change in future versions.
2485 </para>
2486 </warning>
2487
2488 <para>
2489  Client tag patterns are not set based on HTTP headers but based on
2490  the client's IP address. Users can enable them themselves, but the
2491  Privoxy admin controls which tags are available and what their effect
2492  is.
2493 </para>
2494
2495 <para>
2496  After a client-specific tag has been defined with the
2497  <link linkend="client-specific-tag">client-specific-tag</link>,
2498  directive, action sections can be activated based on the tag by using a
2499  CLIENT-TAG pattern. The CLIENT-TAG pattern is evaluated at the same priority
2500  as URL patterns, as a result the last matching pattern wins. Tags that
2501  are created based on client or server headers are evaluated later on
2502  and can overrule CLIENT-TAG and URL patterns!
2503 </para>
2504 <para>
2505  The tag is set for all requests that come from clients that requested
2506  it to be set. Note that "clients" are  differentiated by IP address,
2507  if the IP address changes the tag has to be requested again.
2508 </para>
2509 <para>
2510  Clients can request tags to be set by using the CGI interface <ulink
2511   url="http://config.privoxy.org/client-tags">http://config.privoxy.org/client-tags</ulink>.
2512 </para>
2513
2514 <para>
2515  Example:
2516 </para>
2517
2518  <screen>
2519 # If the admin defined the client-specific-tag circumvent-blocks,
2520 # and the request comes from a client that previously requested
2521 # the tag to be set, overrule all previous +block actions that
2522 # are enabled based on URL to CLIENT-TAG patterns.
2523 {-block}
2524 CLIENT-TAG:^circumvent-blocks$
2525
2526 # This section is not overruled because it's located after
2527 # the previous one.
2528 {+block{Nobody is supposed to request this.}}
2529 example.org/blocked-example-page</screen>
2530
2531 </sect3>
2532
2533 </sect2>
2534
2535 <!--  ~  End section  ~  -->
2536
2537
2538 <!--   ~~~~~       New section      ~~~~~     -->
2539
2540 <sect2 id="actions">
2541 <title>Actions</title>
2542 <para>
2543  All actions are disabled by default, until they are explicitly enabled
2544  somewhere in an actions file. Actions are turned on if preceded with a
2545  <quote>+</quote>, and turned off if preceded with a <quote>-</quote>. So a
2546  <literal>+action</literal> means <quote>do that action</quote>, e.g.
2547  <literal>+block</literal> means <quote>please block URLs that match the
2548  following patterns</quote>, and <literal>-block</literal> means <quote>don't
2549  block URLs that match the following patterns, even if <literal>+block</literal>
2550  previously applied.</quote>
2551 </para>
2552
2553 <para>
2554  Again, actions are invoked by placing them on a line, enclosed in curly braces and
2555  separated by whitespace, like in
2556  <literal>{+some-action -some-other-action{some-parameter}}</literal>,
2557  followed by a list of URL patterns, one per line, to which they apply.
2558  Together, the actions line and the following pattern lines make up a section
2559  of the actions file.
2560 </para>
2561
2562 <para>
2563  Actions fall into three categories:
2564 </para>
2565
2566  <itemizedlist>
2567  <listitem>
2568   <para>
2569    Boolean, i.e the action can only be <quote>enabled</quote> or
2570    <quote>disabled</quote>. Syntax:
2571   </para>
2572    <screen>
2573   +<replaceable class="function">name</replaceable>        # enable action <replaceable class="parameter">name</replaceable>
2574   -<replaceable class="function">name</replaceable>        # disable action <replaceable class="parameter">name</replaceable></screen>
2575   <para>
2576    Example: <literal>+handle-as-image</literal>
2577   </para>
2578  </listitem>
2579
2580
2581  <listitem>
2582   <para>
2583    Parameterized, where some value is required in order to enable this type of action.
2584    Syntax:
2585   </para>
2586    <screen>
2587   +<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>}  # enable action and set parameter to <replaceable class="parameter">param</replaceable>,
2588                # overwriting parameter from previous match if necessary
2589   -<replaceable class="function">name</replaceable>         # disable action. The parameter can be omitted</screen>
2590   <para>
2591    Note that if the URL matches multiple positive forms of a parameterized action,
2592    the last match wins, i.e. the params from earlier matches are simply ignored.
2593   </para>
2594   <para>
2595    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>
2596   </para>
2597  </listitem>
2598
2599  <listitem>
2600   <para>
2601    Multi-value. These look exactly like parameterized actions,
2602    but they behave differently: If the action applies multiple times to the
2603    same URL, but with different parameters, <emphasis>all</emphasis> the parameters
2604    from <emphasis>all</emphasis> matches are remembered. This is used for actions
2605    that can be executed for the same request repeatedly, like adding multiple
2606    headers, or filtering through multiple filters. Syntax:
2607   </para>
2608    <screen>
2609   +<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>}   # enable action and add <replaceable class="parameter">param</replaceable> to the list of parameters
2610   -<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>}   # remove the parameter <replaceable class="parameter">param</replaceable> from the list of parameters
2611                 # If it was the last one left, disable the action.
2612   <replaceable class="parameter">-name</replaceable>          # disable this action completely and remove all parameters from the list</screen>
2613   <para>
2614    Examples: <literal>+add-header{X-Fun-Header: Some text}</literal> and
2615    <literal>+filter{html-annoyances}</literal>
2616   </para>
2617  </listitem>
2618
2619  </itemizedlist>
2620
2621 <para>
2622  If nothing is specified in any actions file, no <quote>actions</quote> are
2623  taken. So in this case <application>Privoxy</application> would just be a
2624  normal, non-blocking, non-filtering proxy. You must specifically enable the
2625  privacy and blocking features you need (although the provided default actions
2626  files will give a good starting point).
2627 </para>
2628
2629 <para>
2630  Later defined action sections always over-ride earlier ones of the same type.
2631  So exceptions to any rules you make, should come in the latter part of the file (or
2632  in a file that is processed later when using multiple actions files such
2633  as <filename>user.action</filename>). For multi-valued actions, the actions
2634  are applied in the order they are specified. Actions files are processed in
2635  the order they are defined in <filename>config</filename> (the default
2636  installation has three actions files). It also quite possible for any given
2637  URL to match more than one <quote>pattern</quote> (because of wildcards and
2638  regular expressions), and thus to trigger more than one set of actions! Last
2639  match wins.
2640 </para>
2641
2642 <!-- start actions listing -->
2643 <para>
2644  The list of valid <application>Privoxy</application> actions are:
2645 </para>
2646
2647
2648 <!-- ********************************************************** -->
2649 <!-- Please note the below defined actions use id's that are    -->
2650 <!-- probably linked from other places, so please don't change. -->
2651 <!--                                                            -->
2652 <!-- ********************************************************** -->
2653
2654
2655 <!--   ~~~~~       New section      ~~~~~     -->
2656
2657 <sect3 renderas="sect4" id="add-header">
2658 <title>add-header</title>
2659
2660 <variablelist>
2661  <varlistentry>
2662   <term>Typical use:</term>
2663   <listitem>
2664    <para>Confuse log analysis, custom applications</para>
2665   </listitem>
2666  </varlistentry>
2667
2668  <varlistentry>
2669   <term>Effect:</term>
2670   <listitem>
2671    <para>
2672     Sends a user defined HTTP header to the web server.
2673    </para>
2674   </listitem>
2675  </varlistentry>
2676
2677  <varlistentry>
2678   <term>Type:</term>
2679   <!-- boolean, parameterized, Multi-value -->
2680   <listitem>
2681    <para>Multi-value.</para>
2682   </listitem>
2683  </varlistentry>
2684
2685  <varlistentry>
2686   <term>Parameter:</term>
2687   <listitem>
2688    <para>
2689     Any string value is possible. Validity of the defined HTTP headers is not checked.
2690     It is recommended that you use the <quote><literal>X-</literal></quote> prefix
2691     for custom headers.
2692    </para>
2693   </listitem>
2694  </varlistentry>
2695
2696 <varlistentry>
2697   <term>Notes:</term>
2698   <listitem>
2699    <para>
2700     This action may be specified multiple times, in order to define multiple
2701     headers. This is rarely needed for the typical user. If you don't know what
2702     <quote>HTTP headers</quote> are, you definitely don't need to worry about this
2703     one.
2704    </para>
2705    <para>
2706     Headers added by this action are not modified by other actions.
2707    </para>
2708   </listitem>
2709  </varlistentry>
2710
2711  <varlistentry>
2712   <term>Example usage:</term>
2713   <listitem>
2714      <screen># Add a DNT ("Do not track") header to all requests,
2715 # event to those that already have one.
2716 #
2717 # This is just an example, not a recommendation.
2718 #
2719 # There is no reason to believe that user-tracking websites care
2720 # about the DNT header and depending on the User-Agent, adding the
2721 # header may make user-tracking easier.
2722 {+add-header{DNT: 1}}
2723 /</screen>
2724   </listitem>
2725  </varlistentry>
2726 </variablelist>
2727 </sect3>
2728
2729
2730 <!--   ~~~~~       New section      ~~~~~     -->
2731 <sect3 renderas="sect4" id="block">
2732 <title>block</title>
2733
2734 <variablelist>
2735  <varlistentry>
2736   <term>Typical use:</term>
2737   <listitem>
2738    <para>Block ads or other unwanted content</para>
2739   </listitem>
2740  </varlistentry>
2741
2742  <varlistentry>
2743   <term>Effect:</term>
2744   <listitem>
2745    <para>
2746     Requests for URLs to which this action applies are blocked, i.e. the
2747     requests are trapped by &my-app; and the requested URL is never retrieved,
2748     but is answered locally with a substitute page or image, as determined by
2749     the <literal><link
2750     linkend="handle-as-image">handle-as-image</link></literal>,
2751     <literal><link
2752     linkend="set-image-blocker">set-image-blocker</link></literal>, and
2753     <literal><link
2754     linkend="handle-as-empty-document">handle-as-empty-document</link></literal> actions.
2755
2756    </para>
2757   </listitem>
2758  </varlistentry>
2759
2760  <varlistentry>
2761   <term>Type:</term>
2762   <!-- boolean, parameterized, Multi-value -->
2763   <listitem>
2764    <para>Parameterized.</para>
2765   </listitem>
2766  </varlistentry>
2767
2768  <varlistentry>
2769   <term>Parameter:</term>
2770   <listitem>
2771    <para>A block reason that should be given to the user.</para>
2772   </listitem>
2773  </varlistentry>
2774
2775 <varlistentry>
2776   <term>Notes:</term>
2777   <listitem>
2778    <para>
2779     <application>Privoxy</application> sends a special <quote>BLOCKED</quote> page
2780     for requests to blocked pages. This page contains the block reason given as
2781     parameter, a link to find out why the block action applies, and a click-through
2782     to the blocked content (the latter only if the force feature is available and
2783     enabled).
2784    </para>
2785    <para>
2786     A very important exception occurs if <emphasis>both</emphasis>
2787     <literal>block</literal> and <literal><link linkend="handle-as-image">handle-as-image</link></literal>,
2788     apply to the same request: it will then be replaced by an image. If
2789     <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>
2790     (see below) also applies, the type of image will be determined by its parameter,
2791     if not, the standard checkerboard pattern is sent.
2792    </para>
2793    <para>
2794     It is important to understand this process, in order
2795     to understand how <application>Privoxy</application> deals with
2796     ads and other unwanted content. Blocking is a core feature, and one
2797     upon which various other features depend.
2798    </para>
2799    <para>
2800     The <literal><link linkend="filter">filter</link></literal>
2801     action can perform a very similar task, by <quote>blocking</quote>
2802     banner images and other content through rewriting the relevant URLs in the
2803     document's HTML source, so they don't get requested in the first place.
2804     Note that this is a totally different technique, and it's easy to confuse the two.
2805    </para>
2806   </listitem>
2807  </varlistentry>
2808
2809  <varlistentry>
2810   <term>Example usage (section):</term>
2811   <listitem>
2812      <screen>{+block{No nasty stuff for you.}}
2813 # Block and replace with "blocked" page
2814  .nasty-stuff.example.com
2815
2816 {+block{Doubleclick banners.} +handle-as-image}
2817 # Block and replace with image
2818  .ad.doubleclick.net
2819  .ads.r.us/banners/
2820
2821 {+block{Layered ads.} +handle-as-empty-document}
2822 # Block and then ignore
2823  adserver.example.net/.*\.js$</screen>
2824   </listitem>
2825  </varlistentry>
2826
2827
2828 </variablelist>
2829 </sect3>
2830
2831
2832 <!--   ~~~~~       New section      ~~~~~     -->
2833 <sect3 renderas="sect4" id="change-x-forwarded-for">
2834 <title>change-x-forwarded-for</title>
2835
2836 <variablelist>
2837  <varlistentry>
2838   <term>Typical use:</term>
2839   <listitem>
2840    <para>Improve privacy by not forwarding the source of the request in the HTTP headers.</para>
2841   </listitem>
2842  </varlistentry>
2843
2844  <varlistentry>
2845   <term>Effect:</term>
2846   <listitem>
2847    <para>
2848     Deletes the <quote>X-Forwarded-For:</quote> HTTP header from the client request,
2849     or adds a new one.
2850    </para>
2851   </listitem>
2852  </varlistentry>
2853
2854  <varlistentry>
2855   <term>Type:</term>
2856   <!-- Boolean, Parameterized, Multi-value -->
2857   <listitem>
2858    <para>Parameterized.</para>
2859   </listitem>
2860  </varlistentry>
2861
2862  <varlistentry>
2863   <term>Parameter:</term>
2864   <listitem>
2865    <itemizedlist>
2866     <listitem>
2867      <para><quote>block</quote> to delete the header.</para>
2868     </listitem>
2869     <listitem>
2870      <para>
2871        <quote>add</quote> to create the header (or append
2872        the client's IP address to an already existing one).
2873      </para>
2874     </listitem>
2875    </itemizedlist>
2876   </listitem>
2877  </varlistentry>
2878
2879  <varlistentry>
2880   <term>Notes:</term>
2881   <listitem>
2882    <para>
2883     It is safe and recommended to use <literal>block</literal>.
2884    </para>
2885    <para>
2886     Forwarding the source address of the request may make
2887     sense in some multi-user setups but is also a privacy risk.
2888    </para>
2889   </listitem>
2890  </varlistentry>
2891  <varlistentry>
2892   <term>Example usage:</term>
2893   <listitem>
2894      <screen>+change-x-forwarded-for{block}</screen>
2895   </listitem>
2896  </varlistentry>
2897 </variablelist>
2898 </sect3>
2899
2900 <!--   ~~~~~       New section      ~~~~~     -->
2901 <sect3 renderas="sect4" id="client-header-filter">
2902 <title>client-header-filter</title>
2903
2904 <variablelist>
2905  <varlistentry>
2906   <term>Typical use:</term>
2907   <listitem>
2908    <para>
2909    Rewrite or remove single client headers.
2910    </para>
2911   </listitem>
2912  </varlistentry>
2913
2914  <varlistentry>
2915   <term>Effect:</term>
2916   <listitem>
2917    <para>
2918     All client headers to which this action applies are filtered on-the-fly through
2919     the specified regular expression based substitutions.
2920    </para>
2921   </listitem>
2922  </varlistentry>
2923
2924  <varlistentry>
2925   <term>Type:</term>
2926   <!-- boolean, parameterized, Multi-value -->
2927   <listitem>
2928    <para>Multi-value.</para>
2929   </listitem>
2930  </varlistentry>
2931
2932  <varlistentry>
2933   <term>Parameter:</term>
2934   <listitem>
2935    <para>
2936     The name of a client-header filter, as defined in one of the
2937     <link linkend="filter-file">filter files</link>.
2938    </para>
2939   </listitem>
2940  </varlistentry>
2941
2942  <varlistentry>
2943   <term>Notes:</term>
2944   <listitem>
2945    <para>
2946     Client-header filters are applied to each header on its own, not to
2947     all at once. This makes it easier to diagnose problems, but on the downside
2948     you can't write filters that only change header x if header y's value is z.
2949     You can do that by using tags though.
2950    </para>
2951    <para>
2952     Client-header filters are executed after the other header actions have finished
2953     and use their output as input.
2954    </para>
2955    <para>
2956     If the request URI gets changed, &my-app; will detect that and use the new
2957     one. This can be used to rewrite the request destination behind the client's
2958     back, for example to specify a Tor exit relay for certain requests.
2959    </para>
2960    <para>
2961     Please refer to the <link linkend="filter-file">filter file chapter</link>
2962     to learn which client-header filters are available by default, and how to
2963     create your own.
2964    </para>
2965
2966   </listitem>
2967  </varlistentry>
2968
2969  <varlistentry>
2970   <term>Example usage (section):</term>
2971   <listitem>
2972      <screen>
2973 # Hide Tor exit notation in Host and Referer Headers
2974 {+client-header-filter{hide-tor-exit-notation}}
2975 /
2976 </screen>
2977   </listitem>
2978  </varlistentry>
2979
2980 </variablelist>
2981 </sect3>
2982
2983
2984 <!--   ~~~~~       New section      ~~~~~     -->
2985 <sect3 renderas="sect4" id="client-header-tagger">
2986 <title>client-header-tagger</title>
2987
2988 <variablelist>
2989  <varlistentry>
2990   <term>Typical use:</term>
2991   <listitem>
2992    <para>
2993    Block requests based on their headers.
2994    </para>
2995   </listitem>
2996  </varlistentry>
2997
2998  <varlistentry>
2999   <term>Effect:</term>
3000   <listitem>
3001    <para>
3002     Client headers to which this action applies are filtered on-the-fly through
3003     the specified regular expression based substitutions, the result is used as
3004     tag.
3005    </para>
3006   </listitem>
3007  </varlistentry>
3008
3009  <varlistentry>
3010   <term>Type:</term>
3011   <!-- boolean, parameterized, Multi-value -->
3012   <listitem>
3013    <para>Multi-value.</para>
3014   </listitem>
3015  </varlistentry>
3016
3017  <varlistentry>
3018   <term>Parameter:</term>
3019   <listitem>
3020    <para>
3021     The name of a client-header tagger, as defined in one of the
3022     <link linkend="filter-file">filter files</link>.
3023    </para>
3024   </listitem>
3025  </varlistentry>
3026
3027  <varlistentry>
3028   <term>Notes:</term>
3029   <listitem>
3030    <para>
3031     Client-header taggers are applied to each header on its own,
3032     and as the header isn't modified, each tagger <quote>sees</quote>
3033     the original.
3034    </para>
3035    <para>
3036     Client-header taggers are the first actions that are executed
3037     and their tags can be used to control every other action.
3038    </para>
3039  </listitem>
3040  </varlistentry>
3041
3042  <varlistentry>
3043   <term>Example usage (section):</term>
3044   <listitem>
3045      <screen>
3046 # Tag every request with the User-Agent header
3047 {+client-header-tagger{user-agent}}
3048 /
3049
3050 # Tagging itself doesn't change the action
3051 # settings, sections with TAG patterns do:
3052 #
3053 # If it's a download agent, use a different forwarding proxy,
3054 # show the real User-Agent and make sure resume works.
3055 {+forward-override{forward-socks5 10.0.0.2:2222 .} \
3056  -hide-if-modified-since      \
3057  -overwrite-last-modified     \
3058  -hide-user-agent             \
3059  -filter                      \
3060  -deanimate-gifs              \
3061 }
3062 TAG:^User-Agent: NetBSD-ftp/
3063 TAG:^User-Agent: Novell ZYPP Installer
3064 TAG:^User-Agent: RPM APT-HTTP/
3065 TAG:^User-Agent: fetch libfetch/
3066 TAG:^User-Agent: Ubuntu APT-HTTP/
3067 TAG:^User-Agent: MPlayer/
3068 </screen>
3069
3070      <screen>
3071 # Tag all requests with the Range header set
3072 {+client-header-tagger{range-requests}}
3073 /
3074
3075 # Disable filtering for the tagged requests.
3076 #
3077 # With filtering enabled Privoxy would remove the Range headers
3078 # to be able to filter the whole response. The downside is that
3079 # it prevents clients from resuming downloads or skipping over
3080 # parts of multimedia files.
3081 {-filter -deanimate-gifs}
3082 TAG:^RANGE-REQUEST$
3083 </screen>
3084
3085      <screen>
3086 # Tag all requests with the client IP address
3087 #
3088 # (Technically the client IP address isn't included in the
3089 # client headers but client-header taggers can set it anyway.
3090 # For details see the tagger in default.filter)
3091 {+client-header-tagger{client-ip-address}}
3092 /
3093
3094 # Change forwarding settings for requests coming from address 10.0.0.1
3095 {+forward-override{forward-socks5 127.0.1.2:2222 .}}
3096 TAG:^IP-ADDRESS: 10\.0\.0\.1$
3097 </screen>
3098   </listitem>
3099  </varlistentry>
3100
3101 </variablelist>
3102 </sect3>
3103
3104
3105 <!--   ~~~~~       New section      ~~~~~     -->
3106 <sect3 renderas="sect4" id="content-type-overwrite">
3107 <title>content-type-overwrite</title>
3108
3109 <variablelist>
3110  <varlistentry>
3111   <term>Typical use:</term>
3112   <listitem>
3113    <para>Stop useless download menus from popping up, or change the browser's rendering mode</para>
3114   </listitem>
3115  </varlistentry>
3116
3117  <varlistentry>
3118   <term>Effect:</term>
3119   <listitem>
3120    <para>
3121     Replaces the <quote>Content-Type:</quote> HTTP server header.
3122    </para>
3123   </listitem>
3124  </varlistentry>
3125
3126  <varlistentry>
3127   <term>Type:</term>
3128   <!-- Boolean, Parameterized, Multi-value -->
3129   <listitem>
3130    <para>Parameterized.</para>
3131   </listitem>
3132  </varlistentry>
3133
3134  <varlistentry>
3135   <term>Parameter:</term>
3136   <listitem>
3137    <para>
3138     Any string.
3139    </para>
3140   </listitem>
3141  </varlistentry>
3142
3143  <varlistentry>
3144   <term>Notes:</term>
3145   <listitem>
3146    <para>
3147     The <quote>Content-Type:</quote> HTTP server header is used by the
3148     browser to decide what to do with the document. The value of this
3149     header can cause the browser to open a download menu instead of
3150     displaying the document by itself, even if the document's format is
3151     supported by the browser.
3152    </para>
3153    <para>
3154     The declared content type can also affect which rendering mode
3155     the browser chooses. If XHTML is delivered as <quote>text/html</quote>,
3156     many browsers treat it as yet another broken HTML document.
3157     If it is send as <quote>application/xml</quote>, browsers with
3158     XHTML support will only display it, if the syntax is correct.
3159    </para>
3160    <para>
3161     If you see a web site that proudly uses XHTML buttons, but sets
3162     <quote>Content-Type: text/html</quote>, you can use &my-app;
3163     to overwrite it with <quote>application/xml</quote> and validate
3164     the web master's claim inside your XHTML-supporting browser.
3165     If the syntax is incorrect, the browser will complain loudly.
3166    </para>
3167    <para>
3168     You can also go the opposite direction: if your browser prints
3169     error messages instead of rendering a document falsely declared
3170     as XHTML, you can overwrite the content type with
3171     <quote>text/html</quote> and have it rendered as broken HTML document.
3172    </para>
3173    <para>
3174     By default <literal>content-type-overwrite</literal> only replaces
3175     <quote>Content-Type:</quote> headers that look like some kind of text.
3176     If you want to overwrite it unconditionally, you have to combine it with
3177     <literal><link linkend="force-text-mode">force-text-mode</link></literal>.
3178     This limitation exists for a reason, think twice before circumventing it.
3179    </para>
3180    <para>
3181     Most of the time it's easier to replace this action with a custom
3182     <literal><link linkend="server-header-filter">server-header filter</link></literal>.
3183     It allows you to activate it for every document of a certain site and it will still
3184     only replace the content types you aimed at.
3185    </para>
3186    <para>
3187     Of course you can apply <literal>content-type-overwrite</literal>
3188     to a whole site and then make URL based exceptions, but it's a lot
3189     more work to get the same precision.
3190    </para>
3191   </listitem>
3192  </varlistentry>
3193
3194  <varlistentry>
3195   <term>Example usage (sections):</term>
3196   <listitem>
3197      <screen># Check if www.example.net/ really uses valid XHTML
3198 { +content-type-overwrite{application/xml} }
3199 www.example.net/
3200
3201 # but leave the content type unmodified if the URL looks like a style sheet
3202 {-content-type-overwrite}
3203 www.example.net/.*\.css$
3204 www.example.net/.*style
3205 </screen>
3206   </listitem>
3207  </varlistentry>
3208 </variablelist>
3209 </sect3>
3210
3211
3212 <!--   ~~~~~       New section      ~~~~~     -->
3213 <sect3 renderas="sect4" id="crunch-client-header">
3214 <!--
3215 new action
3216 -->
3217 <title>crunch-client-header</title>
3218
3219 <variablelist>
3220  <varlistentry>
3221   <term>Typical use:</term>
3222   <listitem>
3223    <para>Remove a client header <application>Privoxy</application> has no dedicated action for.</para>
3224   </listitem>
3225  </varlistentry>
3226
3227  <varlistentry>
3228   <term>Effect:</term>
3229   <listitem>
3230    <para>
3231     Deletes every header sent by the client that contains the string the user supplied as parameter.
3232    </para>
3233   </listitem>
3234  </varlistentry>
3235
3236  <varlistentry>
3237   <term>Type:</term>
3238   <!-- Boolean, Parameterized, Multi-value -->
3239   <listitem>
3240    <para>Parameterized.</para>
3241   </listitem>
3242  </varlistentry>
3243
3244  <varlistentry>
3245   <term>Parameter:</term>
3246   <listitem>
3247    <para>
3248     Any string.
3249    </para>
3250   </listitem>
3251  </varlistentry>
3252
3253  <varlistentry>
3254   <term>Notes:</term>
3255   <listitem>
3256    <para>
3257     This action allows you to block client headers for which no dedicated
3258     <application>Privoxy</application> action exists.
3259     <application>Privoxy</application> will remove every client header that
3260     contains the string you supplied as parameter.
3261    </para>
3262    <para>
3263     Regular expressions are <emphasis>not supported</emphasis> and you can't
3264     use this action to block different headers in the same request, unless
3265     they contain the same string.
3266    </para>
3267    <para>
3268     <literal>crunch-client-header</literal> is only meant for quick tests.
3269     If you have to block several different headers, or only want to modify
3270     parts of them, you should use a
3271     <literal><link linkend="client-header-filter">client-header filter</link></literal>.
3272    </para>
3273     <warning>
3274      <para>
3275       Don't block any header without understanding the consequences.
3276      </para>
3277     </warning>
3278   </listitem>
3279  </varlistentry>
3280
3281  <varlistentry>
3282   <term>Example usage (section):</term>
3283   <listitem>
3284      <screen># Block the non-existent "Privacy-Violation:" client header
3285 { +crunch-client-header{Privacy-Violation:} }
3286 /
3287 </screen>
3288   </listitem>
3289  </varlistentry>
3290 </variablelist>
3291 </sect3>
3292
3293
3294 <!--   ~~~~~       New section      ~~~~~     -->
3295 <sect3 renderas="sect4" id="crunch-if-none-match">
3296 <title>crunch-if-none-match</title>
3297 <!--
3298 new action
3299 -->
3300 <variablelist>
3301  <varlistentry>
3302   <term>Typical use:</term>
3303   <listitem>
3304    <para>Prevent yet another way to track the user's steps between sessions.</para>
3305   </listitem>
3306  </varlistentry>
3307
3308  <varlistentry>
3309   <term>Effect:</term>
3310   <listitem>
3311    <para>
3312     Deletes the <quote>If-None-Match:</quote> HTTP client header.
3313    </para>
3314   </listitem>
3315  </varlistentry>
3316
3317  <varlistentry>
3318   <term>Type:</term>
3319   <!-- Boolean, Parameterized, Multi-value -->
3320   <listitem>
3321    <para>Boolean.</para>
3322   </listitem>
3323  </varlistentry>
3324
3325  <varlistentry>
3326   <term>Parameter:</term>
3327   <listitem>
3328    <para>
3329     N/A
3330    </para>
3331   </listitem>
3332  </varlistentry>
3333
3334  <varlistentry>
3335   <term>Notes:</term>
3336   <listitem>
3337    <para>
3338     Removing the <quote>If-None-Match:</quote> HTTP client header
3339     is useful for filter testing, where you want to force a real
3340     reload instead of getting status code <quote>304</quote> which
3341     would cause the browser to use a cached copy of the page.
3342    </para>
3343    <para>
3344     It is also useful to make sure the header isn't used as a cookie
3345     replacement (unlikely but possible).
3346    </para>
3347    <para>
3348     Blocking the <quote>If-None-Match:</quote> header shouldn't cause any
3349     caching problems, as long as the <quote>If-Modified-Since:</quote> header
3350     isn't blocked or missing as well.
3351    </para>
3352    <para>
3353     It is recommended to use this action together with
3354     <literal><link linkend="hide-if-modified-since">hide-if-modified-since</link></literal>
3355     and
3356     <literal><link linkend="overwrite-last-modified">overwrite-last-modified</link></literal>.
3357    </para>
3358   </listitem>
3359  </varlistentry>
3360
3361  <varlistentry>
3362   <term>Example usage (section):</term>
3363   <listitem>
3364      <screen># Let the browser revalidate cached documents but don't
3365 # allow the server to use the revalidation headers for user tracking.
3366 {+hide-if-modified-since{-60} \
3367  +overwrite-last-modified{randomize} \
3368  +crunch-if-none-match}
3369 /
3370 </screen>
3371   </listitem>
3372  </varlistentry>
3373 </variablelist>
3374 </sect3>
3375
3376
3377 <!--   ~~~~~       New section      ~~~~~     -->
3378 <sect3 renderas="sect4" id="crunch-incoming-cookies">
3379 <title>crunch-incoming-cookies</title>
3380
3381 <variablelist>
3382  <varlistentry>
3383   <term>Typical use:</term>
3384   <listitem>
3385    <para>
3386     Prevent the web server from setting HTTP cookies on your system
3387    </para>
3388   </listitem>
3389  </varlistentry>
3390
3391  <varlistentry>
3392   <term>Effect:</term>
3393   <listitem>
3394    <para>
3395     Deletes any <quote>Set-Cookie:</quote> HTTP headers from server replies.
3396    </para>
3397   </listitem>
3398  </varlistentry>
3399
3400  <varlistentry>
3401   <term>Type:</term>
3402   <!-- Boolean, Parameterized, Multi-value -->
3403   <listitem>
3404    <para>Boolean.</para>
3405   </listitem>
3406  </varlistentry>
3407
3408  <varlistentry>
3409   <term>Parameter:</term>
3410   <listitem>
3411    <para>
3412     N/A
3413    </para>
3414   </listitem>
3415  </varlistentry>
3416
3417  <varlistentry>
3418   <term>Notes:</term>
3419   <listitem>
3420    <para>
3421     This action is only concerned with <emphasis>incoming</emphasis> HTTP cookies. For
3422     <emphasis>outgoing</emphasis> HTTP cookies, use
3423     <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>.
3424     Use <emphasis>both</emphasis> to disable HTTP cookies completely.
3425    </para>
3426    <para>
3427     It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
3428     with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
3429     since it would prevent the session cookies from being set. See also
3430     <literal><link linkend="filter-content-cookies">filter-content-cookies</link></literal>.
3431    </para>
3432   </listitem>
3433  </varlistentry>
3434
3435  <varlistentry>
3436   <term>Example usage:</term>
3437   <listitem>
3438     <screen>+crunch-incoming-cookies</screen>
3439   </listitem>
3440  </varlistentry>
3441 </variablelist>
3442 </sect3>
3443
3444
3445 <!--   ~~~~~       New section      ~~~~~     -->
3446 <sect3 renderas="sect4" id="crunch-server-header">
3447 <title>crunch-server-header</title>
3448 <!--
3449 new action
3450 -->
3451 <variablelist>
3452  <varlistentry>
3453   <term>Typical use:</term>
3454   <listitem>
3455    <para>Remove a server header <application>Privoxy</application> has no dedicated action for.</para>
3456   </listitem>
3457  </varlistentry>
3458
3459  <varlistentry>
3460   <term>Effect:</term>
3461   <listitem>
3462    <para>
3463     Deletes every header sent by the server that contains the string the user supplied as parameter.
3464    </para>
3465   </listitem>
3466  </varlistentry>
3467
3468  <varlistentry>
3469   <term>Type:</term>
3470   <!-- Boolean, Parameterized, Multi-value -->
3471   <listitem>
3472    <para>Parameterized.</para>
3473   </listitem>
3474  </varlistentry>
3475
3476  <varlistentry>
3477   <term>Parameter:</term>
3478   <listitem>
3479    <para>
3480     Any string.
3481    </para>
3482   </listitem>
3483  </varlistentry>
3484
3485  <varlistentry>
3486   <term>Notes:</term>
3487   <listitem>
3488    <para>
3489     This action allows you to block server headers for which no dedicated
3490     <application>Privoxy</application> action exists. <application>Privoxy</application>
3491     will remove every server header that contains the string you supplied as parameter.
3492    </para>
3493    <para>
3494     Regular expressions are <emphasis>not supported</emphasis> and you can't
3495     use this action to block different headers in the same request, unless
3496     they contain the same string.
3497    </para>
3498    <para>
3499     <literal>crunch-server-header</literal> is only meant for quick tests.
3500     If you have to block several different headers, or only want to modify
3501     parts of them, you should use a custom
3502     <literal><link linkend="server-header-filter">server-header filter</link></literal>.
3503    </para>
3504     <warning>
3505      <para>
3506      Don't block any header without understanding the consequences.
3507      </para>
3508     </warning>
3509   </listitem>
3510  </varlistentry>
3511
3512  <varlistentry>
3513   <term>Example usage (section):</term>
3514   <listitem>
3515      <screen># Crunch server headers that try to prevent caching
3516 { +crunch-server-header{no-cache} }
3517 /
3518 </screen>
3519   </listitem>
3520  </varlistentry>
3521 </variablelist>
3522 </sect3>
3523
3524
3525 <!--   ~~~~~       New section      ~~~~~     -->
3526 <sect3 renderas="sect4" id="crunch-outgoing-cookies">
3527 <title>crunch-outgoing-cookies</title>
3528
3529 <variablelist>
3530  <varlistentry>
3531   <term>Typical use:</term>
3532   <listitem>
3533    <para>
3534     Prevent the web server from reading any HTTP cookies from your system
3535    </para>
3536   </listitem>
3537  </varlistentry>
3538
3539  <varlistentry>
3540   <term>Effect:</term>
3541   <listitem>
3542    <para>
3543     Deletes any <quote>Cookie:</quote> HTTP headers from client requests.
3544    </para>
3545   </listitem>
3546  </varlistentry>
3547
3548  <varlistentry>
3549   <term>Type:</term>
3550   <!-- Boolean, Parameterized, Multi-value -->
3551   <listitem>
3552    <para>Boolean.</para>
3553   </listitem>
3554  </varlistentry>
3555
3556  <varlistentry>
3557   <term>Parameter:</term>
3558   <listitem>
3559    <para>
3560     N/A
3561    </para>
3562   </listitem>
3563  </varlistentry>
3564
3565  <varlistentry>
3566   <term>Notes:</term>
3567   <listitem>
3568    <para>
3569     This action is only concerned with <emphasis>outgoing</emphasis> HTTP cookies. For
3570     <emphasis>incoming</emphasis> HTTP cookies, use
3571     <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal>.
3572     Use <emphasis>both</emphasis> to disable HTTP cookies completely.
3573    </para>
3574    <para>
3575     It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
3576     with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
3577     since it would prevent the session cookies from being read.
3578    </para>
3579   </listitem>
3580  </varlistentry>
3581
3582  <varlistentry>
3583   <term>Example usage:</term>
3584   <listitem>
3585     <screen>+crunch-outgoing-cookies</screen>
3586   </listitem>
3587  </varlistentry>
3588
3589 </variablelist>
3590 </sect3>
3591
3592
3593 <!--   ~~~~~       New section      ~~~~~     -->
3594 <sect3 renderas="sect4" id="deanimate-gifs">
3595 <title>deanimate-gifs</title>
3596
3597 <variablelist>
3598  <varlistentry>
3599   <term>Typical use:</term>
3600   <listitem>
3601    <para>Stop those annoying, distracting animated GIF images.</para>
3602   </listitem>
3603  </varlistentry>
3604
3605  <varlistentry>
3606   <term>Effect:</term>
3607   <listitem>
3608    <para>
3609     De-animate GIF animations, i.e. reduce them to their first or last image.
3610    </para>
3611   </listitem>
3612  </varlistentry>
3613
3614  <varlistentry>
3615   <term>Type:</term>
3616   <!-- boolean, parameterized, Multi-value -->
3617   <listitem>
3618    <para>Parameterized.</para>
3619   </listitem>
3620  </varlistentry>
3621
3622  <varlistentry>
3623   <term>Parameter:</term>
3624   <listitem>
3625    <para>
3626     <quote>last</quote> or <quote>first</quote>
3627    </para>
3628   </listitem>
3629  </varlistentry>
3630
3631  <varlistentry>
3632   <term>Notes:</term>
3633   <listitem>
3634    <para>
3635     This will also shrink the images considerably (in bytes, not pixels!). If
3636     the option <quote>first</quote> is given, the first frame of the animation
3637     is used as the replacement. If <quote>last</quote> is given, the last
3638     frame of the animation is used instead, which probably makes more sense for
3639     most banner animations, but also has the risk of not showing the entire
3640     last frame (if it is only a delta to an earlier frame).
3641    </para>
3642    <para>