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