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