1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "IGNORE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity seealso SYSTEM "seealso.sgml">
7 <!entity buildsource SYSTEM "buildsource.sgml">
8 <!entity contacting SYSTEM "contacting.sgml">
9 <!entity history SYSTEM "history.sgml">
10 <!entity copyright SYSTEM "copyright.sgml">
11 <!entity license SYSTEM "license.sgml">
12 <!entity p-authors SYSTEM "p-authors.sgml">
13 <!entity p-version "2.9.15">
14 <!entity p-status "beta">
15 <!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
16 <!entity % p-not-stable "INCLUDE">
17 <!entity % p-stable "IGNORE">
18 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
19 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
20 <!entity % p-readme "IGNORE">
21 <!entity % p-config "IGNORE">
22 <!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml -->
23 <!entity my-copy "©"> <!-- kludge for docbook2man -->
24 <!entity % draft "IGNORE"> <!-- WIP stuff -->
27 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
30 This file belongs into
31 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
33 $Id: user-manual.sgml,v 1.118 2002/05/21 04:54:55 hal9 Exp $
35 Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
38 ========================================================================
39 NOTE: Please read developer-manual/documentation.html before touching
40 anything in this, or other Privoxy documentation.
41 ========================================================================
48 <title>Privoxy User Manual</title>
52 <!-- Completely the wrong markup, but very little is allowed -->
53 <!-- in this part of an article. FIXME -->
54 <link linkend="copyright">Copyright</link> &my-copy; 2001, 2002 by
55 <ulink url="http://www.privoxy.org">Privoxy Developers</ulink>
59 <pubdate>$Id: user-manual.sgml,v 1.118 2002/05/21 04:54:55 hal9 Exp $</pubdate>
63 Note: the following should generate a separate page, and a live link to it,
64 all nicely done. But it doesn't for some mysterious reason. Please leave
65 commented unless it can be fixed proper. For the time being, the
66 copyright/license declarations will be in their own sgml.
73 <holder>Privoxy Developers</holder>
76 <legalnotice id="legalnotice">
78 text goes here ........
90 This is here to keep vim syntax file from breaking :/
91 If I knew enough to fix it, I would.
92 PLEASE DO NOT REMOVE! HB: hal@foobox.net
98 The user manual gives users information on how to install, configure and use
100 url="http://www.privoxy.org/"><application>Privoxy</application></ulink>.
103 <!-- Include privoxy.sgml boilerplate: -->
105 <!-- end privoxy.sgml -->
108 You can find the latest version of the user manual at <ulink
109 url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
110 Please see the <ulink url="contact.html">Contact section</ulink> on how to
111 contact the developers.
115 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
121 <!-- ~~~~~ New section ~~~~~ -->
122 <sect1 label="1" id="introduction"><title>Introduction</title>
124 This documentation is included with the current &p-status; version of
125 <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[,
126 and is mostly complete at this point. The most up to date reference for the
127 time being is still the comments in the source files and in the individual
128 configuration files. Development of version 3.0 is currently nearing
129 completion, and includes many significant changes and enhancements over
130 earlier versions. The target release date for
131 stable v3.0 is <quote>soon</quote> ;-)]]>.
134 <!-- include only in non-stable versions -->
137 Since this is a &p-status; version, not all new features are well tested. This
138 documentation may be slightly out of sync as a result (especially with
139 CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
144 <!-- ~~~~~ New section ~~~~~ -->
145 <sect2 id="features"><title>Features</title>
147 In addition to <application>Internet Junkbuster's</application> traditional
148 features of ad and banner blocking and cookie management,
149 <application>Privoxy</application> provides new features<![%p-not-stable;[,
150 some of them currently under development]]>:
152 <!-- Include newfeatures.sgml boilerplate here: -->
154 <!-- end boilerplate -->
159 <!-- ~ End section ~ -->
162 <!-- ~~~~~ New section ~~~~~ -->
163 <sect1 id="installation"><title>Installation</title>
166 <application>Privoxy</application> is available both in convenient pre-compiled
167 packages for a wide range of operating systems, and as raw source code.
168 For most users, we recommend using the packages, which can be downloaded from our
169 <ulink url="http://sourceforge.net/projects/ijbswa/">Privoxy Project
174 Note: If you have a previous <application>Junkbuster</application> or
175 <application>Privoxy</application> installation on your system, you
176 will need to remove it. On some platforms, this may be done for you as part
177 of their installation procedure. (See below for your platform). In any case
178 <emphasis>be sure to backup your old configuration if it is valuable to
179 you.</emphasis> See the <link linkend="upgradersnote">note to
180 upgraders</link> section below.
183 <!-- ~~~~~ New section ~~~~~ -->
184 <sect2 id="installation-packages"><title>Binary Packages</title>
186 How to install the binary packages depends on your operating system:
189 <!-- ~~~~~ New section ~~~~~ -->
190 <sect3 id="installation-pack-rpm"><title>Red Hat, SuSE RPMs and Conectiva</title>
193 RPMs can be installed with <literal>rpm -Uvh privoxy-&p-version;-1.rpm</literal>,
194 and will use <filename>/etc/privoxy</filename> for the location
195 of configuration files.
199 Note that on Red Hat, <application>Privoxy</application> will
200 <emphasis>not</emphasis> be automatically started on system boot. You will
201 need to enable that using <command>chkconfig</command>,
202 <command>ntsysv</command>, or similar methods. Note that SuSE will
203 automatically start Privoxy in the boot process.
207 If you have problems with failed dependencies, try rebuilding the SRC RPM:
208 <literal>rpm --rebuild privoxy-&p-version;-1.src.rpm;</literal>. This
209 will use your locally installed libraries and RPM version.
213 Also note that if you have a <application>Junkbuster</application> RPM installed
214 on your system, you need to remove it first, because the packages conflict.
215 Otherwise, RPM will try to remove <application>Junkbuster</application>
216 automatically, before installing <application>Privoxy</application>.
220 <!-- ~~~~~ New section ~~~~~ -->
221 <sect3 id="installation-deb"><title>Debian</title>
227 <!-- ~~~~~ New section ~~~~~ -->
228 <sect3 id="installation-pack-win"><title>Windows</title>
231 Just double-click the installer, which will guide you through
232 the installation process. You will find the configuration files
233 in the same directory as you installed Privoxy in. We do not
234 use the registry of Windows.
238 <!-- ~~~~~ New section ~~~~~ -->
239 <sect3 id="installation-pack-bintgz"><title>Solaris, NetBSD, FreeBSD, HP-UX</title>
242 Create a new directory, <literal>cd</literal> to it, then unzip and
243 untar the archive. For the most part, you'll have to figure out where
248 <!-- ~~~~~ New section ~~~~~ -->
249 <sect3 id="installation-os2"><title>OS/2</title>
252 First, make sure that no previous installations of
253 <application>Junkbuster</application> and / or
254 <application>Privoxy</application> are left on your
255 system. You can do this by
259 Then, just double-click the WarpIN self-installing archive, which will
260 guide you through the installation process. A shadow of the
261 <application>Privoxy</application> executable will be placed in your
262 startup folder so it will start automatically whenever OS/2 starts.
266 The directory you choose to install <application>Privoxy</application>
267 into will contain all of the configuration files.
271 <!-- ~~~~~ New section ~~~~~ -->
272 <sect3 id="installation-mac"><title>Max OSX</title>
274 Unzip the downloaded package (you can either double-click on the file
275 in the finder, or on the desktop if you downloaded it there). Then,
276 double-click on the package installer icon and follow the installation
278 <application>Privoxy</application> will be installed in the subdirectory
279 <literal>/Applications/Privoxy.app</literal>.
280 <application>Privoxy</application> will set itself up to start
281 automatically on system bring-up via
282 <literal>/System/Library/StartupItems/Privoxy</literal>.
286 <!-- ~~~~~ New section ~~~~~ -->
287 <sect3 id="installation-amiga"><title>AmigaOS</title>
289 Copy and then unpack the <filename>lha</filename> archive to a suitable location.
290 All necessary files will be installed into <application>Privoxy</application>
291 directory, including all configuration and log files. To uninstall, just
292 remove this directory.
295 Start <application>Privoxy</application> (with RUN <>NIL:) in your
296 <filename>startnet</filename> script (AmiTCP), in
297 <filename>s:user-startup</filename> (RoadShow), as startup program in your
298 startup script (Genesis), or as startup action (Miami and MiamiDx).
299 <application>Privoxy</application> will automatically quit when you quit your
300 TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
301 <application>Privoxy</application> is still running).
306 <!-- ~~~~~ New section ~~~~~ -->
307 <sect2 id="installation-source"><title>Building from Source</title>
310 The most convenient way to obtain the <application>Privoxy</application> sources
311 is to download the source tarball from our <ulink url="http://sf.net/projects/ijbswa/">project
316 If you like to live on the bleeding edge and are not afraid of using
317 possibly unstable development versions, you can check out the up-to-the-minute
318 version directly from <ulink url="http://sourceforge.net/cvs/?group_id=11118">the
319 CVS repository</ulink> or simply download <ulink
320 url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz">the nightly CVS
324 <!-- include buildsource.sgml boilerplate: -->
326 <!-- end boilerplate -->
332 <!-- ~ End section ~ -->
334 <!-- ~~~~~ New section ~~~~~ -->
335 <sect1 id="upgradersnote">
336 <title>Note to Upgraders</title>
338 There are very significant changes from earlier
339 <application>Junkbuster</application> versions to the current
340 <application>Privoxy</application>. The number, names, syntax, and
341 purposes of configuration files have substantially changed.
342 <application>Junkbuster 2.0.x</application> configuration
343 files will not migrate, <application>Junkbuster 2.9.x</application>
344 and <application>Privoxy</application> configurations will need to be
345 ported. The functionalities of the old <filename>blockfile</filename>,
346 <filename>cookiefile</filename> and <filename>imagelist</filename>
347 are now combined into the <link linkend="actions-file"><quote>actions
348 files</quote></link>.
349 <filename>default.action</filename>, is the main actions file. Local
350 exceptions should best be put into <filename>user.action</filename>.
353 A <link linkend="filter-file"><quote>filter file</quote></link> (typically
354 <filename>default.filter</filename>) is new as of <application>Privoxy
355 2.9.x</application>, and provides some of the new sophistication (explained
356 below). <filename>config</filename> is much the same as before.
359 If upgrading from a 2.0.x version, you will have to use the new config
360 files, and possibly adapt any personal rules from your older files.
361 When porting personal rules over from the old <filename>blockfile</filename>
362 to the new actions files, please note that even the pattern syntax has
363 changed. If upgrading from 2.9.x development versions, it is still
364 recommended to use the new configuration files.
367 A quick list of things to be aware of before upgrading:
375 The default listening port is now 8118 due to a conflict with another
381 Some installers may remove earlier versions completely. Save any
382 important configuration files!
387 <application>Privoxy</application> is controllable with a web browser
388 at the special URL: <ulink
389 url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
390 (Shortcut: <ulink url="http://p.p/">http://p.p/</ulink>). Many
391 aspects of configuration can be done here, including temporarily disabling
392 <application>Privoxy</application>.
397 The primary configuration files for cookie management, ad and banner
398 blocking, and many other aspects of <application>Privoxy</application>
399 configuration are the <link linkend="actions-file">actions
400 files</link>. It is strongly recommended to become familiar with the new
401 actions concept below, before modifying these files. Locally defined rules
402 should go into <filename>user.action</filename>.
407 <!-- I think it is best to keep this somewhat vague, in case -->
408 <!-- the situation changes under our feet. -->
409 Some installers may not automatically start
410 <application>Privoxy</application> after installation.
418 <!-- ~~~~~ New section ~~~~~ -->
419 <sect1 id="quickstart"><title>Quickstart to Using <application>Privoxy</application></title>
425 If upgrading, from versions before 2.9.16, please back up any configuration
426 files. See the <link linkend="upgradersnote">Note to Upgraders</link> Section.
432 Install <application>Privoxy</application>. See the <link
433 linkend="installation">Installation Section</link> below for platform specific
440 Advanced users and those who want to offer <application>Privoxy</application>
441 service to more than just their local machine should check the <link
442 linkend="config">main config file</link>, especially the <link
443 linkend="access-control">security-relevant</link> options. These are
450 Start <application>Privoxy</application>, if the installation program has
451 not done this already (may vary according to platform). See the section
452 <link linkend="startup">Starting <application>Privoxy</application></link>.
458 Set your browser to use <application>Privoxy</application> as HTTP and
459 HTTPS proxy by setting the proxy configuration for address of
460 <literal>127.0.0.1</literal> and port <literal>8118</literal>.
461 (<application>Junkbuster</application> and earlier versions of
462 <application>Privoxy</application> used port 8000.) See the section <link
463 linkend="startup">Starting <application>Privoxy</application></link> below
464 for more details on this.
470 Flush your browser's disk and memory caches, to remove any cached ad images.
476 A default installation should provide a reasonable starting point for
477 most. There will undoubtedly be occasions where you will want to adjust the
478 configuration, but that can be dealt with as the need arises. Little
479 to no initial configuration is required in most cases.
482 See the <link linkend="configuration">Configuration section</link> for more
483 configuration options, and how to customize your installation.
484 <![%draft;[ You might also want to look at the <link
485 linkend="quickstart-ad-blocking">next section</link> for a quick
486 introduction to how <application>Privoxy</application> blocks ads and
493 If you experience ads that slipped through, innocent images that are
494 blocked, or otherwise feel the need to fine-tune
495 <application>Privoxy's</application> behaviour, take a look at the <link
496 linkend="actions-file">actions files</link>. As a quick start, you might
497 find the <link linkend="act-examples">richly commented examples</link>
498 helpful. You can also view and edit the actions files through the <ulink
499 url="http://config.privoxy.org">web-based user interface</ulink>. The
500 Appendix <quote><link linkend="actionsanat">Anatomy of an
501 Action</link></quote> has hints how to debug actions that
502 <quote>misbehave</quote>.
508 Please see the section <link linkend="contact">Contacting the
509 Developers</link> on how to report bugs or problems with websites or to get
516 Now enjoy surfing with enhanced comfort and privacy!
524 <!-- ~~~~~ New section ~~~~~ -->
526 <sect2 id="quickstart-ad-blocking">
527 <title>Quickstart to Ad Blocking</title>
529 NOTE: This section is deliberately redundant for those that don't
530 want to read the whole thing (which is getting lengthy).
533 Ad blocking is but one of <application>Privoxy's</application>
534 array of features. Many of these features are for the technically minded advanced
535 user. But, ad and banner blocking is surely common ground for everybody.
538 This section will provide a quick summary of ad blocking so
539 you can get up to speed quickly without having to read the more extensive
540 information provided below, though this is highly recommeneded.
543 First a bit of a warning ... blocking ads is much like blocking SPAM: the
544 more aggressive you are about it, the more likely you are to block
545 things that were not intended. So there is a trade off here. If you want
546 extreme ad free browsing, be prepared to deal with more
547 <quote>problem</quote> sites, and to spend more time adjusting the
548 configuration to solve these unintended consequences. In short, there is
549 not an easy way to eliminate <emphasis>all</emphasis> ads. Either take
550 the easy way and settle for <emphasis>most</emphasis> ads blocked with the
551 default configuration, or jump in and tweak it for your personal surfing
552 habits and preferences.
555 Secondly, a brief explanation of <application>Privoxy's </application>
556 <quote>actions</quote>. <quote>Actions</quote> in this context, are
557 the directives we use to tell <application>Privoxy</application> to perform
558 some task relating to HTTP transactions (i.e. web browsing). We tell
559 <application>Privoxy</application> to take some <quote>action</quote>. Each
560 action has a unique name and function. While there are many potential
561 <application>actions</application> in <application>Privoxy's</application>
562 arsenal, only a few are used for ad blocking. <link
563 linkend="actions">Actions</link>, and <link linkend="actions-file">action
564 configuration files</link>, are explained in depth below.
567 Actions are specified in <application>Privoxy's</application> configuration,
568 followed by one or more URLs to which the action should apply. URLs
569 can actually be URL type <link linkend="af-patterns">patterns</link> that use
570 wildcards so they can apply potentially to a range of similar URLs.
573 When you connect to a website, the full path of the URL will either match one
574 of the <quote>actions</quote> as defined in
575 <application>Privoxy's</application> configuration, or not. If so, then
576 <application>Privoxy</application> will perform the action accordingly. If
577 not, then nothing special happens. Futhermore, web pages may contain
578 embedded, secondary URLs that your web browser will display as it parses the
579 original page's HTML content. An ad image for instance, is just a URL
580 embedded in the page somewhere. The image itself may be on the same server,
581 or a server somewhere else on the Internet. Complex web pages will have many
586 The actions we need to know about for ad blocking are: <link
587 linkend="block">block</link>, <link
588 linkend="handle-as-image">handle-as-image</link>, and <link
589 linkend="set-image-blocker">set-image-blocker</link>:
597 <link linkend="block"><emphasis>block</emphasis></link> - this action stops
598 any contact between your browser and any URL patterns that match this
599 action's configuration. It can be used for blocking ads, but also anything
600 that is determined to be unwanted. By itself, it simply stops any
601 communication with the remote server. If this is the only action that
602 matches for this particular URL, then <application>Privoxy</application> will
603 display its own BLOCKED page to let you now what has happened.
609 <link linkend="handle-as-image"><emphasis>handle-as-image</emphasis></link> -
610 forces <application>Privoxy</application> to treat this URL as if it were
611 an image. <application>Privoxy</application> knows about common image
612 types (e.g. GIF), but there are many situations where this does not apply.
613 So we'll force it. This is particularly important for ad blocking, since
614 once we can treat it as an image, we can make more intelligent decisisions
615 on how to handle it. There are some limitations to this though. For
616 instance, you can't just force an image substituion for an entire HTML page
624 linkend="set-image-blocker"><emphasis>set-image-blocker</emphasis></link> -
625 tells <application>Privoxy</application> what to display in place of
626 an ad image that has hit a block rule. For this to come into play,
627 the URL must match a block action somewhere in the configuration.
628 <emphasis>And</emphasis>, it must also either be of a known image type, or
630 linkend="handle-as-image"><emphasis>handle-as-image</emphasis></link>
634 The configuration options on what to display instead of the ad are:
638 <emphasis>pattern</emphasis> - a checkboard pattern, so that an ad
639 replacement is obvious. This is the default.
644 <emphasis>blank</emphasis> - A very small empty GIF image is displayed.
645 This is the so-called <quote>invisible</quote> configuration option.
650 <emphasis>http://<URL></emphasis> - A redirect to any URL of the
651 user's choosing (advanced usage).
660 The quickest way to adjust any of these settings is with your browser through
661 the special <application>Privoxy</application> editor at <ulink
662 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
663 (shortcut: <ulink url="http://p.p/">http://p.p/show-status</ulink>). This
664 is an internal page, and does not require Internet access. Select the
665 appropriate <quote>actions</quote> file, and click
666 <quote><guibutton>Edit</guibutton></quote>. It is best to put personal or
667 local preferences in <filename>user.action</filename> since this is not
668 meant to be overwritten during upgrades, and will over-ride the settings in
669 other files. Here you can insert new <quote>actions</quote>, and URLs for ad
670 blocking or other purposes, and make other adjustments to the configuration.
671 <application>Privoxy</application> will detect these changes automatically.
675 A quick and simple step by step example:
683 Right click on the ad image to be blocked, then select
684 <quote><guimenuitem>Copy Link Location</guimenuitem></quote> from the
692 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
697 Find <filename>user.action</filename> in the top section, and click
698 on <quote><guibutton>Edit</guibutton></quote>:
701 <!-- image of editor and actions files selections -->
703 <figure pgwide="0" float="0"><title>Actions Files in Use</title>
706 <imagedata fileref="../images/files-in-use.jpg" format="jpg">
709 <phrase>Screenshot of Files in Use</phrase>
718 You should have an Actions section labeled <emphasis>+block</emphasis>.
719 If not, click the <quote><guibutton>Edit</guibutton></quote> button just
720 under the word <quote>Actions</quote>. This will bring up a list of all
721 actions. Find <emphasis>block</emphasis> near the top, and click in the
722 <quote>Enabled</quote> column, then
723 <quote><guibutton>Submit</guibutton></quote> just below the list.
728 Now, in the <emphasis>+block</emphasis> actions section, click the
729 <quote><guibutton>Add</guibutton></quote> button, and paste the URL the
730 browser got from <quote><guimenuitem>Copy Link
731 Location</guimenuitem></quote>. Remove the <literal>http://</literal> at
732 the beginning of the URL. Then, click
733 <quote><guibutton>Submit</guibutton></quote>.
738 Now go back to the original page, and press <keycap>SHIFT-Reload</keycap>
739 (or flush all browser caches). The image should be gone now.
747 This is a very crude and simple example. There might be good reasons to use a
748 wildcard pattern match to include potentially similar images from the same
749 site. For a more extensive explanation of <quote>patterns</quote>, and
750 the entire actions concept, see <link linkend="actions-file">the Actions
755 For advanced users who want to hand edit their config files, you might want
756 to now go to the <link linkend="act-examples">Actions Files Tutorial</link>.
763 <!-- ~ End section ~ -->
766 <!-- ~~~~~ New section ~~~~~ -->
768 <title>Starting <application>Privoxy</application></title>
770 Before launching <application>Privoxy</application> for the first time, you
771 will want to configure your browser(s) to use
772 <application>Privoxy</application> as a HTTP and HTTPS proxy. The default is
773 127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions
774 used port 8000). This is the one configuration step that must be done!
778 With <application>Netscape</application> (and
779 <application>Mozilla</application>), this can be set under <literal>Edit
780 -> Preferences -> Advanced -> Proxies -> HTTP Proxy</literal>.
781 For <application>Internet Explorer</application>: <literal>Tools ->
782 Internet Properties -> Connections -> LAN Setting</literal>. Then,
783 check <quote>Use Proxy</quote> and fill in the appropriate info (Address:
784 127.0.0.1, Port: 8118). Include if HTTPS proxy support too.
788 After doing this, flush your browser's disk and memory caches to force a
789 re-reading of all pages and to get rid of any ads that may be cached. You
790 are now ready to start enjoying the benefits of using
791 <application>Privoxy</application>!
795 <application>Privoxy</application> is typically started by specifying the
796 main configuration file to be used on the command line. If no configuration
797 file is specified on the command line, <application>Privoxy</application>
798 will look for a file named <filename>config</filename> in the current
799 directory. Except on Win32 where it will try <filename>config.txt</filename>.
802 <sect2 id="start-redhatdebian">
803 <title>RedHat, Conectiva and Debian</title>
805 We use a script. Note that RedHat does not start Privoxy upon booting per
806 default. It will use the file <filename>/etc/privoxy/config</filename> as its
807 main configuration file. FIXME: Debian??
811 # /etc/rc.d/init.d/privoxy start
816 <sect2 id="start-suse">
819 We use a script. It will use the file <filename>/etc/privoxy/config</filename>
820 as its main configuration file. Note that SuSE starts Privoxy upon booting
830 <sect2 id="start-windows">
831 <title>Windows</title>
833 Click on the Privoxy Icon to start Privoxy. If no configuration file is
834 specified on the command line, <application>Privoxy</application> will look
835 for a file named <filename>config.txt</filename>. Note that Windows will
836 automatically start Privoxy upon booting you PC.
840 <sect2 id="start-unices">
841 <title>Solaris, NetBSD, FreeBSD, HP-UX and others</title>
843 Example Unix startup command:
847 # /usr/sbin/privoxy /etc/privoxy/config
852 <sect2 id="start-os2">
859 <sect2 id="start-macosx">
860 <title>MAX OSX</title>
867 <sect2 id="start-amigaos">
868 <title>AmigaOS</title>
877 See the section <link linkend="cmdoptions">Command line options</link> for
881 must find a better place for this paragraph
884 The included default configuration files should give a reasonable starting
885 point. Most of the per site configuration is done in the
886 <ulink url="actions-file.html"><quote>actions</quote></ulink> files. These are
887 where various cookie actions are defined, ad and banner blocking, and other
888 aspects of <application>Privoxy</application> configuration. There are several
889 such files included, with varying levels of aggressiveness.
893 You will probably want to keep an eye out for sites for which you may prefer
894 persistent cookies, and add these to your actions configuration as needed. By
895 default, most of these will be accepted only during the current browser
896 session (aka <quote>session cookies</quote>), unless you add them to the
897 configuration. If you want the browser to handle this instead, you will need
898 to edit <filename>user.action</filename> (or through the web based interface)
899 and disable this feature. If you use more than one browser, it would make
900 more sense to let <application>Privoxy</application> handle this. In which
901 case, the browser(s) should be set to accept all cookies.
905 Another feature where you will probably want to define exceptions for trusted
906 sites is the popup-killing (through the <ulink
907 url="actions-file.html#KILL-POPUPS"><quote>+kill-popups</quote></ulink> and
909 url="actions-file.html#FILTER-POPUPS"><quote>+filter{popups}</quote></ulink>
910 actions), because your favorite shopping, banking, or leisure site may need
911 popups (explained below).
915 <application>Privoxy</application> is HTTP/1.1 compliant, but not all of
916 the optional 1.1 features are as yet supported. In the unlikely event that
917 you experience inexplicable problems with browsers that use HTTP/1.1 per default
918 (like <application>Mozilla</application> or recent versions of I.E.), you might
919 try to force HTTP/1.0 compatibility. For Mozilla, look under <literal>Edit ->
920 Preferences -> Debug -> Networking</literal>.
921 Alternatively, set the <quote>+downgrade-http-version</quote> config option in
922 <filename>default.action</filename> which will downgrade your browser's HTTP
923 requests from HTTP/1.1 to HTTP/1.0 before processing them.
927 After running <application>Privoxy</application> for a while, you can
928 start to fine tune the configuration to suit your personal, or site,
929 preferences and requirements. There are many, many aspects that can
930 be customized. <quote>Actions</quote>
931 can be adjusted by pointing your browser to
932 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
933 (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
934 and then follow the link to <quote>View & Change the Current Configuration</quote>.
935 (This is an internal page and does not require Internet access.)
939 In fact, various aspects of <application>Privoxy</application>
940 configuration can be viewed from this page, including
941 current configuration parameters, source code version numbers,
942 the browser's request headers, and <quote>actions</quote> that apply
943 to a given URL. In addition to the actions file
944 editor mentioned above, <application>Privoxy</application> can also
945 be turned <quote>on</quote> and <quote>off</quote> (toggled) from this page.
949 If you encounter problems, try loading the page without
950 <application>Privoxy</application>. If that helps, enter the URL where
951 you have the problems into <ulink url="http://p.p/show-url-info">the browser
952 based rule tracing utility</ulink>. See which rules apply and why, and
953 then try turning them off for that site one after the other, until the problem
954 is gone. When you have found the culprit, you might want to turn the rest on
959 If the above paragraph sounds gibberish to you, you might want to <ulink
960 url="actions-file.html#ACTIONSFILE">read more about the actions concept</ulink>
961 or even dive deep into the <ulink url="appendix.html#ACTIONSANAT">Appendix
966 If you can't get rid of the problem at all, think you've found a bug in
967 Privoxy, want to propose a new feature or smarter rules, please see the
968 section <ulink url="contact.html"><quote>Contacting the
969 Developers</quote></ulink> below.
974 <!-- ~~~~~ New section ~~~~~ -->
975 <sect2 id="cmdoptions">
976 <title>Command Line Options</title>
978 <application>Privoxy</application> may be invoked with the following
979 command-line options:
987 <emphasis>--version</emphasis>
990 Print version info and exit. Unix only.
995 <emphasis>--help</emphasis>
998 Print short usage info and exit. Unix only.
1003 <emphasis>--no-daemon</emphasis>
1006 Don't become a daemon, i.e. don't fork and become process group
1007 leader, and don't detach from controlling tty. Unix only.
1012 <emphasis>--pidfile FILE</emphasis>
1016 On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
1017 <emphasis>FILE</emphasis> on exit. Failure to create or delete the
1018 <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
1019 option is given, no PID file will be used. Unix only.
1024 <emphasis>--user USER[.GROUP]</emphasis>
1028 After (optionally) writing the PID file, assume the user ID of
1029 <emphasis>USER</emphasis>, and if included the GID of GROUP. Exit if the
1030 privileges are not sufficient to do so. Unix only.
1035 <emphasis>configfile</emphasis>
1038 If no <emphasis>configfile</emphasis> is included on the command line,
1039 <application>Privoxy</application> will look for a file named
1040 <quote>config</quote> in the current directory (except on Win32
1041 where it will look for <quote>config.txt</quote> instead). Specify
1042 full path to avoid confusion. If no config file is found,
1043 <application>Privoxy</application> will fail to start.
1054 <!-- ~ End section ~ -->
1057 <!-- ~~~~~ New section ~~~~~ -->
1058 <sect1 id="configuration"><title><application>Privoxy</application> Configuration</title>
1060 All <application>Privoxy</application> configuration is stored
1061 in text files. These files can be edited with a text editor.
1062 Many important aspects of <application>Privoxy</application> can
1063 also be controlled easily with a web browser.
1067 <!-- ~~~~~ New section ~~~~~ -->
1070 <title>Controlling <application>Privoxy</application> with Your Web Browser</title>
1072 <application>Privoxy</application>'s user interface can be reached through the special
1073 URL <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
1074 (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
1075 which is a built-in page and works without Internet access.
1076 You will see the following section:
1080 <!-- Needs to be put in a table and colorized -->
1083 <bridgehead renderas="sect2">Privoxy Menu</bridgehead>
1087 ▪ <ulink url="http://config.privoxy.org/show-status">View & change the current configuration</ulink>
1090 ▪ <ulink url="http://config.privoxy.org/show-version">View the source code version numbers</ulink>
1093 ▪ <ulink url="http://config.privoxy.org/show-request">View the request headers.</ulink>
1096 ▪ <ulink url="http://config.privoxy.org/show-url-info">Look up which actions apply to a URL and why</ulink>
1099 ▪ <ulink url="http://config.privoxy.org/toggle">Toggle Privoxy on or off</ulink>
1107 This should be self-explanatory. Note the first item leads to an editor for the
1108 <link linkend="actions-file">actions files</link>, which is where the ad, banner,
1109 cookie, and URL blocking magic is configured as well as other advanced features of
1110 <application>Privoxy</application>. This is an easy way to adjust various
1111 aspects of <application>Privoxy</application> configuration. The actions
1112 file, and other configuration files, are explained in detail below.
1116 <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
1117 have problems with your current actions and filters. You can in fact use
1118 it as a test to see whether it is <application>Privoxy</application>
1119 causing the problem or not. <application>Privoxy</application> continues
1120 to run as a proxy in this case, but all manipulation is disabled, i.e.
1121 <application>Privoxy</application> acts like a normal forwarding proxy. There
1122 is even a toggle <link linkend="bookmarklets">Bookmarklet</link> offered, so
1123 that you can toggle <application>Privoxy</application> with one click from
1129 <!-- ~ End section ~ -->
1134 <!-- ~~~~~ New section ~~~~~ -->
1136 <sect2 id="confoverview">
1137 <title>Configuration Files Overview</title>
1139 For Unix, *BSD and Linux, all configuration files are located in
1140 <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
1141 AmigaOS these are all in the same directory as the
1142 <application>Privoxy</application> executable. <![%p-not-stable;[ The name
1143 and number of configuration files has changed from previous versions, and is
1144 subject to change as development progresses.]]>
1148 The installed defaults provide a reasonable starting point, though
1149 some settings may be aggressive by some standards. For the time being, the
1150 principle configuration files are:
1158 The <link linkend="config">main configuration file</link> is named <filename>config</filename>
1159 on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
1160 on Windows. This is a required file.
1166 <filename>default.action</filename> (the main <link linkend="actions-file">actions file</link>)
1167 is used to define which <quote>actions</quote> relating to banner-blocking, images, pop-ups,
1168 content modification, cookie handling etc should be applied by default. It also defines many
1169 exceptions (both positive and negative) from this default set of actions that enable
1170 <application>Privoxy</application> to selectively eliminate the junk, and only the junk, on
1171 as many websites as possible.
1174 Multiple actions files may be defined in <filename>config</filename>. These
1175 are processed in the order they are defined. Local customizations and locally
1176 preferred exceptions to the default policies as defined in
1177 <filename>default.action</filename> (which you will most probably want
1178 to define sooner or later) are probably best applied in
1179 <filename>user.action</filename>, where you can preserve them across
1180 upgrades. <filename>standard.action</filename> is for
1181 <application>Privoxy's</application> internal use.
1184 There is also a web based editor that can be accessed from
1186 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
1188 url="http://p.p/show-status">http://p.p/show-status</ulink>) for the
1189 various actions files.
1195 <filename>default.filter</filename> (the <link linkend="filter-file">filter
1196 file</link>) can be used to re-write the raw page content, including
1197 viewable text as well as embedded HTML and JavaScript, and whatever else
1198 lurks on any given web page. The filtering jobs are only pre-defined here;
1199 whether to apply them or not is up to the actions files.
1207 All files use the <quote><literal>#</literal></quote> character to denote a
1208 comment (the rest of the line will be ignored) and understand line continuation
1209 through placing a backslash ("<literal>\</literal>") as the very last character
1210 in a line. If the <literal>#</literal> is preceded by a backslash, it looses
1211 its special function. Placing a <literal>#</literal> in front of an otherwise
1212 valid configuration line to prevent it from being interpreted is called "commenting
1217 The actions files and <filename>default.filter</filename>
1218 can use Perl style <link linkend="regex">regular expressions</link> for
1219 maximum flexibility.
1223 After making any changes, there is no need to restart
1224 <application>Privoxy</application> in order for the changes to take
1225 effect. <application>Privoxy</application> detects such changes
1226 automatically. Note, however, that it may take one or two additional
1227 requests for the change to take effect. When changing the listening address
1228 of <application>Privoxy</application>, these <quote>wake up</quote> requests
1229 must obviously be sent to the <emphasis>old</emphasis> listening address.
1234 While under development, the configuration content is subject to change.
1235 The below documentation may not be accurate by the time you read this.
1236 Also, what constitutes a <quote>default</quote> setting, may change, so
1237 please check all your configuration files on important issues.
1243 <!-- ~ End section ~ -->
1246 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
1249 <title>The Main Configuration File</title>
1252 Again, the main configuration file is named <filename>config</filename> on
1253 Linux/Unix/BSD and OS/2, and <filename>config.txt</filename> on Windows.
1254 Configuration lines consist of an initial keyword followed by a list of
1255 values, all separated by whitespace (any number of spaces or tabs). For
1263 <emphasis>confdir /etc/privoxy</emphasis></literallayout>
1269 Assigns the value <literal>/etc/privoxy</literal> to the option
1270 <literal>confdir</literal> and thus indicates that the configuration
1271 directory is named <quote>/etc/privoxy/</quote>.
1275 All options in the config file except for <literal>confdir</literal> and
1276 <literal>logdir</literal> are optional. Watch out in the below description
1277 for what happens if you leave them unset.
1281 The main config file controls all aspects of <application>Privoxy</application>'s
1282 operation that are not location dependent (i.e. they apply universally, no matter
1283 where you may be surfing).
1287 <!-- ~~~~~ New section ~~~~~ -->
1289 <sect2 id="conf-log-loc">
1290 <title>Configuration and Log File Locations</title>
1293 <application>Privoxy</application> can (and normally does) use a number of
1294 other files for additional configuration, help and logging.
1295 This section of the configuration file tells <application>Privoxy</application>
1296 where to find those other files.
1300 The user running Privoxy, must have read permission for all
1301 configuration files, and write permission to any files that would
1302 be modified, such as log files.
1305 <sect3 renderas="sect4" id="confdir"><title>confdir</title>
1309 <term>Specifies:</term>
1311 <para>The directory where the other configuration files are located</para>
1315 <term>Type of value:</term>
1317 <para>Path name</para>
1321 <term>Default value:</term>
1323 <para>/etc/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
1327 <term>Effect if unset:</term>
1329 <para><emphasis>Mandatory</emphasis></para>
1336 No trailing <quote><literal>/</literal></quote>, please
1339 When development goes modular and multi-user, the blocker, filter, and
1340 per-user config will be stored in subdirectories of <quote>confdir</quote>.
1341 For now, the configuration directory structure is flat, except for
1342 <filename>confdir/templates</filename>, where the HTML templates for CGI
1343 output reside (e.g. <application>Privoxy's</application> 404 error page).
1351 <sect3 renderas="sect4" id="logdir"><title>logdir</title>
1355 <term>Specifies:</term>
1358 The directory where all logging takes place (i.e. where <filename>logfile</filename> and
1359 <filename>jarfile</filename> are located)
1364 <term>Type of value:</term>
1366 <para>Path name</para>
1370 <term>Default value:</term>
1372 <para>/var/log/privoxy (Unix) <emphasis>or</emphasis> <application>Privoxy</application> installation dir (Windows) </para>
1376 <term>Effect if unset:</term>
1378 <para><emphasis>Mandatory</emphasis></para>
1385 No trailing <quote><literal>/</literal></quote>, please
1392 <sect3 renderas="sect4" id="actionsfile"><title>
1395 <anchor id="default.action">
1396 <anchor id="standard.action">
1397 <anchor id="user.action">
1398 <!-- Note: slightly modified this section 04/28/02, hal. See NOTE. -->
1401 <term>Specifies:</term>
1404 The <link linkend="actions-file">actions file(s)</link> to use
1409 <term>Type of value:</term>
1411 <para>File name, relative to <literal>confdir</literal>, without the <literal>.action</literal> suffix</para>
1415 <term>Default values:</term>
1419 <msgtext><literallayout> standard # Internal purposes, no editing recommended</literallayout></msgtext>
1422 <msgtext><literallayout> default # Main actions file</literallayout></msgtext>
1425 <msgtext><literallayout> user # User customizations</literallayout></msgtext>
1431 <term>Effect if unset:</term>
1434 No actions are taken at all. Simple neutral proxying.
1442 Multiple <literal>actionsfile</literal> lines are permitted, and are in fact recommended!
1445 The default values include standard.action, which is used for internal
1446 purposes and should be loaded, default.action, which is the
1447 <quote>main</quote> actions file maintained by the developers, and
1448 <filename>user.action</filename>, where you can make your personal additions.
1451 Actions files are where all the per site and per URL configuration is done for
1452 ad blocking, cookie management, privacy considerations, etc.
1453 There is no point in using <application>Privoxy</application> without at
1454 least one actions file.
1461 <sect3 renderas="sect4" id="filterfile"><title>filterfile</title>
1462 <anchor id="default.filter">
1465 <term>Specifies:</term>
1468 The <link linkend="filter-file">filter file</link> to use
1473 <term>Type of value:</term>
1475 <para>File name, relative to <literal>confdir</literal></para>
1479 <term>Default value:</term>
1481 <para>default.filter (Unix) <emphasis>or</emphasis> default.filter.txt (Windows)</para>
1485 <term>Effect if unset:</term>
1488 No textual content filtering takes place, i.e. all
1489 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
1490 actions in the actions files are turned neutral.
1498 The <link linkend="filter-file">filter file</link> contains content modification
1499 rules that use <link linkend="regex">regular expressions</link>. These rules permit
1500 powerful changes on the content of Web pages, e.g., you could disable your favorite
1501 JavaScript annoyances, re-write the actual displayed text, or just have some
1502 fun replacing <quote>Microsoft</quote> with <quote>MicroSuck</quote> wherever
1503 it appears on a Web page.
1507 <literal>+<link linkend="filter">filter</link>{<replaceable class="parameter">name</replaceable>}</literal>
1508 actions rely on the relevant filter (<replaceable class="parameter">name</replaceable>)
1509 to be defined in the filter file!
1512 A pre-defined filter file called <filename>default.filter</filename> that contains
1513 a bunch of handy filters for common problems is included in the distribution.
1514 See the section on the <literal><link linkend="filter">filter</link></literal>
1522 <sect3 renderas="sect4" id="logfile"><title>logfile</title>
1526 <term>Specifies:</term>
1534 <term>Type of value:</term>
1536 <para>File name, relative to <literal>logdir</literal></para>
1540 <term>Default value:</term>
1542 <para>logfile (Unix) <emphasis>or</emphasis> privoxy.log (Windows)</para>
1546 <term>Effect if unset:</term>
1549 No log file is used, all log messages go to the console (<literal>stderr</literal>).
1557 The windows version will additionally log to the console.
1560 The logfile is where all logging and error messages are written. The level
1561 of detail and number of messages are set with the <literal>debug</literal>
1562 option (see below). The logfile can be useful for tracking down a problem with
1563 <application>Privoxy</application> (e.g., it's not blocking an ad you
1564 think it should block) but in most cases you probably will never look at it.
1567 Your logfile will grow indefinitely, and you will probably want to
1568 periodically remove it. On Unix systems, you can do this with a cron job
1569 (see <quote>man cron</quote>). For Red Hat, a <command>logrotate</command>
1570 script has been included.
1573 On SuSE Linux systems, you can place a line like <quote>/var/log/privoxy.*
1574 +1024k 644 nobody.nogroup</quote> in <filename>/etc/logfiles</filename>, with
1575 the effect that cron.daily will automatically archive, gzip, and empty the
1576 log, when it exceeds 1M size.
1579 Any log files must be writable by whatever user <application>Privoxy</application>
1580 is being run as (default on UNIX, user id is <quote>privoxy</quote>).
1587 <sect3 renderas="sect4" id="jarfile"><title>jarfile</title>
1591 <term>Specifies:</term>
1594 The file to store intercepted cookies in
1599 <term>Type of value:</term>
1601 <para>File name, relative to <literal>logdir</literal></para>
1605 <term>Default value:</term>
1607 <para>jarfile (Unix) <emphasis>or</emphasis> privoxy.jar (Windows)</para>
1611 <term>Effect if unset:</term>
1614 Intercepted cookies are not stored at all.
1622 The jarfile may grow to ridiculous sizes over time.
1629 <sect3 renderas="sect4" id="trustfile"><title>trustfile</title>
1632 <term>Specifies:</term>
1635 The trust file to use
1640 <term>Type of value:</term>
1642 <para>File name, relative to <literal>confdir</literal></para>
1646 <term>Default value:</term>
1648 <para><emphasis>Unset (commented out)</emphasis>. When activated: trust (Unix) <emphasis>or</emphasis> trust.txt (Windows)</para>
1652 <term>Effect if unset:</term>
1655 The whole trust mechanism is turned off.
1663 The trust mechanism is an experimental feature for building white-lists and should
1664 be used with care. It is <emphasis>NOT</emphasis> recommended for the casual user.
1667 If you specify a trust file, <application>Privoxy</application> will only allow
1668 access to sites that are named in the trustfile.
1669 You can also mark sites as trusted referrers (with <literal>+</literal>), with
1670 the effect that access to untrusted sites will be granted, if a link from a
1671 trusted referrer was used.
1672 The link target will then be added to the <quote>trustfile</quote>.
1673 Possible applications include limiting Internet access for children.
1676 If you use <literal>+</literal> operator in the trust file, it may grow considerably over time.
1684 <!-- ~ End section ~ -->
1688 <!-- ~~~~~ New section ~~~~~ -->
1690 <sect2 id="local-set-up">
1691 <title>Local Set-up Documentation</title>
1694 If you intend to operate <application>Privoxy</application> for more users
1695 than just yourself, it might be a good idea to let them know how to reach
1696 you, what you block and why you do that, your policies, etc.
1699 <sect3 renderas="sect4" id="user-manual"><title>user-manual</title>
1702 <term>Specifies:</term>
1705 Location of the <application>Privoxy</application> User Manual.
1710 <term>Type of value:</term>
1712 <para>A fully qualified URI</para>
1716 <term>Default value:</term>
1718 <para><emphasis>Unset</emphasis></para>
1722 <term>Effect if unset:</term>
1725 <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/<replaceable class="parameter">version</replaceable>/user-manual/</ulink>
1726 will be used, where <replaceable class="parameter">version</replaceable> is the <application>Privoxy</application> version.
1734 The User Manual URI is used for help links from some of the internal CGI pages.
1735 The manual itself is normally packaged with the binary distributions, so you probably want
1736 to set this to a locally installed copy. For multi-user setups, you could provide a copy on
1737 a local webserver for all your users and use the corresponding URL here.
1743 Unix, in local filesystem:
1746 <screen>user-manual file:///usr/share/doc/privoxy-&p-version;/user-manual/</screen>
1749 Any platform, on local webserver (called <quote>local-webserver</quote>):
1752 <screen>user-manual http://local-webserver/privoxy-user-manual/</screen>
1756 If set, this option should be <emphasis>the first option in the config file</emphasis>, because
1757 it is used while the config file is being read.
1765 <sect3 renderas="sect4" id="trust-info-url"><title>trust-info-url</title>
1769 <term>Specifies:</term>
1772 A URL to be displayed in the error page that users will see if access to an untrusted page is denied.
1777 <term>Type of value:</term>
1783 <term>Default value:</term>
1785 <para>Two example URL are provided</para>
1789 <term>Effect if unset:</term>
1792 No links are displayed on the "untrusted" error page.
1800 The value of this option only matters if the experimental trust mechanism has been
1801 activated. (See <link linkend="trustfile"><emphasis>trustfile</emphasis></link> above.)
1804 If you use the trust mechanism, it is a good idea to write up some on-line
1805 documentation about your trust policy and to specify the URL(s) here.
1806 Use multiple times for multiple URLs.
1809 The URL(s) should be added to the trustfile as well, so users don't end up
1810 locked out from the information on why they were locked out in the first place!
1817 <sect3 renderas="sect4" id="admin-address"><title>admin-address</title>
1821 <term>Specifies:</term>
1824 An email address to reach the proxy administrator.
1829 <term>Type of value:</term>
1831 <para>Email address</para>
1835 <term>Default value:</term>
1837 <para><emphasis>Unset</emphasis></para>
1841 <term>Effect if unset:</term>
1844 No email address is displayed on error pages and the CGI user interface.
1852 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
1853 are unset, the whole "Local Privoxy Support" box on all generated pages will
1861 <sect3 renderas="sect4" id="proxy-info-url"><title>proxy-info-url</title>
1865 <term>Specifies:</term>
1868 A URL to documentation about the local <application>Privoxy</application> setup,
1869 configuration or policies.
1874 <term>Type of value:</term>
1880 <term>Default value:</term>
1882 <para><emphasis>Unset</emphasis></para>
1886 <term>Effect if unset:</term>
1889 No link to local documentation is displayed on error pages and the CGI user interface.
1897 If both <literal>admin-address</literal> and <literal>proxy-info-url</literal>
1898 are unset, the whole "Local Privoxy Support" box on all generated pages will
1902 This URL shouldn't be blocked ;-)
1910 <!-- ~ End section ~ -->
1912 <!-- ~~~~~ New section ~~~~~ -->
1914 <sect2 id="debugging">
1915 <title>Debugging</title>
1918 These options are mainly useful when tracing a problem.
1919 Note that you might also want to invoke
1920 <application>Privoxy</application> with the <literal>--no-daemon</literal>
1921 command line option when debugging.
1924 <sect3 renderas="sect4" id="debug"><title>debug</title>
1928 <term>Specifies:</term>
1931 Key values that determine what information gets logged to the
1932 <link linkend="logfile"><emphasis>logfile</emphasis></link>.
1937 <term>Type of value:</term>
1939 <para>Integer values</para>
1943 <term>Default value:</term>
1945 <para>12289 (i.e.: URLs plus informational and warning messages)</para>
1949 <term>Effect if unset:</term>
1952 Nothing gets logged.
1960 The available debug levels are:
1964 debug 1 # show each GET/POST/CONNECT request
1965 debug 2 # show each connection status
1966 debug 4 # show I/O status
1967 debug 8 # show header parsing
1968 debug 16 # log all data into the logfile
1969 debug 32 # debug force feature
1970 debug 64 # debug regular expression filter
1971 debug 128 # debug fast redirects
1972 debug 256 # debug GIF de-animation
1973 debug 512 # Common Log Format
1974 debug 1024 # debug kill pop-ups
1975 debug 4096 # Startup banner and warnings.
1976 debug 8192 # Non-fatal errors
1980 To select multiple debug levels, you can either add them or use
1981 multiple <literal>debug</literal> lines.
1984 A debug level of 1 is informative because it will show you each request
1985 as it happens. <emphasis>1, 4096 and 8192 are highly recommended</emphasis>
1986 so that you will notice when things go wrong. The other levels are probably
1987 only of interest if you are hunting down a specific problem. They can produce
1988 a hell of an output (especially 16).
1992 The reporting of <emphasis>fatal</emphasis> errors (i.e. ones which crash
1993 <application>Privoxy</application>) is always on and cannot be disabled.
1996 If you want to use CLF (Common Log Format), you should set <quote>debug
1997 512</quote> <emphasis>ONLY</emphasis> and not enable anything else.
2004 <sect3 renderas="sect4" id="single-threaded"><title>single-threaded</title>
2008 <term>Specifies:</term>
2011 Whether to run only one server thread
2016 <term>Type of value:</term>
2018 <para><emphasis>None</emphasis></para>
2022 <term>Default value:</term>
2024 <para><emphasis>Unset</emphasis></para>
2028 <term>Effect if unset:</term>
2031 Multi-threaded (or, where unavailable: forked) operation, i.e. the ability to
2032 serve multiple requests simultaneously.
2040 This option is only there for debug purposes and you should never
2041 need to use it. <emphasis>It will drastically reduce performance.</emphasis>
2050 <!-- ~~~~~ New section ~~~~~ -->
2052 <sect2 id="access-control">
2053 <title>Access Control and Security</title>
2056 This section of the config file controls the security-relevant aspects
2057 of <application>Privoxy</application>'s configuration.
2060 <sect3 renderas="sect4" id="listen-address"><title>listen-address</title>
2064 <term>Specifies:</term>
2067 The IP address and TCP port on which <application>Privoxy</application> will
2068 listen for client requests.
2073 <term>Type of value:</term>
2075 <para>[<replaceable class="parameter">IP-Address</replaceable>]:<replaceable class="parameter">Port</replaceable></para>
2080 <term>Default value:</term>
2082 <para>127.0.0.1:8118</para>
2086 <term>Effect if unset:</term>
2089 Bind to 127.0.0.1 (localhost), port 8118. This is suitable and recommended for
2090 home users who run <application>Privoxy</application> on the same machine as
2099 You will need to configure your browser(s) to this proxy address and port.
2102 If you already have another service running on port 8118, or if you want to
2103 serve requests from other machines (e.g. on your local network) as well, you
2104 will need to override the default.
2107 If you leave out the IP address, <application>Privoxy</application> will
2108 bind to all interfaces (addresses) on your machine and may become reachable
2109 from the Internet. In that case, consider using <link
2110 linkend="acls">access control lists</link> (ACL's, see below), and/or
2114 If you open <application>Privoxy</application> to untrusted users, you will
2115 also want to turn off the <literal><link
2116 linkend="enable-edit-actions">enable-edit-actions</link></literal> and
2117 <literal><link linkend="enable-remote-toggle">enable-remote-toggle</link></literal>
2123 <term>Example:</term>
2126 Suppose you are running <application>Privoxy</application> on
2127 a machine which has the address 192.168.0.1 on your local private network
2128 (192.168.0.0) and has another outside connection with a different address.
2129 You want it to serve requests from inside only:
2133 listen-address 192.168.0.1:8118
2141 <sect3 renderas="sect4" id="toggle"><title>toggle</title>
2145 <term>Specifies:</term>
2148 Initial state of "toggle" status
2153 <term>Type of value:</term>
2159 <term>Default value:</term>
2165 <term>Effect if unset:</term>
2168 Act as if toggled on
2176 If set to 0, <application>Privoxy</application> will start in
2177 <quote>toggled off</quote> mode, i.e. behave like a normal, content-neutral
2178 proxy where all ad blocking, filtering, etc are disabled. See
2179 <literal>enable-remote-toggle</literal> below. This is not really useful
2180 anymore, since toggling is much easier via <ulink
2181 url="http://config.privoxy.org/toggle">the web interface</ulink> than via
2182 editing the <filename>conf</filename> file.
2185 The windows version will only display the toggle icon in the system tray
2186 if this option is present.
2194 <sect3 renderas="sect4" id="enable-remote-toggle"><title>enable-remote-toggle</title>
2197 <term>Specifies:</term>
2200 Whether or not the <ulink url="http://config.privoxy.org/toggle">web-based toggle
2201 feature</ulink> may be used
2206 <term>Type of value:</term>
2212 <term>Default value:</term>
2218 <term>Effect if unset:</term>
2221 The web-based toggle feature is disabled.
2229 When toggled off, <application>Privoxy</application> acts like a normal,
2230 content-neutral proxy, i.e. it acts as if none of the actions applied to
2234 For the time being, access to the toggle feature can <emphasis>not</emphasis> be
2235 controlled separately by <quote>ACLs</quote> or HTTP authentication,
2236 so that everybody who can access <application>Privoxy</application> (see
2237 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
2238 toggle it for all users. So this option is <emphasis>not recommended</emphasis>
2239 for multi-user environments with untrusted users.
2242 Note that you must have compiled <application>Privoxy</application> with
2243 support for this feature, otherwise this option has no effect.
2251 <sect3 renderas="sect4" id="enable-edit-actions"><title>enable-edit-actions</title>
2254 <term>Specifies:</term>
2257 Whether or not the <ulink url="http://config.privoxy.org/show-status">web-based actions
2258 file editor</ulink> may be used
2263 <term>Type of value:</term>
2269 <term>Default value:</term>
2275 <term>Effect if unset:</term>
2278 The web-based actions file editor is disabled.
2286 For the time being, access to the editor can <emphasis>not</emphasis> be
2287 controlled separately by <quote>ACLs</quote> or HTTP authentication,
2288 so that everybody who can access <application>Privoxy</application> (see
2289 <quote>ACLs</quote> and <literal>listen-address</literal> above) can
2290 modify its configuration for all users. So this option is <emphasis>not
2291 recommended</emphasis> for multi-user environments with untrusted users.
2294 Note that you must have compiled <application>Privoxy</application> with
2295 support for this feature, otherwise this option has no effect.
2302 <sect3 renderas="sect4" id="acls"><title>
2303 ACLs: permit-access and deny-access</title>
2304 <anchor id="permit-access">
2305 <anchor id="deny-access">
2309 <term>Specifies:</term>
2312 Who can access what.
2317 <term>Type of value:</term>
2320 <replaceable class="parameter">src_addr</replaceable>[/<replaceable class="parameter">src_masklen</replaceable>]
2321 [<replaceable class="parameter">dst_addr</replaceable>[/<replaceable class="parameter">dst_masklen</replaceable>]]
2324 Where <replaceable class="parameter">src_addr</replaceable> and
2325 <replaceable class="parameter">dst_addr</replaceable> are IP addresses in dotted decimal notation or valid
2326 DNS names, and <replaceable class="parameter">src_masklen</replaceable> and
2327 <replaceable class="parameter">dst_masklen</replaceable> are subnet masks in CIDR notation, i.e. integer
2328 values from 2 to 30 representing the length (in bits) of the network address. The masks and the whole
2329 destination part are optional.
2334 <term>Default value:</term>
2336 <para><emphasis>Unset</emphasis></para>
2340 <term>Effect if unset:</term>
2343 Don't restrict access further than implied by <literal>listen-address</literal>
2351 Access controls are included at the request of ISPs and systems
2352 administrators, and <emphasis>are not usually needed by individual users</emphasis>.
2353 For a typical home user, it will normally suffice to ensure that
2354 <application>Privoxy</application> only listens on the localhost
2355 (127.0.0.1) or internal (home) network address by means of the
2356 <link linkend="listen-address"><emphasis>listen-address</emphasis></link>
2360 Please see the warnings in the FAQ that this proxy is not intended to be a substitute
2361 for a firewall or to encourage anyone to defer addressing basic security
2365 Multiple ACL lines are OK.
2366 If any ACLs are specified, then the <application>Privoxy</application>
2367 talks only to IP addresses that match at least one <literal>permit-access</literal> line
2368 and don't match any subsequent <literal>deny-access</literal> line. In other words, the
2369 last match wins, with the default being <literal>deny-access</literal>.
2372 If <application>Privoxy</application> is using a forwarder (see <literal>forward</literal> below)
2373 for a particular destination URL, the <replaceable class="parameter">dst_addr</replaceable>
2374 that is examined is the address of the forwarder and <emphasis>NOT</emphasis> the address
2375 of the ultimate target. This is necessary because it may be impossible for the local
2376 <application>Privoxy</application> to determine the IP address of the
2377 ultimate target (that's often what gateways are used for).
2380 You should prefer using IP addresses over DNS names, because the address lookups take
2381 time. All DNS names must resolve! You can <emphasis>not</emphasis> use domain patterns
2382 like <quote>*.org</quote> or partial domain names. If a DNS name resolves to multiple
2383 IP addresses, only the first one is used.
2386 Denying access to particular sites by ACL may have undesired side effects
2387 if the site in question is hosted on a machine which also hosts other sites.
2392 <term>Examples:</term>
2395 Explicitly define the default behavior if no ACL and
2396 <literal>listen-address</literal> are set: <quote>localhost</quote>
2397 is OK. The absence of a <replaceable class="parameter">dst_addr</replaceable> implies that
2398 <emphasis>all</emphasis> destination addresses are OK:
2402 permit-access localhost
2406 Allow any host on the same class C subnet as www.privoxy.org access to
2407 nothing but www.example.com:
2411 permit-access www.privoxy.org/24 www.example.com/32
2415 Allow access from any host on the 26-bit subnet 192.168.45.64 to anywhere,
2416 with the exception that 192.168.45.73 may not access www.dirty-stuff.example.com:
2420 permit-access 192.168.45.64/26
2421 deny-access 192.168.45.73 www.dirty-stuff.example.com
2429 <sect3 renderas="sect4" id="buffer-limit"><title>buffer-limit</title>
2433 <term>Specifies:</term>
2436 Maximum size of the buffer for content filtering.
2441 <term>Type of value:</term>
2443 <para>Size in Kbytes</para>
2447 <term>Default value:</term>
2453 <term>Effect if unset:</term>
2456 Use a 4MB (4096 KB) limit.
2464 For content filtering, i.e. the <literal>+filter</literal> and
2465 <literal>+deanimate-gif</literal> actions, it is necessary that
2466 <application>Privoxy</application> buffers the entire document body.
2467 This can be potentially dangerous, since a server could just keep sending
2468 data indefinitely and wait for your RAM to exhaust -- with nasty consequences.
2472 When a document buffer size reaches the <literal>buffer-limit</literal>, it is
2473 flushed to the client unfiltered and no further attempt to
2474 filter the rest of the document is made. Remember that there may be multiple threads
2475 running, which might require up to <literal>buffer-limit</literal> Kbytes
2476 <emphasis>each</emphasis>, unless you have enabled <quote>single-threaded</quote>
2486 <!-- ~ End section ~ -->
2489 <!-- ~~~~~ New section ~~~~~ -->
2491 <sect2 id="forwarding">
2492 <title>Forwarding</title>
2495 This feature allows routing of HTTP requests through a chain of
2497 It can be used to better protect privacy and confidentiality when
2498 accessing specific domains by routing requests to those domains
2499 through an anonymous public proxy (see e.g. <ulink
2500 url="http://www.multiproxy.org/anon_list.htm">http://www.multiproxy.org/anon_list.htm</ulink>)
2501 Or to use a caching proxy to speed up browsing. Or chaining to a parent
2502 proxy may be necessary because the machine that <application>Privoxy</application>
2503 runs on has no direct Internet access.
2507 Also specified here are SOCKS proxies. <application>Privoxy</application>
2508 supports the SOCKS 4 and SOCKS 4A protocols.
2511 <sect3 renderas="sect4" id="forward"><title>forward</title>
2514 <term>Specifies:</term>
2517 To which parent HTTP proxy specific requests should be routed.
2522 <term>Type of value:</term>
2525 <replaceable class="parameter">target_domain</replaceable>[:<replaceable class="parameter">port</replaceable>]
2526 <replaceable class="parameter">http_parent</replaceable>[/<replaceable class="parameter">port</replaceable>]
2529 Where <replaceable class="parameter">target_domain</replaceable> is a domain name pattern (see the
2530 chapter on domain matching in the <filename>default.action</filename> file),
2531 <replaceable class="parameter">http_parent</replaceable> is the address of the parent HTTP proxy
2532 as an IP addresses in dotted decimal notation or as a valid DNS name (or <quote>.</quote> to denote
2533 <quote>no forwarding</quote>, and the optional
2534 <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer
2535 values from 1 to 64535
2540 <term>Default value:</term>
2542 <para><emphasis>Unset</emphasis></para>
2546 <term>Effect if unset:</term>
2549 Don't use parent HTTP proxies.
2557 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2558 forwarded to another HTTP proxy but are made directly to the web servers.
2561 Multiple lines are OK, they are checked in sequence, and the last match wins.
2566 <term>Examples:</term>
2569 Everything goes to an example anonymizing proxy, except SSL on port 443 (which it doesn't handle):
2573 forward .* anon-proxy.example.org:8080
2578 Everything goes to our example ISP's caching proxy, except for requests
2579 to that ISP's sites:
2583 forward .*. caching-proxy.example-isp.net:8000
2584 forward .example-isp.net .
2592 <sect3 renderas="sect4" id="socks"><title>
2593 forward-socks4 and forward-socks4a</title>
2594 <anchor id="forward-socks4">
2595 <anchor id="forward-socks4a">
2599 <term>Specifies:</term>
2602 Through which SOCKS proxy (and to which parent HTTP proxy) specific requests should be routed.
2607 <term>Type of value:</term>
2610 <replaceable class="parameter">target_domain</replaceable>[:<replaceable class="parameter">port</replaceable>]
2611 <replaceable class="parameter">socks_proxy</replaceable>[/<replaceable class="parameter">port</replaceable>]
2612 <replaceable class="parameter">http_parent</replaceable>[/<replaceable class="parameter">port</replaceable>]
2615 Where <replaceable class="parameter">target_domain</replaceable> is a domain name pattern (see the
2616 chapter on domain matching in the <filename>default.action</filename> file),
2617 <replaceable class="parameter">http_parent</replaceable> and <replaceable class="parameter">socks_proxy</replaceable>
2618 are IP addresses in dotted decimal notation or valid DNS names (<replaceable class="parameter">http_parent</replaceable>
2619 may be <quote>.</quote> to denote <quote>no HTTP forwarding</quote>), and the optional
2620 <replaceable class="parameter">port</replaceable> parameters are TCP ports, i.e. integer values from 1 to 64535
2625 <term>Default value:</term>
2627 <para><emphasis>Unset</emphasis></para>
2631 <term>Effect if unset:</term>
2634 Don't use SOCKS proxies.
2642 Multiple lines are OK, they are checked in sequence, and the last match wins.
2645 The difference between <literal>forward-socks4</literal> and <literal>forward-socks4a</literal>
2646 is that in the SOCKS 4A protocol, the DNS resolution of the target hostname happens on the SOCKS
2647 server, while in SOCKS 4 it happens locally.
2650 If <replaceable class="parameter">http_parent</replaceable> is <quote>.</quote>, then requests are not
2651 forwarded to another HTTP proxy but are made (HTTP-wise) directly to the web servers, albeit through
2657 <term>Examples:</term>
2660 From the company example.com, direct connections are made to all
2661 <quote>internal</quote> domains, but everything outbound goes through
2662 their ISP's proxy by way of example.com's corporate SOCKS 4A gateway to
2667 forward-socks4a .*. socks-gw.example.com:1080 www-cache.example-isp.net:8080
2668 forward .example.com .
2672 A rule that uses a SOCKS 4 gateway for all destinations but no HTTP parent looks like this:
2676 forward-socks4 .*. socks-gw.example.com:1080 .
2684 <sect3 renderas="sect4" id="advanced-forwarding-examples"><title>Advanced Forwarding Examples</title>
2687 If you have links to multiple ISPs that provide various special content
2688 only to their subscribers, you can configure multiple <application>Privoxies</application>
2689 which have connections to the respective ISPs to act as forwarders to each other, so that
2690 <emphasis>your</emphasis> users can see the internal content of all ISPs.
2694 Assume that host-a has a PPP connection to isp-a.net. And host-b has a PPP connection to
2695 isp-b.net. Both run <application>Privoxy</application>. Their forwarding
2696 configuration can look like this:
2706 forward .isp-b.net host-b:8118
2717 forward .isp-a.net host-a:8118
2722 Now, your users can set their browser's proxy to use either
2723 host-a or host-b and be able to browse the internal content
2724 of both isp-a and isp-b.
2728 If you intend to chain <application>Privoxy</application> and
2729 <application>squid</application> locally, then chain as
2730 <literal>browser -> squid -> privoxy</literal> is the recommended way.
2734 Assuming that <application>Privoxy</application> and <application>squid</application>
2735 run on the same box, your squid configuration could then look like this:
2740 # Define Privoxy as parent proxy (without ICP)
2741 cache_peer 127.0.0.1 parent 8118 7 no-query
2743 # Define ACL for protocol FTP
2746 # Do not forward FTP requests to Privoxy
2747 always_direct allow ftp
2749 # Forward all the rest to Privoxy
2750 never_direct allow all</screen>
2754 You would then need to change your browser's proxy settings to <application>squid</application>'s address and port.
2755 Squid normally uses port 3128. If unsure consult <literal>http_port</literal> in <filename>squid.conf</filename>.
2762 <!-- ~ End section ~ -->
2765 <!-- ~~~~~ New section ~~~~~ -->
2767 <sect2 id="windows-gui">
2768 <title>Windows GUI Options</title>
2770 <application>Privoxy</application> has a number of options specific to the
2771 Windows GUI interface:
2774 <anchor id="activity-animation">
2776 If <quote>activity-animation</quote> is set to 1, the
2777 <application>Privoxy</application> icon will animate when
2778 <quote>Privoxy</quote> is active. To turn off, set to 0.
2785 <emphasis>activity-animation 1</emphasis>
2791 <anchor id="log-messages">
2793 If <quote>log-messages</quote> is set to 1,
2794 <application>Privoxy</application> will log messages to the console
2802 <emphasis>log-messages 1</emphasis>
2808 <anchor id="log-buffer-size">
2810 If <quote>log-buffer-size</quote> is set to 1, the size of the log buffer,
2811 i.e. the amount of memory used for the log messages displayed in the
2812 console window, will be limited to <quote>log-max-lines</quote> (see below).
2816 Warning: Setting this to 0 will result in the buffer to grow infinitely and
2817 eat up all your memory!
2824 <emphasis>log-buffer-size 1</emphasis>
2830 <anchor id="log-max-lines">
2832 <application>log-max-lines</application> is the maximum number of lines held
2833 in the log buffer. See above.
2840 <emphasis>log-max-lines 200</emphasis>
2846 <anchor id="log-highlight-messages">
2848 If <quote>log-highlight-messages</quote> is set to 1,
2849 <application>Privoxy</application> will highlight portions of the log
2850 messages with a bold-faced font:
2857 <emphasis>log-highlight-messages 1</emphasis>
2863 <anchor id="log-font-name">
2865 The font used in the console window:
2872 <emphasis>log-font-name Comic Sans MS</emphasis>
2878 <anchor id="log-font-size">
2880 Font size used in the console window:
2887 <emphasis>log-font-size 8</emphasis>
2893 <anchor id="show-on-task-bar">
2895 <quote>show-on-task-bar</quote> controls whether or not
2896 <application>Privoxy</application> will appear as a button on the Task bar
2904 <emphasis>show-on-task-bar 0</emphasis>
2910 <anchor id="close-button-minimizes">
2912 If <quote>close-button-minimizes</quote> is set to 1, the Windows close
2913 button will minimize <application>Privoxy</application> instead of closing
2914 the program (close with the exit option on the File menu).
2921 <emphasis>close-button-minimizes 1</emphasis>
2927 <anchor id="hide-console">
2929 The <quote>hide-console</quote> option is specific to the MS-Win console
2930 version of <application>Privoxy</application>. If this option is used,
2931 <application>Privoxy</application> will disconnect from and hide the
2939 #<emphasis>hide-console</emphasis>
2948 <!-- ~ End section ~ -->
2952 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
2954 <sect1 id="actions-file"><title>Actions Files</title>
2957 The actions files are used to define what actions
2958 <application>Privoxy</application> takes for which URLs, and thus determine
2959 how ad images, cookies and various other aspects of HTTP content and
2960 transactions are handled, and on which sites (or even parts thereof). There
2961 are three such files included with <application>Privoxy</application> (as of
2962 version 2.9.15), with differing purposes:
2969 <filename>default.action</filename> - is the primary action file
2970 that sets the initial values for all actions. It is intended to
2971 provide a base level of functionality for
2972 <application>Privoxy's</application> array of features. So it is
2973 a set of broad rules that should work reasonably well for users everywhere.
2974 This is the file that the developers are keeping updated, and making
2980 <filename>user.action</filename> - is intended to be for local site
2981 preferences and exceptions. As an example, if your ISP or your bank
2982 has specific requirements, and need special handling, this kind of
2983 thing should go here. This file will not be upgraded.
2988 <filename>standard.action</filename> - is used by the web based editor,
2989 to set various pre-defined sets of rules for the default actions section
2990 in <filename>default.action</filename>. These have increasing levels of
2991 aggressiveness <emphasis>and have no influence on your browsing unless
2992 you select them explicitly in the editor</emphasis>. It is not recommend
3000 The list of actions files to be used are defined in the main configuration
3001 file, and are processed in the order they are defined. The content of these
3002 can all be viewed and edited from <ulink
3003 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
3007 An actions file typically has multiple sections. If you want to use
3008 <quote>aliases</quote> in an actions file, you have to place the (optional)
3009 <link linkend="aliases">alias section</link> at the top of that file.
3010 Then comes the default set of rules which will apply universally to all
3011 sites and pages (be <emphasis>very careful</emphasis> with using such a
3012 universal set in <filename>user.action</filename> or any other actions file after
3013 <filename>default.action</filename>, because it will override the result
3014 from consulting any previous file). And then below that,
3015 exceptions to the defined universal policies. You can regard
3016 <filename>user.action</filename> as an appendix to <filename>default.action</filename>,
3017 with the advantage that is a separate file, which makes preserving your
3018 personal settings across <application>Privoxy</application> upgrades easier.
3022 Actions can be used to block anything you want, including ads, banners, or
3023 just some obnoxious URL that you would rather not see. Cookies can be accepted
3024 or rejected, or accepted only during the current browser session (i.e. not
3025 written to disk), content can be modified, JavaScripts tamed, user-tracking
3026 fooled, and much more. See below for a <link linkend="actions">complete list
3030 <!-- ~~~~~ New section ~~~~~ -->
3032 <title>Finding the Right Mix</title>
3034 Note that some <link linkend="actions">actions</link>, like cookie suppression
3035 or script disabling, may render some sites unusable that rely on these
3036 techniques to work properly. Finding the right mix of actions is not always easy and
3037 certainly a matter of personal taste. In general, it can be said that the more
3038 <quote>aggressive</quote> your default settings (in the top section of the
3039 actions file) are, the more exceptions for <quote>trusted</quote> sites you
3040 will have to make later. If, for example, you want to kill popup windows per
3041 default, you'll have to make exceptions from that rule for sites that you
3042 regularly use and that require popups for actually useful content, like maybe
3043 your bank, favorite shop, or newspaper.
3047 We have tried to provide you with reasonable rules to start from in the
3048 distribution actions files. But there is no general rule of thumb on these
3049 things. There just are too many variables, and sites are constantly changing.
3050 Sooner or later you will want to change the rules (and read this chapter again :).
3054 <!-- ~~~~~ New section ~~~~~ -->
3056 <title>How to Edit</title>
3058 The easiest way to edit the actions files is with a browser by
3059 using our browser-based editor, which can be reached from <ulink
3060 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
3061 The editor allows both fine-grained control over every single feature on a
3062 per-URL basis, and easy choosing from wholesale sets of defaults like
3063 <quote>Cautious</quote>, <quote>Medium</quote> or <quote>Advanced</quote>.
3067 If you prefer plain text editing to GUIs, you can of course also directly edit the
3068 the actions files. Look at <filename>default.action</filename> which is richly
3074 <sect2 id="actions-apply">
3075 <title>How Actions are Applied to URLs</title>
3077 Actions files are divided into sections. There are special sections,
3078 like the <quote><link linkend="aliases">alias</link></quote> sections which will be discussed later. For now
3079 let's concentrate on regular sections: They have a heading line (often split
3080 up to multiple lines for readability) which consist of a list of actions,
3081 separated by whitespace and enclosed in curly braces. Below that, there
3082 is a list of URL patterns, each on a separate line.
3086 To determine which actions apply to a request, the URL of the request is
3087 compared to all patterns in each action file file. Every time it matches, the list of
3088 applicable actions for the URL is incrementally updated, using the heading
3089 of the section in which the pattern is located. If multiple matches for
3090 the same URL set the same action differently, the last match wins. If not,
3091 the effects are aggregated (e.g. a URL might match both the
3092 <ulink url="actions-file.html#HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></ulink>
3093 and <ulink url="actions-file.html#BLOCK"><quote>+block</quote></ulink> actions).
3098 You can trace this process for any given URL by visiting <ulink
3099 url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>.
3103 More detail on this is provided in the Appendix, <link linkend="ACTIONSANAT">
3104 Anatomy of an Action</link>.
3108 <!-- ~~~~~ New section ~~~~~ -->
3109 <sect2 id="af-patterns">
3110 <title>Patterns</title>
3112 Generally, a pattern has the form <literal><domain>/<path></literal>,
3113 where both the <literal><domain></literal> and <literal><path></literal>
3114 are optional. (This is why the pattern <literal>/</literal> matches all URLs).
3119 <term><literal>www.example.com/</literal></term>
3122 is a domain-only pattern and will match any request to <literal>www.example.com</literal>,
3123 regardless of which document on that server is requested.
3128 <term><literal>www.example.com</literal></term>
3131 means exactly the same. For domain-only patterns, the trailing <literal>/</literal> may
3137 <term><literal>www.example.com/index.html</literal></term>
3140 matches only the single document <literal>/index.html</literal>
3141 on <literal>www.example.com</literal>.
3146 <term><literal>/index.html</literal></term>
3149 matches the document <literal>/index.html</literal>, regardless of the domain,
3150 i.e. on <emphasis>any</emphasis> web server.
3155 <term><literal>index.html</literal></term>
3158 matches nothing, since it would be interpreted as a domain name and
3159 there is no top-level domain called <literal>.html</literal>.
3166 <!-- ~~~~~ New section ~~~~~ -->
3167 <sect3><title>The Domain Pattern</title>
3170 The matching of the domain part offers some flexible options: if the
3171 domain starts or ends with a dot, it becomes unanchored at that end.
3177 <term><literal>.example.com</literal></term>
3180 matches any domain that <emphasis>ENDS</emphasis> in
3181 <literal>.example.com</literal>
3186 <term><literal>www.</literal></term>
3189 matches any domain that <emphasis>STARTS</emphasis> with
3190 <literal>www.</literal>
3195 <term><literal>.example.</literal></term>
3198 matches any domain that <emphasis>CONTAINS</emphasis> <literal>.example.</literal>
3199 (Correctly speaking: It matches any FQDN that contains <literal>example</literal> as a domain.)
3206 Additionally, there are wild-cards that you can use in the domain names
3207 themselves. They work pretty similar to shell wild-cards: <quote>*</quote>
3208 stands for zero or more arbitrary characters, <quote>?</quote> stands for
3209 any single character, you can define character classes in square
3210 brackets and all of that can be freely mixed:
3215 <term><literal>ad*.example.com</literal></term>
3218 matches <quote>adserver.example.com</quote>,
3219 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>
3224 <term><literal>*ad*.example.com</literal></term>
3227 matches all of the above, and then some.
3232 <term><literal>.?pix.com</literal></term>
3235 matches <literal>www.ipix.com</literal>,
3236 <literal>pictures.epix.com</literal>, <literal>a.b.c.d.e.upix.com</literal> etc.
3241 <term><literal>www[1-9a-ez].example.c*</literal></term>
3244 matches <literal>www1.example.com</literal>,
3245 <literal>www4.example.cc</literal>, <literal>wwwd.example.cy</literal>,
3246 <literal>wwwz.example.com</literal> etc., but <emphasis>not</emphasis>
3247 <literal>wwww.example.com</literal>.
3255 <!-- ~ End section ~ -->
3258 <!-- ~~~~~ New section ~~~~~ -->
3259 <sect3><title>The Path Pattern</title>
3262 <application>Privoxy</application> uses Perl compatible regular expressions
3263 (through the <ulink url="http://www.pcre.org/">PCRE</ulink> library) for
3268 There is an <link linkend="regex">Appendix</link> with a brief quick-start into regular
3269 expressions, and full (very technical) documentation on PCRE regex syntax is available on-line
3270 at <ulink url="http://www.pcre.org/man.txt">http://www.pcre.org/man.txt</ulink>.
3271 You might also find the Perl man page on regular expressions (<literal>man perlre</literal>)
3272 useful, which is available on-line at <ulink
3273 url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>.
3277 Note that the path pattern is automatically left-anchored at the <quote>/</quote>,
3278 i.e. it matches as if it would start with a <quote>^</quote> (regular expression speak
3279 for the beginning of a line).
3283 Please also note that matching in the path is case
3284 <emphasis>INSENSITIVE</emphasis> by default, but you can switch to case
3285 sensitive at any point in the pattern by using the
3286 <quote>(?-i)</quote> switch:
3287 <literal>www.example.com/(?-i)PaTtErN.*</literal> will match only
3288 documents whose path starts with <literal>PaTtErN</literal> in
3289 <emphasis>exactly</emphasis> this capitalization.
3295 <!-- ~ End section ~ -->
3298 <!-- ~~~~~ New section ~~~~~ -->
3300 <sect2 id="actions">
3301 <title>Actions</title>
3303 All actions are disabled by default, until they are explicitly enabled
3304 somewhere in an actions file. Actions are turned on if preceded with a
3305 <quote>+</quote>, and turned off if preceded with a <quote>-</quote>. So a
3306 <literal>+action</literal> means <quote>do that action</quote>, e.g.
3307 <literal>+block</literal> means <quote>please block URLs that match the
3308 following patterns</quote>, and <literal>-block</literal> means <quote>don't
3309 block URLs that match the following patterns, even if <literal>+block</literal>
3310 previously applied.</quote>
3315 Again, actions are invoked by placing them on a line, enclosed in curly braces and
3316 separated by whitespace, like in
3317 <literal>{+some-action -some-other-action{some-parameter}}</literal>,
3318 followed by a list of URL patterns, one per line, to which they apply.
3319 Together, the actions line and the following pattern lines make up a section
3320 of the actions file.
3324 There are three classes of actions:
3331 Boolean, i.e the action can only be <quote>enabled</quote> or
3332 <quote>disabled</quote>. Syntax:
3336 +<replaceable class="function">name</replaceable> # enable action <replaceable class="parameter">name</replaceable>
3337 -<replaceable class="function">name</replaceable> # disable action <replaceable class="parameter">name</replaceable></screen>
3340 Example: <literal>+block</literal>
3347 Parameterized, where some value is required in order to enable this type of action.
3352 +<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # enable action and set parameter to <replaceable class="parameter">param</replaceable>,
3353 # overwriting parameter from previous match if necessary
3354 -<replaceable class="function">name</replaceable> # disable action. The parameter can be omitted</screen>
3357 Note that if the URL matches multiple positive forms of a parameterized action,
3358 the last match wins, i.e. the params from earlier matches are simply ignored.
3361 Example: <literal>+hide-user-agent{ Mozilla 1.0 }</literal>
3367 Multi-value. These look exactly like parameterized actions,
3368 but they behave differently: If the action applies multiple times to the
3369 same URL, but with different parameters, <emphasis>all</emphasis> the parameters
3370 from <emphasis>all</emphasis> matches are remembered. This is used for actions
3371 that can be executed for the same request repeatedly, like adding multiple
3372 headers, or filtering through multiple filters. Syntax:
3376 +<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # enable action and add <replaceable class="parameter">param</replaceable> to the list of parameters
3377 -<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # remove the parameter <replaceable class="parameter">param</replaceable> from the list of parameters
3378 # If it was the last one left, disable the action.
3379 <replaceable class="parameter">-name</replaceable> # disable this action completely and remove all parameters from the list</screen>
3382 Examples: <literal>+add-header{X-Fun-Header: Some text}</literal> and
3383 <literal>+filter{html-annoyances}</literal>
3391 If nothing is specified in any actions file, no <quote>actions</quote> are
3392 taken. So in this case <application>Privoxy</application> would just be a
3393 normal, non-blocking, non-anonymizing proxy. You must specifically enable the
3394 privacy and blocking features you need (although the provided default actions
3395 files will give a good starting point).
3399 Later defined actions always over-ride earlier ones. So exceptions
3400 to any rules you make, should come in the latter part of the file (or
3401 in a file that is processed later when using multiple actions files). For
3402 multi-valued actions, the actions are applied in the order they are specified.
3403 Actions files are processed in the order they are defined in
3404 <filename>config</filename> (the default installation has three actions
3405 files). It also quite possible for any given URL pattern to match more than
3406 one pattern and thus more than one set of actions!
3409 <!-- start actions listing -->
3411 The list of valid <application>Privoxy</application> actions are:
3415 <!-- ********************************************************** -->
3416 <!-- Please note the below defined actions use id's that are -->
3417 <!-- probably linked from other places, so please don't change. -->
3419 <!-- ********************************************************** -->
3422 <!-- ~~~~~ New section ~~~~~ -->
3424 <sect3 renderas="sect4" id="add-header">
3425 <title><emphasis>add-header</emphasis></title>
3429 <term>Typical use:</term>
3431 <para>Confuse log analysis, custom applications</para>
3436 <term>Effect:</term>
3439 Sends a user defined HTTP header to the web server.
3446 <!-- boolean, parameterized, Multi-value -->
3448 <para>Multi-value.</para>
3453 <term>Parameter:</term>
3456 Any string value is possible. Validity of the defined HTTP headers is not checked.
3457 It is recommended that you use the <quote><literal>X-</literal></quote> prefix
3467 This action may be specified multiple times, in order to define multiple
3468 headers. This is rarely needed for the typical user. If you don't know what
3469 <quote>HTTP headers</quote> are, you definitely don't need to worry about this
3476 <term>Example usage:</term>
3479 <screen>+add-header{X-User-Tracking: sucks}</screen>
3487 <!-- ~~~~~ New section ~~~~~ -->
3488 <sect3 renderas="sect4" id="block">
3489 <title><emphasis>block</emphasis></title>
3493 <term>Typical use:</term>
3495 <para>Block ads or other obnoxious content</para>
3500 <term>Effect:</term>
3503 Requests for URLs to which this action applies are blocked, i.e. the requests are not
3504 forwarded to the remote server, but answered locally with a substitute page or image,
3505 as determined by the <literal><link linkend="handle-as-image">handle-as-image</link></literal>
3506 and <literal><link linkend="set-image-blocker">set-image-blocker</link></literal> actions.
3513 <!-- boolean, parameterized, Multi-value -->
3515 <para>Boolean.</para>
3520 <term>Parameter:</term>
3530 <application>Privoxy</application> sends a special <quote>BLOCKED</quote> page
3531 for requests to blocked pages. This page contains links to find out why the request
3532 was blocked, and a click-through to the blocked content (the latter only if compiled with the
3533 force feature enabled). The <quote>BLOCKED</quote> page adapts to the available
3534 screen space -- it displays full-blown if space allows, or miniaturized and text-only
3535 if loaded into a small frame or window. If you are using <application>Privoxy</application>
3536 right now, you can take a look at the
3537 <ulink url="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"><quote>BLOCKED</quote>
3541 A very important exception occurs if <emphasis>both</emphasis>
3542 <literal>block</literal> and <literal><link linkend="handle-as-image">handle-as-image</link></literal>,
3543 apply to the same request: it will then be replaced by an image. If
3544 <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>
3545 (see below) also applies, the type of image will be determined by its parameter,
3546 if not, the standard checkerboard pattern is sent.
3549 It is important to understand this process, in order
3550 to understand how <application>Privoxy</application> deals with
3551 ads and other unwanted content.
3554 The <literal><link linkend="filter">filter</link></literal>
3555 action can perform a very similar task, by <quote>blocking</quote>
3556 banner images and other content through rewriting the relevant URLs in the
3557 document's HTML source, so they don't get requested in the first place.
3558 Note that this is a totally different technique, and it's easy to confuse the two.
3564 <term>Example usage (section):</term>
3567 <screen>{+block} # Block and replace with "blocked" page
3568 .nasty-stuff.example.com
3570 {+block +handle-as-image} # Block and replace with image
3581 <!-- ~~~~~ New section ~~~~~ -->
3582 <sect3 renderas="sect4" id="crunch-incoming-cookies">
3583 <title><emphasis>crunch-incoming-cookies</emphasis></title>
3587 <term>Typical use:</term>
3590 Prevent the web server from setting any cookies on your system
3596 <term>Effect:</term>
3599 Deletes any <quote>Set-Cookie:</quote> HTTP headers from server replies.
3606 <!-- Boolean, Parameterized, Multi-value -->
3608 <para>Boolean.</para>
3613 <term>Parameter:</term>
3625 This action is only concerned with <emphasis>incoming</emphasis> cookies. For
3626 <emphasis>outgoing</emphasis> cookies, use
3627 <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>.
3628 Use <emphasis>both</emphasis> to disable cookies completely.
3631 It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
3632 with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
3633 since it would prevent the session cookies from being set.
3639 <term>Example usage:</term>
3642 <screen>+crunch-incoming-cookies</screen>
3650 <!-- ~~~~~ New section ~~~~~ -->
3651 <sect3 renderas="sect4" id="crunch-outgoing-cookies">
3652 <title><emphasis>crunch-outgoing-cookies</emphasis></title>
3656 <term>Typical use:</term>
3659 Prevent the web server from reading any cookies from your system
3665 <term>Effect:</term>
3668 Deletes any <quote>Cookie:</quote> HTTP headers from client requests.
3675 <!-- Boolean, Parameterized, Multi-value -->
3677 <para>Boolean.</para>
3682 <term>Parameter:</term>
3694 This action is only concerned with <emphasis>outgoing</emphasis> cookies. For
3695 <emphasis>incoming</emphasis> cookies, use
3696 <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal>.
3697 Use <emphasis>both</emphasis> to disable cookies completely.
3700 It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
3701 with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
3702 since it would prevent the session cookies from being read.
3708 <term>Example usage:</term>
3711 <screen>+crunch-outgoing-cookies</screen>
3720 <!-- ~~~~~ New section ~~~~~ -->
3721 <sect3 renderas="sect4" id="deanimate-gifs">
3722 <title><emphasis>deanimate-gifs</emphasis></title>
3726 <term>Typical use:</term>
3728 <para>Stop those annoying, distracting animated GIF images.</para>
3733 <term>Effect:</term>
3736 De-animate GIF animations, i.e. reduce them to their first or last image.
3743 <!-- boolean, parameterized, Multi-value -->
3745 <para>Parameterized.</para>
3750 <term>Parameter:</term>
3753 <quote>last</quote> or <quote>first</quote>
3762 This will also shrink the images considerably (in bytes, not pixels!). If
3763 the option <quote>first</quote> is given, the first frame of the animation
3764 is used as the replacement. If <quote>last</quote> is given, the last
3765 frame of the animation is used instead, which probably makes more sense for
3766 most banner animations, but also has the risk of not showing the entire
3767 last frame (if it is only a delta to an earlier frame).
3770 You can safely use this action with patterns that will also match non-GIF
3771 objects, because no attempt will be made at anything that doesn't look like
3778 <term>Example usage:</term>
3781 <screen>+deanimate-gifs{last}</screen>
3788 <!-- ~~~~~ New section ~~~~~ -->
3789 <sect3 renderas="sect4" id="downgrade-http-version">
3790 <title><emphasis>downgrade-http-version</emphasis></title>
3794 <term>Typical use:</term>
3796 <para>Work around (very rare) problems with HTTP/1.1</para>
3801 <term>Effect:</term>
3804 Downgrades HTTP/1.1 client requests and server replies to HTTP/1.0.
3811 <!-- boolean, parameterized, Multi-value -->
3813 <para>Boolean.</para>
3818 <term>Parameter:</term>
3830 This is a left-over from the time when <application>Privoxy</application>
3831 didn't support important HTTP/1.1 features well. It is left here for the
3832 unlikely case that you experience HTTP/1.1 related problems with some server
3833 out there. Not all (optional) HTTP/1.1 features are supported yet, so there
3834 is a chance you might need this action.
3840 <term>Example usage (section):</term>
3843 <screen>{+downgrade-http-version}
3844 problem-host.example.com</screen>
3852 <!-- ~~~~~ New section ~~~~~ -->
3853 <sect3 renderas="sect4" id="fast-redirects">
3854 <title><emphasis>fast-redirects</emphasis></title>
3858 <term>Typical use:</term>
3860 <para>Fool some click-tracking scripts and speed up indirect links</para>
3865 <term>Effect:</term>
3868 Cut off all but the last valid URL from requests.
3875 <!-- boolean, parameterized, Multi-value -->
3877 <para>Boolean.</para>
3882 <term>Parameter:</term>
3894 Many sites, like yahoo.com, don't just link to other sites. Instead, they
3895 will link to some script on their own servers, giving the destination as a
3896 parameter, which will then redirect you to the final target. URLs
3897 resulting from this scheme typically look like:
3898 <emphasis>http://some.place/click-tracker.cgi?target=http://some.where.else</emphasis>.
3901 Sometimes, there are even multiple consecutive redirects encoded in the
3902 URL. These redirections via scripts make your web browsing more traceable,
3903 since the server from which you follow such a link can see where you go
3904 to. Apart from that, valuable bandwidth and time is wasted, while your
3905 browser ask the server for one redirect after the other. Plus, it feeds
3909 This feature is currently not very smart and is scheduled for improvement.
3910 It is likely to break some sites. You should expect to need possibly
3911 many exceptions to this action, if it is enabled by default in
3912 <filename>default.action</filename>. Some sites just don't work without
3919 <term>Example usage:</term>
3922 <screen>{+fast-redirects}</screen>
3931 <!-- ~~~~~ New section ~~~~~ -->
3932 <sect3 renderas="sect4" id="filter">
3933 <title><emphasis>filter</emphasis></title>
3937 <term>Typical use:</term>
3939 <para>Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements, etc.</para>
3944 <term>Effect:</term>
3947 Text documents, including HTML and JavaScript, to which this action applies, are filtered on-the-fly
3948 through the specified regular expression based substitutions.
3955 <!-- boolean, parameterized, Multi-value -->
3957 <para>Parameterized.</para>
3962 <term>Parameter:</term>
3965 The name of a filter, as defined in the <link linkend="filter-file">filter file</link>
3966 (typically <filename>default.filter</filename>, set by the
3967 <literal><link linkend="filterfile">filterfile</link></literal>
3968 option in the <link linkend="config">config file</link>)
3977 For your convenience, there are a bunch of pre-defined filters available
3978 in the distribution filter file that you can use. See the example below for
3982 This is potentially a very powerful feature! But <quote>rolling your own</quote>
3983 filters requires a knowledge of regular expressions and HTML.
3986 Filtering requires buffering the page content, which may appear to
3987 slow down page rendering since nothing is displayed until all content has
3988 passed the filters. (It does not really take longer, but seems that way
3989 since the page is not incrementally displayed.) This effect will be more
3990 noticeable on slower connections.
3993 At this time, <application>Privoxy</application> cannot (yet!) uncompress compressed
3994 documents. If you want filtering to work on all documents, even those that
3995 would normally be sent compressed, use the
3996 <literal><link linkend="prevent-compression">prevent-compression</link></literal>
3997 action in conjunction with <literal>filter</literal>.
4000 Filtering can achieve some of the effects as the
4001 <literal><link linkend="block">block</link></literal>
4002 action, i.e. it can be used to block ads and banners.
4005 <link linkend="contact">Feedback</link> with suggestions for new or improved filters is particularly
4012 <term>Example usage (with filters from the distribution <filename>default.filter</filename> file):</term>
4015 <anchor id="filter-html-annoyances">
4016 <screen>+filter{html-annoyances} # Get rid of particularly annoying HTML abuse.</screen>
4019 <anchor id="filter-js-annoyances">
4020 <screen>+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse</screen>
4023 <anchor id="filter-banners-by-size">
4024 <screen>+filter{banners-by-size} # Kill banners by size (<emphasis>very</emphasis> efficient!)</screen>
4027 <anchor id="filter-content-cookies">
4028 <screen>+filter{content-cookies} # Kill cookies that come sneaking in the HTML or JS content</screen>
4031 <anchor id="filter-popups">
4032 <screen>+filter{popups} # Kill all popups in JS and HTML</screen>
4035 <anchor id="filter-webbugs">
4036 <screen>+filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking)</screen>
4039 <anchor id="filter-fun">
4040 <screen>+filter{fun} # Text replacements for subversive browsing fun!</screen>
4043 <anchor id="filter-frameset-borders">
4044 <screen>+filter{frameset-borders} # Give frames a border and make them resizeable</screen>
4047 <anchor id="filter-refresh-tags">
4048 <screen>+filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups)</screen>
4051 <anchor id="filter-nimda">
4052 <screen>+filter{nimda} # Remove Nimda (virus) code.</screen>
4055 <anchor id="filter-shockwave-flash">
4056 <screen>+filter{shockwave-flash} # Kill embedded Shockwave Flash objects</screen>
4059 <anchor id="filter-crude-parental">
4060 <screen>+filter{crude-parental} # Kill all web pages that contain the words "sex" or "warez"</screen>
4068 <!-- ~~~~~ New section ~~~~~ -->
4069 <sect3 renderas="sect4" id="handle-as-image">
4070 <title><emphasis>handle-as-image</emphasis></title>
4074 <term>Typical use:</term>
4076 <para>Mark URLs as belonging to images (so they'll be replaced by images <emphasis>if they get blocked</emphasis>)</para>
4081 <term>Effect:</term>
4084 This action alone doesn't do anything noticeable. It just marks URLs as images.
4085 If the <literal><link linkend="block">block</link></literal> action <emphasis>also applies</emphasis>,
4086 the presence or absence of this mark decides whether an HTML <quote>blocked</quote>
4087 page, or a replacement image (as determined by the <literal><link
4088 linkend="set-image-blocker">set-image-blocker</link></literal> action) will be sent to the
4089 client as a substitute for the blocked content.
4096 <!-- Boolean, Parameterized, Multi-value -->
4098 <para>Boolean.</para>
4103 <term>Parameter:</term>
4115 The below generic example section is actually part of <filename>default.action</filename>.
4116 It marks all URLs with well-known image file name extensions as images and should
4120 Users will probably only want to use the handle-as-image action in conjunction with
4121 <literal><link linkend="block">block</link></literal>, to block sources of banners, whose URLs don't
4122 reflect the file type, like in the second example section.
4125 Note that you cannot treat HTML pages as images in most cases. For instance, (inline) ad
4126 frames require an HTML page to be sent, or they won't display properly.
4127 Forcing <literal>handle-as-image</literal> in this situation will not replace the
4128 ad frame with an image, but lead to error messages.
4134 <term>Example usage (sections):</term>
4137 <screen># Generic image extensions:
4140 /.*\.(gif|jpg|jpeg|png|bmp|ico)$
4142 # These don't look like images, but they're banners and should be
4143 # blocked as images:
4145 {+block +handle-as-image}
4146 some.nasty-banner-server.com/junk.cgi?output=trash
4148 # Banner source! Who cares if they also have non-image content?
4158 <!-- ~~~~~ New section ~~~~~ -->
4159 <sect3 renderas="sect4" id="hide-forwarded-for-headers">
4160 <title><emphasis>hide-forwarded-for-headers</emphasis></title>
4164 <term>Typical use:</term>
4166 <para>Improve privacy by hiding the true source of the request</para>
4171 <term>Effect:</term>
4174 Deletes any existing <quote>X-Forwarded-for:</quote> HTTP header from client requests,
4175 and prevents adding a new one.
4182 <!-- Boolean, Parameterized, Multi-value -->
4184 <para>Boolean.</para>
4189 <term>Parameter:</term>
4201 It is fairly safe to leave this on.
4204 This action is scheduled for improvement: It should be able to generate forged
4205 <quote>X-Forwarded-for:</quote> headers using random IP addresses from a specified network,
4206 to make successive requests from the same client look like requests from a pool of different
4207 users sharing the same proxy.
4213 <term>Example usage:</term>
4216 <screen>+hide-forwarded-for-headers</screen>
4224 <!-- ~~~~~ New section ~~~~~ -->
4225 <sect3 renderas="sect4" id="hide-from-header">
4226 <title><emphasis>hide-from-header</emphasis></title>
4230 <term>Typical use:</term>
4232 <para>Keep your (old and ill) browser from telling web servers your email address</para>
4237 <term>Effect:</term>
4240 Deletes any existing <quote>From:</quote> HTTP header, or replaces it with the
4248 <!-- Boolean, Parameterized, Multi-value -->
4250 <para>Parameterized.</para>
4255 <term>Parameter:</term>
4258 Keyword: <quote>block</quote>, or any user defined value.
4267 The keyword <quote>block</quote> will completely remove the header
4268 (not to be confused with the <literal><link linkend="block">block</link></literal>
4272 Alternately, you can specify any value you prefer to be sent to the web
4273 server. If you do, it is a matter of fairness not to use any address that
4274 is actually used by a real person.
4277 This action is rarely needed, as modern web browsers don't send
4278 <quote>From:</quote> headers anymore.
4284 <term>Example usage:</term>
4287 <screen>+hide-from-header{block}</screen> or
4288 <screen>+hide-from-header{spam-me-senseless@sittingduck.example.com}</screen>
4296 <!-- ~~~~~ New section ~~~~~ -->
4297 <sect3 renderas="sect4" id="hide-referrer">
4298 <title><emphasis>hide-referrer</emphasis></title>
4299 <anchor id="hide-referer">
4302 <term>Typical use:</term>
4304 <para>Conceal which link you followed to get to a particular site</para>
4309 <term>Effect:</term>
4312 Deletes the <quote>Referer:</quote> (sic) HTTP header from the client request,
4313 or replaces it with a forged one.
4320 <!-- Boolean, Parameterized, Multi-value -->
4322 <para>Parameterized.</para>
4327 <term>Parameter:</term>
4331 <para><quote>block</quote> to delete the header completely.</para>
4334 <para><quote>forge</quote> to pretend to be coming from the homepage of the server we are talking to.</para>
4337 <para>Any other string to set a user defined referrer.</para>
4347 <quote>forge</quote> is the preferred option here, since some servers will
4348 not send images back otherwise, in an attempt to prevent their valuable
4349 content from being embedded elsewhere (and hence, without being surrounded
4350 by <emphasis>their</emphasis> banners).
4353 <literal>hide-referer</literal> is an alternate spelling of
4354 <literal>hide-referrer</literal> and the two can be can be freely
4355 substituted with each other. (<quote>referrer</quote> is the
4356 correct English spelling, however the HTTP specification has a bug - it
4357 requires it to be spelled as <quote>referer</quote>.)
4363 <term>Example usage:</term>
4366 <screen>+hide-referrer{forge}</screen> or
4367 <screen>+hide-referrer{http://www.yahoo.com/}</screen>
4375 <!-- ~~~~~ New section ~~~~~ -->
4376 <sect3 renderas="sect4" id="hide-user-agent">
4377 <title><emphasis>hide-user-agent</emphasis></title>
4381 <term>Typical use:</term>
4383 <para>Conceal your type of browser and client operating system</para>
4388 <term>Effect:</term>
4391 Replaces the value of the <quote>User-Agent:</quote> HTTP header
4392 in client requests with the specified value.
4399 <!-- Boolean, Parameterized, Multi-value -->
4401 <para>Parameterized.</para>
4406 <term>Parameter:</term>
4409 Any user-defined string.
4419 This breaks many web sites that depend on looking at this header in order
4420 to customize their content for different browsers (which, by the
4421 way, is <emphasis>NOT</emphasis> a <ulink
4422 url="http://www.javascriptkit.com/javaindex.shtml">smart way to do
4427 Using this action in multi-user setups or wherever different types of
4428 browsers will access the same <application>Privoxy</application> is
4429 <emphasis>not recommended</emphasis>. In single-user, single-browser
4430 setups, you might use it to delete your OS version information from
4431 the headers, because it is an invitation to exploit known bugs for your
4432 OS. It is also occasionally useful to forge this in order to access
4433 sites that won't let you in otherwise (though there may be a good
4434 reason in some cases). Example of this: some MSN sites will not
4435 let <application>Mozilla</application> enter, yet forging to a
4436 <application>Netscape 6.1</application> user-agent works just fine.
4437 (Must be just a silly MS goof, I'm sure :-).
4440 This action is scheduled for improvement.
4446 <term>Example usage:</term>
4449 <screen>+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}</screen>
4457 <!-- ~~~~~ New section ~~~~~ -->
4458 <sect3 renderas="sect4" id="kill-popups">
4459 <title><emphasis>kill-popups<anchor id="kill-popup"></emphasis></title>
4463 <term>Typical use:</term>
4465 <para>Eliminate those annoying pop-up windows</para>
4470 <term>Effect:</term>
4473 While loading the document, replace JavaScript code that opens
4474 pop-up windows with (syntactically neutral) dummy code on the fly.
4481 <!-- Boolean, Parameterized, Multi-value -->
4483 <para>Boolean.</para>
4488 <term>Parameter:</term>
4500 This action is easily confused with the built-in, hardwired <literal><link linkend="filter">filter</link></literal>
4501 action, but there are important differences: For <literal>kill-popups</literal>,
4502 the document need not be buffered, so it can be incrementally rendered while
4503 downloading. But <literal>kill-popups</literal> doesn't catch as many pop-ups as
4505 linkend="filter">filter</link>{<replaceable>popups</replaceable>}</literal>
4509 Think of it as a fast and efficient replacement for a filter that you
4510 can use if you don't want any filtering at all. Note that it doesn't make
4511 sense to combine it with any <literal><link linkend="filter">filter</link></literal> action,
4512 since as soon as one <literal><link linkend="filter">filter</link></literal> applies,
4513 the whole document needs to be buffered anyway, which destroys the advantage of
4514 the <literal>kill-popups</literal> action over its filter equivalent.
4517 Killing all pop-ups is a dangerous business. Many shops and banks rely on
4518 pop-ups to display forms, shopping carts etc, and killing only the unwanted pop-ups
4519 would require artificial intelligence in <application>Privoxy</application>.
4520 If the only kind of pop-ups that you want to kill are exit consoles (those
4521 <emphasis>really nasty</emphasis> windows that appear when you close an other
4522 one), you might want to use
4524 linkend="filter">filter</link>{<replaceable>js-annoyances</replaceable>}</literal>
4530 An alternate spelling is <literal>+kill-popup</literal>, which is
4538 <term>Example usage:</term>
4540 <para><screen>+kill-popups</screen></para>
4547 <!-- ~~~~~ New section ~~~~~ -->
4548 <sect3 renderas="sect4" id="limit-connect">
4549 <title><emphasis>limit-connect</emphasis></title>
4553 <term>Typical use:</term>
4555 <para>Prevent abuse of <application>Privoxy</application> as a TCP proxy relay</para>
4560 <term>Effect:</term>
4563 Specifies to which ports HTTP CONNECT requests are allowable.
4570 <!-- Boolean, Parameterized, Multi-value -->
4572 <para>Parameterized.</para>
4577 <term>Parameter:</term>
4580 A comma-separated list of ports or port ranges (the latter using dashes, with the minimum
4581 defaulting to 0 and the maximum to 65K).
4590 By default, i.e. if no <literal>limit-connect</literal> action applies,
4591 <application>Privoxy</application> only allows HTTP CONNECT
4592 requests to port 443 (the standard, secure HTTPS port). Use
4593 <literal>limit-connect</literal> if more fine-grained control is desired
4594 for some or all destinations.
4597 The CONNECT methods exists in HTTP to allow access to secure websites
4598 (<quote>https://</quote> URLs) through proxies. It works very simply:
4599 the proxy connects to the server on the specified port, and then
4600 short-circuits its connections to the client and to the remote server.
4601 This can be a big security hole, since CONNECT-enabled proxies can be
4602 abused as TCP relays very easily.
4605 If you don't know what any of this means, there probably is no reason to
4606 change this one, since the default is already very restrictive.
4612 <term>Example usages:</term>
4614 <!-- I had trouble getting the spacing to look right in my browser -->
4615 <!-- I probably have the wrong font setup, bollocks. -->
4616 <!-- Apparently the emphasis tag uses a proportional font no matter what -->
4618 <screen>+limit-connect{443} # This is the default and need not be specified.
4619 +limit-connect{80,443} # Ports 80 and 443 are OK.
4620 +limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
4621 +limit-connect{-} # All ports are OK (gaping security hole!)</screen>
4628 <!-- ~~~~~ New section ~~~~~ -->
4629 <sect3 renderas="sect4" id="prevent-compression">
4630 <title><emphasis>prevent-compression</emphasis></title>
4634 <term>Typical use:</term>
4637 Ensure that servers send the content uncompressed, so it can be
4638 passed through <literal><link linkend="filter">filter</link></literal>s
4644 <term>Effect:</term>
4647 Adds a header to the request that asks for uncompressed transfer.
4654 <!-- Boolean, Parameterized, Multi-value -->
4656 <para>Boolean.</para>
4661 <term>Parameter:</term>
4673 More and more websites send their content compressed by default, which
4674 is generally a good idea and saves bandwidth. But for the <literal><link
4675 linkend="filter">filter</link></literal>, <literal><link linkend="deanimate-gifs">deanimate-gifs</link></literal>
4676 and <literal><link linkend="kill-popups">kill-popups</link></literal> actions to work,
4677 <application>Privoxy</application> needs access to the uncompressed data.
4678 Unfortunately, <application>Privoxy</application> can't yet(!) uncompress, filter, and
4679 re-compress the content on the fly. So if you want to ensure that all websites, including
4680 those that normally compress, can be filtered, you need to use this action.
4683 This will slow down transfers from those websites, though. If you use any of the above-mentioned
4684 actions, you will typically want to use <literal>prevent-compression</literal> in conjunction
4688 Note that some (rare) ill-configured sites don't handle requests for uncompressed
4689 documents correctly (they send an empty document body). If you use <literal>prevent-compression</literal>
4690 per default, you'll have to add exceptions for those sites. See the example for how to do that.
4696 <term>Example usage (sections):</term>
4699 <screen># Set default:
4701 {+prevent-compression}
4704 # Make exceptions for ill sites:
4706 {-prevent-compression}
4708 www.pclinuxonline.com</screen>
4717 <!-- ~~~~~ New section ~~~~~ -->
4718 <sect3 renderas="sect4" id="send-vanilla-wafer">
4719 <title><emphasis>send-vanilla-wafer</emphasis></title>
4723 <term>Typical use:</term>
4726 Feed log analysis scripts with useless data.
4732 <term>Effect:</term>
4735 Sends a cookie with each request stating that you do not accept any copyright
4736 on cookies sent to you, and asking the site operator not to track you.
4743 <!-- Boolean, Parameterized, Multi-value -->
4745 <para>Boolean.</para>
4750 <term>Parameter:</term>
4762 The vanilla wafer is a (relatively) unique header and could conceivably be used to track you.
4765 This action is rarely used and not enabled in the default configuration.
4771 <term>Example usage:</term>
4774 <screen>+send-vanilla-wafer</screen>
4783 <!-- ~~~~~ New section ~~~~~ -->
4784 <sect3 renderas="sect4" id="send-wafer">
4785 <title><emphasis>send-wafer</emphasis></title>
4789 <term>Typical use:</term>
4792 Send custom cookies or feed log analysis scripts with even more useless data.
4798 <term>Effect:</term>
4801 Sends a custom, user-defined cookie with each request.
4808 <!-- Boolean, Parameterized, Multi-value -->
4810 <para>Multi-value.</para>
4815 <term>Parameter:</term>
4818 A string of the form <quote><replaceable class="option">name</replaceable>=<replaceable
4819 class="parameter">value</replaceable></quote>.
4828 Being multi-valued, multiple instances of this action can apply to the same request,
4829 resulting in multiple cookies being sent.
4832 This action is rarely used and not enabled in the default configuration.
4837 <term>Example usage (section):</term>
4840 <screen>{+send-wafer{UsingPrivoxy=true}}
4841 my-internal-testing-server.void</screen>
4849 <!-- ~~~~~ New section ~~~~~ -->
4850 <sect3 renderas="sect4" id="session-cookies-only">
4851 <title><emphasis>session-cookies-only</emphasis></title>
4855 <term>Typical use:</term>
4858 Allow only temporary <quote>session</quote> cookies (for the current browser session <emphasis>only</emphasis>).
4864 <term>Effect:</term>
4867 Deletes the <quote>expires</quote> field from <quote>Set-Cookie:</quote> server headers.
4868 Most browsers will not store such cookies permanently and forget them in between sessions.
4875 <!-- Boolean, Parameterized, Multi-value -->
4877 <para>Boolean.</para>
4882 <term>Parameter:</term>
4894 This is less strict than <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal> /
4895 <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal> and allows you to browse
4896 websites that insist or rely on setting cookies, without compromising your privacy too badly.
4899 Most browsers will not permanently store cookies that have been processed by
4900 <literal>session-cookies-only</literal> and will forget about them between sessions.
4901 This makes profiling cookies useless, but won't break sites which require cookies so
4902 that you can log in for transactions. This is generally turned on for all
4903 sites, and is the recommended setting.
4906 It makes <emphasis>no sense at all</emphasis> to use <literal>session-cookies-only</literal>
4907 together with <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal> or
4908 <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>. If you do, cookies
4909 will be plainly killed.
4912 Note that it is up to the browser how it handles such cookies without an <quote>expires</quote>
4913 field. If you use an exotic browser, you might want to try it out to be sure.
4919 <term>Example usage:</term>
4922 <screen>+session-cookies-only</screen>
4930 <!-- ~~~~~ New section ~~~~~ -->
4931 <sect3 renderas="sect4" id="set-image-blocker">
4932 <title><emphasis>set-image-blocker</emphasis></title>
4936 <term>Typical use:</term>
4938 <para>Choose the replacement for blocked images</para>
4943 <term>Effect:</term>
4946 This action alone doesn't do anything noticeable. If <emphasis>both</emphasis>
4947 <literal><link linkend="block">block</link></literal> <emphasis>and</emphasis> <literal><link
4948 linkend="handle-as-image">handle-as-image</link></literal> <emphasis>also</emphasis>
4949 apply, i.e. if the request is to be blocked as an image,
4950 <emphasis>then</emphasis> the parameter of this action decides what will be
4951 sent as a replacement.
4958 <!-- Boolean, Parameterized, Multi-value -->
4960 <para>Parameterized.</para>
4965 <term>Parameter:</term>
4970 <quote>pattern</quote> to send a built-in checkerboard pattern image. The image is visually
4971 decent, scales very well, and makes it obvious where banners were busted.
4976 <quote>blank</quote> to send a built-in transparent image. This makes banners disappear
4977 completely, but makes it hard to detect where <application>Privoxy</application> has blocked
4978 images on a given page and complicates troubleshooting if <application>Privoxy</application>
4979 has blocked innocent images, like navigation icons.
4984 <quote><replaceable class="parameter">target-url</replaceable></quote> to
4985 send a redirect to <replaceable class="parameter">target-url</replaceable>. You can redirect
4986 to any image anywhere, even in your local filesystem (via <quote>file:///</quote> URL).
4989 A good application of redirects is to use special <application>Privoxy</application>-built-in
4990 URLs, which send the built-in images, as <replaceable class="parameter">target-url</replaceable>.
4991 This has the same visual effect as specifying <quote>blank</quote> or <quote>pattern</quote> in
4992 the first place, but enables your browser to cache the replacement image, instead of requesting
4993 it over and over again.
5004 The URLs for the built-in images are <quote>http://config.privoxy.org/send-banner?type=<replaceable
5005 class="parameter">type</replaceable></quote>, where <replaceable class="parameter">type</replaceable> is
5006 either <quote>blank</quote> or <quote>pattern</quote>.
5009 There is a third (advanced) type, called <quote>auto</quote>. It is <emphasis>NOT</emphasis> to be
5010 used in <literal>set-image-blocker</literal>, but meant for use from <link linkend="filter-file">filters</link>.
5011 Auto will select the type of image that would have applied to the referring page, had it been an image.
5017 <term>Example usage:</term>
5023 <screen>+set-image-blocker{pattern}</screen>
5026 Redirect to the BSD devil:
5029 <screen>+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</screen>
5032 Redirect to the built-in pattern for better caching:
5035 <screen>+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</screen>
5043 <!-- ~~~~~ New section ~~~~~ -->
5045 <title>Summary</title>
5047 Note that many of these actions have the potential to cause a page to
5048 misbehave, possibly even not to display at all. There are many ways
5049 a site designer may choose to design his site, and what HTTP header
5050 content, and other criteria, he may depend on. There is no way to have hard
5051 and fast rules for all sites. See the <link
5052 linkend="ACTIONSANAT">Appendix</link> for a brief example on troubleshooting
5058 <!-- ~~~~~ New section ~~~~~ -->
5059 <sect2 id="aliases">
5060 <title>Aliases</title>
5062 Custom <quote>actions</quote>, known to <application>Privoxy</application>
5063 as <quote>aliases</quote>, can be defined by combining other actions.
5064 These can in turn be invoked just like the built-in actions.
5065 Currently, an alias name can contain any character except space, tab,
5067 <quote>{</quote> and <quote>}</quote>, but we <emphasis>strongly
5068 recommend</emphasis> that you only use <quote>a</quote> to <quote>z</quote>,
5069 <quote>0</quote> to <quote>9</quote>, <quote>+</quote>, and <quote>-</quote>.
5070 Alias names are not case sensitive, and are not required to start with a
5071 <quote>+</quote> or <quote>-</quote> sign, since they are merely textually
5075 Aliases can be used throughout the actions file, but they <emphasis>must be
5076 defined in a special section at the top of the file!</emphasis>
5077 And there can only be one such section per actions file. Each actions file may
5078 have its own alias section, and the aliases defined in it are only visible
5082 There are two main reasons to use aliases: One is to save typing for frequently
5083 used combinations of actions, the other one is a gain in flexibility: If you
5084 decide once how you want to handle shops by defining an alias called
5085 <quote>shop</quote>, you can later change your policy on shops in
5086 <emphasis>one</emphasis> place, and your changes will take effect everywhere
5087 in the actions file where the <quote>shop</quote> alias is used. Calling aliases
5088 by their purpose also makes your actions files more readable.
5091 Currently, there is one big drawback to using aliases, though:
5092 <application>Privoxy</application>'s built-in web-based action file
5093 editor honors aliases when reading the actions files, but it expands
5094 them before writing. So the effects of your aliases are of course preserved,
5095 but the aliases themselves are lost when you edit sections that use aliases
5097 This is likely to change in future versions of <application>Privoxy</application>.
5101 Now let's define some aliases...
5106 # Useful custom aliases we can use later.
5108 # Note the (required!) section header line and that this section
5109 # must be at the top of the actions file!
5113 # These aliases just save typing later:
5114 # (Note that some already use other aliases!)
5116 +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
5117 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
5118 block-as-image = +block +handle-as-image
5119 mercy-for-cookies = -crunch-all-cookies -session-cookies-only
5121 # These aliases define combinations of actions
5122 # that are useful for certain types of sites:
5124 fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups
5125 shop = -crunch-all-cookies -filter{popups} -kill-popups
5127 # Short names for other aliases, for really lazy people ;-)
5129 c0 = +crunch-all-cookies
5130 c1 = -crunch-all-cookies</screen>
5134 ...and put them to use. These sections would appear in the lower part of an
5135 actions file and define exceptions to the default actions (as specified further
5136 up for the <quote>/</quote> pattern):
5141 # These sites are either very complex or very keen on
5142 # user data and require minimal interference to work:
5145 .office.microsoft.com
5146 .windowsupdate.microsoft.com
5150 # Allow cookies (for setting and retrieving your customer data)
5154 .worldpay.com # for quietpc.com
5157 # These shops require pop-ups:
5159 {shop -kill-popups -filter{popups}}
5161 .overclockers.co.uk</screen>
5165 Aliases like <quote>shop</quote> and <quote>fragile</quote> are often used for
5166 <quote>problem</quote> sites that require some actions to be disabled
5167 in order to function properly.
5171 <!-- ~~~~~ New section ~~~~~ -->
5172 <sect2 id="act-examples">
5173 <title>Actions Files Tutorial</title>
5175 The above chapters have shown <link linkend="actions-file">which actions files
5176 there are and how they are organized</link>, how actions are <link
5177 linkend="actions">specified</link> and <link linkend="actions-apply">applied
5178 to URLs</link>, how <link linkend="af-patterns">patterns</link> work, and how to
5179 define and use <link linkend="aliases">aliases</link>. Now, let's look at an
5180 example <filename>default.action</filename> and <filename>user.action</filename>
5181 file and see how all these pieces come together:
5184 <sect3><title>default.action</title>
5187 Every config file should start with a short comment stating its purpose:
5191 <screen># Sample default.action file <developers@privoxy.org></screen>
5195 Then, since this is the <filename>default.action</filename> file, the
5196 first section is a special section for internal use that you needn't
5197 change or worry about:
5202 ##########################################################################
5203 # Settings -- Don't change! For internal Privoxy use ONLY.
5204 ##########################################################################
5207 for-privoxy-version=3.0</screen>
5211 After that comes the (optional) alias section. We'll use the example
5212 section from the above <link linkend="aliases">chapter on aliases</link>,
5213 that also explains why and how aliases are used:
5218 ##########################################################################
5220 ##########################################################################
5223 # These aliases just save typing later:
5224 # (Note that some already use other aliases!)
5226 +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
5227 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
5228 block-as-image = +block +handle-as-image
5229 mercy-for-cookies = -crunch-all-cookies -session-cookies-only
5231 # These aliases define combinations of actions
5232 # that are useful for certain types of sites:
5234 fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups
5235 shop = mercy-for-cookies -filter{popups} -kill-popups</screen>
5239 Now come the regular sections, i.e. sets of actions, accompanied
5240 by URL patterns to which they apply. Remember <emphasis>all actions
5241 are disabled when matching starts</emphasis>, so we have to explicitly
5242 enable the ones we want.
5246 The first regular section is probably the most important. It has only
5247 one pattern, <quote><literal>/</literal></quote>, but this pattern
5248 <link linkend="af-patterns">matches all URLs.</link>. Therefore, the
5249 set of actions used in this <quote>default</quote> section <emphasis>will
5250 be applied to all requests as a start</emphasis>. It can be partly or
5251 wholly overridden by later matches further down this file, or in user.action,
5252 but it will still be largely responsible for your overall browsing
5257 Again, at the start of matching, all actions are disabled, so there is
5258 no real need to disable any actions here, but we will do that nonetheless,
5259 to have a complete listing for your reference. (Remember: A <quote>+</quote>
5260 preceding the action name enables the action, a <quote>-</quote> disables!).
5261 Also note how this long line has been made more readable by splitting it into
5262 multiple lines with line continuation.
5267 ##########################################################################
5268 # "Defaults" section:
5269 ##########################################################################
5271 -<link linkend="ADD-HEADER">add-header</link> \
5272 -<link linkend="BLOCK">block</link> \
5273 -<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> \
5274 -<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link> \
5275 +<link linkend="DEANIMATE-GIFS">deanimate-gifs</link> \
5276 -<link linkend="DOWNGRADE-HTTP-VERSION">downgrade-http-version</link> \
5277 +<link linkend="FAST-REDIRECTS">fast-redirects</link> \
5278 +<link linkend="FILTER-HTML-ANNOYANCES">filter{html-annoyances}</link> \
5279 +<link linkend="FILTER-JS-ANNOYANCES">filter{js-annoyances}</link> \
5280 -<link linkend="FILTER-CONTENT-COOKIES">filter{content-cookies}</link> \
5281 +<link linkend="FILTER-POPUPS">filter{popups}</link> \
5282 +<link linkend="FILTER-WEBBUGS">filter{webbugs}</link> \
5283 -<link linkend="FILTER-REFRESH-TAGS">filter{refresh-tags}</link> \
5284 -<link linkend="FILTER-FUN">filter{fun}</link> \
5285 +<link linkend="FILTER-NIMDA">filter{nimda}</link> \
5286 +<link linkend="FILTER-BANNERS-BY-SIZE">filter{banners-by-size}</link> \
5287 -<link linkend="FILTER-SHOCKWAVE-FLASH">filter{shockwave-flash}</link> \
5288 -<link linkend="FILTER-CRUDE-PARENTAL">filter{crude-parental}</link> \
5289 -<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> \
5290 +<link linkend="HIDE-FORWARDED-FOR-HEADERS">hide-forwarded-for-headers</link> \
5291 +<link linkend="HIDE-FROM-HEADER">hide-from-header{block}</link> \
5292 +<link linkend="HIDE-REFERER">hide-referrer{forge}</link> \
5293 -<link linkend="HIDE-USER-AGENT">hide-user-agent</link> \
5294 -<link linkend="KILL-POPUPS">kill-popups</link> \
5295 -<link linkend="LIMIT-CONNECT">limit-connect</link> \
5296 +<link linkend="PREVENT-COMPRESSION">prevent-compression</link> \
5297 -<link linkend="SEND-VANILLA-WAFER">send-vanilla-wafer</link> \
5298 -<link linkend="SEND-WAFER">send-wafer</link> \
5299 +<link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> \
5300 +<link linkend="SET-IMAGE-BLOCKER">set-image-blocker{pattern}</link> \
5302 / # forward slash will match *all* potential URL patterns.</screen>
5306 The default behavior is now set. Note that some actions, like not hiding
5307 the user agent, are part of a <quote>general policy</quote> that applies
5308 universally and won't get any exceptions defined later. Other choices,
5309 like not blocking (which is <emphasis>understandably</emphasis> the
5310 default!) need exceptions, i.e. we need to specify explicitly what we
5311 want to block in later sections.
5312 We will also want to make exceptions from our general pop-up-killing,
5313 and use our defined aliases for that.
5317 The first of our specialized sections is concerned with <quote>fragile</quote>
5318 sites, i.e. sites that require minimum interference, because they are either
5319 very complex or very keen on tracking you (and have mechanisms in place that
5320 make them unusable for people who avoid being tracked). We will simply use
5321 our pre-defined <literal>fragile</literal> alias instead of stating the list
5322 of actions explicitly:
5327 ##########################################################################
5328 # Exceptions for sites that'll break under the default action set:
5329 ##########################################################################
5331 # "Fragile" Use a minimum set of actions for these sites (see alias above):
5334 .office.microsoft.com # surprise, surprise!
5335 .windowsupdate.microsoft.com</screen>
5339 Shopping sites are not as fragile, but they typically
5340 require cookies to log in, and pop-up windows for shopping
5341 carts or item details. Again, we'll use a pre-defined alias:
5350 .worldpay.com # for quietpc.com
5352 .scan.co.uk</screen>
5356 Then, there are sites which rely on pop-up windows (yuck!) to work.
5357 Since we made pop-up-killing our default above, we need to make exceptions
5358 now. <ulink url="http://www.mozilla.org/">Mozilla</ulink> users, who
5359 can turn on smart handling of unwanted pop-ups in their browsers, can
5361 -<literal><link linkend="FILTER-POPUPS">filter{popups}</link></literal> (and
5362 -<literal><link linkend="KILL-POPUPS">kill-popups</link></literal>) above
5363 and hence don't need this section. Anyway, disabling an already disabled
5364 action doesn't hurt, so we'll define our exceptions regardless of what was
5365 chosen in the defaults section:
5370 # These sites require pop-ups too :(
5372 { -<link linkend="KILL-POPUPS">kill-popups</link> -<link linkend="FILTER-POPUPS">filter{popups}</link> }
5375 .deutsche-bank-24.de</screen>
5379 The <literal><link linkend="FAST-REDIRECTS">fast-redirects</link></literal>
5380 action, which we enabled per default above, breaks some sites. So disable
5381 it for popular sites where we know it misbehaves:
5386 { -<link linkend="FAST-REDIRECTS">fast-redirects</link> }
5390 .altavista.com/.*(like|url|link):http
5391 .altavista.com/trans.*urltext=http
5392 .nytimes.com</screen>
5396 It is important that <application>Privoxy</application> knows which
5397 URLs belong to images, so that <emphasis>if</emphasis> they are to
5398 be blocked, a substitute image can be sent, rather than an HTML page.
5399 Contacting the remote site to find out is not an option, since it
5400 would destroy the loading time advantage of banner blocking, and it
5401 would feed the advertisers (in terms of money <emphasis>and</emphasis>
5402 information). We can mark any URL as an image with the <literal><link
5403 linkend="handle-as-image">handle-as-image</link></literal> action,
5404 and marking all URLs that end in a known image file extension is a
5410 ##########################################################################
5412 ##########################################################################
5414 # Define which file types will be treated as images, in case they get
5415 # blocked further down this file:
5417 { +<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> }
5418 /.*\.(gif|jpe?g|png|bmp|ico)$</screen>
5422 And then there are known banner sources. They often use scripts to
5423 generate the banners, so it won't be visible from the URL that the
5424 request is for an image. Hence we block them <emphasis>and</emphasis>
5425 mark them as images in one go, with the help of our
5426 <literal>block-as-image</literal> alias defined above. (We could of
5427 course just as well use <literal>+<link linkend="block">block</link>
5428 +<link linkend="handle-as-image">handle-as-image</link></literal> here.)
5429 Remember that the type of the replacement image is chosen by the
5430 <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>
5431 action. Since all URLs have matched the default section with its
5432 <literal>+<link linkend="set-image-blocker">set-image-blocker</link>{pattern}</literal>
5433 action before, it still applies and needn't be repeated:
5438 # Known ad generators:
5443 .ad.*.doubleclick.net
5444 .a.yimg.com/(?:(?!/i/).)*$
5445 .a[0-9].yimg.com/(?:(?!/i/).)*$
5452 One of the most important jobs of <application>Privoxy</application>
5453 is to block banners. A huge bunch of them are already <quote>blocked</quote>
5454 by the <literal><link linkend="filter">filter</link>{banners-by-size}</literal>
5455 action, which we enabled above, and which deletes the references to banner
5456 images from the pages while they are loaded, so the browser doesn't request
5457 them anymore, and hence they don't need to be blocked here. But this naturally
5458 doesn't catch all banners, and some people choose not to use filters, so we
5459 need a comprehensive list of patterns for banner URLs here, and apply the
5460 <literal><link linkend="block">block</link></literal> action to them.
5463 First comes a bunch of generic patterns, which do most of the work, by
5464 matching typical domain and path name components of banners. Then comes
5465 a list of individual patterns for specific sites, which is omitted here
5466 to keep the example short:
5471 ##########################################################################
5472 # Block these fine banners:
5473 ##########################################################################
5474 { <link linkend="BLOCK">+block</link> }
5482 /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
5483 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/
5485 # Site-specific patterns (abbreviated):
5487 .hitbox.com</screen>
5491 You wouldn't believe how many advertisers actually call their banner
5492 servers ads.<replaceable>company</replaceable>.com, or call the directory
5493 in which the banners are stored simply <quote>banners</quote>. So the above
5494 generic patterns are surprisingly effective.
5497 But being very generic, they necessarily also catch URLs that we don't want
5498 to block. The pattern <literal>.*ads.</literal> e.g. catches
5499 <quote>nasty-<emphasis>ads</emphasis>.nasty-corp.com</quote> as intended,
5500 but also <quote>downlo<emphasis>ads</emphasis>.sourcefroge.net</quote> or
5501 <quote><emphasis>ads</emphasis>l.some-provider.net.</quote> So here come some
5502 well-known exceptions to the <literal>+<link linkend="BLOCK">block</link></literal>
5506 Note that these are exceptions to exceptions from the default! Consider the URL
5507 <quote>downloads.sourcefroge.net</quote>: Initially, all actions are deactivated,
5508 so it wouldn't get blocked. Then comes the defaults section, which matches the
5509 URL, but just deactivates the <literal><link linkend="BLOCK">block</link></literal>
5510 action once again. Then it matches <literal>.*ads.</literal>, an exception to the
5511 general non-blocking policy, and suddenly
5512 <literal><link linkend="BLOCK">+block</link></literal> applies. And now, it'll match
5513 <literal>.*loads.</literal>, where <literal><link linkend="BLOCK">-block</link></literal>
5514 applies, so (unless it matches <emphasis>again</emphasis> further down) it ends up
5515 with no <literal><link linkend="BLOCK">block</link></literal> action applying.
5520 ##########################################################################
5521 # Save some innocent victims of the above generic block patterns:
5522 ##########################################################################
5526 { -<link linkend="BLOCK">block</link> }
5527 adv[io]*. # (for advogato.org and advice.*)
5528 adsl. # (has nothing to do with ads)
5529 ad[ud]*. # (adult.* and add.*)
5530 .edu # (universities don't host banners (yet!))
5531 .*loads. # (downloads, uploads etc)
5539 www.globalintersec.com/adv # (adv = advanced)
5540 www.ugu.com/sui/ugu/adv</screen>
5544 Filtering source code can have nasty side effects,
5545 so make an exception for our friends at sourceforge.net,
5546 and all paths with <quote>cvs</quote> in them. Note that
5547 <literal>-<link linkend="FILTER">filter</link></literal>
5548 disables <emphasis>all</emphasis> filters in one fell swoop!
5553 # Don't filter code!
5555 { -<link linkend="FILTER">filter</link> }
5557 .sourceforge.net</screen>
5561 The actual <filename>default.action</filename> is of course more
5562 comprehensive, but we hope this example made clear how it works.
5567 <sect3><title>user.action</title>
5570 So far we are painting with a broad brush by setting general policies,
5571 which would be a reasonable starting point for many people. Now,
5572 you'd maybe want to be more specific and have customized rules that
5573 are more suitable to your personal habits and preferences. These would
5574 be for narrowly defined situations like your ISP or your bank, and should
5575 be placed in <filename>user.action</filename>, which is parsed after all other
5576 actions files and hence has the last word, over-riding any previously
5577 defined actions. <filename>user.action</filename> is also a
5578 <emphasis>safe</emphasis> place for your personal settings, since
5579 <filename>default.action</filename> is actively maintained by the
5580 <application>Privoxy</application> developers and you'll probably want
5581 to install updated versions from time to time.
5585 So let's look at a few examples of things that one might typically do in
5586 <filename>user.action</filename>:
5590 <!-- brief sample user.action here -->
5594 # My user.action file. <fred@foobar.com></screen>
5598 As <link linkend="aliases">aliases</link> are local to the actions
5599 file that they are defined in, you can't use the ones from
5600 <filename>default.action</filename>, unless you repeat them here:
5605 # (Re-)define aliases for this file:
5608 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
5609 mercy-for-cookies = -crunch-all-cookies -session-cookies-only
5610 fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups
5611 shop = mercy-for-cookies -filter{popups} -kill-popups
5612 allow-ads = -block -filter{banners-by-size} # (see below)</screen>
5617 Say you have accounts on some sites that you visit regularly, and
5618 you don't want to have to log in manually each time. So you'd like
5619 to allow persistent cookies for these sites. The
5620 <literal>mercy-for-cookies</literal> alias defined above does exactly
5621 that, i.e. it disables crunching of cookies in any direction, and
5622 processing of cookies to make them temporary.
5627 { mercy-for-cookies }
5632 .redhat.com</screen>
5636 Your bank needs popups and is allergic to some filter, but you don't
5637 know which, so you disable them all:
5642 { -<link linkend="FILTER">filter</link> -<link linkend="KILL-POPUPS">kill-popups</link> }
5643 .your-home-banking-site.com</screen>
5647 While browsing the web with <application>Privoxy</application> you
5648 noticed some ads that sneaked through, but you were too lazy to
5649 report them through our fine and easy <link linkend="contact">feedback</link>
5650 system, so you have added them here:
5655 { +<link linkend="BLOCK">block</link> }
5656 www.a-popular-site.com/some/unobvious/path
5657 another.popular.site.net/more/junk/here/</screen>
5661 Note that, assuming the banners in the above example have regular image
5662 extensions (most do),
5663 <literal>+<link linkend="HANDLE-AS-IMAGE">handle-as-image</link></literal>
5664 need not be specified, since all URLs ending in these extensions will
5665 already have been tagged as images in the relevant section of
5666 <filename>default.action</filename> by now.
5670 Then you noticed that the default configuration breaks Forbes Magazine,
5671 but you were too lazy to find out which action is the culprit, and you
5672 were again too lazy to give <link linkend="contact">feedback</link>, so
5673 you just used the <literal>fragile</literal> alias on the site, and
5674 -- whoa! -- it worked:
5680 .forbes.com</screen>
5684 You like the <quote>fun</quote> text replacements in <filename>default.filter</filename>,
5685 but it is disabled in the distributed actions file. (My colleagues on the team just
5686 don't have a sense of humour, that's why! ;-). So you'd like to turn it on in your private,
5687 update-safe config, once and for all:
5692 { +<link linkend="filter-fun">filter{fun}</link> }
5693 / # For ALL sites!</screen>
5697 Note that the above is not really a good idea: There are exceptions
5698 to the filters in <filename>default.action</filename> for things that
5699 really shouldn't be filtered, like code on CVS->Web interfaces. Since
5700 <filename>user.action</filename> has the last word, these exceptions
5701 won't be valid for the <quote>fun</quote> filtering specified here.
5705 Finally, you might think about how your favourite free websites are
5706 funded, and find that they rely on displaying banner advertisements
5707 to survive. So you might want to specifically allow banners for those
5708 sites that you feel provide value to you:
5720 Note that <literal>allow-ads</literal> has been aliased to
5721 <literal>-<link linkend="block">block</link></literal>
5722 <literal>-<link linkend="filter-banners-by-size">filter{banners-by-size}</link></literal>
5728 <!-- ~ End section ~ -->
5732 <!-- ~ End section ~ -->
5734 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
5736 <sect1 id="filter-file">
5737 <title>The Filter File</title>
5740 All text substitutions that can be invoked through the
5741 <literal><link linkend="filter">filter</link></literal> action
5742 must first be defined in the filter file, which is typically
5743 called <filename>default.filter</filename> and which can be
5744 selected through the <literal>
5745 <link linkend="filterfile">filterfile</link></literal> config
5750 Typical reasons for doing such substitutions are to eliminate
5751 common annoyances in HTML and JavaScript, such as pop-up windows,
5752 exit consoles, crippled windows without navigation tools, the
5753 infamous <BLINK> tag etc, to suppress images with certain
5754 width and height attributes (standard banner sizes or web-bugs),
5755 or just to have fun. The possibilities are endless.
5759 Filtering works on any text-based document type, including plain
5760 text, HTML, JavaScript, CSS etc. (all <literal>text/*</literal>
5761 MIME types). Substitutions are made at the source level, so if
5762 you want to <quote>roll your own</quote> filters, you should be
5763 familiar with HTML syntax.
5767 Just like the <link linkend="actions-file">actions files</link>, the
5768 filter file is organized in sections, which are called <emphasis>filters</emphasis>
5769 here. Each filter consists of a heading line, that starts with the
5770 <emphasis>keyword</emphasis> <literal>FILTER:</literal>, followed by
5771 the filter's <emphasis>name</emphasis>, and a short (one line)
5772 <emphasis>description</emphasis> of what it does. Below that line
5773 come the <emphasis>jobs</emphasis>, i.e. lines that define the actual
5774 text substitutions. By convention, the name of a filter
5775 should describe what the filter <emphasis>eliminates</emphasis>. The
5776 comment is used in the <ulink url="http://config.privoxy.org/">web-based
5777 user interface</ulink>.
5781 Once a filter called <replaceable>name</replaceable> has been defined
5782 in the filter file, it can be invoked by using an action of the form
5783 +<literal><link linkend="filter">filter</link>{<replaceable>name</replaceable>}</literal>
5784 in any <link linkend="actions-file">actions file</link>.
5788 A filter header line for a filter called <quote>foo</quote> could look
5793 <screen>FILTER: foo Replace all "foo" with "bar"</screen>
5797 Below that line, and up to the next header line, come the jobs that
5798 define what text replacements the filter executes. They are specified
5799 in a syntax that imitates <ulink url="http://www.perl.org/">Perl</ulink>'s
5800 <literal>s///</literal> operator. If you are familiar with Perl, you
5801 will find this to be quite intuitive, and may want to look at the
5802 <ulink url="http://www.oesterhelt.org/pcrs/pcrs.1.html">PCRS man page</ulink>
5803 for the subtle differences to Perl behaviour. Most notably, the non-standard
5804 option letter <literal>U</literal> is supported, which turns the default
5805 to ungreedy matching.
5809 If you are new to regular expressions, you might want to take a look at
5810 the <link linkend="regex">Appendix on regular expressions</link>, and
5811 see the <ulink url="http://perldoc.com/perl5.6.1/pod/perl.html">Perl
5813 <ulink url="http://perldoc.com/perl5.6.1/pod/perlop.html#s-PATTERN-REPLACEMENT-egimosx">the
5814 <literal>s///</literal> operator's syntax</ulink> and <ulink
5815 url="http://perldoc.com/perl5.6.1/pod/perlre.html">Perl-style regular
5816 expressions</ulink> in general.
5817 The below examples might also help to get you started.
5820 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
5822 <sect2><title>Filter File Tutorial</title>
5824 Now, let's complete our <quote>foo</quote> filter. We have already defined
5825 the heading, but the jobs are still missing. Since all it does is to replace
5826 <quote>foo</quote> with <quote>bar</quote>, there is only one (trivial) job
5831 <screen>s/foo/bar/</screen>
5835 But wait! Didn't the comment say that <emphasis>all</emphasis> occurrences
5836 of <quote>foo</quote> should be replaced? Our current job will only take
5837 care of the first <quote>foo</quote> on each page. For global substitution,
5838 we'll need to add the <literal>g</literal> option:
5842 <screen>s/foo/bar/g</screen>
5846 Our complete filter now looks like this:
5849 <screen>FILTER: foo Replace all "foo" with "bar"
5850 s/foo/bar/g</screen>
5854 Let's look at some real filters for more interesting examples. Here you see
5855 a filter that protects against some common annoyances that arise from JavaScript
5856 abuse. Let's look at its jobs one after the other:
5862 FILTER: js-annoyances Get rid of particularly annoying JavaScript abuse
5864 # Get rid of JavaScript referrer tracking. Test page: http://www.randomoddness.com/untitled.htm
5866 s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|Usg</screen>
5870 Following the header line and a comment, you see the job. Note that it uses
5871 <literal>|</literal> as the delimiter instead of <literal>/</literal>, because
5872 the pattern contains a forward slash, which would otherwise have to be escaped
5873 by a backslash (<literal>\</literal>).
5877 Now, let's examine the pattern: it starts with the text <literal><script.*</literal>
5878 enclosed in parentheses. Since the dot matches any character, and <literal>*</literal>
5879 means: <quote>Match an arbitrary number of the element left of myself</quote>, this
5880 matches <quote><script</quote>, followed by <emphasis>any</emphasis> text, i.e.
5881 it matches the whole page, from the start of the first <script> tag.
5885 That's more than we want, but the pattern continues: <literal>document\.referrer</literal>
5886 matches only the exact string <quote>document.referrer</quote>. The dot needed to
5887 be <emphasis>escaped</emphasis>, i.e. preceded by a backslash, to take away its
5888 special meaning as a joker, and make it just a regular dot. So far, the meaning is:
5889 Match from the start of the first <script> tag in a the page, up to, and including,
5890 the text <quote>document.referrer</quote>, if <emphasis>both</emphasis> are present
5891 in the page (and appear in that order).
5895 But there's still more pattern to go. The next element, again enclosed in parentheses,
5896 is <literal>.*</script></literal>. You already know what <literal>.*</literal>
5897 means, so the whole pattern translates to: Match from the start of the first <script>
5898 tag in a page to the end of the last <script> tag, provided that the text
5899 <quote>document.referrer</quote> appears somewhere in between.
5903 This is still not the whole story, since we have ignored the options and the parentheses:
5904 The portions of the page matched by sub-patterns that are enclosed in parentheses, will be
5905 remembered and be available through the variables <literal>$1, $2, ...</literal> in
5906 the substitute. The <literal>U</literal> option switches to ungreedy matching, which means
5907 that the first <literal>.*</literal> in the pattern will only <quote>eat up</quote> all
5908 text in between <quote><script</quote> and the <emphasis>first</emphasis> occurrence
5909 of <quote>document.referrer</quote>, and that the second <literal>.*</literal> will
5910 only span the text up to the <emphasis>first</emphasis> <quote></script></quote>
5911 tag. Furthermore, the <literal>s</literal> option says that the match may span
5912 multiple lines in the page, and the <literal>g</literal> option again means that the
5913 substitution is global.
5917 So, to summarize, the pattern means: Match all scripts that contain the text
5918 <quote>document.referrer</quote>. Remember the parts of the script from
5919 (and including) the start tag up to (and excluding) the string
5920 <quote>document.referrer</quote> as <literal>$1</literal>, and the part following
5921 that string, up to and including the closing tag, as <literal>$2</literal>.
5925 Now the pattern is deciphered, but wasn't this about substituting things? So
5926 lets look at the substitute: <literal>$1"Not Your Business!"$2</literal> is
5927 easy to read: The text remembered as <literal>$1</literal>, followed by
5928 <literal>"Not Your Business!"</literal> (<emphasis>including</emphasis>
5929 the quotation marks!), followed by the text remembered as <literal>$2</literal>.
5930 This produces an exact copy of the original string, with the middle part
5931 (the <quote>document.referrer</quote>) replaced by <literal>"Not Your
5932 Business!"</literal>.
5936 The whole job now reads: Replace <quote>document.referrer</quote> by
5937 <literal>"Not Your Business!"</literal> wherever it appears inside a
5938 <script> tag. Note that this job won't break JavaScript syntax,
5939 since both the original and the replacement are syntactically valid
5940 string objects. The script just won't have access to the referrer
5941 information anymore.
5945 We'll show you two other jobs from the JavaScript taming department, but
5946 this time only point out the constructs of special interest:
5951 # The status bar is for displaying link targets, not pointless blahblah
5953 s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig</screen>
5957 <literal>\s</literal> stands for whitespace characters (space, tab, newline,
5958 carriage return, form feed), so that <literal>\s*</literal> means: <quote>zero
5959 or more whitespace</quote>. The <literal>?</literal> in <literal>.*?</literal>
5960 makes this matching of arbitrary text ungreedy. (Note that the <literal>U</literal>
5961 option is not set). The <literal>['"]</literal> construct means: <quote>a single
5962 <emphasis>or</emphasis> a double quote</quote>.
5966 So what does this job do? It replaces assignments of single- or double-quoted
5967 strings to the <quote>window.status</quote> object with a dummy assignment
5968 (using a variable name that is hopefully odd enough not to conflict with
5969 real variables in scripts). Thus, it catches many cases where e.g. pointless
5970 descriptions are displayed in the status bar instead of the link target when
5971 you move your mouse over links.
5976 # Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
5978 s/(<body .*)onunload(.*>)/$1never$2/iU</screen>
5983 <ulink url="http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Events-eventgroupings-htmlevents">OnUnload
5984 event binding</ulink> in the HTML DOM was a <emphasis>CRIME</emphasis>.
5985 When I close a browser window, I want it to close and die. Basta.
5986 This job replaces the <quote>onunload</quote> attribute in
5987 <quote><body></quote> tags with the dummy word <literal>never</literal>.
5988 Note that the <literal>i</literal> option makes the pattern matching
5993 The last example is from the fun department:
5998 FILTER: fun Fun text replacements
6000 # Spice the daily news:
6002 s/microsoft(?!\.com)/MicroSuck/ig</screen>
6006 Note the <literal>(?!\.com)</literal> part (a so-called negative lookahead)
6007 in the job's pattern, which means: Don't match, if the string
6008 <quote>.com</quote> appears directly following <quote>microsoft</quote>
6009 in the page. This prevents links to microsoft.com from being messed, while
6010 still replacing the word everywhere else.
6015 # Buzzword Bingo (example for extended regex syntax)
6017 s* industry[ -]leading \
6019 | award[ -]winning # Comments are OK, too! \
6020 | high[ -]performance \
6021 | solutions[ -]based \
6025 *<font color="red"><b>BINGO!</b></font> \
6030 The <literal>x</literal> option in this job turns on extended syntax, and allows for
6031 e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting.
6040 <!-- ~ End section ~ -->
6044 <!-- ~~~~~ New section ~~~~~ -->
6046 <sect1 id="templates">
6047 <title>Templates</title>
6049 All <application>Privoxy</application> built-in pages, i.e. error pages such as the
6050 <ulink url="http://show-the-404-error.page"><quote>404 - No Such Domain</quote>
6051 error page</ulink>, the <ulink
6052 url="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"><quote>BLOCKED</quote>
6054 and all pages of its <ulink url="http://config.privoxy.org/">web-based
6055 user interface</ulink>, are generated from <emphasis>templates</emphasis>.
6056 (<application>Privoxy</application> must be running for the above links to work as
6061 These templates are stored in a subdirectory of the <link linkend="confdir">configuration
6062 directory</link> called <filename>templates</filename>. On unixish platforms,
6064 <ulink url="file:///etc/privoxy/templates/"><filename>/etc/privoxy/templates/</filename></ulink>.
6068 The templates are basically normal HTML files, but with place-holders (called symbols
6069 or exports), which <application>Privoxy</application> fills at run time. You can
6070 edit the templates with a normal text editor, should you want to customize them.
6071 (<emphasis>Not recommended for the casual user</emphasis>). Note that
6072 just like in configuration files, lines starting with <literal>#</literal> are
6073 ignored when the templates are filled in.
6077 The place-holders are of the form <literal>@name@</literal>, and you will
6078 find a list of available symbols, which vary from template to template,
6079 in the comments at the start of each file. Note that these comments are not
6080 always accurate, and that it's probably best to look at the existing HTML
6081 code to find out which symbols are supported and what they are filled in with.
6085 A special application of this substitution mechanism is to make whole
6086 blocks of HTML code disappear when a specific symbol is set. We use this
6087 for many purposes, one of them being to include the beta warning in all
6088 our user interface (CGI) pages when <application>Privoxy</application>
6089 in in an alpha or beta development stage:
6094 <!-- @if-unstable-start -->
6096 ... beta warning HTML code goes here ...
6098 <!-- if-unstable-end@ --></screen>
6102 If the "unstable" symbol is set, everything in between and including
6103 <literal>@if-unstable-start</literal> and <literal>if-unstable-end@</literal>
6104 will disappear, leaving nothing but an empty comment:
6108 <screen><!-- --></screen>
6112 There's also an if-then-else construct and an <literal>#include</literal>
6113 mechanism, but you'll sure find out if you are inclined to edit the
6118 All templates refer to a style located at
6119 <ulink url="http://config.privoxy.org/send-stylesheet"><literal>http://config.privoxy.org/send-stylesheet</literal></ulink>.
6120 This is, of course, locally served by <application>Privoxy</application>
6121 and the source for it can be found and edited in the
6122 <filename>cgi-style.css</filename> template.
6127 <!-- ~ End section ~ -->
6131 <!-- ~~~~~ New section ~~~~~ -->
6133 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
6136 <!-- Include contacting.sgml boilerplate: -->
6138 <!-- end boilerplate -->
6142 <!-- ~ End section ~ -->
6145 <!-- ~~~~~ New section ~~~~~ -->
6146 <sect1 id="copyright"><title><application>Privoxy</application> Copyright, License and History</title>
6148 <!-- Include copyright.sgml: -->
6150 <!-- end copyright -->
6152 <!-- ~~~~~ New section ~~~~~ -->
6153 <sect2><title>License</title>
6154 <!-- Include copyright.sgml: -->
6156 <!-- end copyright -->
6158 <!-- ~ End section ~ -->
6161 <!-- ~~~~~ New section ~~~~~ -->
6163 <sect2 id="history"><title>History</title>
6164 <!-- Include history.sgml: -->
6166 <!-- end history -->
6169 <sect2 id="authors"><title>Authors</title>
6170 <!-- Include p-authors.sgml: -->
6172 <!-- end authors -->
6177 <!-- ~ End section ~ -->
6180 <!-- ~~~~~ New section ~~~~~ -->
6181 <sect1 id="seealso"><title>See Also</title>
6182 <!-- Include seealso.sgml: -->
6184 <!-- end seealso -->
6189 <!-- ~~~~~ New section ~~~~~ -->
6190 <sect1 id="appendix"><title>Appendix</title>
6193 <!-- ~~~~~ New section ~~~~~ -->
6195 <title>Regular Expressions</title>
6197 <application>Privoxy</application> uses Perl-style <quote>regular
6198 expressions</quote> in its <link linkend="actions-file">actions
6199 files</link> and <link linkend="filter-file">filter file</link>,
6200 through the <ulink url="http://www.pcre.org/">PCRE</ulink> and
6201 <ulink url="http://www.oesterhelt.org/pcrs/">PCRS</ulink> libraries.
6205 If you are reading this, you probably don't understand what <quote>regular
6206 expressions</quote> are, or what they can do. So this will be a very brief
6207 introduction only. A full explanation would require a <ulink
6208 url="http://www.oreilly.com/catalog/regex/">book</ulink> ;-)
6212 Regular expressions provide a language to describe patterns that can be
6213 run against strings of characters (letter, numbers, etc), to see if they
6214 match the string or not. The patterns are themselves (sometimes complex)
6215 strings of literal characters, combined with wild-cards, and other special
6216 characters, called meta-characters. The <quote>meta-characters</quote> have
6217 special meanings and are used to build complex patterns to be matched against.
6218 Perl Compatible Regular Expressions are an especially convenient
6219 <quote>dialect</quote> of the regular expression language.
6223 To make a simple analogy, we do something similar when we use wild-card
6224 characters when listing files with the <command>dir</command> command in DOS.
6225 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
6226 character here is the asterisk which matches any and all characters. We can be
6227 more specific and use <literal>?</literal> to match just individual
6228 characters. So <quote>dir file?.text</quote> would match
6229 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
6230 matching, using a similar technique to <quote>regular expressions</quote>!
6234 Regular expressions do essentially the same thing, but are much, much more
6235 powerful. There are many more <quote>special characters</quote> and ways of
6236 building complex patterns however. Let's look at a few of the common ones,
6237 and then some examples:
6242 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
6243 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
6245 </simplelist></para>
6249 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
6252 </simplelist></para>
6256 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
6259 </simplelist></para>
6263 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
6266 </simplelist></para>
6270 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
6271 the following character should be taken literally. This is used where one of the
6272 special characters (e.g. <quote>.</quote>) needs to be taken literally and
6273 not as a special meta-character. Example: <quote>example\.com</quote>, makes
6274 sure the period is recognized only as a period (and not expanded to its
6275 meta-character meaning of any single character).
6277 </simplelist></para>
6281 <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
6282 any of the enclosed characters are encountered. For instance, <quote>[0-9]</quote>
6283 matches any numeric digit (zero through nine). As an example, we can combine
6284 this with <quote>+</quote> to match any digit one of more times: <quote>[0-9]+</quote>.
6286 </simplelist></para>
6290 <emphasis>()</emphasis> - parentheses are used to group a sub-expression,
6291 or multiple sub-expressions.
6293 </simplelist></para>
6297 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
6298 <quote>or</quote> conditional statement. A match is successful if the
6299 sub-expression on either side of <quote>|</quote> matches. As an example:
6300 <quote>/(this|that) example/</quote> uses grouping and the bar character
6301 and would match either <quote>this example</quote> or <quote>that
6302 example</quote>, and nothing else.
6304 </simplelist></para>
6307 These are just some of the ones you are likely to use when matching URLs with
6308 <application>Privoxy</application>, and is a long way from a definitive
6309 list. This is enough to get us started with a few simple examples which may
6310 be more illuminating:
6314 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
6315 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
6316 denote any character, zero or more times. In other words, any string at all.
6317 So we start with a literal forward slash, then our regular expression pattern
6318 (<quote>.*</quote>) another literal forward slash, the string
6319 <quote>banners</quote>, another forward slash, and lastly another
6320 <quote>.*</quote>. We are building
6321 a directory path here. This will match any file with the path that has a
6322 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
6323 any characters, and this could conceivably be more forward slashes, so it
6324 might expand into a much longer looking path. For example, this could match:
6325 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
6326 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
6327 possible combinations, just so it has <quote>banners</quote> in the path
6332 A now something a little more complex:
6336 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
6337 We have several literal forward slashes again (<quote>/</quote>), so we are
6338 building another expression that is a file path statement. We have another
6339 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
6340 it matches our expression. The only true literal that <emphasis>must
6341 match</emphasis> our pattern is <application>adv</application>, together with
6342 the forward slashes. What comes after the <quote>adv</quote> string is the
6347 Remember the <quote>?</quote> means the preceding expression (either a
6348 literal character or anything grouped with <quote>(...)</quote> in this case)
6349 can exist or not, since this means either zero or one match. So
6350 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
6351 individual sub-expressions: <quote>(er)</quote>,
6352 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
6353 means <quote>or</quote>. We have two of those. For instance,
6354 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
6355 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
6356 attempt at matching as many variations of <quote>advertisement</quote>, and
6357 similar, as possible. So this would expand to match just <quote>adv</quote>,
6358 or <quote>advert</quote>, or <quote>adverts</quote>, or
6359 <quote>advertising</quote>, or <quote>advertisement</quote>, or
6360 <quote>advertisements</quote>. You get the idea. But it would not match
6361 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
6362 changing our regular expression to:
6363 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
6368 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
6369 another path statement with forward slashes. Anything in the square brackets
6370 <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
6371 shorthand expression to mean any digit one through nine. It is the same as
6372 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
6373 means one or more of the preceding expression must be included. The preceding
6374 expression here is what is in the square brackets -- in this case, any digit
6375 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
6376 This includes a <quote>|</quote>, so this needs to match the expression on
6377 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
6378 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
6379 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
6380 can be matched once or not at all. So we are building an expression here to
6381 match image GIF or JPEG type image file. It must include the literal
6382 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
6383 (which is now a literal, and not a special character, since it is escaped
6384 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
6385 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
6386 include: <quote>//advert1.jpg</quote>,
6387 <quote>/nasty/ads/advert1234.gif</quote>,
6388 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
6389 <quote>advert1.gif</quote> (no leading slash), or
6390 <quote>/adverts232.jpg</quote> (the expression does not include an
6391 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
6392 in the expression anywhere).
6396 We are barely scratching the surface of regular expressions here so that you
6397 can understand the default <application>Privoxy</application>
6398 configuration files, and maybe use this knowledge to customize your own
6399 installation. There is much, much more that can be done with regular
6400 expressions. Now that you know enough to get started, you can learn more on
6405 More reading on Perl Compatible Regular expressions:
6406 <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
6410 For information on regular expression based substititions and their applications
6411 in filters, please see the <link linkend="filter-file">filter file tutorial</link>
6416 <!-- ~ End section ~ -->
6419 <!-- ~~~~~ New section ~~~~~ -->
6421 <title><application>Privoxy</application>'s Internal Pages</title>
6424 Since <application>Privoxy</application> proxies each requested
6425 web page, it is easy for <application>Privoxy</application> to
6426 trap certain special URLs. In this way, we can talk directly to
6427 <application>Privoxy</application>, and see how it is
6428 configured, see how our rules are being applied, change these
6429 rules and other configuration options, and even turn
6430 <application>Privoxy's</application> filtering off, all with
6436 The URLs listed below are the special ones that allow direct access
6437 to <application>Privoxy</application>. Of course,
6438 <application>Privoxy</application> must be running to access these. If
6439 not, you will get a friendly error message. Internet access is not
6452 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
6456 There is a shortcut: <ulink url="http://p.p/">http://p.p/</ulink> (But it
6457 doesn't provide a fallback to a real page, in case the request is not
6458 sent through <application>Privoxy</application>)
6464 Show information about the current configuration, including viewing and
6465 editing of actions files:
6469 <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
6476 Show the source code version numbers:
6480 <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
6487 Show the browser's request headers:
6491 <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
6498 Show which actions apply to a URL and why:
6502 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
6509 Toggle Privoxy on or off. In this case, <quote>Privoxy</quote> continues
6510 to run, but only as a pass-through proxy, with no actions taking place:
6514 <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
6518 Short cuts. Turn off, then on:
6522 <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
6527 <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
6536 These may be bookmarked for quick reference. See next.
6540 <sect3 id="bookmarklets">
6541 <title>Bookmarklets</title>
6543 Below are some <quote>bookmarklets</quote> to allow you to easily access a
6544 <quote>mini</quote> version of some of <application>Privoxy's</application>
6545 special pages. They are designed for MS Internet Explorer, but should work
6546 equally well in Netscape, Mozilla, and other browsers which support
6547 JavaScript. They are designed to run directly from your bookmarks - not by
6548 clicking the links below (although that should work for testing).
6551 To save them, right-click the link and choose <quote>Add to Favorites</quote>
6552 (IE) or <quote>Add Bookmark</quote> (Netscape). You will get a warning that
6553 the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
6554 Bookmarklet directly from your favorites/bookmarks. For even faster access,
6555 you can put them on the <quote>Links</quote> bar (IE) or the <quote>Personal
6556 Toolbar</quote> (Netscape), and run them with a single click.
6565 url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=enabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Enable</ulink>
6572 url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=disabled','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Disable</ulink>
6579 url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y&set=toggle','ijbstatus','width=250,height=100,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Toggle Privoxy</ulink> (Toggles between enabled and disabled)
6586 url="javascript:void(window.open('http://config.privoxy.org/toggle?mini=y','ijbstatus','width=250,height=2,resizable=yes,scrollbars=no,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy- View Status</ulink>
6592 <ulink url="javascript:w=Math.floor(screen.width/2);h=Math.floor(screen.height*0.9);void(window.open('http://www.privoxy.org/actions/index.php?url='+escape(location.href),'Feedback','screenx='+w+',width='+w+',height='+h+',scrollbars=yes,toolbar=no,location=no,directories=no,status=no,menubar=no,copyhistory=no').focus());">Privoxy - Submit Actions File Feedback</ulink>
6600 Credit: The site which gave us the general idea for these bookmarklets is
6601 <ulink url="http://www.bookmarklets.com">www.bookmarklets.com</ulink>. They
6602 have more information about bookmarklets.
6611 <!-- ~~~~~ New section ~~~~~ -->
6613 <title>Chain of Events</title>
6615 Let's take a quick look at the basic sequence of events when a web page is
6616 requested by your browser and <application>Privoxy</application> is on duty:
6623 First, your web browser requests a web page. The browser knows to send
6624 the request to <application>Privoxy</application>, which will in turn,
6625 relay the request to the remote web server after passing the following
6631 <application>Privoxy</application> traps any request for its own internal CGI
6632 pages (e.g http://p.p/) and sends the CGI page back to the browser.
6637 Next, <application>Privoxy</application> checks to see if the URL
6639 linkend="BLOCK"><quote>+block</quote></link> patterns. If
6640 so, the URL is then blocked, and the remote web server will not be contacted.
6641 <link linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>
6642 is then checked and if it does not match, an
6643 HTML <quote>BLOCKED</quote> page is sent back. Otherwise, if it does match,
6644 an image is returned. The type of image depends on the setting of <link
6645 linkend="SET-IMAGE-BLOCKER"><quote>+set-image-blocker</quote></link>
6646 (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere).
6651 Untrusted URLs are blocked. If URLs are being added to the
6652 <filename>trust</filename> file, then that is done.
6657 If the URL pattern matches the <link
6658 linkend="FAST-REDIRECTS"><quote>+fast-redirects</quote></link> action,
6659 it is then processed. Unwanted parts of the requested URL are stripped.
6664 Now the rest of the client browser's request headers are processed. If any
6665 of these match any of the relevant actions (e.g. <link
6666 linkend="HIDE-USER-AGENT"><quote>+hide-user-agent</quote></link>,
6667 etc.), headers are suppressed or forged as determined by these actions and
6673 Now the web server starts sending its response back (i.e. typically a web page and related
6679 First, the server headers are read and processed to determine, among other
6680 things, the MIME type (document type) and encoding. The headers are then
6681 filtered as deterimed by the
6682 <link linkend="CRUNCH-INCOMING-COOKIES"><quote>+crunch-incoming-cookies</quote></link>,
6683 <link linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>,
6684 and <link linkend="DOWNGRADE-HTTP-VERSION"><quote>+downgrade-http-version</quote></link>
6690 If the <link linkend="KILL-POPUPS"><quote>+kill-popups</quote></link>
6691 action applies, and it is an HTML or JavaScript document, the popup-code in the
6692 response is filtered on-the-fly as it is received.
6697 If a <link linkend="FILTER"><quote>+filter</quote></link>
6699 linkend="DEANIMATE-GIFS"><quote>+deanimate-gifs</quote></link>
6700 action applies (and the document type fits the action), the rest of the page is
6701 read into memory (up to a configurable limit). Then the filter rules (from
6702 <filename>default.filter</filename>) are processed against the buffered
6703 content. Filters are applied in the order they are specified in the
6704 <filename>default.filter</filename> file. Animated GIFs, if present, are
6705 reduced to either the first or last frame, depending on the action
6706 setting.The entire page, which is now filtered, is then sent by
6707 <application>Privoxy</application> back to your browser.
6710 If neither <link linkend="FILTER"><quote>+filter</quote></link>
6712 linkend="DEANIMATE-GIFS"><quote>+deanimate-gifs</quote></link>
6713 matches, then <application>Privoxy</application> passes the raw data through
6714 to the client browser as it becomes available.
6719 As the browser receives the now (probably filtered) page content, it
6720 reads and then requests any URLs that may be embedded within the page
6721 source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
6722 frames), sounds, etc. For each of these objects, the browser issues a new
6723 request. And each such request is in turn processed as above. Note that a
6724 complex web page may have many such embedded URLs.
6734 <!-- ~~~~~ New section ~~~~~ -->
6735 <sect2 id="actionsanat">
6736 <title>Anatomy of an Action</title>
6739 The way <application>Privoxy</application> applies
6740 <link linkend="ACTIONS">actions</link> and <link linkend="FILTER">filters</link>
6741 to any given URL can be complex, and not always so
6742 easy to understand what is happening. And sometimes we need to be able to
6743 <emphasis>see</emphasis> just what <application>Privoxy</application> is
6744 doing. Especially, if something <application>Privoxy</application> is doing
6745 is causing us a problem inadvertently. It can be a little daunting to look at
6746 the actions and filters files themselves, since they tend to be filled with
6747 <link linkend="regex">regular expressions</link> whose consequences are not
6752 One quick test to see if <application>Privoxy</application> is causing a problem
6753 or not, is to disable it temporarily. This should be the first troubleshooting
6754 step. See <link linkend="bookmarklets">the Bookmarklets</link> section on a quick
6755 and easy way to do this (be sure to flush caches afterward!).
6759 <application>Privoxy</application> also provides the
6760 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
6761 page that can show us very specifically how <application>actions</application>
6762 are being applied to any given URL. This is a big help for troubleshooting.
6766 First, enter one URL (or partial URL) at the prompt, and then
6767 <application>Privoxy</application> will tell us
6768 how the current configuration will handle it. This will not
6769 help with filtering effects (i.e. the <link
6770 linkend="FILTER"><quote>+filter</quote></link> action) from
6771 the <filename>default.filter</filename> file since this is handled very
6772 differently and not so easy to trap! It also will not tell you about any other
6773 URLs that may be embedded within the URL you are testing. For instance, images
6774 such as ads are expressed as URLs within the raw page source of HTML pages. So
6775 you will only get info for the actual URL that is pasted into the prompt area
6776 -- not any sub-URLs. If you want to know about embedded URLs like ads, you
6777 will have to dig those out of the HTML source. Use your browser's <quote>View
6778 Page Source</quote> option for this. Or right click on the ad, and grab the
6783 Let's try an example, <ulink url="http://google.com">google.com</ulink>,
6784 and look at it one section at a time:
6789 Matches for http://google.com:
6791 In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
6795 -crunch-outgoing-cookies
6796 -crunch-incoming-cookies
6797 +deanimate-gifs{last}
6798 -downgrade-http-version
6802 -filter{shockwave-flash}
6803 -filter{crude-parental}
6804 +filter{html-annoyances}
6805 +filter{js-annoyances}
6806 +filter{content-cookies}
6808 +filter{refresh-tags}
6810 +filter{banners-by-size}
6811 +hide-forwarded-for-headers
6812 +hide-from-header{block}
6813 +hide-referer{forge}
6818 +prevent-compression
6821 +session-cookies-only
6822 +set-image-blocker{pattern} }
6825 { -session-cookies-only }
6831 In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
6832 (no matches in this file)
6837 This tells us how we have defined our
6838 <link linkend="ACTIONS"><quote>actions</quote></link>, and
6839 which ones match for our example, <quote>google.com</quote>. The first listing
6840 is any matches for the <filename>standard.action</filename> file. No hits at
6841 all here on <quote>standard</quote>. Then next is <quote>default</quote>, or
6842 our <filename>default.action</filename> file. The large, multi-line listing,
6843 is how the actions are set to match for all URLs, i.e. our default settings.
6844 If you look at your <quote>actions</quote> file, this would be the section
6845 just below the <quote>aliases</quote> section near the top. This will apply to
6846 all URLs as signified by the single forward slash at the end of the listing
6847 -- <quote>/</quote>.
6851 But we can define additional actions that would be exceptions to these general
6852 rules, and then list specific URLs (or patterns) that these exceptions would
6853 apply to. Last match wins. Just below this then are two explicit matches for
6854 <quote>.google.com</quote>. The first is negating our previous cookie setting,
6856 linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>
6857 (i.e. not persistent). So we will allow persistent cookies for google. The
6858 second turns <emphasis>off</emphasis> any
6860 linkend="FAST-REDIRECTS"><quote>+fast-redirects</quote></link>
6861 action, allowing this to take place unmolested. Note that there is a leading
6862 dot here -- <quote>.google.com</quote>. This will match any hosts and
6863 sub-domains, in the google.com domain also, such as
6864 <quote>www.google.com</quote>. So, apparently, we have these two actions
6865 defined somewhere in the lower part of our <filename>default.action</filename>
6866 file, and <quote>google.com</quote> is referenced somewhere in these latter
6871 Then, for our <filename>user.action</filename> file, we again have no hits.
6875 And finally we pull it all together in the bottom section and summarize how
6876 <application>Privoxy</application> is applying all its <quote>actions</quote>
6877 to <quote>google.com</quote>:
6888 -crunch-outgoing-cookies
6889 -crunch-incoming-cookies
6890 +deanimate-gifs{last}
6891 -downgrade-http-version
6895 -filter{shockwave-flash}
6896 -filter{crude-parental}
6897 +filter{html-annoyances}
6898 +filter{js-annoyances}
6899 +filter{content-cookies}
6901 +filter{refresh-tags}
6903 +filter{banners-by-size}
6904 +hide-forwarded-for-headers
6905 +hide-from-header{block}
6906 +hide-referer{forge}
6911 +prevent-compression
6914 -session-cookies-only
6915 +set-image-blocker{pattern}
6920 Notice the only difference here to the previous listing, is to
6921 <quote>fast-redirects</quote> and <quote>session-cookies-only</quote>.
6925 Now another example, <quote>ad.doubleclick.net</quote>:
6931 { +block +handle-as-image }
6934 { +block +handle-as-image }
6937 { +block +handle-as-image }
6943 We'll just show the interesting part here, the explicit matches. It is
6944 matched three different times. Each as an <quote>+block +handle-as-image</quote>,
6945 which is the expanded form of one of our aliases that had been defined as:
6946 <quote>+imageblock</quote>. (<link
6947 linkend="ALIASES"><quote>Aliases</quote></link> are defined in
6948 the first section of the actions file and typically used to combine more
6953 Any one of these would have done the trick and blocked this as an unwanted
6954 image. This is unnecessarily redundant since the last case effectively
6955 would also cover the first. No point in taking chances with these guys
6956 though ;-) Note that if you want an ad or obnoxious
6957 URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
6958 is done here -- as both a <link
6959 linkend="BLOCK"><quote>+block</quote></link>
6960 <emphasis>and</emphasis> an
6962 linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>.
6963 The custom alias <quote>+imageblock</quote> just simplifies the process and make
6968 One last example. Let's try <quote>http://www.rhapsodyk.net/adsl/HOWTO/</quote>.
6969 This one is giving us problems. We are getting a blank page. Hmmm...
6975 Matches for http://www.rhapsodyk.net/adsl/HOWTO/:
6977 In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
6981 -crunch-incoming-cookies
6982 -crunch-outgoing-cookies
6984 -downgrade-http-version
6986 +filter{html-annoyances}
6987 +filter{js-annoyances}
6988 +filter{kill-popups}
6991 +filter{banners-by-size}
6994 +hide-forwarded-for-headers
6995 +hide-from-header{block}
6996 +hide-referer{forge}
7000 +prevent-compression
7003 +session-cookies-only
7004 +set-image-blocker{blank} }
7007 { +block +handle-as-image }
7013 Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote>! But
7014 we did not want this at all! Now we see why we get the blank page. We could
7015 now add a new action below this that explicitly does <emphasis>not</emphasis>
7016 block (<quote>{-block}</quote>) paths with <quote>adsl</quote>. There are
7017 various ways to handle such exceptions. Example:
7029 Now the page displays ;-) Be sure to flush your browser's caches when
7030 making such changes. Or, try using <literal>Shift+Reload</literal>.
7034 But now what about a situation where we get no explicit matches like
7041 { +block +handle-as-image }
7047 That actually was very telling and pointed us quickly to where the problem
7048 was. If you don't get this kind of match, then it means one of the default
7049 rules in the first section is causing the problem. This would require some
7050 guesswork, and maybe a little trial and error to isolate the offending rule.
7051 One likely cause would be one of the <quote>{+filter}</quote> actions. Try
7052 adding the URL for the site to one of aliases that turn off <quote>+filter</quote>:
7060 .worldpay.com # for quietpc.com
7068 <quote>{shop}</quote> is an <quote>alias</quote> that expands to
7069 <quote>{ -filter -session-cookies-only }</quote>.
7070 Or you could do your own exception to negate filtering:
7083 This would probably be most appropriately put in <filename>user.action</filename>,
7084 for local site exceptions.
7088 <quote>{fragile}</quote> is an alias that disables most actions. This can be
7089 used as a last resort for problem sites. Remember to flush caches! If this
7090 still does not work, you will have to go through the remaining actions one by
7091 one to find which one(s) is causing the problem.
7100 This program is free software; you can redistribute it
7101 and/or modify it under the terms of the GNU General
7102 Public License as published by the Free Software
7103 Foundation; either version 2 of the License, or (at
7104 your option) any later version.
7106 This program is distributed in the hope that it will
7107 be useful, but WITHOUT ANY WARRANTY; without even the
7108 implied warranty of MERCHANTABILITY or FITNESS FOR A
7109 PARTICULAR PURPOSE. See the GNU General Public
7110 License for more details.
7112 The GNU General Public License should be included with
7113 this file. If not, you can view it at
7114 http://www.gnu.org/copyleft/gpl.html
7115 or write to the Free Software Foundation, Inc., 59
7116 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
7118 $Log: user-manual.sgml,v $
7119 Revision 1.118 2002/05/21 04:54:55 hal9
7120 -New Section: Quickstart to Ad Blocking
7121 -Reformat Actions Anatomy to match new CGI layout
7123 Revision 1.117 2002/05/17 13:56:16 oes
7124 - Reworked & extended Templates chapter
7125 - Small changes to Regex appendix
7126 - #included authors.sgml into (C) and hist chapter
7128 Revision 1.116 2002/05/17 03:23:46 hal9
7129 Fixing merge conflict in Quickstart section.
7131 Revision 1.115 2002/05/16 16:25:00 oes
7132 Extended the Filter File chapter & minor fixes
7134 Revision 1.114 2002/05/16 09:42:50 oes
7135 More ulink->link, added some hints to Quickstart section
7137 Revision 1.113 2002/05/15 21:07:25 oes
7138 Extended and further commented the example actions files
7140 Revision 1.112 2002/05/15 03:57:14 hal9
7141 Spell check. A few minor edits here and there for better syntax and
7144 Revision 1.111 2002/05/14 23:01:36 oes
7147 Revision 1.110 2002/05/14 19:10:45 oes
7148 Restored alphabetical order of actions
7150 Revision 1.109 2002/05/14 17:23:11 oes
7151 Renamed the prevent-*-cookies actions, extended aliases section and moved it before the example AFs
7153 Revision 1.108 2002/05/14 15:29:12 oes
7154 Completed proofreading the actions chapter
7156 Revision 1.107 2002/05/12 03:20:41 hal9
7157 Small clarifications for 127.0.0.1 vs localhost for listen-address since this
7158 apparently an important distinction for some OS's.
7160 Revision 1.106 2002/05/10 01:48:20 hal9
7161 This is mostly proposed copyright/licensing additions and changes. Docs
7162 are still GPL, but licensing and copyright are more visible. Also, copyright
7163 changed in doc header comments (eliminate references to JB except FAQ).
7165 Revision 1.105 2002/05/05 20:26:02 hal9
7166 Sorting out license vs copyright in these docs.
7168 Revision 1.104 2002/05/04 08:44:45 swa
7171 Revision 1.103 2002/05/04 00:40:53 hal9
7172 -Remove the TOC first page kludge. It's fixed proper now in ldp.dsl.in.
7173 -Some minor additions to Quickstart.
7175 Revision 1.102 2002/05/03 17:46:00 oes
7176 Further proofread & reactivated short build instructions
7178 Revision 1.101 2002/05/03 03:58:30 hal9
7179 Move the user-manual config directive to top of section. Add note about
7180 Privoxy needing read permissions for configs, and write for logs.
7182 Revision 1.100 2002/04/29 03:05:55 hal9
7183 Add clarification on differences of new actions files.
7185 Revision 1.99 2002/04/28 16:59:05 swa
7186 more structure in starting section
7188 Revision 1.98 2002/04/28 05:43:59 hal9
7189 This is the break up of configuration.html into multiple files. This
7190 will probably break links elsewhere :(
7192 Revision 1.97 2002/04/27 21:04:42 hal9
7193 -Rewrite of Actions File example.
7194 -Add section for user-manual directive in config.
7196 Revision 1.96 2002/04/27 05:32:00 hal9
7197 -Add short section to Filter Files to tie in with +filter action.
7198 -Start rewrite of examples in Actions Examples (not finished).
7200 Revision 1.95 2002/04/26 17:23:29 swa
7201 bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
7203 Revision 1.94 2002/04/26 05:24:36 hal9
7204 -Add most of Andreas suggestions to Chain of Events section.
7205 -A few other minor corrections and touch up.
7207 Revision 1.92 2002/04/25 18:55:13 hal9
7208 More catchups on new actions files, and new actions names.
7209 Other assorted cleanups, and minor modifications.
7211 Revision 1.91 2002/04/24 02:39:31 hal9
7212 Add 'Chain of Events' section.
7214 Revision 1.90 2002/04/23 21:41:25 hal9
7215 Linuxconf is deprecated on RH, substitute chkconfig.
7217 Revision 1.89 2002/04/23 21:05:28 oes
7218 Added hint for startup on Red Hat
7220 Revision 1.88 2002/04/23 05:37:54 hal9
7221 Add AmigaOS install stuff.
7223 Revision 1.87 2002/04/23 02:53:15 david__schmidt
7224 Updated OSX installation section
7225 Added a few English tweaks here an there
7227 Revision 1.86 2002/04/21 01:46:32 hal9
7228 Re-write actions section.
7230 Revision 1.85 2002/04/18 21:23:23 hal9
7231 Fix ugly typo (mine).
7233 Revision 1.84 2002/04/18 21:17:13 hal9
7234 Spell Redhat correctly (ie Red Hat). A few minor grammar corrections.
7236 Revision 1.83 2002/04/18 18:21:12 oes
7237 Added RPM install detail
7239 Revision 1.82 2002/04/18 12:04:50 oes
7242 Revision 1.81 2002/04/18 11:50:24 oes
7243 Extended Install section - needs fixing by packagers
7245 Revision 1.80 2002/04/18 10:45:19 oes
7246 Moved text to buildsource.sgml, renamed some filters, details
7248 Revision 1.79 2002/04/18 03:18:06 hal9
7249 Spellcheck, and minor touchups.
7251 Revision 1.78 2002/04/17 18:04:16 oes
7254 Revision 1.77 2002/04/17 13:51:23 oes
7255 Proofreading, part one
7257 Revision 1.76 2002/04/16 04:25:51 hal9
7258 -Added 'Note to Upgraders' and re-ordered the 'Quickstart' section.
7259 -Note about proxy may need requests to re-read config files.
7261 Revision 1.75 2002/04/12 02:08:48 david__schmidt
7262 Remove OS/2 building info... it is already in the developer-manual
7264 Revision 1.74 2002/04/11 00:54:38 hal9
7265 Add small section on submitting actions.
7267 Revision 1.73 2002/04/10 18:45:15 swa
7270 Revision 1.72 2002/04/10 04:06:19 hal9
7271 Added actions feedback to Bookmarklets section
7273 Revision 1.71 2002/04/08 22:59:26 hal9
7274 Version update. Spell chkconfig correctly :)
7276 Revision 1.70 2002/04/08 20:53:56 swa
7279 Revision 1.69 2002/04/06 05:07:29 hal9
7280 -Add privoxy-man-page.sgml, for man page.
7281 -Add authors.sgml for AUTHORS (and p-authors.sgml)
7282 -Reworked various aspects of various docs.
7283 -Added additional comments to sub-docs.
7285 Revision 1.68 2002/04/04 18:46:47 swa
7286 consistent look. reuse of copyright, history et. al.
7288 Revision 1.67 2002/04/04 17:27:57 swa
7289 more single file to be included at multiple points. make maintaining easier
7291 Revision 1.66 2002/04/04 06:48:37 hal9
7292 Structural changes to allow for conditional inclusion/exclusion of content
7293 based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
7294 definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
7295 eventually be set by Makefile.
7296 More boilerplate text for use across multiple docs.
7298 Revision 1.65 2002/04/03 19:52:07 swa
7299 enhance squid section due to user suggestion
7301 Revision 1.64 2002/04/03 03:53:43 hal9
7302 A few minor bug fixes, and touch ups. Ready for review.
7304 Revision 1.63 2002/04/01 16:24:49 hal9
7305 Define entities to include boilerplate text. See doc/source/*.
7307 Revision 1.62 2002/03/30 04:15:53 hal9
7308 - Fix privoxy.org/config links.
7309 - Paste in Bookmarklets from Toggle page.
7310 - Move Quickstart nearer top, and minor rework.
7312 Revision 1.61 2002/03/29 01:31:08 hal9
7315 Revision 1.60 2002/03/27 01:57:34 hal9
7316 Added more to Anatomy section.
7318 Revision 1.59 2002/03/27 00:54:33 hal9
7319 Touch up intro for new name.
7321 Revision 1.58 2002/03/26 22:29:55 swa
7322 we have a new homepage!
7324 Revision 1.57 2002/03/24 20:33:30 hal9
7325 A few minor catch ups with name change.
7327 Revision 1.56 2002/03/24 16:17:06 swa
7328 configure needs to be generated.
7330 Revision 1.55 2002/03/24 16:08:08 swa
7331 we are too lazy to make a block-built
7332 privoxy logo. hence removed the option.
7334 Revision 1.54 2002/03/24 15:46:20 swa
7335 name change related issue.
7337 Revision 1.53 2002/03/24 11:51:00 swa
7338 name change. changed filenames.
7340 Revision 1.52 2002/03/24 11:01:06 swa
7343 Revision 1.51 2002/03/23 15:13:11 swa
7344 renamed every reference to the old name with foobar.
7345 fixed "application foobar application" tag, fixed
7346 "the foobar" with "foobar". left junkbustser in cvs
7347 comments and remarks to history untouched.
7349 Revision 1.50 2002/03/23 05:06:21 hal9
7352 Revision 1.49 2002/03/21 17:01:05 hal9
7353 New section in Appendix.
7355 Revision 1.48 2002/03/12 06:33:01 hal9
7356 Catching up to Andreas and re_filterfile changes.
7358 Revision 1.47 2002/03/11 13:13:27 swa
7359 correct feedback channels
7361 Revision 1.46 2002/03/10 00:51:08 hal9
7362 Added section on JB internal pages in Appendix.
7364 Revision 1.45 2002/03/09 17:43:53 swa
7367 Revision 1.44 2002/03/09 17:08:48 hal9
7368 New section on Jon's actions file editor, and move some stuff around.
7370 Revision 1.43 2002/03/08 00:47:32 hal9
7371 Added imageblock{pattern}.
7373 Revision 1.42 2002/03/07 18:16:55 swa
7376 Revision 1.41 2002/03/07 16:46:43 hal9
7377 Fix a few markup problems for jade.
7379 Revision 1.40 2002/03/07 16:28:39 swa
7380 provide correct feedback channels
7382 Revision 1.39 2002/03/06 16:19:28 hal9
7383 Note on perceived filtering slowdown per FR.
7385 Revision 1.38 2002/03/05 23:55:14 hal9
7386 Stupid I did it again. Double hyphen in comment breaks jade.
7388 Revision 1.37 2002/03/05 23:53:49 hal9
7389 jade barfs on '- -' embedded in comments. - -user option broke it.
7391 Revision 1.36 2002/03/05 22:53:28 hal9
7392 Add new - - user option.
7394 Revision 1.35 2002/03/05 00:17:27 hal9
7395 Added section on command line options.
7397 Revision 1.34 2002/03/04 19:32:07 oes
7398 Changed default port to 8118
7400 Revision 1.33 2002/03/03 19:46:13 hal9
7401 Emphasis on where/how to report bugs, etc
7403 Revision 1.32 2002/03/03 09:26:06 joergs
7404 AmigaOS changes, config is now loaded from PROGDIR: instead of
7405 AmiTCP:db/junkbuster/ if no configuration file is specified on the
7408 Revision 1.31 2002/03/02 22:45:52 david__schmidt
7411 Revision 1.30 2002/03/02 22:00:14 hal9
7412 Updated 'New Features' list. Ran through spell-checker.
7414 Revision 1.29 2002/03/02 20:34:07 david__schmidt
7415 Update OS/2 build section
7417 Revision 1.28 2002/02/24 14:34:24 jongfoster
7418 Formatting changes. Now changing the doctype to DocBook XML 4.1
7419 will work - no other changes are needed.
7421 Revision 1.27 2002/01/11 14:14:32 hal9
7422 Added a very short section on Templates
7424 Revision 1.26 2002/01/09 20:02:50 hal9
7425 Fix bug re: auto-detect config file changes.
7427 Revision 1.25 2002/01/09 18:20:30 hal9
7428 Touch ups for *.action files.
7430 Revision 1.24 2001/12/02 01:13:42 hal9
7433 Revision 1.23 2001/12/02 00:20:41 hal9
7434 Updates for recent changes.
7436 Revision 1.22 2001/11/05 23:57:51 hal9
7437 Minor update for startup now daemon mode.
7439 Revision 1.21 2001/10/31 21:11:03 hal9
7440 Correct 2 minor errors
7442 Revision 1.18 2001/10/24 18:45:26 hal9
7443 *** empty log message ***
7445 Revision 1.17 2001/10/24 17:10:55 hal9
7446 Catching up with Jon's recent work, and a few other things.
7448 Revision 1.16 2001/10/21 17:19:21 swa
7449 wrong url in documentation
7451 Revision 1.15 2001/10/14 23:46:24 hal9
7452 Various minor changes. Fleshed out SEE ALSO section.
7454 Revision 1.13 2001/10/10 17:28:33 hal9
7457 Revision 1.12 2001/09/28 02:57:04 hal9
7460 Revision 1.11 2001/09/28 02:25:20 hal9
7463 Revision 1.9 2001/09/27 23:50:29 hal9
7464 A few changes. A short section on regular expression in appendix.
7466 Revision 1.8 2001/09/25 00:34:59 hal9
7467 Some additions, and re-arranging.
7469 Revision 1.7 2001/09/24 14:31:36 hal9
7472 Revision 1.6 2001/09/24 14:10:32 hal9
7473 Including David's OS/2 installation instructions.
7475 Revision 1.2 2001/09/13 15:27:40 swa
7478 Revision 1.1 2001/09/12 15:36:41 swa
7479 source files for junkbuster documentation
7481 Revision 1.3 2001/09/10 17:43:59 swa
7482 first proposal of a structure.
7484 Revision 1.2 2001/06/13 14:28:31 swa
7485 docs should have an author.
7487 Revision 1.1 2001/06/13 14:20:37 swa
7488 first import of project's documentation for the webserver.
projects / privoxy.git / blob