1 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
2 <!entity % dummy "IGNORE">
3 <!entity supported SYSTEM "supported.sgml">
4 <!entity newfeatures SYSTEM "newfeatures.sgml">
5 <!entity p-intro SYSTEM "privoxy.sgml">
6 <!entity seealso SYSTEM "seealso.sgml">
7 <!entity buildsource SYSTEM "buildsource.sgml">
8 <!entity contacting SYSTEM "contacting.sgml">
9 <!entity history SYSTEM "history.sgml">
10 <!entity copyright SYSTEM "copyright.sgml">
11 <!entity license SYSTEM "license.sgml">
12 <!entity p-authors SYSTEM "p-authors.sgml">
13 <!entity config SYSTEM "p-config.sgml">
14 <!entity p-version "3.0.9">
15 <!entity p-status "UNRELEASED">
16 <!entity % p-authors-formal "INCLUDE"> <!-- include additional text, etc -->
17 <!entity % p-not-stable "INCLUDE">
18 <!entity % p-stable "IGNORE">
19 <!entity % p-text "IGNORE"> <!-- define we are not a text only doc -->
20 <!entity % p-doc "INCLUDE"> <!-- and we are a formal doc -->
21 <!entity % p-readme "IGNORE">
22 <!entity % user-man "IGNORE">
23 <!entity % config-file "IGNORE">
24 <!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml -->
25 <!entity my-copy "©"> <!-- kludge for docbook2man -->
26 <!entity % draft "IGNORE"> <!-- WIP stuff -->
27 <!entity my-app "<application>Privoxy</application>">
30 File : $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
33 This file belongs into
34 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
36 $Id: user-manual.sgml,v 2.69 2008/03/29 12:14:25 fabiankeil Exp $
38 Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
41 ========================================================================
42 NOTE: Please read developer-manual/documentation.html before touching
43 anything in this, or other Privoxy documentation.
44 ========================================================================
51 <title>Privoxy &p-version; User Manual</title>
55 <!-- Completely the wrong markup, but very little is allowed -->
56 <!-- in this part of an article. FIXME -->
57 <link linkend="copyright">Copyright</link> &my-copy; 2001 - 2008 by
58 <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
62 <pubdate>$Id: user-manual.sgml,v 2.69 2008/03/29 12:14:25 fabiankeil Exp $</pubdate>
66 Note: the following should generate a separate page, and a live link to it,
67 all nicely done. But it doesn't for some mysterious reason. Please leave
68 commented unless it can be fixed proper. For the time being, the
69 copyright/license declarations will be in their own sgml.
82 This is here to keep vim syntax file from breaking :/
83 If I knew enough to fix it, I would.
84 PLEASE DO NOT REMOVE! HB: hal@foobox.net
90 The <citetitle>Privoxy User Manual</citetitle> gives users information on how to
91 install, configure and use <ulink
92 url="http://www.privoxy.org/">Privoxy</ulink>.
95 <!-- Include privoxy.sgml boilerplate: -->
97 <!-- end privoxy.sgml -->
100 You can find the latest version of the <citetitle>Privoxy User Manual</citetitle> at <ulink
101 url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
102 Please see the <link linkend="contact">Contact section</link> on how to
103 contact the developers.
107 <!-- Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
113 <!-- ~~~~~ New section ~~~~~ -->
114 <sect1 label="1" id="introduction"><title>Introduction</title>
116 This documentation is included with the current &p-status; version of
117 <application>Privoxy</application>, v.&p-version;<![%p-not-stable;[,
118 and is mostly complete at this point. The most up to date reference for the
119 time being is still the comments in the source files and in the individual
120 configuration files. Development of a new version is currently nearing
121 completion, and includes significant changes and enhancements over
122 earlier versions. ]]>.
125 <!-- include only in non-stable versions -->
128 Since this is a &p-status; version, not all new features are well tested. This
129 documentation may be slightly out of sync as a result (especially with
130 CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
135 <!-- ~~~~~ New section ~~~~~ -->
136 <sect2 id="features"><title>Features</title>
138 In addition to the core
139 features of ad blocking and
140 <ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookie</ulink> management,
141 <application>Privoxy</application> provides many supplemental
142 features<![%p-not-stable;[, some of them currently under development]]>,
143 that give the end-user more control, more privacy and more freedom:
145 <!-- Include newfeatures.sgml boilerplate here: -->
147 <!-- end boilerplate -->
152 <!-- ~ End section ~ -->
155 <!-- ~~~~~ New section ~~~~~ -->
156 <sect1 id="installation"><title>Installation</title>
159 <application>Privoxy</application> is available both in convenient pre-compiled
160 packages for a wide range of operating systems, and as raw source code.
161 For most users, we recommend using the packages, which can be downloaded from our
162 <ulink url="http://sourceforge.net/projects/ijbswa/">Privoxy Project
168 On some platforms, the installer may remove previously installed versions, if
169 found. (See below for your platform). In any case <emphasis>be sure to backup
170 your old configuration if it is valuable to you.</emphasis> See the <link
171 linkend="upgradersnote">note to upgraders</link> section below.
174 <!-- ~~~~~ New section ~~~~~ -->
175 <sect2 id="installation-packages"><title>Binary Packages</title>
177 How to install the binary packages depends on your operating system:
180 <!-- XXX: The installation sections should be sorted -->
182 <!-- ~~~~~ New section ~~~~~ -->
183 <sect3 id="installation-pack-rpm"><title>Red Hat and Fedora RPMs</title>
186 RPMs can be installed with <literal>rpm -Uvh privoxy-&p-version;-1.rpm</literal>,
187 and will use <filename>/etc/privoxy</filename> for the location
188 of configuration files.
192 Note that on Red Hat, <application>Privoxy</application> will
193 <emphasis>not</emphasis> be automatically started on system boot. You will
194 need to enable that using <command>chkconfig</command>,
195 <command>ntsysv</command>, or similar methods.
199 If you have problems with failed dependencies, try rebuilding the SRC RPM:
200 <literal>rpm --rebuild privoxy-&p-version;-1.src.rpm</literal>. This
201 will use your locally installed libraries and RPM version.
205 Also note that if you have a <application>Junkbuster</application> RPM installed
206 on your system, you need to remove it first, because the packages conflict.
207 Otherwise, RPM will try to remove <application>Junkbuster</application>
208 automatically if found, before installing <application>Privoxy</application>.
212 <!-- ~~~~~ New section ~~~~~ -->
213 <sect3 id="installation-deb"><title>Debian and Ubuntu</title>
215 DEBs can be installed with <literal>apt-get install privoxy</literal>,
216 and will use <filename>/etc/privoxy</filename> for the location of
221 <!-- ~~~~~ New section ~~~~~ -->
222 <sect3 id="installation-pack-win"><title>Windows</title>
225 Just double-click the installer, which will guide you through
226 the installation process. You will find the configuration files
227 in the same directory as you installed <application>Privoxy</application> in.
230 Version 3.0.5 beta introduced full <application>Windows</application> service
231 functionality. On Windows only, the <application>Privoxy</application>
232 program has two new command line arguments to install and uninstall
233 <application>Privoxy</application> as a <emphasis>service</emphasis>.
237 <term>Arguments:</term>
240 <replaceable class="parameter">--install</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
243 <replaceable class="parameter">--uninstall</replaceable>[:<replaceable class="parameter">service_name</replaceable>]
249 After invoking <application>Privoxy</application> with
250 <command>--install</command>, you will need to bring up the
251 <application>Windows</application> service console to assign the user you
252 want <application>Privoxy</application> to run under, and whether or not you
253 want it to run whenever the system starts. You can start the
254 <application>Windows</application> services console with the following
255 command: <command>services.msc</command>. If you do not take the manual step
256 of modifying <application>Privoxy's</application> service settings, it will
257 not start. Note too that you will need to give Privoxy a user account that
258 actually exists, or it will not be permitted to
259 write to its log and configuration files.
264 <!-- ~~~~~ New section ~~~~~ -->
265 <sect3 id="installation-pack-bintgz"><title>Solaris <!--, NetBSD, HP-UX--></title>
268 Create a new directory, <literal>cd</literal> to it, then unzip and
269 untar the archive. For the most part, you'll have to figure out where
270 things go. <!-- FIXME, more info needed? -->
274 <!-- ~~~~~ New section ~~~~~ -->
275 <sect3 id="installation-os2"><title>OS/2</title>
278 First, make sure that no previous installations of
279 <application>Junkbuster</application> and / or
280 <application>Privoxy</application> are left on your
281 system. Check that no <application>Junkbuster</application>
282 or <application>Privoxy</application> objects are in
288 Then, just double-click the WarpIN self-installing archive, which will
289 guide you through the installation process. A shadow of the
290 <application>Privoxy</application> executable will be placed in your
291 startup folder so it will start automatically whenever OS/2 starts.
295 The directory you choose to install <application>Privoxy</application>
296 into will contain all of the configuration files.
300 <!-- ~~~~~ New section ~~~~~ -->
301 <sect3 id="installation-mac"><title>Mac OS X</title>
303 Unzip the downloaded file (you can either double-click on the zip file
304 icon from the Finder, or from the desktop if you downloaded it there).
305 Then, double-click on the package installer icon and follow the
306 installation process.
309 The privoxy service will automatically start after a successful
310 installation (in addition to every time your computer starts up). To
311 prevent the privoxy service from automatically starting when your
312 computer starts up, remove or rename the folder named
313 <literal>/Library/StartupItems/Privoxy</literal>.
316 To manually start or stop the privoxy service, use the Privoxy Utility
317 for Mac OS X. This application controls the privoxy service (e.g.
318 starting and stopping the service as well as uninstalling the software).
322 <!-- ~~~~~ New section ~~~~~ -->
323 <sect3 id="installation-amiga"><title>AmigaOS</title>
325 Copy and then unpack the <filename>lha</filename> archive to a suitable location.
326 All necessary files will be installed into <application>Privoxy</application>
327 directory, including all configuration and log files. To uninstall, just
328 remove this directory.
332 <!-- ~~~~~ New section ~~~~~ -->
333 <sect3 id="installation-tbz"><title>FreeBSD</title>
336 Privoxy is part of FreeBSD's Ports Collection, you can build and install
337 it with <literal>cd /usr/ports/www/privoxy; make install clean</literal>.
340 If you don't use the ports, you can fetch and install
341 the package with <literal>pkg_add -r privoxy</literal>.
344 The port skeleton and the package can also be downloaded from the
345 <ulink url="https://sourceforge.net/project/showfiles.php?group_id=11118">File Release
346 Page</ulink>, but there's no reason to use them unless you're interested in the
347 beta releases which are only available there.
351 <!-- ~~~~~ New section ~~~~~ -->
352 <sect3 id="installattion-gentoo"><title>Gentoo</title>
354 Gentoo source packages (Ebuilds) for <application>Privoxy</application> are
355 contained in the Gentoo Portage Tree (they are not on the download page,
356 but there is a Gentoo section, where you can see when a new
357 <application>Privoxy</application> Version is added to the Portage Tree).
360 Before installing <application>Privoxy</application> under Gentoo just do
361 first <literal>emerge rsync</literal> to get the latest changes from the
362 Portage tree. With <literal>emerge privoxy</literal> you install the latest
366 Configuration files are in <filename>/etc/privoxy</filename>, the
367 documentation is in <filename>/usr/share/doc/privoxy-&p-version;</filename>
368 and the Log directory is in <filename>/var/log/privoxy</filename>.
374 <!-- ~~~~~ New section ~~~~~ -->
375 <sect2 id="installation-source"><title>Building from Source</title>
378 The most convenient way to obtain the <application>Privoxy</application> sources
379 is to download the source tarball from our
380 <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118&package_id=10571">project download
385 If you like to live on the bleeding edge and are not afraid of using
386 possibly unstable development versions, you can check out the up-to-the-minute
387 version directly from <ulink url="http://sourceforge.net/cvs/?group_id=11118">the
388 CVS repository</ulink>.
390 deprecated...out of business.
391 or simply download <ulink
392 url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.bz2">the nightly CVS
397 <!-- include buildsource.sgml boilerplate: -->
399 <!-- end boilerplate -->
402 <!-- ~~~~~ New section ~~~~~ -->
403 <sect2 id="installation-keepupdated"><title>Keeping your Installation Up-to-Date</title>
405 As user feedback comes in and development continues, we will make updated versions
406 of both the main <link linkend="actions-file">actions file</link> (as a <ulink
407 url="http://sourceforge.net/project/showfiles.php?group_id=11118&release_id=103670">separate
408 package</ulink>) and the software itself (including the actions file) available for
413 If you wish to receive an email notification whenever we release updates of
414 <application>Privoxy</application> or the actions file, <ulink
415 url="http://lists.sourceforge.net/lists/listinfo/ijbswa-announce/">subscribe
416 to our announce mailing list</ulink>, ijbswa-announce@lists.sourceforge.net.
420 In order not to lose your personal changes and adjustments when updating
421 to the latest <literal>default.action</literal> file we <emphasis>strongly
422 recommend</emphasis> that you use <literal>user.action</literal> and
423 <literal>user.filter</literal> for your local
424 customizations of <application>Privoxy</application>. See the <link
425 linkend="actions-file">Chapter on actions files</link> for details.
433 <!-- ~ End section ~ -->
435 <!-- ~~~~~ New section ~~~~~ -->
436 <sect1 id="whatsnew">
437 <title>What's New in this Release</title>
439 There are many improvements and new features since <application>Privoxy 3.0.6</application>, the last stable release:
446 Two new actions <link
447 linkend="server-header-tagger">server-header-tagger</link>
449 linkend="client-header-tagger">client-header-tagger</link>
450 that can be used to create arbitrary <quote>tags</quote>
451 based on client and server headers.
452 These <quote>tags</quote> can then subsequently be used
453 to control the other actions used for the current request,
454 greatly increasing &my-app;'s flexibility and selectivity. See <link
455 linkend="tag-pattern">tag patterns</link> for more information on tags.
461 Header filtering is done with dedicated header filters now. As a result
462 the actions <quote>filter-client-headers</quote> and <quote>filter-server-headers</quote>
463 that were introduced with <application>Privoxy 3.0.5</application> to apply
464 content filters to the headers have been removed.
465 See the new actions <link
466 linkend="server-header-filter">server-header-filter</link>
468 linkend="client-header-filter">client-header-filter</link> for details.
473 There are four new options for the main <filename>config</filename> file:
480 linkend="allow-cgi-request-crunching">allow-cgi-request-crunching</link>
481 which allows requests for Privoxy's internal CGI pages to be
482 blocked, redirected or (un)trusted like ordinary requests.
488 linkend="split-large-forms">split-large-forms</link>
489 that will work around a browser bug that caused IE6 and IE7 to
490 ignore the Submit button on the Privoxy's edit-actions-for-url CGI
497 linkend="accept-intercepted-requests">accept-intercepted-requests</link>
498 which allows to combine Privoxy with any packet filter to create an
499 intercepting proxy for HTTP/1.1 requests (and for HTTP/1.0 requests
500 with Host header set). This means clients can be forced to use
501 &my-app; even if their proxy settings are configured differently.
507 linkend="templdir">templdir</link>
508 to designate an alternate location for &my-app;'s
509 locally customized CGI templates so that
510 these are not overwritten during upgrades.
518 A new command line option <literal>--pre-chroot-nslookup hostname</literal> to
519 initialize the resolver library before chroot'ing. On some systems this
520 reduces the number of files that must be copied into the chroot tree.
521 (Patch provided by Stephen Gildea)
528 linkend="forward-override">forward-override</link> action
529 allows changing of the forwarding settings through the actions files.
530 Combined with tags, this allows to choose the forwarder based on
531 client headers like the <literal>User-Agent</literal>, or the request origin.
538 linkend="redirect">redirect</link> action can now use regular
539 expression substitutions against the original URL.
545 <application>zlib</application> support is now available as a compile
546 time option to filter compressed content. Patch provided by Wil Mahan.
551 Improve various filters, and add new ones.
558 Include support for RFC 3253 so that <filename>Subversion</filename> works
559 with &my-app;. Patch provided by Petr Kadlec.
565 Logging can be completely turned off by not specifying a logfile directive.
572 A number of improvements to Privoxy's internal CGI pages, including the
573 use of favicons for error and control pages.
579 Many bugfixes, memory leaks addressed, code improvements, and logging
587 For a more detailed list of changes please have a look at the ChangeLog.
590 <!-- ~~~~~ New section ~~~~~ -->
592 <sect2 id="upgradersnote">
593 <title>Note to Upgraders</title>
596 A quick list of things to be aware of before upgrading from earlier
597 versions of <application>Privoxy</application>:
605 The recommended way to upgrade &my-app; is to backup your old
606 configuration files, install the new ones, verify that &my-app;
607 is working correctly and finally merge back your changes using
608 <application>diff</application> and maybe <application>patch</application>.
611 There are a number of new features in each &my-app; release and
612 most of them have to be explicitly enabled in the configuration
613 files. Old configuration files obviously don't do that and due
614 to syntax changes using old configuration files with a new
615 &my-app; isn't always possible anyway.
620 Note that some installers remove earlier versions completely,
621 including configuration files, therefore you should really save
622 any important configuration files!
627 On the other hand, other installers don't overwrite existing configuration
628 files, thinking you will want to do that yourself.
633 <filename>standard.action</filename> now only includes the enabled actions.
634 Not all actions as before.
639 In the default configuration only fatal errors are logged now.
640 You can change that in the <link linkend="DEBUG">debug section</link>
641 of the configuration file. You may also want to enable more verbose
642 logging until you verified that the new &my-app; version is working
649 Three other config file settings are now off by default:
650 <link linkend="enable-remote-toggle">enable-remote-toggle</link>,
651 <link linkend="enable-remote-http-toggle">enable-remote-http-toggle</link>,
652 and <link linkend="enable-edit-actions">enable-edit-actions</link>.
653 If you use or want these, you will need to explicitly enable them, and
654 be aware of the security issues involved.
660 The <quote>filter-client-headers</quote> and
661 <quote>filter-server-headers</quote> actions that were introduced with
662 <application>Privoxy 3.0.5</application> to apply content filters to
663 the headers have been removed and replaced with new actions.
665 linkend="whatsnew">What's New section</link> above.
673 What constitutes a <quote>default</quote> configuration has changed,
674 and you may want to review which actions are <quote>on</quote> by
675 default. This is primarily a matter of emphasis, but some features
676 you may have been used to, may now be <quote>off</quote> by default.
677 There are also a number of new actions and filters you may want to
678 consider, most of which are not fully incorporated into the default
679 settings as yet (see above).
686 The default actions setting is now <literal>Cautious</literal>. Previous
687 releases had a default setting of <literal>Medium</literal>. Experienced
688 users may want to adjust this, as it is fairly conservative by &my-app;
689 standards and past practices. See <ulink
690 url="http://config.privoxy.org/edit-actions-list?f=default">
691 http://config.privoxy.org/edit-actions-list?f=default</ulink>. New users
692 should try the default settings for a while before turning up the volume.
698 The default setting has filtering turned <emphasis>off</emphasis>, which
699 subsequently means that compression is <emphasis>on</emphasis>. Remember
700 that filtering does not work on compressed pages, so if you use, or want to
701 use, filtering, you will need to force compression off. Example:
705 { +<link linkend="filter">filter</link>{google} +<link linkend="prevent-compression">prevent-compression</link> }
709 Or if you use a number of filters, or filter many sites, you may just want
710 to turn off compression for all sites in
711 <filename>default.action</filename> (or
712 <filename>user.action</filename>).
719 Also, <link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> is
720 off by default now. If you've liked this feature in the past, you may want
721 to turn it back on in <filename>user.action</filename> now.
728 Some installers may not automatically start
729 <application>Privoxy</application> after installation.
740 <!-- ~~~~~ New section ~~~~~ -->
741 <sect1 id="quickstart"><title>Quickstart to Using Privoxy</title>
747 Install <application>Privoxy</application>. See the <link
748 linkend="installation">Installation Section</link> below for platform specific
755 Advanced users and those who want to offer <application>Privoxy</application>
756 service to more than just their local machine should check the <link
757 linkend="config">main config file</link>, especially the <link
758 linkend="access-control">security-relevant</link> options. These are
765 Start <application>Privoxy</application>, if the installation program has
766 not done this already (may vary according to platform). See the section
767 <link linkend="startup">Starting <application>Privoxy</application></link>.
773 Set your browser to use <application>Privoxy</application> as HTTP and
774 HTTPS (SSL) <ulink url="http://en.wikipedia.org/wiki/Proxy_server">proxy</ulink>
775 by setting the proxy configuration for address of
776 <literal>127.0.0.1</literal> and port <literal>8118</literal>.
777 <emphasis>DO NOT</emphasis> activate proxying for <literal>FTP</literal> or
778 any protocols besides HTTP and HTTPS (SSL) unless you intend to prevent your
779 browser from using these protocols.
785 Flush your browser's disk and memory caches, to remove any cached ad images.
786 If using <application>Privoxy</application> to manage
787 <ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookies</ulink>,
788 you should remove any currently stored cookies too.
794 A default installation should provide a reasonable starting point for
795 most. There will undoubtedly be occasions where you will want to adjust the
796 configuration, but that can be dealt with as the need arises. Little
797 to no initial configuration is required in most cases, you may want
799 <ulink url="config.html#ENABLE-EDIT-ACTIONS">web-based action editor</ulink> though.
800 Be sure to read the warnings first.
803 See the <link linkend="configuration">Configuration section</link> for more
804 configuration options, and how to customize your installation.
805 You might also want to look at the <link
806 linkend="quickstart-ad-blocking">next section</link> for a quick
807 introduction to how <application>Privoxy</application> blocks ads and
814 If you experience ads that slip through, innocent images that are
815 blocked, or otherwise feel the need to fine-tune
816 <application>Privoxy's</application> behavior, take a look at the <link
817 linkend="actions-file">actions files</link>. As a quick start, you might
818 find the <link linkend="act-examples">richly commented examples</link>
819 helpful. You can also view and edit the actions files through the <ulink
820 url="http://config.privoxy.org">web-based user interface</ulink>. The
821 Appendix <quote><link linkend="actionsanat">Troubleshooting: Anatomy of an
822 Action</link></quote> has hints on how to understand and debug actions that
823 <quote>misbehave</quote>.
828 Did anyone test these lately?
832 For easy access to &my-app;'s most important controls, drag the provided
833 <link linkend="bookmarklets">Bookmarklets</link> into your browser's
841 Please see the section <link linkend="contact">Contacting the
842 Developers</link> on how to report bugs, problems with websites or to get
849 Now enjoy surfing with enhanced control, comfort and privacy!
857 <!-- ~~~~~ New section ~~~~~ -->
859 <sect2 id="quickstart-ad-blocking">
860 <title>Quickstart to Ad Blocking</title>
862 NOTE: This section is deliberately redundant for those that don't
863 want to read the whole thing (which is getting lengthy).
866 Ad blocking is but one of <application>Privoxy's</application>
867 array of features. Many of these features are for the technically minded advanced
868 user. But, ad and banner blocking is surely common ground for everybody.
871 This section will provide a quick summary of ad blocking so
872 you can get up to speed quickly without having to read the more extensive
873 information provided below, though this is highly recommended.
876 First a bit of a warning ... blocking ads is much like blocking SPAM: the
877 more aggressive you are about it, the more likely you are to block
878 things that were not intended. And the more likely that some things
879 may not work as intended. So there is a trade off here. If you want
880 extreme ad free browsing, be prepared to deal with more
881 <quote>problem</quote> sites, and to spend more time adjusting the
882 configuration to solve these unintended consequences. In short, there is
883 not an easy way to eliminate <emphasis>all</emphasis> ads. Either take
884 the easy way and settle for <emphasis>most</emphasis> ads blocked with the
885 default configuration, or jump in and tweak it for your personal surfing
886 habits and preferences.
889 Secondly, a brief explanation of <application>Privoxy's </application>
890 <quote>actions</quote>. <quote>Actions</quote> in this context, are
891 the directives we use to tell <application>Privoxy</application> to perform
892 some task relating to HTTP transactions (i.e. web browsing). We tell
893 <application>Privoxy</application> to take some <quote>action</quote>. Each
894 action has a unique name and function. While there are many potential
895 <application>actions</application> in <application>Privoxy's</application>
896 arsenal, only a few are used for ad blocking. <link
897 linkend="actions">Actions</link>, and <link linkend="actions-file">action
898 configuration files</link>, are explained in depth below.
901 Actions are specified in <application>Privoxy's</application> configuration,
902 followed by one or more URLs to which the action should apply. URLs
903 can actually be URL type <link linkend="af-patterns">patterns</link> that use
904 wildcards so they can apply potentially to a range of similar URLs. The
905 actions, together with the URL patterns are called a section.
908 When you connect to a website, the full URL will either match one or more
909 of the sections as defined in <application>Privoxy's</application> configuration,
910 or not. If so, then <application>Privoxy</application> will perform the
911 respective actions. If not, then nothing special happens. Furthermore, web
912 pages may contain embedded, secondary URLs that your web browser will
913 use to load additional components of the page, as it parses the
914 original page's HTML content. An ad image for instance, is just an URL
915 embedded in the page somewhere. The image itself may be on the same server,
916 or a server somewhere else on the Internet. Complex web pages will have many
917 such embedded URLs. &my-app; can deal with each URL individually, so, for
918 instance, the main page text is not touched, but images from such-and-such
923 The most important actions for basic ad blocking are: <literal><link
924 linkend="block">block</link></literal>, <literal><link
925 linkend="handle-as-image">handle-as-image</link></literal>,
927 linkend="handle-as-empty-document">handle-as-empty-document</link></literal>,and
928 <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>:
936 <literal><link linkend="block">block</link></literal> - this is perhaps
937 the single most used action, and is particularly important for ad blocking.
938 This action stops any contact between your browser and any URL patterns
939 that match this action's configuration. It can be used for blocking ads,
940 but also anything that is determined to be unwanted. By itself, it simply
941 stops any communication with the remote server and sends
942 <application>Privoxy</application>'s own built-in BLOCKED page instead to
943 let you now what has happened (with some exceptions, see below).
949 <literal><link linkend="handle-as-image">handle-as-image</link></literal> -
950 tells <application>Privoxy</application> to treat this URL as an image.
951 <application>Privoxy</application>'s default configuration already does this
952 for all common image types (e.g. GIF), but there are many situations where this
953 is not so easy to determine. So we'll force it in these cases. This is particularly
954 important for ad blocking, since only if we know that it's an image of
955 some kind, can we replace it with an image of our choosing, instead of the
956 <application>Privoxy</application> BLOCKED page (which would only result in
957 a <quote>broken image</quote> icon). There are some limitations to this
958 though. For instance, you can't just brute-force an image substitution for
959 an entire HTML page in most situations.
965 <literal><link linkend="handle-as-empty-document">handle-as-empty-document</link></literal> -
966 sends an empty document instead of <application>Privoxy's</application>
967 normal BLOCKED HTML page. This is useful for file types that are neither
968 HTML nor images, such as blocking JavaScript files.
975 linkend="set-image-blocker">set-image-blocker</link></literal> - tells
976 <application>Privoxy</application> what to display in place of an ad image that
977 has hit a block rule. For this to come into play, the URL must match a
978 <literal><link linkend="block">block</link></literal> action somewhere in the
979 configuration, <emphasis>and</emphasis>, it must also match an
980 <literal><link linkend="handle-as-image">handle-as-image</link></literal> action.
983 The configuration options on what to display instead of the ad are:
987 <emphasis>pattern</emphasis> - a checkerboard pattern, so that an ad
988 replacement is obvious. This is the default.
993 <emphasis>blank</emphasis> - A very small empty GIF image is displayed.
994 This is the so-called <quote>invisible</quote> configuration option.
999 <emphasis>http://<URL></emphasis> - A redirect to any image anywhere
1000 of the user's choosing (advanced usage).
1009 Advanced users will eventually want to explore &my-app;
1010 <literal><link linkend="filter">filters</link></literal> as well. Filters
1011 are very different from <literal><link
1012 linkend="block">blocks</link></literal>.
1013 A <quote>block</quote> blocks a site, page, or unwanted contented. Filters
1014 are a way of filtering or modifying what is actually on the page. An example
1015 filter usage: a text replacement of <quote>no-no</quote> for
1016 <quote>nasty-word</quote>. That is a very simple example. This process can be
1017 used for ad blocking, but it is more in the realm of advanced usage and has
1018 some pitfalls to be wary off.
1022 The quickest way to adjust any of these settings is with your browser through
1023 the special <application>Privoxy</application> editor at <ulink
1024 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
1025 (shortcut: <ulink url="http://p.p/">http://p.p/show-status</ulink>). This
1026 is an internal page, and does not require Internet access.
1030 Note that as of <application>Privoxy</application> 3.0.7 beta the
1031 action editor is disabled by default. Check the
1032 <ulink url="config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions
1033 section in the configuration file</ulink> to learn why and in which
1034 cases it's safe to enable again.
1038 If you decided to enable the action editor, select the appropriate
1039 <quote>actions</quote> file, and click
1040 <quote><guibutton>Edit</guibutton></quote>. It is best to put personal or
1041 local preferences in <filename>user.action</filename> since this is not
1042 meant to be overwritten during upgrades, and will over-ride the settings in
1043 other files. Here you can insert new <quote>actions</quote>, and URLs for ad
1044 blocking or other purposes, and make other adjustments to the configuration.
1045 <application>Privoxy</application> will detect these changes automatically.
1049 A quick and simple step by step example:
1057 Right click on the ad image to be blocked, then select
1058 <quote><guimenuitem>Copy Link Location</guimenuitem></quote> from the
1066 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
1071 Find <filename>user.action</filename> in the top section, and click
1072 on <quote><guibutton>Edit</guibutton></quote>:
1075 <!-- image of editor and actions files selections -->
1077 <figure pgwide="0" float="0"><title>Actions Files in Use</title>
1080 <imagedata fileref="files-in-use.jpg" format="jpg">
1083 <phrase>[ Screenshot of Actions Files in Use ]</phrase>
1092 You should have a section with only
1093 <literal><link linkend="block">block</link></literal> listed under
1094 <quote>Actions:</quote>.
1095 If not, click a <quote><guibutton>Insert new section below</guibutton></quote>
1096 button, and in the new section that just appeared, click the
1097 <guibutton>Edit</guibutton> button right under the word <quote>Actions:</quote>.
1098 This will bring up a list of all actions. Find
1099 <literal><link linkend="block">block</link></literal> near the top, and click
1100 in the <quote>Enabled</quote> column, then <quote><guibutton>Submit</guibutton></quote>
1101 just below the list.
1106 Now, in the <literal><link linkend="block">block</link></literal> actions section,
1107 click the <quote><guibutton>Add</guibutton></quote> button, and paste the URL the
1108 browser got from <quote><guimenuitem>Copy Link Location</guimenuitem></quote>.
1109 Remove the <literal>http://</literal> at the beginning of the URL. Then, click
1110 <quote><guibutton>Submit</guibutton></quote> (or
1111 <quote><guibutton>OK</guibutton></quote> if in a pop-up window).
1116 Now go back to the original page, and press <keycap>SHIFT-Reload</keycap>
1117 (or flush all browser caches). The image should be gone now.
1125 This is a very crude and simple example. There might be good reasons to use a
1126 wildcard pattern match to include potentially similar images from the same
1127 site. For a more extensive explanation of <quote>patterns</quote>, and
1128 the entire actions concept, see <link linkend="actions-file">the Actions
1133 For advanced users who want to hand edit their config files, you might want
1134 to now go to the <link linkend="act-examples">Actions Files Tutorial</link>.
1135 The ideas explained therein also apply to the web-based editor.
1138 There are also various
1139 <link linkend="filter">filters</link> that can be used for ad blocking
1140 (filters are a special subset of actions). These
1141 fall into the <quote>advanced</quote> usage category, and are explained in
1142 depth in later sections.
1149 <!-- ~ End section ~ -->
1152 <!-- ~~~~~ New section ~~~~~ -->
1153 <sect1 id="startup">
1154 <title>Starting Privoxy</title>
1156 Before launching <application>Privoxy</application> for the first time, you
1157 will want to configure your browser(s) to use
1158 <application>Privoxy</application> as a HTTP and HTTPS (SSL)
1159 <ulink url="http://en.wikipedia.org/wiki/Proxy_server">proxy</ulink>. The default is
1160 127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions
1161 used port 8000). This is the one configuration step <emphasis>that must be done
1165 Please note that <application>Privoxy</application> can only proxy HTTP and
1166 HTTPS traffic. It will not work with FTP or other protocols.
1169 <!-- image of Mozilla Proxy configuration -->
1171 <figure pgwide="0" float="0"><title>Proxy Configuration Showing
1172 Mozilla/Netscape HTTP and HTTPS (SSL) Settings</title>
1175 <imagedata fileref="proxy_setup.jpg" format="jpg">
1178 <phrase>[ Screenshot of Mozilla Proxy Configuration ]</phrase>
1186 With <application>Firefox</application>, this is typically set under:
1190 <guibutton>Tools</guibutton> -> <guibutton>Options</guibutton> -> <guibutton>Advanced</guibutton> -> <guibutton>Network</guibutton> -><guibutton>Connection</guibutton> -> <guibutton>Settings</guibutton>
1195 Or optionally on some platforms:
1199 <guibutton>Edit</guibutton> -> <guibutton>Preferences</guibutton> -> <guibutton>General</guibutton> -> <guibutton>Connection Settings</guibutton> -> <guibutton>Manual Proxy Configuration</guibutton>
1205 With <application>Netscape</application> (and
1206 <application>Mozilla</application>), this can be set under:
1211 <!-- Mix ascii and gui art, something for everybody -->
1212 <!-- spacing on this is tricky -->
1213 <guibutton>Edit</guibutton> -> <guibutton>Preferences</guibutton> -> <guibutton>Advanced</guibutton> -> <guibutton>Proxies</guibutton> -> <guibutton>HTTP Proxy</guibutton>
1218 For <application>Internet Explorer v.5-7</application>:
1222 <guibutton>Tools</guibutton> -> <guibutton>Internet Options</guibutton> -> <guibutton>Connections</guibutton> -> <guibutton>LAN Settings</guibutton>
1226 Then, check <quote>Use Proxy</quote> and fill in the appropriate info
1227 (Address: 127.0.0.1, Port: 8118). Include HTTPS (SSL), if you want HTTPS
1228 proxy support too (sometimes labeled <quote>Secure</quote>). Make sure any
1229 checkboxes like <quote>Use the same proxy server for all protocols</quote> is
1230 <emphasis>UNCHECKED</emphasis>. You want only HTTP and HTTPS (SSL)!
1233 <!-- image of IE Proxy configuration -->
1235 <figure pgwide="0" float="0"><title>Proxy Configuration Showing
1236 Internet Explorer HTTP and HTTPS (Secure) Settings</title>
1239 <imagedata fileref="proxy2.jpg" format="jpg">
1242 <phrase>[ Screenshot of IE Proxy Configuration ]</phrase>
1250 After doing this, flush your browser's disk and memory caches to force a
1251 re-reading of all pages and to get rid of any ads that may be cached. Remove
1252 any <ulink url="http://en.wikipedia.org/wiki/Browser_cookie">cookies</ulink>,
1253 if you want <application>Privoxy</application> to manage that. You are now
1254 ready to start enjoying the benefits of using
1255 <application>Privoxy</application>!
1259 <application>Privoxy</application> itself is typically started by specifying the
1260 main configuration file to be used on the command line. If no configuration
1261 file is specified on the command line, <application>Privoxy</application>
1262 will look for a file named <filename>config</filename> in the current
1263 directory. Except on Win32 where it will try <filename>config.txt</filename>.
1266 <sect2 id="start-redhat">
1267 <title>Red Hat and Fedora</title>
1269 A default Red Hat installation may not start &my-app; upon boot. It will use
1270 the file <filename>/etc/privoxy/config</filename> as its main configuration
1275 # /etc/rc.d/init.d/privoxy start
1283 # service privoxy start
1288 <sect2 id="start-debian">
1289 <title>Debian</title>
1291 We use a script. Note that Debian typically starts &my-app; upon booting per
1292 default. It will use the file
1293 <filename>/etc/privoxy/config</filename> as its main configuration
1298 # /etc/init.d/privoxy start
1303 <sect2 id="start-windows">
1304 <title>Windows</title>
1306 Click on the &my-app; Icon to start <application>Privoxy</application>. If no configuration file is
1307 specified on the command line, <application>Privoxy</application> will look
1308 for a file named <filename>config.txt</filename>. Note that Windows will
1309 automatically start &my-app; when the system starts if you chose that option
1313 <application>Privoxy</application> can run with full Windows service functionality.
1314 On Windows only, the &my-app; program has two new command line arguments
1315 to install and uninstall &my-app; as a service. See the
1316 <link linkend="installation-pack-win">Windows Installation
1317 instructions</link> for details.
1321 <sect2 id="start-unices">
1322 <title>Solaris, NetBSD, FreeBSD, HP-UX and others</title>
1324 Example Unix startup command:
1328 # /usr/sbin/privoxy /etc/privoxy/config
1333 <sect2 id="start-os2">
1336 During installation, <application>Privoxy</application> is configured to
1337 start automatically when the system restarts. You can start it manually by
1338 double-clicking on the <application>Privoxy</application> icon in the
1339 <application>Privoxy</application> folder.
1343 <sect2 id="start-macosx">
1344 <title>Mac OS X</title>
1346 After downloading the privoxy software, unzip the downloaded file by
1347 double-clicking on the zip file icon. Then, double-click on the
1348 installer package icon and follow the installation process.
1351 The privoxy service will automatically start after a successful
1352 installation. In addition, the privoxy service will automatically
1353 start every time your computer starts up.
1356 To prevent the privoxy service from automatically starting when your
1357 computer starts up, remove or rename the folder named
1358 /Library/StartupItems/Privoxy.
1361 A simple application named Privoxy Utility has been created which
1362 enables administrators to easily start and stop the privoxy service.
1365 In addition, the Privoxy Utility presents a simple way for
1366 administrators to edit the various privoxy config files. A method
1367 to uninstall the software is also available.
1370 An administrator username and password must be supplied in order for
1371 the Privoxy Utility to perform any of the tasks.
1374 During installation, <application>Privoxy</application> is configured to
1375 start automatically when the system restarts. To start &my-app; manually,
1376 double-click on the <literal>StartPrivoxy.command</literal> icon in the
1377 <literal>/Library/Privoxy</literal> folder. Or, type this command
1382 /Library/Privoxy/StartPrivoxy.command
1386 You will be prompted for the administrator password.
1391 <sect2 id="start-amigaos">
1392 <title>AmigaOS</title>
1394 Start <application>Privoxy</application> (with RUN <>NIL:) in your
1395 <filename>startnet</filename> script (AmiTCP), in
1396 <filename>s:user-startup</filename> (RoadShow), as startup program in your
1397 startup script (Genesis), or as startup action (Miami and MiamiDx).
1398 <application>Privoxy</application> will automatically quit when you quit your
1399 TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that
1400 <application>Privoxy</application> is still running).
1404 <sect2 id="start-gentoo">
1405 <title>Gentoo</title>
1407 A script is again used. It will use the file <filename>/etc/privoxy/config
1408 </filename> as its main configuration file.
1412 /etc/init.d/privoxy start
1416 Note that <application>Privoxy</application> is not automatically started at
1417 boot time by default. You can change this with the <literal>rc-update</literal>
1422 rc-update add privoxy default
1430 See the section <link linkend="cmdoptions">Command line options</link> for
1434 must find a better place for this paragraph
1437 The included default configuration files should give a reasonable starting
1438 point. Most of the per site configuration is done in the
1439 <ulink url="actions-file.html"><quote>actions</quote></ulink> files. These are
1440 where various cookie actions are defined, ad and banner blocking, and other
1441 aspects of <application>Privoxy</application> configuration. There are several
1442 such files included, with varying levels of aggressiveness.
1446 You will probably want to keep an eye out for sites for which you may prefer
1447 persistent cookies, and add these to your actions configuration as needed. By
1448 default, most of these will be accepted only during the current browser
1449 session (aka <quote>session cookies</quote>), unless you add them to the
1450 configuration. If you want the browser to handle this instead, you will need
1451 to edit <filename>user.action</filename> (or through the web based interface)
1452 and disable this feature. If you use more than one browser, it would make
1453 more sense to let <application>Privoxy</application> handle this. In which
1454 case, the browser(s) should be set to accept all cookies.
1458 Another feature where you will probably want to define exceptions for trusted
1459 sites is the popup-killing (through <ulink
1460 url="actions-file.html#FILTER-POPUPS"><quote>+filter{popups}</quote></ulink>),
1461 because your favorite shopping, banking, or leisure site may need
1462 popups (explained below).
1466 <application>Privoxy</application> does not support all of the optional HTTP/1.1
1467 features yet. In the unlikely event that you experience inexplicable problems
1468 with browsers that use HTTP/1.1 per default
1469 (like <application>Mozilla</application> or recent versions of I.E.), you might
1470 try to force HTTP/1.0 compatibility. For Mozilla, look under <literal>Edit ->
1471 Preferences -> Debug -> Networking</literal>.
1472 Alternatively, set the <quote>+downgrade-http-version</quote> config option in
1473 <filename>default.action</filename> which will downgrade your browser's HTTP
1474 requests from HTTP/1.1 to HTTP/1.0 before processing them.
1478 After running <application>Privoxy</application> for a while, you can
1479 start to fine tune the configuration to suit your personal, or site,
1480 preferences and requirements. There are many, many aspects that can
1481 be customized. <quote>Actions</quote>
1482 can be adjusted by pointing your browser to
1483 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
1484 (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
1485 and then follow the link to <quote>View & Change the Current Configuration</quote>.
1486 (This is an internal page and does not require Internet access.)
1490 In fact, various aspects of <application>Privoxy</application>
1491 configuration can be viewed from this page, including
1492 current configuration parameters, source code version numbers,
1493 the browser's request headers, and <quote>actions</quote> that apply
1494 to a given URL. In addition to the actions file
1495 editor mentioned above, <application>Privoxy</application> can also
1496 be turned <quote>on</quote> and <quote>off</quote> (toggled) from this page.
1500 If you encounter problems, try loading the page without
1501 <application>Privoxy</application>. If that helps, enter the URL where
1502 you have the problems into <ulink url="http://p.p/show-url-info">the browser
1503 based rule tracing utility</ulink>. See which rules apply and why, and
1504 then try turning them off for that site one after the other, until the problem
1505 is gone. When you have found the culprit, you might want to turn the rest on
1510 If the above paragraph sounds gibberish to you, you might want to <link
1511 linkend="actions-file">read more about the actions concept</link>
1512 or even dive deep into the <link linkend="actionsanat">Appendix
1517 If you can't get rid of the problem at all, think you've found a bug in
1518 Privoxy, want to propose a new feature or smarter rules, please see the
1519 section <link linkend="contact"><quote>Contacting the
1520 Developers</quote></link> below.
1525 <!-- ~~~~~ New section ~~~~~ -->
1526 <sect2 id="cmdoptions">
1527 <title>Command Line Options</title>
1529 <application>Privoxy</application> may be invoked with the following
1530 command-line options:
1538 <emphasis>--version</emphasis>
1541 Print version info and exit. Unix only.
1546 <emphasis>--help</emphasis>
1549 Print short usage info and exit. Unix only.
1554 <emphasis>--no-daemon</emphasis>
1557 Don't become a daemon, i.e. don't fork and become process group
1558 leader, and don't detach from controlling tty. Unix only.
1563 <emphasis>--pidfile FILE</emphasis>
1566 On startup, write the process ID to <emphasis>FILE</emphasis>. Delete the
1567 <emphasis>FILE</emphasis> on exit. Failure to create or delete the
1568 <emphasis>FILE</emphasis> is non-fatal. If no <emphasis>FILE</emphasis>
1569 option is given, no PID file will be used. Unix only.
1574 <emphasis>--user USER[.GROUP]</emphasis>
1577 After (optionally) writing the PID file, assume the user ID of
1578 <emphasis>USER</emphasis>, and if included the GID of GROUP. Exit if the
1579 privileges are not sufficient to do so. Unix only.
1584 <emphasis>--chroot</emphasis>
1587 Before changing to the user ID given in the <emphasis>--user</emphasis> option,
1588 chroot to that user's home directory, i.e. make the kernel pretend to the &my-app;
1589 process that the directory tree starts there. If set up carefully, this can limit
1590 the impact of possible vulnerabilities in &my-app; to the files contained in that hierarchy.
1596 <emphasis>--pre-chroot-nslookup hostname</emphasis>
1599 Specifies a hostname to look up before doing a chroot. On some systems, initializing the
1600 resolver library involves reading config files from /etc and/or loading additional shared
1601 libraries from /lib. On these systems, doing a hostname lookup before the chroot reduces
1602 the number of files that must be copied into the chroot tree.
1605 For fastest startup speed, a good value is a hostname that is not in /etc/hosts but that
1606 your local name server (listed in /etc/resolv.conf) can resolve without recursion
1607 (that is, without having to ask any other name servers). The hostname need not exist,
1608 but if it doesn't, an error message (which can be ignored) will be output.
1614 <emphasis>configfile</emphasis>
1617 If no <emphasis>configfile</emphasis> is included on the command line,
1618 <application>Privoxy</application> will look for a file named
1619 <quote>config</quote> in the current directory (except on Win32
1620 where it will look for <quote>config.txt</quote> instead). Specify
1621 full path to avoid confusion. If no config file is found,
1622 <application>Privoxy</application> will fail to start.
1630 On <application>MS Windows</application> only there are two additional
1631 command-line options to allow <application>Privoxy</application> to install and
1632 run as a <emphasis>service</emphasis>. See the
1633 <link linkend="installation-pack-win">Window Installation section</link>
1641 <!-- ~ End section ~ -->
1644 <!-- ~~~~~ New section ~~~~~ -->
1645 <sect1 id="configuration"><title>Privoxy Configuration</title>
1647 All <application>Privoxy</application> configuration is stored
1648 in text files. These files can be edited with a text editor.
1649 Many important aspects of <application>Privoxy</application> can
1650 also be controlled easily with a web browser.
1654 <!-- ~~~~~ New section ~~~~~ -->
1657 <title>Controlling Privoxy with Your Web Browser</title>
1659 <application>Privoxy</application>'s user interface can be reached through the special
1660 URL <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
1661 (shortcut: <ulink url="http://p.p/">http://p.p/</ulink>),
1662 which is a built-in page and works without Internet access.
1663 You will see the following section:
1667 <!-- Needs to be put in a table and colorized -->
1670 <bridgehead renderas="sect2"> Privoxy Menu</bridgehead>
1674 ▪ <ulink url="http://config.privoxy.org/show-status">View & change the current configuration</ulink>
1677 ▪ <ulink url="http://config.privoxy.org/show-version">View the source code version numbers</ulink>
1680 ▪ <ulink url="http://config.privoxy.org/show-request">View the request headers.</ulink>
1683 ▪ <ulink url="http://config.privoxy.org/show-url-info">Look up which actions apply to a URL and why</ulink>
1686 ▪ <ulink url="http://config.privoxy.org/toggle">Toggle Privoxy on or off</ulink>
1689 ▪ <ulink url="http://www.privoxy.org/
1690 &p-version;/user-manual/">Documentation</ulink>
1698 This should be self-explanatory. Note the first item leads to an editor for the
1699 <link linkend="actions-file">actions files</link>, which is where the ad, banner,
1700 cookie, and URL blocking magic is configured as well as other advanced features of
1701 <application>Privoxy</application>. This is an easy way to adjust various
1702 aspects of <application>Privoxy</application> configuration. The actions
1703 file, and other configuration files, are explained in detail below.
1707 <quote>Toggle Privoxy On or Off</quote> is handy for sites that might
1708 have problems with your current actions and filters. You can in fact use
1709 it as a test to see whether it is <application>Privoxy</application>
1710 causing the problem or not. <application>Privoxy</application> continues
1711 to run as a proxy in this case, but all manipulation is disabled, i.e.
1712 <application>Privoxy</application> acts like a normal forwarding proxy. There
1713 is even a toggle <link linkend="bookmarklets">Bookmarklet</link> offered, so
1714 that you can toggle <application>Privoxy</application> with one click from
1719 Note that several of the features described above are disabled by default
1720 in <application>Privoxy</application> 3.0.7 beta and later.
1722 <ulink url="config.html">configuration file</ulink> to learn why
1723 and in which cases it's safe to enable them again.
1728 <!-- ~ End section ~ -->
1733 <!-- ~~~~~ New section ~~~~~ -->
1735 <sect2 id="confoverview">
1736 <title>Configuration Files Overview</title>
1738 For Unix, *BSD and Linux, all configuration files are located in
1739 <filename>/etc/privoxy/</filename> by default. For MS Windows, OS/2, and
1740 AmigaOS these are all in the same directory as the
1741 <application>Privoxy</application> executable. <![%p-not-stable;[ The name
1742 and number of configuration files has changed from previous versions, and is
1743 subject to change as development progresses.]]>
1747 The installed defaults provide a reasonable starting point, though
1748 some settings may be aggressive by some standards. For the time being, the
1749 principle configuration files are:
1757 The <link linkend="config">main configuration file</link> is named <filename>config</filename>
1758 on Linux, Unix, BSD, OS/2, and AmigaOS and <filename>config.txt</filename>
1759 on Windows. This is a required file.
1765 <filename>default.action</filename> (the main <link linkend="actions-file">actions file</link>)
1766 is used to define which <quote>actions</quote> relating to banner-blocking, images, pop-ups,
1767 content modification, cookie handling etc should be applied by default. It also defines many
1768 exceptions (both positive and negative) from this default set of actions that enable
1769 <application>Privoxy</application> to selectively eliminate the junk, and only the junk, on
1770 as many websites as possible.
1773 Multiple actions files may be defined in <filename>config</filename>. These
1774 are processed in the order they are defined. Local customizations and locally
1775 preferred exceptions to the default policies as defined in
1776 <filename>default.action</filename> (which you will most probably want
1777 to define sooner or later) are probably best applied in
1778 <filename>user.action</filename>, where you can preserve them across
1779 upgrades. <filename>standard.action</filename> is only for
1780 <application>Privoxy's</application> internal use.
1783 There is also a web based editor that can be accessed from
1785 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
1787 url="http://p.p/show-status">http://p.p/show-status</ulink>) for the
1788 various actions files.
1794 <quote>Filter files</quote> (the <link linkend="filter-file">filter
1795 file</link>) can be used to re-write the raw page content, including
1796 viewable text as well as embedded HTML and JavaScript, and whatever else
1797 lurks on any given web page. The filtering jobs are only pre-defined here;
1798 whether to apply them or not is up to the actions files.
1799 <filename>default.filter</filename> includes various filters made
1800 available for use by the developers. Some are much more intrusive than
1801 others, and all should be used with caution. You may define additional
1802 filter files in <filename>config</filename> as you can with
1803 actions files. We suggest <filename>user.filter</filename> for any
1804 locally defined filters or customizations.
1812 The syntax of the configuration and filter files may change between different
1813 Privoxy versions, unfortunately some enhancements cost backwards compatibility.
1814 <!-- Add link to documentation-->
1818 All files use the <quote><literal>#</literal></quote> character to denote a
1819 comment (the rest of the line will be ignored) and understand line continuation
1820 through placing a backslash ("<literal>\</literal>") as the very last character
1821 in a line. If the <literal>#</literal> is preceded by a backslash, it looses
1822 its special function. Placing a <literal>#</literal> in front of an otherwise
1823 valid configuration line to prevent it from being interpreted is called "commenting
1824 out" that line. Blank lines are ignored.
1828 The actions files and filter files
1829 can use Perl style <link linkend="regex">regular expressions</link> for
1830 maximum flexibility.
1834 After making any changes, there is no need to restart
1835 <application>Privoxy</application> in order for the changes to take
1836 effect. <application>Privoxy</application> detects such changes
1837 automatically. Note, however, that it may take one or two additional
1838 requests for the change to take effect. When changing the listening address
1839 of <application>Privoxy</application>, these <quote>wake up</quote> requests
1840 must obviously be sent to the <emphasis>old</emphasis> listening address.
1845 While under development, the configuration content is subject to change.
1846 The below documentation may not be accurate by the time you read this.
1847 Also, what constitutes a <quote>default</quote> setting, may change, so
1848 please check all your configuration files on important issues.
1854 <!-- ~ End section ~ -->
1857 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
1859 <!-- **************************************************** -->
1860 <!-- Include config.sgml here -->
1861 <!-- This is where the entire config file is detailed. -->
1863 <!-- end include -->
1866 <!-- ~ End section ~ -->
1870 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
1872 <sect1 id="actions-file"><title>Actions Files</title>
1875 The actions files are used to define what <emphasis>actions</emphasis>
1876 <application>Privoxy</application> takes for which URLs, and thus determines
1877 how ad images, cookies and various other aspects of HTTP content and
1878 transactions are handled, and on which sites (or even parts thereof).
1879 There are a number of such actions, with a wide range of functionality.
1880 Each action does something a little different.
1881 These actions give us a veritable arsenal of tools with which to exert
1882 our control, preferences and independence. Actions can be combined so that
1883 their effects are aggregated when applied against a given set of URLs.
1887 are three action files included with <application>Privoxy</application> with
1895 <filename>default.action</filename> - is the primary action file
1896 that sets the initial values for all actions. It is intended to
1897 provide a base level of functionality for
1898 <application>Privoxy's</application> array of features. So it is
1899 a set of broad rules that should work reasonably well as-is for most users.
1900 This is the file that the developers are keeping updated, and <link
1901 linkend="installation-keepupdated">making available to users</link>.
1902 The user's preferences as set in <filename>standard.action</filename>,
1903 e.g. either <literal>Cautious</literal> (the default),
1904 <literal>Medium</literal>, or <literal>Advanced</literal> (see
1910 <filename>user.action</filename> - is intended to be for local site
1911 preferences and exceptions. As an example, if your ISP or your bank
1912 has specific requirements, and need special handling, this kind of
1913 thing should go here. This file will not be upgraded.
1918 <filename>standard.action</filename> - is used only by the web based editor
1919 at <ulink url="http://config.privoxy.org/edit-actions-list?f=default">
1920 http://config.privoxy.org/edit-actions-list?f=default</ulink>,
1921 to set various pre-defined sets of rules for the default actions section
1922 in <filename>default.action</filename>.
1925 <guibutton>Edit</guibutton> <guibutton>Set to Cautious</guibutton> <guibutton>Set to Medium</guibutton> <guibutton>Set to Advanced</guibutton>
1928 These have increasing levels of aggressiveness <emphasis>and have no
1929 influence on your browsing unless you select them explicitly in the
1930 editor</emphasis>. A default installation should be pre-set to
1931 <literal>Cautious</literal> (versions prior to 3.0.5 were set to
1932 <literal>Medium</literal>). New users should try this for a while before
1933 adjusting the settings to more aggressive levels. The more aggressive
1934 the settings, then the more likelihood there is of problems such as sites
1935 not working as they should.
1938 The <guibutton>Edit</guibutton> button allows you to turn each
1939 action on/off individually for fine-tuning. The <guibutton>Cautious</guibutton>
1940 button changes the actions list to low/safe settings which will activate
1941 ad blocking and a minimal set of &my-app;'s features, and subsequently
1942 there will be less of a chance for accidental problems. The
1943 <guibutton>Medium</guibutton> button sets the list to a medium level of
1944 other features and a low level set of privacy features. The
1945 <guibutton>Advanced</guibutton> button sets the list to a high level of
1946 ad blocking and medium level of privacy. See the chart below. The latter
1947 three buttons over-ride any changes via with the
1948 <guibutton>Edit</guibutton> button. More fine-tuning can be done in the
1949 lower sections of this internal page.
1952 It is not recommend to edit the <filename>standard.action</filename> file
1956 The default profiles, and their associated actions, as pre-defined in
1957 <filename>standard.action</filename> are<!-- different than this table which is out of date -->:
1960 <table frame=all><title>Default Configurations</title>
1961 <tgroup cols=4 align=left colsep=1 rowsep=1>
1962 <colspec colname=c1>
1963 <colspec colname=c2>
1964 <colspec colname=c3>
1965 <colspec colname=c4>
1968 <entry>Feature</entry>
1969 <entry>Cautious</entry>
1970 <entry>Medium</entry>
1971 <entry>Advanced</entry>
1976 <!-- <entry>f1</entry> -->
1977 <!-- <entry>f2</entry> -->
1978 <!-- <entry>f3</entry> -->
1979 <!-- <entry>f4</entry> -->
1985 <entry>Ad-blocking Aggressiveness</entry>
1986 <entry>medium</entry>
1992 <entry>Ad-filtering by size</entry>
1999 <entry>Ad-filtering by link</entry>
2005 <entry>Pop-up killing</entry>
2006 <entry>blocks only</entry>
2007 <entry>blocks only</entry>
2008 <entry>blocks only</entry>
2012 <entry>Privacy Features</entry>
2014 <entry>medium</entry>
2015 <entry>medium/high</entry>
2019 <entry>Cookie handling</entry>
2021 <entry>session-only</entry>
2026 <entry>Referer forging</entry>
2034 <entry>GIF de-animation</entry>
2042 <entry>Fast redirects</entry>
2049 <entry>HTML taming</entry>
2056 <entry>JavaScript taming</entry>
2063 <entry>Web-bug killing</entry>
2070 <entry>Image tag reordering</entry>
2086 The list of actions files to be used are defined in the main configuration
2087 file, and are processed in the order they are defined (e.g.
2088 <filename>default.action</filename> is typically processed before
2089 <filename>user.action</filename>). The content of these can all be viewed and
2091 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
2092 The over-riding principle when applying actions, is that the last action that
2093 matches a given URL wins. The broadest, most general rules go first
2094 (defined in <filename>default.action</filename>),
2095 followed by any exceptions (typically also in
2096 <filename>default.action</filename>), which are then followed lastly by any
2097 local preferences (typically in <emphasis>user</emphasis><filename>.action</filename>).
2098 Generally, <filename>user.action</filename> has the last word.
2102 An actions file typically has multiple sections. If you want to use
2103 <quote>aliases</quote> in an actions file, you have to place the (optional)
2104 <link linkend="aliases">alias section</link> at the top of that file.
2105 Then comes the default set of rules which will apply universally to all
2106 sites and pages (be <emphasis>very careful</emphasis> with using such a
2107 universal set in <filename>user.action</filename> or any other actions file after
2108 <filename>default.action</filename>, because it will override the result
2109 from consulting any previous file). And then below that,
2110 exceptions to the defined universal policies. You can regard
2111 <filename>user.action</filename> as an appendix to <filename>default.action</filename>,
2112 with the advantage that it is a separate file, which makes preserving your
2113 personal settings across <application>Privoxy</application> upgrades easier.
2117 Actions can be used to block anything you want, including ads, banners, or
2118 just some obnoxious URL whose content you would rather not see. Cookies can be accepted
2119 or rejected, or accepted only during the current browser session (i.e. not
2120 written to disk), content can be modified, some JavaScripts tamed, user-tracking
2121 fooled, and much more. See below for a <link linkend="actions">complete list
2125 <!-- ~~~~~ New section ~~~~~ -->
2127 <title>Finding the Right Mix</title>
2129 Note that some <link linkend="actions">actions</link>, like cookie suppression
2130 or script disabling, may render some sites unusable that rely on these
2131 techniques to work properly. Finding the right mix of actions is not always easy and
2132 certainly a matter of personal taste. And, things can always change, requiring
2133 refinements in the configuration. In general, it can be said that the more
2134 <quote>aggressive</quote> your default settings (in the top section of the
2135 actions file) are, the more exceptions for <quote>trusted</quote> sites you
2136 will have to make later. If, for example, you want to crunch all cookies per
2137 default, you'll have to make exceptions from that rule for sites that you
2138 regularly use and that require cookies for actually useful purposes, like maybe
2139 your bank, favorite shop, or newspaper.
2143 We have tried to provide you with reasonable rules to start from in the
2144 distribution actions files. But there is no general rule of thumb on these
2145 things. There just are too many variables, and sites are constantly changing.
2146 Sooner or later you will want to change the rules (and read this chapter again :).
2150 <!-- ~~~~~ New section ~~~~~ -->
2152 <title>How to Edit</title>
2154 The easiest way to edit the actions files is with a browser by
2155 using our browser-based editor, which can be reached from <ulink
2156 url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>.
2157 Note: the config file option <link
2158 linkend="enable-edit-actions">enable-edit-actions</link> must be enabled for
2159 this to work. The editor allows both fine-grained control over every single
2160 feature on a per-URL basis, and easy choosing from wholesale sets of defaults
2161 like <quote>Cautious</quote>, <quote>Medium</quote> or
2162 <quote>Advanced</quote>. Warning: the <quote>Advanced</quote> setting is more
2163 aggressive, and will be more likely to cause problems for some sites.
2164 Experienced users only!
2168 If you prefer plain text editing to GUIs, you can of course also directly edit the
2169 the actions files with your favorite text editor. Look at
2170 <filename>default.action</filename> which is richly commented with many
2176 <sect2 id="actions-apply">
2177 <title>How Actions are Applied to Requests</title>
2179 Actions files are divided into sections. There are special sections,
2180 like the <quote><link linkend="aliases">alias</link></quote> sections which will
2181 be discussed later. For now let's concentrate on regular sections: They have a
2182 heading line (often split up to multiple lines for readability) which consist
2183 of a list of actions, separated by whitespace and enclosed in curly braces.
2184 Below that, there is a list of URL and tag patterns, each on a separate line.
2188 To determine which actions apply to a request, the URL of the request is
2189 compared to all URL patterns in each <quote>action file</quote>.
2190 Every time it matches, the list of applicable actions for the request is
2191 incrementally updated, using the heading of the section in which the
2192 pattern is located. The same is done again for tags and tag patterns later on.
2196 If multiple applying sections set the same action differently,
2197 the last match wins. If not, the effects are aggregated.
2198 E.g. a URL might match a regular section with a heading line of <literal>{
2199 +<link linkend="handle-as-image">handle-as-image</link> }</literal>,
2200 then later another one with just <literal>{
2201 +<link linkend="block">block</link> }</literal>, resulting
2202 in <emphasis>both</emphasis> actions to apply. And there may well be
2203 cases where you will want to combine actions together. Such a section then
2209 { +<literal>handle-as-image</literal> +<literal>block{Banner ads.}</literal> }
2210 # Block these as if they were images. Send no block page.
2212 media.example.com/.*banners
2213 .example.com/images/ads/</screen>
2217 You can trace this process for URL patterns and any given URL by visiting <ulink
2218 url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>.
2222 Examples and more detail on this is provided in the Appendix, <link linkend="ACTIONSANAT">
2223 Troubleshooting: Anatomy of an Action</link> section.
2227 <!-- ~~~~~ New section ~~~~~ -->
2228 <sect2 id="af-patterns">
2229 <title>Patterns</title>
2231 As mentioned, <application>Privoxy</application> uses <quote>patterns</quote>
2232 to determine what <emphasis>actions</emphasis> might apply to which sites and
2233 pages your browser attempts to access. These <quote>patterns</quote> use wild
2234 card type <emphasis>pattern</emphasis> matching to achieve a high degree of
2235 flexibility. This allows one expression to be expanded and potentially match
2236 against many similar patterns.
2240 Generally, an URL pattern has the form
2241 <literal><domain>/<path></literal>, where both the
2242 <literal><domain></literal> and <literal><path></literal> are
2243 optional. (This is why the special <literal>/</literal> pattern matches all
2244 URLs). Note that the protocol portion of the URL pattern (e.g.
2245 <literal>http://</literal>) should <emphasis>not</emphasis> be included in
2246 the pattern. This is assumed already!
2249 The pattern matching syntax is different for the domain and path parts of
2250 the URL. The domain part uses a simple globbing type matching technique,
2251 while the path part uses a more flexible
2252 <ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
2253 Expressions (PCRE)</quote></ulink> based syntax.
2258 <term><literal>www.example.com/</literal></term>
2261 is a domain-only pattern and will match any request to <literal>www.example.com</literal>,
2262 regardless of which document on that server is requested. So ALL pages in
2263 this domain would be covered by the scope of this action. Note that a
2264 simple <literal>example.com</literal> is different and would NOT match.
2269 <term><literal>www.example.com</literal></term>
2272 means exactly the same. For domain-only patterns, the trailing <literal>/</literal> may
2278 <term><literal>www.example.com/index.html$</literal></term>
2281 matches all the documents on <literal>www.example.com</literal>
2282 whose name starts with <literal>/index.html</literal>.
2287 <term><literal>www.example.com/index.html$</literal></term>
2290 matches only the single document <literal>/index.html</literal>
2291 on <literal>www.example.com</literal>.
2296 <term><literal>/index.html$</literal></term>
2299 matches the document <literal>/index.html</literal>, regardless of the domain,
2300 i.e. on <emphasis>any</emphasis> web server anywhere.
2305 <term><literal>index.html</literal></term>
2308 matches nothing, since it would be interpreted as a domain name and
2309 there is no top-level domain called <literal>.html</literal>. So its
2317 <!-- ~~~~~ New section ~~~~~ -->
2318 <sect3><title>The Domain Pattern</title>
2321 The matching of the domain part offers some flexible options: if the
2322 domain starts or ends with a dot, it becomes unanchored at that end.
2328 <term><literal>.example.com</literal></term>
2331 matches any domain with first-level domain <literal>com</literal>
2332 and second-level domain <literal>example</literal>.
2333 For example <literal>www.example.com</literal>,
2334 <literal>example.com</literal> and <literal>foo.bar.baz.example.com</literal>.
2335 Note that it wouldn't match if the second-level domain was <literal>another-example</literal>.
2340 <term><literal>www.</literal></term>
2343 matches any domain that <emphasis>STARTS</emphasis> with
2344 <literal>www.</literal> (It also matches the domain
2345 <literal>www</literal> but most of the time that doesn't matter.)
2350 <term><literal>.example.</literal></term>
2353 matches any domain that <emphasis>CONTAINS</emphasis> <literal>.example.</literal>.
2354 And, by the way, also included would be any files or documents that exist
2355 within that domain since no path limitations are specified. (Correctly
2356 speaking: It matches any FQDN that contains <literal>example</literal> as
2357 a domain.) This might be <literal>www.example.com</literal>,
2358 <literal>news.example.de</literal>, or
2359 <literal>www.example.net/cgi/testing.pl</literal> for instance. All these
2367 Additionally, there are wild-cards that you can use in the domain names
2368 themselves. These work similarly to shell globbing type wild-cards:
2369 <quote>*</quote> represents zero or more arbitrary characters (this is
2371 <ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
2372 Expression</quote></ulink> based syntax of <quote>.*</quote>),
2373 <quote>?</quote> represents any single character (this is equivalent to the
2374 regular expression syntax of a simple <quote>.</quote>), and you can define
2375 <quote>character classes</quote> in square brackets which is similar to
2376 the same regular expression technique. All of this can be freely mixed:
2381 <term><literal>ad*.example.com</literal></term>
2384 matches <quote>adserver.example.com</quote>,
2385 <quote>ads.example.com</quote>, etc but not <quote>sfads.example.com</quote>
2390 <term><literal>*ad*.example.com</literal></term>
2393 matches all of the above, and then some.
2398 <term><literal>.?pix.com</literal></term>
2401 matches <literal>www.ipix.com</literal>,
2402 <literal>pictures.epix.com</literal>, <literal>a.b.c.d.e.upix.com</literal> etc.
2407 <term><literal>www[1-9a-ez].example.c*</literal></term>
2410 matches <literal>www1.example.com</literal>,
2411 <literal>www4.example.cc</literal>, <literal>wwwd.example.cy</literal>,
2412 <literal>wwwz.example.com</literal> etc., but <emphasis>not</emphasis>
2413 <literal>wwww.example.com</literal>.
2420 While flexible, this is not the sophistication of full regular expression based syntax.
2425 <!-- ~ End section ~ -->
2428 <!-- ~~~~~ New section ~~~~~ -->
2429 <sect3><title>The Path Pattern</title>
2432 <application>Privoxy</application> uses Perl compatible (PCRE)
2433 <ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
2434 Expression</quote></ulink> based syntax
2435 (through the <ulink url="http://www.pcre.org/">PCRE</ulink> library) for
2436 matching the path portion (after the slash), and is thus more flexible.
2440 There is an <link linkend="regex">Appendix</link> with a brief quick-start into regular
2441 expressions, and full (very technical) documentation on PCRE regex syntax is available on-line
2442 at <ulink url="http://www.pcre.org/man.txt">http://www.pcre.org/man.txt</ulink>.
2443 You might also find the Perl man page on regular expressions (<literal>man perlre</literal>)
2444 useful, which is available on-line at <ulink
2445 url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>.
2449 Note that the path pattern is automatically left-anchored at the <quote>/</quote>,
2450 i.e. it matches as if it would start with a <quote>^</quote> (regular expression speak
2451 for the beginning of a line).
2455 Please also note that matching in the path is <emphasis>CASE INSENSITIVE</emphasis>
2456 by default, but you can switch to case sensitive at any point in the pattern by using the
2457 <quote>(?-i)</quote> switch: <literal>www.example.com/(?-i)PaTtErN.*</literal> will match
2458 only documents whose path starts with <literal>PaTtErN</literal> in
2459 <emphasis>exactly</emphasis> this capitalization.
2464 <term><literal>.example.com/.*</literal></term>
2467 Is equivalent to just <quote>.example.com</quote>, since any documents
2468 within that domain are matched with or without the <quote>.*</quote>
2469 regular expression. This is redundant
2474 <term><literal>.example.com/.*/index.html$</literal></term>
2477 Will match any page in the domain of <quote>example.com</quote> that is
2478 named <quote>index.html</quote>, and that is part of some path. For
2479 example, it matches <quote>www.example.com/testing/index.html</quote> but
2480 NOT <quote>www.example.com/index.html</quote> because the regular
2481 expression called for at least two <quote>/'s</quote>, thus the path
2482 requirement. It also would match
2483 <quote>www.example.com/testing/index_html</quote>, because of the
2484 special meta-character <quote>.</quote>.
2489 <term><literal>.example.com/(.*/)?index\.html$</literal></term>
2492 This regular expression is conditional so it will match any page
2493 named <quote>index.html</quote> regardless of path which in this case can
2494 have one or more <quote>/'s</quote>. And this one must contain exactly
2495 <quote>.html</quote> (but does not have to end with that!).
2500 <term><literal>.example.com/(.*/)(ads|banners?|junk)</literal></term>
2503 This regular expression will match any path of <quote>example.com</quote>
2504 that contains any of the words <quote>ads</quote>, <quote>banner</quote>,
2505 <quote>banners</quote> (because of the <quote>?</quote>) or <quote>junk</quote>.
2506 The path does not have to end in these words, just contain them.
2511 <term><literal>.example.com/(.*/)(ads|banners?|junk)/.*\.(jpe?g|gif|png)$</literal></term>
2514 This is very much the same as above, except now it must end in either
2515 <quote>.jpg</quote>, <quote>.jpeg</quote>, <quote>.gif</quote> or <quote>.png</quote>. So this
2516 one is limited to common image formats.
2523 There are many, many good examples to be found in <filename>default.action</filename>,
2524 and more tutorials below in <link linkend="regex">Appendix on regular expressions</link>.
2529 <!-- ~ End section ~ -->
2532 <!-- ~~~~~ New section ~~~~~ -->
2533 <sect3 id="tag-pattern"><title>The Tag Pattern</title>
2536 Tag patterns are used to change the applying actions based on the
2537 request's tags. Tags can be created with either the
2538 <link linkend="CLIENT-HEADER-TAGGER">client-header-tagger</link>
2539 or the <link linkend="SERVER-HEADER-TAGGER">server-header-tagger</link> action.
2543 Tag patterns have to start with <quote>TAG:</quote>, so &my-app;
2544 can tell them apart from URL patterns. Everything after the colon
2545 including white space, is interpreted as a regular expression with
2546 path pattern syntax, except that tag patterns aren't left-anchored
2547 automatically (&my-app; doesn't silently add a <quote>^</quote>,
2548 you have to do it yourself if you need it).
2552 To match all requests that are tagged with <quote>foo</quote>
2553 your pattern line should be <quote>TAG:^foo$</quote>,
2554 <quote>TAG:foo</quote> would work as well, but it would also
2555 match requests whose tags contain <quote>foo</quote> somewhere.
2556 <quote>TAG: foo</quote> wouldn't work as it requires white space.
2560 Sections can contain URL and tag patterns at the same time,
2561 but tag patterns are checked after the URL patterns and thus
2562 always overrule them, even if they are located before the URL patterns.
2566 Once a new tag is added, Privoxy checks right away if it's matched by one
2567 of the tag patterns and updates the action settings accordingly. As a result
2568 tags can be used to activate other tagger actions, as long as these other
2569 taggers look for headers that haven't already be parsed.
2573 For example you could tag client requests which use the
2574 <literal>POST</literal> method,
2575 then use this tag to activate another tagger that adds a tag if cookies
2576 are sent, and then use a block action based on the cookie tag. This allows
2577 the outcome of one action, to be input into a subsequent action. However if
2578 you'd reverse the position of the described taggers, and activated the
2579 method tagger based on the cookie tagger, no method tags would be created.
2580 The method tagger would look for the request line, but at the time
2581 the cookie tag is created, the request line has already been parsed.
2585 While this is a limitation you should be aware of, this kind of
2586 indirection is seldom needed anyway and even the example doesn't
2587 make too much sense.
2594 <!-- ~ End section ~ -->
2597 <!-- ~~~~~ New section ~~~~~ -->
2599 <sect2 id="actions">
2600 <title>Actions</title>
2602 All actions are disabled by default, until they are explicitly enabled
2603 somewhere in an actions file. Actions are turned on if preceded with a
2604 <quote>+</quote>, and turned off if preceded with a <quote>-</quote>. So a
2605 <literal>+action</literal> means <quote>do that action</quote>, e.g.
2606 <literal>+block</literal> means <quote>please block URLs that match the
2607 following patterns</quote>, and <literal>-block</literal> means <quote>don't
2608 block URLs that match the following patterns, even if <literal>+block</literal>
2609 previously applied.</quote>
2614 Again, actions are invoked by placing them on a line, enclosed in curly braces and
2615 separated by whitespace, like in
2616 <literal>{+some-action -some-other-action{some-parameter}}</literal>,
2617 followed by a list of URL patterns, one per line, to which they apply.
2618 Together, the actions line and the following pattern lines make up a section
2619 of the actions file.
2623 Actions fall into three categories:
2630 Boolean, i.e the action can only be <quote>enabled</quote> or
2631 <quote>disabled</quote>. Syntax:
2635 +<replaceable class="function">name</replaceable> # enable action <replaceable class="parameter">name</replaceable>
2636 -<replaceable class="function">name</replaceable> # disable action <replaceable class="parameter">name</replaceable></screen>
2639 Example: <literal>+handle-as-image</literal>
2646 Parameterized, where some value is required in order to enable this type of action.
2651 +<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # enable action and set parameter to <replaceable class="parameter">param</replaceable>,
2652 # overwriting parameter from previous match if necessary
2653 -<replaceable class="function">name</replaceable> # disable action. The parameter can be omitted</screen>
2656 Note that if the URL matches multiple positive forms of a parameterized action,
2657 the last match wins, i.e. the params from earlier matches are simply ignored.
2660 Example: <literal>+hide-user-agent{Mozilla/5.0 (X11; U; FreeBSD i386; en-US; rv:1.8.1.4) Gecko/20070602 Firefox/2.0.0.4}</literal>
2666 Multi-value. These look exactly like parameterized actions,
2667 but they behave differently: If the action applies multiple times to the
2668 same URL, but with different parameters, <emphasis>all</emphasis> the parameters
2669 from <emphasis>all</emphasis> matches are remembered. This is used for actions
2670 that can be executed for the same request repeatedly, like adding multiple
2671 headers, or filtering through multiple filters. Syntax:
2675 +<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # enable action and add <replaceable class="parameter">param</replaceable> to the list of parameters
2676 -<replaceable class="function">name</replaceable>{<replaceable class="parameter">param</replaceable>} # remove the parameter <replaceable class="parameter">param</replaceable> from the list of parameters
2677 # If it was the last one left, disable the action.
2678 <replaceable class="parameter">-name</replaceable> # disable this action completely and remove all parameters from the list</screen>
2681 Examples: <literal>+add-header{X-Fun-Header: Some text}</literal> and
2682 <literal>+filter{html-annoyances}</literal>
2690 If nothing is specified in any actions file, no <quote>actions</quote> are
2691 taken. So in this case <application>Privoxy</application> would just be a
2692 normal, non-blocking, non-filtering proxy. You must specifically enable the
2693 privacy and blocking features you need (although the provided default actions
2694 files will give a good starting point).
2698 Later defined action sections always over-ride earlier ones of the same type.
2699 So exceptions to any rules you make, should come in the latter part of the file (or
2700 in a file that is processed later when using multiple actions files such
2701 as <filename>user.action</filename>). For multi-valued actions, the actions
2702 are applied in the order they are specified. Actions files are processed in
2703 the order they are defined in <filename>config</filename> (the default
2704 installation has three actions files). It also quite possible for any given
2705 URL to match more than one <quote>pattern</quote> (because of wildcards and
2706 regular expressions), and thus to trigger more than one set of actions! Last
2710 <!-- start actions listing -->
2712 The list of valid <application>Privoxy</application> actions are:
2716 <!-- ********************************************************** -->
2717 <!-- Please note the below defined actions use id's that are -->
2718 <!-- probably linked from other places, so please don't change. -->
2720 <!-- ********************************************************** -->
2723 <!-- ~~~~~ New section ~~~~~ -->
2725 <sect3 renderas="sect4" id="add-header">
2726 <title>add-header</title>
2730 <term>Typical use:</term>
2732 <para>Confuse log analysis, custom applications</para>
2737 <term>Effect:</term>
2740 Sends a user defined HTTP header to the web server.
2747 <!-- boolean, parameterized, Multi-value -->
2749 <para>Multi-value.</para>
2754 <term>Parameter:</term>
2757 Any string value is possible. Validity of the defined HTTP headers is not checked.
2758 It is recommended that you use the <quote><literal>X-</literal></quote> prefix
2768 This action may be specified multiple times, in order to define multiple
2769 headers. This is rarely needed for the typical user. If you don't know what
2770 <quote>HTTP headers</quote> are, you definitely don't need to worry about this
2777 <term>Example usage:</term>
2780 <screen>+add-header{X-User-Tracking: sucks}</screen>
2788 <!-- ~~~~~ New section ~~~~~ -->
2789 <sect3 renderas="sect4" id="block">
2790 <title>block</title>
2794 <term>Typical use:</term>
2796 <para>Block ads or other unwanted content</para>
2801 <term>Effect:</term>
2804 Requests for URLs to which this action applies are blocked, i.e. the
2805 requests are trapped by &my-app; and the requested URL is never retrieved,
2806 but is answered locally with a substitute page or image, as determined by
2808 linkend="handle-as-image">handle-as-image</link></literal>,
2810 linkend="set-image-blocker">set-image-blocker</link></literal>, and
2812 linkend="handle-as-empty-document">handle-as-empty-document</link></literal> actions.
2820 <!-- boolean, parameterized, Multi-value -->
2822 <para>Parameterized.</para>
2827 <term>Parameter:</term>
2829 <para>A block reason that should be given to the user.</para>
2837 <application>Privoxy</application> sends a special <quote>BLOCKED</quote> page
2838 for requests to blocked pages. This page contains the block reason given as
2839 parameter, a link to find out why the block action applies, and a click-through
2840 to the blocked content (the latter only if the force feature is available and
2844 This doesn't actually work in all browser configuration and the user probably doesn't care anyway.
2846 The <quote>BLOCKED</quote> page adapts to the available
2847 screen space -- it displays full-blown if space allows, or miniaturized and text-only
2848 if loaded into a small frame or window. If you are using <application>Privoxy</application>
2849 right now, you can take a look at the
2850 <ulink url="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"><quote>BLOCKED</quote>
2855 A very important exception occurs if <emphasis>both</emphasis>
2856 <literal>block</literal> and <literal><link linkend="handle-as-image">handle-as-image</link></literal>,
2857 apply to the same request: it will then be replaced by an image. If
2858 <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>
2859 (see below) also applies, the type of image will be determined by its parameter,
2860 if not, the standard checkerboard pattern is sent.
2863 It is important to understand this process, in order
2864 to understand how <application>Privoxy</application> deals with
2865 ads and other unwanted content. Blocking is a core feature, and one
2866 upon which various other features depend.
2869 The <literal><link linkend="filter">filter</link></literal>
2870 action can perform a very similar task, by <quote>blocking</quote>
2871 banner images and other content through rewriting the relevant URLs in the
2872 document's HTML source, so they don't get requested in the first place.
2873 Note that this is a totally different technique, and it's easy to confuse the two.
2879 <term>Example usage (section):</term>
2882 <screen>{+block{No nasty stuff for you.}}
2883 # Block and replace with "blocked" page
2884 .nasty-stuff.example.com
2886 {+block{Doubleclick banners.} +handle-as-image}
2887 # Block and replace with image
2891 {+block{Layered ads.} +handle-as-empty-document}
2892 # Block and then ignore
2893 adserver.example.net/.*\.js$</screen>
2903 <!-- ~~~~~ New section ~~~~~ -->
2904 <sect3 renderas="sect4" id="client-header-filter">
2905 <title>client-header-filter</title>
2909 <term>Typical use:</term>
2912 Rewrite or remove single client headers.
2918 <term>Effect:</term>
2921 All client headers to which this action applies are filtered on-the-fly through
2922 the specified regular expression based substitutions.
2929 <!-- boolean, parameterized, Multi-value -->
2931 <para>Parameterized.</para>
2936 <term>Parameter:</term>
2939 The name of a client-header filter, as defined in one of the
2940 <link linkend="filter-file">filter files</link>.
2949 Client-header filters are applied to each header on its own, not to
2950 all at once. This makes it easier to diagnose problems, but on the downside
2951 you can't write filters that only change header x if header y's value is z.
2952 You can do that by using tags though.
2955 Client-header filters are executed after the other header actions have finished
2956 and use their output as input.
2959 If the request URL gets changed, &my-app; will detect that and use the new
2960 one. This can be used to rewrite the request destination behind the client's
2961 back, for example to specify a Tor exit relay for certain requests.
2964 Please refer to the <link linkend="filter-file">filter file chapter</link>
2965 to learn which client-header filters are available by default, and how to
2973 <term>Example usage (section):</term>
2977 # Hide Tor exit notation in Host and Referer Headers
2978 {+client-header-filter{hide-tor-exit-notation}}
2989 <!-- ~~~~~ New section ~~~~~ -->
2990 <sect3 renderas="sect4" id="client-header-tagger">
2991 <title>client-header-tagger</title>
2995 <term>Typical use:</term>
2998 Block requests based on their headers.
3004 <term>Effect:</term>
3007 Client headers to which this action applies are filtered on-the-fly through
3008 the specified regular expression based substitutions, the result is used as
3016 <!-- boolean, parameterized, Multi-value -->
3018 <para>Parameterized.</para>
3023 <term>Parameter:</term>
3026 The name of a client-header tagger, as defined in one of the
3027 <link linkend="filter-file">filter files</link>.
3036 Client-header taggers are applied to each header on its own,
3037 and as the header isn't modified, each tagger <quote>sees</quote>
3041 Client-header taggers are the first actions that are executed
3042 and their tags can be used to control every other action.
3048 <term>Example usage (section):</term>
3052 # Tag every request with the User-Agent header
3053 {+client-header-tagger{user-agent}}
3056 # Tagging itself doesn't change the action
3057 # settings, sections with TAG patterns do:
3059 # If it's a download agent, use a different forwarding proxy,
3060 # show the real User-Agent and make sure resume works.
3061 {+forward-override{forward-socks5 10.0.0.2:2222 .} \
3062 -hide-if-modified-since \
3063 -overwrite-last-modified \
3068 TAG:^User-Agent: NetBSD-ftp/
3069 TAG:^User-Agent: Novell ZYPP Installer
3070 TAG:^User-Agent: RPM APT-HTTP/
3071 TAG:^User-Agent: fetch libfetch/
3072 TAG:^User-Agent: Ubuntu APT-HTTP/
3073 TAG:^User-Agent: MPlayer/
3083 <!-- ~~~~~ New section ~~~~~ -->
3084 <sect3 renderas="sect4" id="content-type-overwrite">
3085 <title>content-type-overwrite</title>
3089 <term>Typical use:</term>
3091 <para>Stop useless download menus from popping up, or change the browser's rendering mode</para>
3096 <term>Effect:</term>
3099 Replaces the <quote>Content-Type:</quote> HTTP server header.
3106 <!-- Boolean, Parameterized, Multi-value -->
3108 <para>Parameterized.</para>
3113 <term>Parameter:</term>
3125 The <quote>Content-Type:</quote> HTTP server header is used by the
3126 browser to decide what to do with the document. The value of this
3127 header can cause the browser to open a download menu instead of
3128 displaying the document by itself, even if the document's format is
3129 supported by the browser.
3132 The declared content type can also affect which rendering mode
3133 the browser chooses. If XHTML is delivered as <quote>text/html</quote>,
3134 many browsers treat it as yet another broken HTML document.
3135 If it is send as <quote>application/xml</quote>, browsers with
3136 XHTML support will only display it, if the syntax is correct.
3139 If you see a web site that proudly uses XHTML buttons, but sets
3140 <quote>Content-Type: text/html</quote>, you can use &my-app;
3141 to overwrite it with <quote>application/xml</quote> and validate
3142 the web master's claim inside your XHTML-supporting browser.
3143 If the syntax is incorrect, the browser will complain loudly.
3146 You can also go the opposite direction: if your browser prints
3147 error messages instead of rendering a document falsely declared
3148 as XHTML, you can overwrite the content type with
3149 <quote>text/html</quote> and have it rendered as broken HTML document.
3152 By default <literal>content-type-overwrite</literal> only replaces
3153 <quote>Content-Type:</quote> headers that look like some kind of text.
3154 If you want to overwrite it unconditionally, you have to combine it with
3155 <literal><link linkend="force-text-mode">force-text-mode</link></literal>.
3156 This limitation exists for a reason, think twice before circumventing it.
3159 Most of the time it's easier to replace this action with a custom
3160 <literal><link linkend="server-header-filter">server-header filter</link></literal>.
3161 It allows you to activate it for every document of a certain site and it will still
3162 only replace the content types you aimed at.
3165 Of course you can apply <literal>content-type-overwrite</literal>
3166 to a whole site and then make URL based exceptions, but it's a lot
3167 more work to get the same precision.
3173 <term>Example usage (sections):</term>
3176 <screen># Check if www.example.net/ really uses valid XHTML
3177 { +content-type-overwrite{application/xml} }
3180 # but leave the content type unmodified if the URL looks like a style sheet
3181 {-content-type-overwrite}
3182 www.example.net/.*\.css$
3183 www.example.net/.*style
3192 <!-- ~~~~~ New section ~~~~~ -->
3193 <sect3 renderas="sect4" id="crunch-client-header">
3197 <title>crunch-client-header</title>
3201 <term>Typical use:</term>
3203 <para>Remove a client header <application>Privoxy</application> has no dedicated action for.</para>
3208 <term>Effect:</term>
3211 Deletes every header sent by the client that contains the string the user supplied as parameter.
3218 <!-- Boolean, Parameterized, Multi-value -->
3220 <para>Parameterized.</para>
3225 <term>Parameter:</term>
3237 This action allows you to block client headers for which no dedicated
3238 <application>Privoxy</application> action exists.
3239 <application>Privoxy</application> will remove every client header that
3240 contains the string you supplied as parameter.
3243 Regular expressions are <emphasis>not supported</emphasis> and you can't
3244 use this action to block different headers in the same request, unless
3245 they contain the same string.
3248 <literal>crunch-client-header</literal> is only meant for quick tests.
3249 If you have to block several different headers, or only want to modify
3250 parts of them, you should use a
3251 <literal><link linkend="client-header-filter">client-header filter</link></literal>.
3255 Don't block any header without understanding the consequences.
3262 <term>Example usage (section):</term>
3265 <screen># Block the non-existent "Privacy-Violation:" client header
3266 { +crunch-client-header{Privacy-Violation:} }
3276 <!-- ~~~~~ New section ~~~~~ -->
3277 <sect3 renderas="sect4" id="crunch-if-none-match">
3278 <title>crunch-if-none-match</title>
3284 <term>Typical use:</term>
3286 <para>Prevent yet another way to track the user's steps between sessions.</para>
3291 <term>Effect:</term>
3294 Deletes the <quote>If-None-Match:</quote> HTTP client header.
3301 <!-- Boolean, Parameterized, Multi-value -->
3303 <para>Boolean.</para>
3308 <term>Parameter:</term>
3320 Removing the <quote>If-None-Match:</quote> HTTP client header
3321 is useful for filter testing, where you want to force a real
3322 reload instead of getting status code <quote>304</quote> which
3323 would cause the browser to use a cached copy of the page.
3326 It is also useful to make sure the header isn't used as a cookie
3327 replacement (unlikely but possible).
3330 Blocking the <quote>If-None-Match:</quote> header shouldn't cause any
3331 caching problems, as long as the <quote>If-Modified-Since:</quote> header
3332 isn't blocked or missing as well.
3335 It is recommended to use this action together with
3336 <literal><link linkend="hide-if-modified-since">hide-if-modified-since</link></literal>
3338 <literal><link linkend="overwrite-last-modified">overwrite-last-modified</link></literal>.
3344 <term>Example usage (section):</term>
3347 <screen># Let the browser revalidate cached documents but don't
3348 # allow the server to use the revalidation headers for user tracking.
3349 {+hide-if-modified-since{-60} \
3350 +overwrite-last-modified{randomize} \
3351 +crunch-if-none-match}
3360 <!-- ~~~~~ New section ~~~~~ -->
3361 <sect3 renderas="sect4" id="crunch-incoming-cookies">
3362 <title>crunch-incoming-cookies</title>
3366 <term>Typical use:</term>
3369 Prevent the web server from setting HTTP cookies on your system
3375 <term>Effect:</term>
3378 Deletes any <quote>Set-Cookie:</quote> HTTP headers from server replies.
3385 <!-- Boolean, Parameterized, Multi-value -->
3387 <para>Boolean.</para>
3392 <term>Parameter:</term>
3404 This action is only concerned with <emphasis>incoming</emphasis> HTTP cookies. For
3405 <emphasis>outgoing</emphasis> HTTP cookies, use
3406 <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>.
3407 Use <emphasis>both</emphasis> to disable HTTP cookies completely.
3410 It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
3411 with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
3412 since it would prevent the session cookies from being set. See also
3413 <literal><link linkend="filter-content-cookies">filter-content-cookies</link></literal>.
3419 <term>Example usage:</term>
3422 <screen>+crunch-incoming-cookies</screen>
3430 <!-- ~~~~~ New section ~~~~~ -->
3431 <sect3 renderas="sect4" id="crunch-server-header">
3432 <title>crunch-server-header</title>
3438 <term>Typical use:</term>
3440 <para>Remove a server header <application>Privoxy</application> has no dedicated action for.</para>
3445 <term>Effect:</term>
3448 Deletes every header sent by the server that contains the string the user supplied as parameter.
3455 <!-- Boolean, Parameterized, Multi-value -->
3457 <para>Parameterized.</para>
3462 <term>Parameter:</term>
3474 This action allows you to block server headers for which no dedicated
3475 <application>Privoxy</application> action exists. <application>Privoxy</application>
3476 will remove every server header that contains the string you supplied as parameter.
3479 Regular expressions are <emphasis>not supported</emphasis> and you can't
3480 use this action to block different headers in the same request, unless
3481 they contain the same string.
3484 <literal>crunch-server-header</literal> is only meant for quick tests.
3485 If you have to block several different headers, or only want to modify
3486 parts of them, you should use a custom
3487 <literal><link linkend="server-header-filter">server-header filter</link></literal>.
3491 Don't block any header without understanding the consequences.
3498 <term>Example usage (section):</term>
3501 <screen># Crunch server headers that try to prevent caching
3502 { +crunch-server-header{no-cache} }
3511 <!-- ~~~~~ New section ~~~~~ -->
3512 <sect3 renderas="sect4" id="crunch-outgoing-cookies">
3513 <title>crunch-outgoing-cookies</title>
3517 <term>Typical use:</term>
3520 Prevent the web server from reading any HTTP cookies from your system
3526 <term>Effect:</term>
3529 Deletes any <quote>Cookie:</quote> HTTP headers from client requests.
3536 <!-- Boolean, Parameterized, Multi-value -->
3538 <para>Boolean.</para>
3543 <term>Parameter:</term>
3555 This action is only concerned with <emphasis>outgoing</emphasis> HTTP cookies. For
3556 <emphasis>incoming</emphasis> HTTP cookies, use
3557 <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal>.
3558 Use <emphasis>both</emphasis> to disable HTTP cookies completely.
3561 It makes <emphasis>no sense at all</emphasis> to use this action in conjunction
3562 with the <literal><link linkend="session-cookies-only">session-cookies-only</link></literal> action,
3563 since it would prevent the session cookies from being read.
3569 <term>Example usage:</term>
3572 <screen>+crunch-outgoing-cookies</screen>
3581 <!-- ~~~~~ New section ~~~~~ -->
3582 <sect3 renderas="sect4" id="deanimate-gifs">
3583 <title>deanimate-gifs</title>
3587 <term>Typical use:</term>
3589 <para>Stop those annoying, distracting animated GIF images.</para>
3594 <term>Effect:</term>
3597 De-animate GIF animations, i.e. reduce them to their first or last image.
3604 <!-- boolean, parameterized, Multi-value -->
3606 <para>Parameterized.</para>
3611 <term>Parameter:</term>
3614 <quote>last</quote> or <quote>first</quote>
3623 This will also shrink the images considerably (in bytes, not pixels!). If
3624 the option <quote>first</quote> is given, the first frame of the animation
3625 is used as the replacement. If <quote>last</quote> is given, the last
3626 frame of the animation is used instead, which probably makes more sense for
3627 most banner animations, but also has the risk of not showing the entire
3628 last frame (if it is only a delta to an earlier frame).
3631 You can safely use this action with patterns that will also match non-GIF
3632 objects, because no attempt will be made at anything that doesn't look like
3639 <term>Example usage:</term>
3642 <screen>+deanimate-gifs{last}</screen>
3649 <!-- ~~~~~ New section ~~~~~ -->
3650 <sect3 renderas="sect4" id="downgrade-http-version">
3651 <title>downgrade-http-version</title>
3655 <term>Typical use:</term>
3657 <para>Work around (very rare) problems with HTTP/1.1</para>
3662 <term>Effect:</term>
3665 Downgrades HTTP/1.1 client requests and server replies to HTTP/1.0.
3672 <!-- boolean, parameterized, Multi-value -->
3674 <para>Boolean.</para>
3679 <term>Parameter:</term>
3691 This is a left-over from the time when <application>Privoxy</application>
3692 didn't support important HTTP/1.1 features well. It is left here for the
3693 unlikely case that you experience HTTP/1.1 related problems with some server
3694 out there. Not all HTTP/1.1 features and requirements are supported yet,
3695 so there is a chance you might need this action.
3701 <term>Example usage (section):</term>
3704 <screen>{+downgrade-http-version}
3705 problem-host.example.com</screen>
3713 <!-- ~~~~~ New section ~~~~~ -->
3714 <sect3 renderas="sect4" id="fast-redirects">
3715 <title>fast-redirects</title>
3719 <term>Typical use:</term>
3721 <para>Fool some click-tracking scripts and speed up indirect links.</para>
3726 <term>Effect:</term>
3729 Detects redirection URLs and redirects the browser without contacting
3730 the redirection server first.
3737 <!-- boolean, parameterized, Multi-value -->
3739 <para>Parameterized.</para>
3744 <term>Parameter:</term>
3749 <quote>simple-check</quote> to just search for the string <quote>http://</quote>
3750 to detect redirection URLs.
3755 <quote>check-decoded-url</quote> to decode URLs (if necessary) before searching
3756 for redirection URLs.
3767 Many sites, like yahoo.com, don't just link to other sites. Instead, they
3768 will link to some script on their own servers, giving the destination as a
3769 parameter, which will then redirect you to the final target. URLs
3770 resulting from this scheme typically look like:
3771 <quote>http://www.example.org/click-tracker.cgi?target=http%3a//www.example.net/</quote>.
3774 Sometimes, there are even multiple consecutive redirects encoded in the
3775 URL. These redirections via scripts make your web browsing more traceable,
3776 since the server from which you follow such a link can see where you go
3777 to. Apart from that, valuable bandwidth and time is wasted, while your
3778 browser asks the server for one redirect after the other. Plus, it feeds
3782 This feature is currently not very smart and is scheduled for improvement.
3783 If it is enabled by default, you will have to create some exceptions to
3784 this action. It can lead to failures in several ways:
3787 Not every URLs with other URLs as parameters is evil.
3788 Some sites offer a real service that requires this information to work.
3789 For example a validation service needs to know, which document to validate.
3790 <literal>fast-redirects</literal> assumes that every URL parameter that
3791 looks like another URL is a redirection target, and will always redirect to
3792 the last one. Most of the time the assumption is correct, but if it isn't,
3793 the user gets redirected anyway.
3796 Another failure occurs if the URL contains other parameters after the URL parameter.
3798 <quote>http://www.example.org/?redirect=http%3a//www.example.net/&foo=bar</quote>.
3799 contains the redirection URL <quote>http://www.example.net/</quote>,
3800 followed by another parameter. <literal>fast-redirects</literal> doesn't know that
3801 and will cause a redirect to <quote>http://www.example.net/&foo=bar</quote>.
3802 Depending on the target server configuration, the parameter will be silently ignored
3803 or lead to a <quote>page not found</quote> error. You can prevent this problem by
3804 first using the <literal><link linkend="redirect">redirect</link></literal> action
3805 to remove the last part of the URL, but it requires a little effort.
3808 To detect a redirection URL, <literal>fast-redirects</literal> only
3809 looks for the string <quote>http://</quote>, either in plain text
3810 (invalid but often used) or encoded as <quote>http%3a//</quote>.
3811 Some sites use their own URL encoding scheme, encrypt the address
3812 of the target server or replace it with a database id. In theses cases
3813 <literal>fast-redirects</literal> is fooled and the request reaches the
3814 redirection server where it probably gets logged.
3820 <term>Example usage:</term>
3824 { +fast-redirects{simple-check} }
3827 { +fast-redirects{check-decoded-url} }
3828 another.example.com/testing</screen>
3837 <!-- ~~~~~ New section ~~~~~ -->
3838 <sect3 renderas="sect4" id="filter">
3839 <title>filter</title>
3843 <term>Typical use:</term>
3845 <para>Get rid of HTML and JavaScript annoyances, banner advertisements (by size),
3846 do fun text replacements, add personalized effects, etc.</para>
3851 <term>Effect:</term>
3854 All instances of text-based type, most notably HTML and JavaScript, to which
3855 this action applies, can be filtered on-the-fly through the specified regular
3856 expression based substitutions. (Note: as of version 3.0.3 plain text documents
3857 are exempted from filtering, because web servers often use the
3858 <literal>text/plain</literal> MIME type for all files whose type they don't know.)
3865 <!-- boolean, parameterized, Multi-value -->
3867 <para>Parameterized.</para>
3872 <term>Parameter:</term>
3875 The name of a content filter, as defined in the <link linkend="filter-file">filter file</link>.
3876 Filters can be defined in one or more files as defined by the
3877 <literal><link linkend="filterfile">filterfile</link></literal>
3878 option in the <link linkend="config">config file</link>.
3879 <filename>default.filter</filename> is the collection of filters
3880 supplied by the developers. Locally defined filters should go
3881 in their own file, such as <filename>user.filter</filename>.
3884 When used in its negative form,
3885 and without parameters, <emphasis>all</emphasis> filtering is completely disabled.
3894 For your convenience, there are a number of pre-defined filters available
3895 in the distribution filter file that you can use. See the examples below for
3899 Filtering requires buffering the page content, which may appear to
3900 slow down page rendering since nothing is displayed until all content has
3901 passed the filters. (It does not really take longer, but seems that way
3902 since the page is not incrementally displayed.) This effect will be more
3903 noticeable on slower connections.
3906 <quote>Rolling your own</quote>
3907 filters requires a knowledge of
3908 <ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
3909 Expressions</quote></ulink> and
3910 <ulink url="http://en.wikipedia.org/wiki/Html"><quote>HTML</quote></ulink>.
3911 This is very powerful feature, and potentially very intrusive.
3912 Filters should be used with caution, and where an equivalent
3913 <quote>action</quote> is not available.
3916 The amount of data that can be filtered is limited to the
3917 <literal><link linkend="buffer-limit">buffer-limit</link></literal>
3918 option in the main <link linkend="config">config file</link>. The
3919 default is 4096 KB (4 Megs). Once this limit is exceeded, the buffered
3920 data, and all pending data, is passed through unfiltered.
3923 Inappropriate MIME types, such as zipped files, are not filtered at all.
3924 (Again, only text-based types except plain text). Encrypted SSL data
3925 (from HTTPS servers) cannot be filtered either, since this would violate
3926 the integrity of the secure transaction. In some situations it might
3927 be necessary to protect certain text, like source code, from filtering
3928 by defining appropriate <literal>-filter</literal> exceptions.
3931 Compressed content can't be filtered either, unless &my-app;
3932 is compiled with zlib support (requires at least &my-app; 3.0.7),
3933 in which case &my-app; will decompress the content before filtering
3937 If you use a &my-app; version without zlib support, but want filtering to work on
3938 as much documents as possible, even those that would normally be sent compressed,
3939 you must use the <literal><link linkend="prevent-compression">prevent-compression</link></literal>
3940 action in conjunction with <literal>filter</literal>.
3943 Content filtering can achieve some of the same effects as the
3944 <literal><link linkend="block">block</link></literal>
3945 action, i.e. it can be used to block ads and banners. But the mechanism
3946 works quite differently. One effective use, is to block ad banners
3947 based on their size (see below), since many of these seem to be somewhat
3951 <link linkend="contact">Feedback</link> with suggestions for new or
3952 improved filters is particularly welcome!
3955 The below list has only the names and a one-line description of each
3956 predefined filter. There are <link linkend="predefined-filters">more
3957 verbose explanations</link> of what these filters do in the <link
3958 linkend="filter-file">filter file chapter</link>.
3964 <term>Example usage (with filters from the distribution <filename>default.filter</filename> file).
3965 See <link linkend="PREDEFINED-FILTERS">the Predefined Filters section</link> for
3966 more explanation on each:</term>
3969 <anchor id="filter-js-annoyances">
3970 <screen>+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse</screen>
3973 <anchor id="filter-js-events">
3974 <screen>+filter{js-events} # Kill all JS event bindings (Radically destructive! Only for extra nasty sites)</screen>
3977 <anchor id="filter-html-annoyances">
3978 <screen>+filter{html-annoyances} # Get rid of particularly annoying HTML abuse</screen>
3981 <anchor id="filter-content-cookies">
3982 <screen>+filter{content-cookies} # Kill cookies that come in the HTML or JS content</screen>
3985 <anchor id="filter-refresh-tags">
3986 <screen>+filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups)</screen>
3989 <anchor id="filter-unsolicited-popups">
3990 <screen>+filter{unsolicited-popups} # Disable only unsolicited pop-up windows. Useful if your browser lacks this ability.</screen>
3993 <anchor id="filter-all-popups">
3994 <screen>+filter{all-popups} # Kill all popups in JavaScript and HTML. Useful if your browser lacks this ability.</screen>
3997 <anchor id="filter-img-reorder">
3998 <screen>+filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective</screen>
4001 <anchor id="filter-banners-by-size">
4002 <screen>+filter{banners-by-size} # Kill banners by size</screen>
4005 <anchor id="filter-banners-by-link">
4006 <screen>+filter{banners-by-link} # Kill banners by their links to known clicktrackers</screen>
4009 <anchor id="filter-webbugs">
4010 <screen>+filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking)</screen>
4013 <anchor id="filter-tiny-textforms">
4014 <screen>+filter{tiny-textforms} # Extend those tiny textareas up to 40x80 and kill the hard wrap</screen>
4017 <anchor id="filter-jumping-windows">
4018 <screen>+filter{jumping-windows} # Prevent windows from resizing and moving themselves</screen>
4021 <anchor id="filter-frameset-borders">
4022 <screen>+filter{frameset-borders} # Give frames a border and make them resizeable</screen>
4025 <anchor id="filter-demoronizer">
4026 <screen>+filter{demoronizer} # Fix MS's non-standard use of standard charsets</screen>
4029 <anchor id="filter-shockwave-flash">
4030 <screen>+filter{shockwave-flash} # Kill embedded Shockwave Flash objects</screen>
4033 <anchor id="filter-quicktime-kioskmode">
4034 <screen>+filter{quicktime-kioskmode} # Make Quicktime movies savable</screen>
4037 <anchor id="filter-fun">
4038 <screen>+filter{fun} # Text replacements for subversive browsing fun!</screen>
4041 <anchor id="filter-crude-parental">
4042 <screen>+filter{crude-parental} # Crude parental filtering (demo only)</screen>
4045 <anchor id="filter-ie-exploits">
4046 <screen>+filter{ie-exploits} # Disable a known Internet Explorer bug exploits</screen>
4049 <anchor id="filter-site-specifics">
4050 <screen>+filter{site-specifics} # Custom filters for specific site related problems</screen>
4053 <anchor id="filter-google">
4054 <screen>+filter{google} # Removes text ads and other Google specific improvements</screen>
4057 <anchor id="filter-yahoo">
4058 <screen>+filter{yahoo} # Removes text ads and other Yahoo specific improvements</screen>
4061 <anchor id="filter-msn">
4062 <screen>+filter{msn} # Removes text ads and other MSN specific improvements</screen>
4065 <anchor id="filter-blogspot">
4066 <screen>+filter{blogspot} # Cleans up Blogspot blogs</screen>
4069 <anchor id="filter-no-ping">
4070 <screen>+filter{no-ping} # Removes non-standard ping attributes from anchor and area tags</screen>
4078 <!-- ~~~~~ New section ~~~~~ -->
4079 <sect3 renderas="sect4" id="force-text-mode">
4080 <title>force-text-mode</title>
4086 <term>Typical use:</term>
4088 <para>Force <application>Privoxy</application> to treat a document as if it was in some kind of <emphasis>text</emphasis> format. </para>
4093 <term>Effect:</term>
4096 Declares a document as text, even if the <quote>Content-Type:</quote> isn't detected as such.
4103 <!-- Boolean, Parameterized, Multi-value -->
4105 <para>Boolean.</para>
4110 <term>Parameter:</term>
4122 As explained <literal><link linkend="filter">above</link></literal>,
4123 <application>Privoxy</application> tries to only filter files that are
4124 in some kind of text format. The same restrictions apply to
4125 <literal><link linkend="content-type-overwrite">content-type-overwrite</link></literal>.
4126 <literal>force-text-mode</literal> declares a document as text,
4127 without looking at the <quote>Content-Type:</quote> first.
4131 Think twice before activating this action. Filtering binary data
4132 with regular expressions can cause file damage.
4139 <term>Example usage:</term>
4152 <!-- ~~~~~ New section ~~~~~ -->
4153 <sect3 renderas="sect4" id="forward-override">
4154 <title>forward-override</title>
4160 <term>Typical use:</term>
4162 <para>Change the forwarding settings based on User-Agent or request origin</para>
4167 <term>Effect:</term>
4170 Overrules the forward directives in the configuration file.
4177 <!-- Boolean, Parameterized, Multi-value -->
4179 <para>Multi-value.</para>
4184 <term>Parameter:</term>
4188 <para><quote>forward .</quote> to use a direct connection without any additional proxies.</para>
4192 <quote>forward 127.0.0.1:8123</quote> to use the HTTP proxy listening at 127.0.0.1 port 8123.
4197 <quote>forward-socks4a 127.0.0.1:9050 .</quote> to use the socks4a proxy listening at
4198 127.0.0.1 port 9050. Replace <quote>forward-socks4a</quote> with <quote>forward-socks4</quote>
4199 to use a socks4 connection (with local DNS resolution) instead, use <quote>forward-socks5</quote>
4200 for socks5 connections (with remote DNS resolution).
4205 <quote>forward-socks4a 127.0.0.1:9050 proxy.example.org:8000</quote> to use the socks4a proxy
4206 listening at 127.0.0.1 port 9050 to reach the HTTP proxy listening at proxy.example.org port 8000.
4207 Replace <quote>forward-socks4a</quote> with <quote>forward-socks4</quote> to use a socks4 connection
4208 (with local DNS resolution) instead, use <quote>forward-socks5</quote>
4209 for socks5 connections (with remote DNS resolution).
4220 This action takes parameters similar to the
4221 <link linkend="forwarding">forward</link> directives in the configuration
4222 file, but without the URL pattern. It can be used as replacement, but normally it's only
4223 used in cases where matching based on the request URL isn't sufficient.
4227 Please read the description for the <link linkend="forwarding">forward</link> directives before
4228 using this action. Forwarding to the wrong people will reduce your privacy and increase the
4229 chances of man-in-the-middle attacks.
4232 If the ports are missing or invalid, default values will be used. This might change
4233 in the future and you shouldn't rely on it. Otherwise incorrect syntax causes Privoxy
4237 Use the <ulink url="http://config.privoxy.org/show-url-info">show-url-info CGI page</ulink>
4238 to verify that your forward settings do what you thought the do.
4245 <term>Example usage:</term>
4249 # Always use direct connections for requests previously tagged as
4250 # <quote>User-Agent: fetch libfetch/2.0</quote> and make sure
4251 # resuming downloads continues to work.
4252 # This way you can continue to use Tor for your normal browsing,
4253 # without overloading the Tor network with your FreeBSD ports updates
4254 # or downloads of bigger files like ISOs.
4255 # Note that HTTP headers are easy to fake and therefore their
4256 # values are as (un)trustworthy as your clients and users.
4257 {+forward-override{forward .} \
4258 -hide-if-modified-since \
4259 -overwrite-last-modified \
4261 TAG:^User-Agent: fetch libfetch/2\.0$
4270 <!-- ~~~~~ New section ~~~~~ -->
4271 <sect3 renderas="sect4" id="handle-as-empty-document">
4272 <title>handle-as-empty-document</title>
4278 <term>Typical use:</term>
4280 <para>Mark URLs that should be replaced by empty documents <emphasis>if they get blocked</emphasis></para>
4285 <term>Effect:</term>
4288 This action alone doesn't do anything noticeable. It just marks URLs.
4289 If the <literal><link linkend="block">block</link></literal> action <emphasis>also applies</emphasis>,
4290 the presence or absence of this mark decides whether an HTML <quote>BLOCKED</quote>
4291 page, or an empty document will be sent to the client as a substitute for the blocked content.
4292 The <emphasis>empty</emphasis> document isn't literally empty, but actually contains a single space.
4299 <!-- Boolean, Parameterized, Multi-value -->
4301 <para>Boolean.</para>
4306 <term>Parameter:</term>
4318 Some browsers complain about syntax errors if JavaScript documents
4319 are blocked with <application>Privoxy's</application>
4320 default HTML page; this option can be used to silence them.
4321 And of course this action can also be used to eliminate the &my-app;
4322 BLOCKED message in frames.
4325 The content type for the empty document can be specified with
4326 <literal><link linkend="content-type-overwrite">content-type-overwrite{}</link></literal>,
4327 but usually this isn't necessary.
4333 <term>Example usage:</term>
4336 <screen># Block all documents on example.org that end with ".js",
4337 # but send an empty document instead of the usual HTML message.
4338 {+block{Blocked JavaScript} +handle-as-empty-document}
4348 <!-- ~~~~~ New section ~~~~~ -->
4349 <sect3 renderas="sect4" id="handle-as-image">
4350 <title>handle-as-image</title>
4354 <term>Typical use:</term>
4356 <para>Mark URLs as belonging to images (so they'll be replaced by images <emphasis>if they do get blocked</emphasis>, rather than HTML pages)</para>
4361 <term>Effect:</term>
4364 This action alone doesn't do anything noticeable. It just marks URLs as images.
4365 If the <literal><link linkend="block">block</link></literal> action <emphasis>also applies</emphasis>,
4366 the presence or absence of this mark decides whether an HTML <quote>blocked</quote>
4367 page, or a replacement image (as determined by the <literal><link
4368 linkend="set-image-blocker">set-image-blocker</link></literal> action) will be sent to the
4369 client as a substitute for the blocked content.
4376 <!-- Boolean, Parameterized, Multi-value -->
4378 <para>Boolean.</para>
4383 <term>Parameter:</term>
4395 The below generic example section is actually part of <filename>default.action</filename>.
4396 It marks all URLs with well-known image file name extensions as images and should
4400 Users will probably only want to use the handle-as-image action in conjunction with
4401 <literal><link linkend="block">block</link></literal>, to block sources of banners, whose URLs don't
4402 reflect the file type, like in the second example section.
4405 Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad
4406 frames require an HTML page to be sent, or they won't display properly.
4407 Forcing <literal>handle-as-image</literal> in this situation will not replace the
4408 ad frame with an image, but lead to error messages.
4414 <term>Example usage (sections):</term>
4417 <screen># Generic image extensions:
4420 /.*\.(gif|jpg|jpeg|png|bmp|ico)$
4422 # These don't look like images, but they're banners and should be
4423 # blocked as images:
4425 {+block{Nasty banners.} +handle-as-image}
4426 nasty-banner-server.example.com/junk.cgi\?output=trash
4435 <!-- ~~~~~ New section ~~~~~ -->
4436 <sect3 renderas="sect4" id="hide-accept-language">
4437 <title>hide-accept-language</title>
4443 <term>Typical use:</term>
4445 <para>Pretend to use different language settings.</para>
4450 <term>Effect:</term>
4453 Deletes or replaces the <quote>Accept-Language:</quote> HTTP header in client requests.
4460 <!-- Boolean, Parameterized, Multi-value -->
4462 <para>Parameterized.</para>
4467 <term>Parameter:</term>
4470 Keyword: <quote>block</quote>, or any user defined value.
4479 Faking the browser's language settings can be useful to make a
4480 foreign User-Agent set with
4481 <literal><link linkend="hide-user-agent">hide-user-agent</link></literal>
4485 However some sites with content in different languages check the
4486 <quote>Accept-Language:</quote> to decide which one to take by default.
4487 Sometimes it isn't possible to later switch to another language without
4488 changing the <quote>Accept-Language:</quote> header first.
4491 Therefore it's a good idea to either only change the
4492 <quote>Accept-Language:</quote> header to languages you understand,
4493 or to languages that aren't wide spread.
4496 Before setting the <quote>Accept-Language:</quote> header
4497 to a rare language, you should consider that it helps to
4498 make your requests unique and thus easier to trace.
4499 If you don't plan to change this header frequently,
4500 you should stick to a common language.
4506 <term>Example usage (section):</term>
4509 <screen># Pretend to use Canadian language settings.
4510 {+hide-accept-language{en-ca} \
4511 +hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv:1.8.0.4) Gecko/20060628 Firefox/1.5.0.4} \
4521 <!-- ~~~~~ New section ~~~~~ -->
4522 <sect3 renderas="sect4" id="hide-content-disposition">
4523 <title>hide-content-disposition</title>
4529 <term>Typical use:</term>
4531 <para>Prevent download menus for content you prefer to view inside the browser.</para>
4536 <term>Effect:</term>
4539 Deletes or replaces the <quote>Content-Disposition:</quote> HTTP header set by some servers.
4546 <!-- Boolean, Parameterized, Multi-value -->
4548 <para>Parameterized.</para>
4553 <term>Parameter:</term>
4556 Keyword: <quote>block</quote>, or any user defined value.
4565 Some servers set the <quote>Content-Disposition:</quote> HTTP header for
4566 documents they assume you want to save locally before viewing them.
4567 The <quote>Content-Disposition:</quote> header contains the file name
4568 the browser is supposed to use by default.
4571 In most browsers that understand this header, it makes it impossible to
4572 <emphasis>just view</emphasis> the document, without downloading it first,
4573 even if it's just a simple text file or an image.
4576 Removing the <quote>Content-Disposition:</quote> header helps
4577 to prevent this annoyance, but some browsers additionally check the
4578 <quote>Content-Type:</quote> header, before they decide if they can
4579 display a document without saving it first. In these cases, you have
4580 to change this header as well, before the browser stops displaying
4584 It is also possible to change the server's file name suggestion
4585 to another one, but in most cases it isn't worth the time to set
4589 This action will probably be removed in the future,
4590 use server-header filters instead.
4596 <term>Example usage:</term>
4599 <screen># Disarm the download link in Sourceforge's patch tracker
4601 +content-type-overwrite{text/plain}\
4602 +hide-content-disposition{block} }
4603 .sourceforge.net/tracker/download\.php</screen>
4611 <!-- ~~~~~ New section ~~~~~ -->
4612 <sect3 renderas="sect4" id="hide-if-modified-since">
4613 <title>hide-if-modified-since</title>
4619 <term>Typical use:</term>
4621 <para>Prevent yet another way to track the user's steps between sessions.</para>
4626 <term>Effect:</term>
4629 Deletes the <quote>If-Modified-Since:</quote> HTTP client header or modifies its value.
4636 <!-- Boolean, Parameterized, Multi-value -->
4638 <para>Parameterized.</para>
4643 <term>Parameter:</term>
4646 Keyword: <quote>block</quote>, or a user defined value that specifies a range of hours.
4655 Removing this header is useful for filter testing, where you want to force a real
4656 reload instead of getting status code <quote>304</quote>, which would cause the
4657 browser to use a cached copy of the page.
4660 Instead of removing the header, <literal>hide-if-modified-since</literal> can
4661 also add or subtract a random amount of time to/from the header's value.
4662 You specify a range of minutes where the random factor should be chosen from and
4663 <application>Privoxy</application> does the rest. A negative value means
4664 subtracting, a positive value adding.
4667 Randomizing the value of the <quote>If-Modified-Since:</quote> makes
4668 it less likely that the server can use the time as a cookie replacement,
4669 but you will run into caching problems if the random range is too high.
4672 It is a good idea to only use a small negative value and let
4673 <literal><link linkend="overwrite-last-modified">overwrite-last-modified</link></literal>
4674 handle the greater changes.
4677 It is also recommended to use this action together with
4678 <literal><link linkend="crunch-if-none-match">crunch-if-none-match</link></literal>,
4679 otherwise it's more or less pointless.
4685 <term>Example usage (section):</term>
4688 <screen># Let the browser revalidate but make tracking based on the time less likely.
4689 {+hide-if-modified-since{-60} \
4690 +overwrite-last-modified{randomize} \
4691 +crunch-if-none-match}
4700 <!-- ~~~~~ New section ~~~~~ -->
4701 <sect3 renderas="sect4" id="hide-forwarded-for-headers">
4702 <title>hide-forwarded-for-headers</title>
4705 <term>Typical use:</term>
4707 <para>Improve privacy by not forwarding the source of the request in the HTTP headers.</para>
4712 <term>Effect:</term>
4715 Deletes any existing <quote>X-Forwarded-for:</quote> HTTP header from client requests.
4722 <!-- Boolean, Parameterized, Multi-value -->
4724 <para>Boolean.</para>
4729 <term>Parameter:</term>
4741 It is safe and recommended to leave this on.
4747 <term>Example usage:</term>
4750 <screen>+hide-forwarded-for-headers</screen>
4758 <!-- ~~~~~ New section ~~~~~ -->
4759 <sect3 renderas="sect4" id="hide-from-header">
4760 <title>hide-from-header</title>
4764 <term>Typical use:</term>
4766 <para>Keep your (old and ill) browser from telling web servers your email address</para>
4771 <term>Effect:</term>
4774 Deletes any existing <quote>From:</quote> HTTP header, or replaces it with the
4782 <!-- Boolean, Parameterized, Multi-value -->
4784 <para>Parameterized.</para>
4789 <term>Parameter:</term>
4792 Keyword: <quote>block</quote>, or any user defined value.
4801 The keyword <quote>block</quote> will completely remove the header
4802 (not to be confused with the <literal><link linkend="block">block</link></literal>
4806 Alternately, you can specify any value you prefer to be sent to the web
4807 server. If you do, it is a matter of fairness not to use any address that
4808 is actually used by a real person.
4811 This action is rarely needed, as modern web browsers don't send
4812 <quote>From:</quote> headers anymore.
4818 <term>Example usage:</term>
4821 <screen>+hide-from-header{block}</screen> or
4822 <screen>+hide-from-header{spam-me-senseless@sittingduck.example.com}</screen>
4830 <!-- ~~~~~ New section ~~~~~ -->
4831 <sect3 renderas="sect4" id="hide-referrer">
4832 <title>hide-referrer</title>
4833 <anchor id="hide-referer">
4836 <term>Typical use:</term>
4838 <para>Conceal which link you followed to get to a particular site</para>
4843 <term>Effect:</term>
4846 Deletes the <quote>Referer:</quote> (sic) HTTP header from the client request,
4847 or replaces it with a forged one.
4854 <!-- Boolean, Parameterized, Multi-value -->
4856 <para>Parameterized.</para>
4861 <term>Parameter:</term>
4865 <para><quote>conditional-block</quote> to delete the header completely if the host has changed.</para>
4868 <para><quote>conditional-forge</quote> to forge the header if the host has changed.</para>
4871 <para><quote>block</quote> to delete the header unconditionally.</para>
4874 <para><quote>forge</quote> to pretend to be coming from the homepage of the server we are talking to.</para>
4877 <para>Any other string to set a user defined referrer.</para>
4887 <literal>conditional-block</literal> is the only parameter,
4888 that isn't easily detected in the server's log file. If it blocks the
4889 referrer, the request will look like the visitor used a bookmark or
4890 typed in the address directly.
4893 Leaving the referrer unmodified for requests on the same host
4894 allows the server owner to see the visitor's <quote>click path</quote>,
4895 but in most cases she could also get that information by comparing
4896 other parts of the log file: for example the User-Agent if it isn't
4897 a very common one, or the user's IP address if it doesn't change between
4901 Always blocking the referrer, or using a custom one, can lead to
4902 failures on servers that check the referrer before they answer any
4903 requests, in an attempt to prevent their content from being
4904 embedded or linked to elsewhere.
4907 Both <literal>conditional-block</literal> and <literal>forge</literal>
4908 will work with referrer checks, as long as content and valid referring page
4909 are on the same host. Most of the time that's the case.
4912 <literal>hide-referer</literal> is an alternate spelling of
4913 <literal>hide-referrer</literal> and the two can be can be freely
4914 substituted with each other. (<quote>referrer</quote> is the
4915 correct English spelling, however the HTTP specification has a bug - it
4916 requires it to be spelled as <quote>referer</quote>.)
4922 <term>Example usage:</term>
4925 <screen>+hide-referrer{forge}</screen> or
4926 <screen>+hide-referrer{http://www.yahoo.com/}</screen>
4934 <!-- ~~~~~ New section ~~~~~ -->
4935 <sect3 renderas="sect4" id="hide-user-agent">
4936 <title>hide-user-agent</title>
4940 <term>Typical use:</term>
4942 <para>Try to conceal your type of browser and client operating system</para>
4947 <term>Effect:</term>
4950 Replaces the value of the <quote>User-Agent:</quote> HTTP header
4951 in client requests with the specified value.
4958 <!-- Boolean, Parameterized, Multi-value -->
4960 <para>Parameterized.</para>
4965 <term>Parameter:</term>
4968 Any user-defined string.
4978 This can lead to problems on web sites that depend on looking at this header in
4979 order to customize their content for different browsers (which, by the
4980 way, is <emphasis>NOT</emphasis> the right thing to do: good web sites
4981 work browser-independently).
4985 Using this action in multi-user setups or wherever different types of
4986 browsers will access the same <application>Privoxy</application> is
4987 <emphasis>not recommended</emphasis>. In single-user, single-browser
4988 setups, you might use it to delete your OS version information from
4989 the headers, because it is an invitation to exploit known bugs for your
4990 OS. It is also occasionally useful to forge this in order to access
4991 sites that won't let you in otherwise (though there may be a good
4992 reason in some cases). Example of this: some MSN sites will not
4993 let <application>Mozilla</application> enter, yet forging to a
4994 <application>Netscape 6.1</application> user-agent works just fine.
4995 (Must be just a silly MS goof, I'm sure :-).
4998 More information on known user-agent strings can be found at
4999 <ulink url="http://www.user-agents.org/">http://www.user-agents.org/</ulink>
5001 <ulink url="http://en.wikipedia.org/wiki/User_agent">http://en.wikipedia.org/wiki/User_agent</ulink>.
5007 <term>Example usage:</term>
5010 <screen>+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}</screen>
5018 <!-- ~~~~~ New section ~~~~~ -->
5019 <sect3 renderas="sect4" id="limit-connect">
5020 <title>limit-connect</title>
5024 <term>Typical use:</term>
5026 <para>Prevent abuse of <application>Privoxy</application> as a TCP proxy relay or disable SSL for untrusted sites</para>
5031 <term>Effect:</term>
5034 Specifies to which ports HTTP CONNECT requests are allowable.
5041 <!-- Boolean, Parameterized, Multi-value -->
5043 <para>Parameterized.</para>
5048 <term>Parameter:</term>
5051 A comma-separated list of ports or port ranges (the latter using dashes, with the minimum
5052 defaulting to 0 and the maximum to 65K).
5061 By default, i.e. if no <literal>limit-connect</literal> action applies,
5062 <application>Privoxy</application> allows HTTP CONNECT requests to all
5063 ports. Use <literal>limit-connect</literal> if fine-grained control
5064 is desired for some or all destinations.
5067 The CONNECT methods exists in HTTP to allow access to secure websites
5068 (<quote>https://</quote> URLs) through proxies. It works very simply:
5069 the proxy connects to the server on the specified port, and then
5070 short-circuits its connections to the client and to the remote server.
5071 This means CONNECT-enabled proxies can be used as TCP relays very easily.
5074 <application>Privoxy</application> relays HTTPS traffic without seeing
5075 the decoded content. Websites can leverage this limitation to circumvent &my-app;'s
5076 filters. By specifying an invalid port range you can disable HTTPS entirely.
5082 <term>Example usages:</term>
5084 <!-- I had trouble getting the spacing to look right in my browser -->
5085 <!-- I probably have the wrong font setup, bollocks. -->
5086 <!-- Apparently the emphasis tag uses a proportional font no matter what -->
5088 <screen>+limit-connect{443} # Port 443 is OK.
5089 +limit-connect{80,443} # Ports 80 and 443 are OK.
5090 +limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
5091 +limit-connect{-} # All ports are OK
5092 +limit-connect{,} # No HTTPS/SSL traffic is allowed</screen>
5099 <!-- ~~~~~ New section ~~~~~ -->
5100 <sect3 renderas="sect4" id="prevent-compression">
5101 <title>prevent-compression</title>
5105 <term>Typical use:</term>
5108 Ensure that servers send the content uncompressed, so it can be
5109 passed through <literal><link linkend="filter">filter</link></literal>s.
5115 <term>Effect:</term>
5118 Removes the Accept-Encoding header which can be used to ask for compressed transfer.
5125 <!-- Boolean, Parameterized, Multi-value -->
5127 <para>Boolean.</para>
5132 <term>Parameter:</term>
5144 More and more websites send their content compressed by default, which
5145 is generally a good idea and saves bandwidth. But the <literal><link
5146 linkend="filter">filter</link></literal> and
5147 <literal><link linkend="deanimate-gifs">deanimate-gifs</link></literal>
5148 actions need access to the uncompressed data.
5151 When compiled with zlib support (available since &my-app; 3.0.7), content that should be
5152 filtered is decompressed on-the-fly and you don't have to worry about this action.
5153 If you are using an older &my-app; version, or one that hasn't been compiled with zlib
5154 support, this action can be used to convince the server to send the content uncompressed.
5157 Most text-based instances compress very well, the size is seldom decreased by less than 50%,
5158 for markup-heavy instances like news feeds saving more than 90% of the original size isn't
5162 Not using compression will therefore slow down the transfer, and you should only
5163 enable this action if you really need it. As of &my-app; 3.0.7 it's disabled in all
5164 predefined action settings.
5167 Note that some (rare) ill-configured sites don't handle requests for uncompressed
5168 documents correctly. Broken PHP applications tend to send an empty document body,
5169 some IIS versions only send the beginning of the content. If you enable
5170 <literal>prevent-compression</literal> per default, you might want to add
5171 exceptions for those sites. See the example for how to do that.
5177 <term>Example usage (sections):</term>
5181 # Selectively turn off compression, and enable a filter
5183 { +filter{tiny-textforms} +prevent-compression }
5184 # Match only these sites
5189 # Or instead, we could set a universal default:
5191 { +prevent-compression }
5194 # Then maybe make exceptions for broken sites:
5196 { -prevent-compression }
5197 .compusa.com/</screen>
5206 <!-- ~~~~~ New section ~~~~~ -->
5207 <sect3 renderas="sect4" id="overwrite-last-modified">
5208 <title>overwrite-last-modified</title>
5214 <term>Typical use:</term>
5216 <para>Prevent yet another way to track the user's steps between sessions.</para>
5221 <term>Effect:</term>
5224 Deletes the <quote>Last-Modified:</quote> HTTP server header or modifies its value.
5231 <!-- Boolean, Parameterized, Multi-value -->
5233 <para>Parameterized.</para>
5238 <term>Parameter:</term>
5241 One of the keywords: <quote>block</quote>, <quote>reset-to-request-time</quote>
5242 and <quote>randomize</quote>
5251 Removing the <quote>Last-Modified:</quote> header is useful for filter
5252 testing, where you want to force a real reload instead of getting status
5253 code <quote>304</quote>, which would cause the browser to reuse the old
5254 version of the page.
5257 The <quote>randomize</quote> option overwrites the value of the
5258 <quote>Last-Modified:</quote> header with a randomly chosen time
5259 between the original value and the current time. In theory the server
5260 could send each document with a different <quote>Last-Modified:</quote>
5261 header to track visits without using cookies. <quote>Randomize</quote>
5262 makes it impossible and the browser can still revalidate cached documents.
5265 <quote>reset-to-request-time</quote> overwrites the value of the
5266 <quote>Last-Modified:</quote> header with the current time. You could use
5267 this option together with
5268 <literal><link linkend="hide-if-modified-since">hided-if-modified-since</link></literal>
5269 to further customize your random range.
5272 The preferred parameter here is <quote>randomize</quote>. It is safe
5273 to use, as long as the time settings are more or less correct.
5274 If the server sets the <quote>Last-Modified:</quote> header to the time
5275 of the request, the random range becomes zero and the value stays the same.
5276 Therefore you should later randomize it a second time with
5277 <literal><link linkend="hide-if-modified-since">hided-if-modified-since</link></literal>,
5281 It is also recommended to use this action together with
5282 <literal><link linkend="crunch-if-none-match">crunch-if-none-match</link></literal>.
5288 <term>Example usage:</term>
5291 <screen># Let the browser revalidate without being tracked across sessions
5292 { +hide-if-modified-since{-60} \
5293 +overwrite-last-modified{randomize} \
5294 +crunch-if-none-match}
5303 <!-- ~~~~~ New section ~~~~~ -->
5304 <sect3 renderas="sect4" id="redirect">
5305 <title>redirect</title>
5311 <term>Typical use:</term>
5314 Redirect requests to other sites.
5320 <term>Effect:</term>
5323 Convinces the browser that the requested document has been moved
5324 to another location and the browser should get it from there.
5331 <!-- Boolean, Parameterized, Multi-value -->
5333 <para>Parameterized</para>
5338 <term>Parameter:</term>
5341 An absolute URL or a single pcrs command.
5350 Requests to which this action applies are answered with a
5351 HTTP redirect to URLs of your choosing. The new URL is
5352 either provided as parameter, or derived by applying a
5353 single pcrs command to the original URL.
5356 This action will be ignored if you use it together with
5357 <literal><link linkend="block">block</link></literal>.
5358 It can be combined with
5359 <literal><link linkend="fast-redirects">fast-redirects{check-decoded-url}</link></literal>
5360 to redirect to a decoded version of a rewritten URL.
5363 Use this action carefully, make sure not to create redirection loops
5364 and be aware that using your own redirects might make it
5365 possible to fingerprint your requests.
5371 <term>Example usages:</term>
5374 <screen># Replace example.com's style sheet with another one
5375 { +redirect{http://localhost/css-replacements/example.com.css} }
5376 example.com/stylesheet\.css
5378 # Create a short, easy to remember nickname for a favorite site
5379 # (relies on the browser accept and forward invalid URLs to &my-app;)
5380 { +redirect{http://www.privoxy.org/user-manual/actions-file.html} }
5383 # Always use the expanded view for Undeadly.org articles
5384 # (Note the $ at the end of the URL pattern to make sure
5385 # the request for the rewritten URL isn't redirected as well)
5386 {+redirect{s@$@&mode=expanded@}}
5387 undeadly.org/cgi\?action=article&sid=\d*$</screen>
5396 <!-- ~~~~~ New section ~~~~~ -->
5397 <sect3 renderas="sect4" id="server-header-filter">
5398 <title>server-header-filter</title>
5402 <term>Typical use:</term>
5405 Rewrite or remove single server headers.
5411 <term>Effect:</term>
5414 All server headers to which this action applies are filtered on-the-fly
5415 through the specified regular expression based substitutions.
5422 <!-- boolean, parameterized, Multi-value -->
5424 <para>Parameterized.</para>
5429 <term>Parameter:</term>
5432 The name of a server-header filter, as defined in one of the
5433 <link linkend="filter-file">filter files</link>.
5442 Server-header filters are applied to each header on its own, not to
5443 all at once. This makes it easier to diagnose problems, but on the downside
5444 you can't write filters that only change header x if header y's value is z.
5445 You can do that by using tags though.
5448 Server-header filters are executed after the other header actions have finished
5449 and use their output as input.
5452 Please refer to the <link linkend="filter-file">filter file chapter</link>
5453 to learn which server-header filters are available by default, and how to
5460 <term>Example usage (section):</term>
5464 {+server-header-filter{html-to-xml}}
5465 example.org/xml-instance-that-is-delivered-as-html
5467 {+server-header-filter{xml-to-html}}
5468 example.org/instance-that-is-delivered-as-xml-but-is-not
5478 <!-- ~~~~~ New section ~~~~~ -->
5479 <sect3 renderas="sect4" id="server-header-tagger">
5480 <title>server-header-tagger</title>
5484 <term>Typical use:</term>
5487 Enable or disable filters based on the Content-Type header.
5493 <term>Effect:</term>
5496 Server headers to which this action applies are filtered on-the-fly through
5497 the specified regular expression based substitutions, the result is used as
5505 <!-- boolean, parameterized, Multi-value -->
5507 <para>Parameterized.</para>
5512 <term>Parameter:</term>
5515 The name of a server-header tagger, as defined in one of the
5516 <link linkend="filter-file">filter files</link>.
5525 Server-header taggers are applied to each header on its own,
5526 and as the header isn't modified, each tagger <quote>sees</quote>
5530 Server-header taggers are executed before all other header actions
5531 that modify server headers. Their tags can be used to control
5532 all of the other server-header actions, the content filters
5533 and the crunch actions (<link linkend="redirect">redirect</link>
5534 and <link linkend="block">block</link>).
5537 Obviously crunching based on tags created by server-header taggers
5538 doesn't prevent the request from showing up in the server's log file.
5545 <term>Example usage (section):</term>
5549 # Tag every request with the content type declared by the server
5550 {+server-header-tagger{content-type}}
5561 <!-- ~~~~~ New section ~~~~~ -->
5562 <sect3 renderas="sect4" id="session-cookies-only">
5563 <title>session-cookies-only</title>
5567 <term>Typical use:</term>
5570 Allow only temporary <quote>session</quote> cookies (for the current
5571 browser session <emphasis>only</emphasis>).
5577 <term>Effect:</term>
5580 Deletes the <quote>expires</quote> field from <quote>Set-Cookie:</quote>
5581 server headers. Most browsers will not store such cookies permanently and
5582 forget them in between sessions.
5589 <!-- Boolean, Parameterized, Multi-value -->
5591 <para>Boolean.</para>
5596 <term>Parameter:</term>
5608 This is less strict than <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal> /
5609 <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal> and allows you to browse
5610 websites that insist or rely on setting cookies, without compromising your privacy too badly.
5613 Most browsers will not permanently store cookies that have been processed by
5614 <literal>session-cookies-only</literal> and will forget about them between sessions.
5615 This makes profiling cookies useless, but won't break sites which require cookies so
5616 that you can log in for transactions. This is generally turned on for all
5617 sites, and is the recommended setting.
5620 It makes <emphasis>no sense at all</emphasis> to use <literal>session-cookies-only</literal>
5621 together with <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal> or
5622 <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>. If you do, cookies
5623 will be plainly killed.
5626 Note that it is up to the browser how it handles such cookies without an <quote>expires</quote>
5627 field. If you use an exotic browser, you might want to try it out to be sure.
5630 This setting also has no effect on cookies that may have been stored
5631 previously by the browser before starting <application>Privoxy</application>.
5632 These would have to be removed manually.
5635 <application>Privoxy</application> also uses
5636 the <link linkend="filter-content-cookies">content-cookies filter</link>
5637 to block some types of cookies. Content cookies are not effected by
5638 <literal>session-cookies-only</literal>.
5644 <term>Example usage:</term>
5647 <screen>+session-cookies-only</screen>
5655 <!-- ~~~~~ New section ~~~~~ -->
5656 <sect3 renderas="sect4" id="set-image-blocker">
5657 <title>set-image-blocker</title>
5661 <term>Typical use:</term>
5663 <para>Choose the replacement for blocked images</para>
5668 <term>Effect:</term>
5671 This action alone doesn't do anything noticeable. If <emphasis>both</emphasis>
5672 <literal><link linkend="block">block</link></literal> <emphasis>and</emphasis> <literal><link
5673 linkend="handle-as-image">handle-as-image</link></literal> <emphasis>also</emphasis>
5674 apply, i.e. if the request is to be blocked as an image,
5675 <emphasis>then</emphasis> the parameter of this action decides what will be
5676 sent as a replacement.
5683 <!-- Boolean, Parameterized, Multi-value -->
5685 <para>Parameterized.</para>
5690 <term>Parameter:</term>
5695 <quote>pattern</quote> to send a built-in checkerboard pattern image. The image is visually
5696 decent, scales very well, and makes it obvious where banners were busted.
5701 <quote>blank</quote> to send a built-in transparent image. This makes banners disappear
5702 completely, but makes it hard to detect where <application>Privoxy</application> has blocked
5703 images on a given page and complicates troubleshooting if <application>Privoxy</application>
5704 has blocked innocent images, like navigation icons.
5709 <quote><replaceable class="parameter">target-url</replaceable></quote> to
5710 send a redirect to <replaceable class="parameter">target-url</replaceable>. You can redirect
5711 to any image anywhere, even in your local filesystem via <quote>file:///</quote> URL.
5712 (But note that not all browsers support redirecting to a local file system).
5715 A good application of redirects is to use special <application>Privoxy</application>-built-in
5716 URLs, which send the built-in images, as <replaceable class="parameter">target-url</replaceable>.
5717 This has the same visual effect as specifying <quote>blank</quote> or <quote>pattern</quote> in
5718 the first place, but enables your browser to cache the replacement image, instead of requesting
5719 it over and over again.
5730 The URLs for the built-in images are <quote>http://config.privoxy.org/send-banner?type=<replaceable
5731 class="parameter">type</replaceable></quote>, where <replaceable class="parameter">type</replaceable> is
5732 either <quote>blank</quote> or <quote>pattern</quote>.
5735 There is a third (advanced) type, called <quote>auto</quote>. It is <emphasis>NOT</emphasis> to be
5736 used in <literal>set-image-blocker</literal>, but meant for use from <link linkend="filter-file">filters</link>.
5737 Auto will select the type of image that would have applied to the referring page, had it been an image.
5743 <term>Example usage:</term>
5749 <screen>+set-image-blocker{pattern}</screen>
5752 Redirect to the BSD daemon:
5755 <screen>+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</screen>
5758 Redirect to the built-in pattern for better caching:
5761 <screen>+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</screen>
5769 <!-- ~~~~~ New section ~~~~~ -->
5771 <title>Summary</title>
5773 Note that many of these actions have the potential to cause a page to
5774 misbehave, possibly even not to display at all. There are many ways
5775 a site designer may choose to design his site, and what HTTP header
5776 content, and other criteria, he may depend on. There is no way to have hard
5777 and fast rules for all sites. See the <link
5778 linkend="ACTIONSANAT">Appendix</link> for a brief example on troubleshooting
5784 <!-- ~~~~~ New section ~~~~~ -->
5785 <sect2 id="aliases">
5786 <title>Aliases</title>
5788 Custom <quote>actions</quote>, known to <application>Privoxy</application>
5789 as <quote>aliases</quote>, can be defined by combining other actions.
5790 These can in turn be invoked just like the built-in actions.
5791 Currently, an alias name can contain any character except space, tab,
5793 <quote>{</quote> and <quote>}</quote>, but we <emphasis>strongly
5794 recommend</emphasis> that you only use <quote>a</quote> to <quote>z</quote>,
5795 <quote>0</quote> to <quote>9</quote>, <quote>+</quote>, and <quote>-</quote>.
5796 Alias names are not case sensitive, and are not required to start with a
5797 <quote>+</quote> or <quote>-</quote> sign, since they are merely textually
5801 Aliases can be used throughout the actions file, but they <emphasis>must be
5802 defined in a special section at the top of the file!</emphasis>
5803 And there can only be one such section per actions file. Each actions file may
5804 have its own alias section, and the aliases defined in it are only visible
5808 There are two main reasons to use aliases: One is to save typing for frequently
5809 used combinations of actions, the other one is a gain in flexibility: If you
5810 decide once how you want to handle shops by defining an alias called
5811 <quote>shop</quote>, you can later change your policy on shops in
5812 <emphasis>one</emphasis> place, and your changes will take effect everywhere
5813 in the actions file where the <quote>shop</quote> alias is used. Calling aliases
5814 by their purpose also makes your actions files more readable.
5817 Currently, there is one big drawback to using aliases, though:
5818 <application>Privoxy</application>'s built-in web-based action file
5819 editor honors aliases when reading the actions files, but it expands
5820 them before writing. So the effects of your aliases are of course preserved,
5821 but the aliases themselves are lost when you edit sections that use aliases
5826 Now let's define some aliases...
5831 # Useful custom aliases we can use later.
5833 # Note the (required!) section header line and that this section
5834 # must be at the top of the actions file!
5838 # These aliases just save typing later:
5839 # (Note that some already use other aliases!)
5841 +crunch-all-cookies = +<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> +<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link>
5842 -crunch-all-cookies = -<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> -<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link>
5843 +block-as-image = +block{Blocked image.} +handle-as-image
5844 allow-all-cookies = -crunch-all-cookies -<link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> -<link linkend="FILTER-CONTENT-COOKIES">filter{content-cookies}</link>
5846 # These aliases define combinations of actions
5847 # that are useful for certain types of sites:
5849 fragile = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link> -<link linkend="PREVENT-COMPRESSION">prevent-compression</link>
5851 shop = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link>
5853 # Short names for other aliases, for really lazy people ;-)
5855 c0 = +crunch-all-cookies
5856 c1 = -crunch-all-cookies</screen>
5860 ...and put them to use. These sections would appear in the lower part of an
5861 actions file and define exceptions to the default actions (as specified further
5862 up for the <quote>/</quote> pattern):
5867 # These sites are either very complex or very keen on
5868 # user data and require minimal interference to work:
5871 .office.microsoft.com
5872 .windowsupdate.microsoft.com
5873 # Gmail is really mail.google.com, not gmail.com
5877 # Allow cookies (for setting and retrieving your customer data)
5881 .worldpay.com # for quietpc.com
5884 # These shops require pop-ups:
5886 {-filter{all-popups} -filter{unsolicited-popups}}
5888 .overclockers.co.uk</screen>
5892 Aliases like <quote>shop</quote> and <quote>fragile</quote> are typically used for
5893 <quote>problem</quote> sites that require more than one action to be disabled
5894 in order to function properly.
5900 <!-- ~~~~~ New section ~~~~~ -->
5901 <sect2 id="act-examples">
5902 <title>Actions Files Tutorial</title>
5904 The above chapters have shown <link linkend="actions-file">which actions files
5905 there are and how they are organized</link>, how actions are <link
5906 linkend="actions">specified</link> and <link linkend="actions-apply">applied
5907 to URLs</link>, how <link linkend="af-patterns">patterns</link> work, and how to
5908 define and use <link linkend="aliases">aliases</link>. Now, let's look at an
5909 example <filename>default.action</filename> and <filename>user.action</filename>
5910 file and see how all these pieces come together:
5913 <sect3><title>default.action</title>
5916 Every config file should start with a short comment stating its purpose:
5920 <screen># Sample default.action file <ijbswa-developers@lists.sourceforge.net></screen>
5924 Then, since this is the <filename>default.action</filename> file, the
5925 first section is a special section for internal use that you needn't
5926 change or worry about:
5931 ##########################################################################
5932 # Settings -- Don't change! For internal Privoxy use ONLY.
5933 ##########################################################################
5936 for-privoxy-version=3.0</screen>
5940 After that comes the (optional) alias section. We'll use the example
5941 section from the above <link linkend="aliases">chapter on aliases</link>,
5942 that also explains why and how aliases are used:
5947 ##########################################################################
5949 ##########################################################################
5952 # These aliases just save typing later:
5953 # (Note that some already use other aliases!)
5955 +crunch-all-cookies = +<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> +<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link>
5956 -crunch-all-cookies = -<link linkend="CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</link> -<link linkend="CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</link>
5957 +block-as-image = +block{Blocked image.} +handle-as-image
5958 mercy-for-cookies = -crunch-all-cookies -<link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> -<link linkend="FILTER-CONTENT-COOKIES">filter{content-cookies}</link>
5960 # These aliases define combinations of actions
5961 # that are useful for certain types of sites:
5963 fragile = -<link linkend="BLOCK">block</link> -<link linkend="FILTER">filter</link> -crunch-all-cookies -<link linkend="FAST-REDIRECTS">fast-redirects</link> -<link linkend="HIDE-REFERER">hide-referrer</link>
5964 shop = -crunch-all-cookies -<link linkend="FILTER-ALL-POPUPS">filter{all-popups}</link></screen>
5968 Now come the regular sections, i.e. sets of actions, accompanied
5969 by URL patterns to which they apply. Remember <emphasis>all actions
5970 are disabled when matching starts</emphasis>, so we have to explicitly
5971 enable the ones we want.
5975 The first regular section is probably the most important. It has only
5976 one pattern, <quote><literal>/</literal></quote>, but this pattern
5977 <link linkend="af-patterns">matches all URLs</link>. Therefore, the
5978 set of actions used in this <quote>default</quote> section <emphasis>will
5979 be applied to all requests as a start</emphasis>. It can be partly or
5980 wholly overridden by later matches further down this file, or in user.action,
5981 but it will still be largely responsible for your overall browsing
5986 Again, at the start of matching, all actions are disabled, so there is
5987 no need to disable any actions here. (Remember: a <quote>+</quote>
5988 preceding the action name enables the action, a <quote>-</quote> disables!).
5989 Also note how this long line has been made more readable by splitting it into
5990 multiple lines with line continuation.
5995 ##########################################################################
5996 # "Defaults" section:
5997 ##########################################################################
5999 +<link linkend="DEANIMATE-GIFS">deanimate-gifs</link> \
6000 +<link linkend="FILTER-HTML-ANNOYANCES">filter{html-annoyances}</link> \
6001 +<link linkend="FILTER-REFRESH-TAGS">filter{refresh-tags}</link> \
6002 +<link linkend="FILTER-WEBBUGS">filter{webbugs}</link> \
6003 +<link linkend="FILTER-IE-EXPLOITS">filter{ie-exploits}</link> \
6004 +<link linkend="HIDE-FORWARDED-FOR-HEADERS">hide-forwarded-for-headers</link> \
6005 +<link linkend="HIDE-FROM-HEADER">hide-from-header{block}</link> \
6006 +<link linkend="HIDE-REFERER">hide-referrer{forge}</link> \
6007 +<link linkend="PREVENT-COMPRESSION">prevent-compression</link> \
6008 +<link linkend="SESSION-COOKIES-ONLY">session-cookies-only</link> \
6009 +<link linkend="SET-IMAGE-BLOCKER">set-image-blocker{pattern}</link> \
6011 / # forward slash will match *all* potential URL patterns.</screen>
6015 The default behavior is now set.
6017 This needs rewording, but it can wait for now.
6020 Note that some actions, like not hiding
6021 the user agent, are part of a <quote>general policy</quote> that applies
6022 universally and won't get any exceptions defined later. Other choices,
6023 like not blocking (which is <emphasis>understandably</emphasis> the
6024 default!) need exceptions, i.e. we need to specify explicitly what we
6025 want to block in later sections.
6030 The first of our specialized sections is concerned with <quote>fragile</quote>
6031 sites, i.e. sites that require minimum interference, because they are either
6032 very complex or very keen on tracking you (and have mechanisms in place that
6033 make them unusable for people who avoid being tracked). We will simply use
6034 our pre-defined <literal>fragile</literal> alias instead of stating the list
6035 of actions explicitly:
6040 ##########################################################################
6041 # Exceptions for sites that'll break under the default action set:
6042 ##########################################################################
6044 # "Fragile" Use a minimum set of actions for these sites (see alias above):
6047 .office.microsoft.com # surprise, surprise!
6048 .windowsupdate.microsoft.com
6049 mail.google.com</screen>
6053 Shopping sites are not as fragile, but they typically
6054 require cookies to log in, and pop-up windows for shopping
6055 carts or item details. Again, we'll use a pre-defined alias:
6064 .worldpay.com # for quietpc.com
6066 .scan.co.uk</screen>
6069 <!-- No longer needed BEGIN OF COMMENTED OUT BLOCK
6072 Then, there are sites which rely on pop-up windows (yuck!) to work.
6073 Since we made pop-up-killing our default above, we need to make exceptions
6074 now. <ulink url="http://www.mozilla.org/">Mozilla</ulink> users, who
6075 can turn on smart handling of unwanted pop-ups in their browsers, can
6077 -<literal><link linkend="FILTER-ALL-POPUPS">filter{popups}</link></literal> above
6078 and hence don't need this section. Anyway, disabling an already disabled
6079 action doesn't hurt, so we'll define our exceptions regardless of what was
6080 chosen in the defaults section:
6085 # These sites require pop-ups too :(
6087 { -<link linkend="FILTER-ALL-POPUPS">filter{popups}</link> }
6090 .deutsche-bank-24.de</screen>
6093 END OF COMMENTED OUT BLOCK -->
6096 The <literal><link linkend="FAST-REDIRECTS">fast-redirects</link></literal>
6097 action, which we enabled per default above, breaks some sites. So disable
6098 it for popular sites where we know it misbehaves:
6103 { -<link linkend="FAST-REDIRECTS">fast-redirects</link> }
6107 .altavista.com/.*(like|url|link):http
6108 .altavista.com/trans.*urltext=http
6109 .nytimes.com</screen>
6113 It is important that <application>Privoxy</application> knows which
6114 URLs belong to images, so that <emphasis>if</emphasis> they are to
6115 be blocked, a substitute image can be sent, rather than an HTML page.
6116 Contacting the remote site to find out is not an option, since it
6117 would destroy the loading time advantage of banner blocking, and it
6118 would feed the advertisers (in terms of money <emphasis>and</emphasis>
6119 information). We can mark any URL as an image with the <literal><link
6120 linkend="handle-as-image">handle-as-image</link></literal> action,
6121 and marking all URLs that end in a known image file extension is a
6127 ##########################################################################
6129 ##########################################################################
6131 # Define which file types will be treated as images, in case they get
6132 # blocked further down this file:
6134 { +<link linkend="HANDLE-AS-IMAGE">handle-as-image</link> }
6135 /.*\.(gif|jpe?g|png|bmp|ico)$</screen>
6139 And then there are known banner sources. They often use scripts to
6140 generate the banners, so it won't be visible from the URL that the
6141 request is for an image. Hence we block them <emphasis>and</emphasis>
6142 mark them as images in one go, with the help of our
6143 <literal>+block-as-image</literal> alias defined above. (We could of
6144 course just as well use <literal>+<link linkend="block">block</link>
6145 +<link linkend="handle-as-image">handle-as-image</link></literal> here.)
6146 Remember that the type of the replacement image is chosen by the
6147 <literal><link linkend="set-image-blocker">set-image-blocker</link></literal>
6148 action. Since all URLs have matched the default section with its
6149 <literal>+<link linkend="set-image-blocker">set-image-blocker</link>{pattern}</literal>
6150 action before, it still applies and needn't be repeated:
6155 # Known ad generators:
6160 .ad.*.doubleclick.net
6161 .a.yimg.com/(?:(?!/i/).)*$
6162 .a[0-9].yimg.com/(?:(?!/i/).)*$
6168 One of the most important jobs of <application>Privoxy</application>
6169 is to block banners. Many of these can be <quote>blocked</quote>
6170 by the <literal><link linkend="filter">filter</link>{banners-by-size}</literal>
6171 action, which we enabled above, and which deletes the references to banner
6172 images from the pages while they are loaded, so the browser doesn't request
6173 them anymore, and hence they don't need to be blocked here. But this naturally
6174 doesn't catch all banners, and some people choose not to use filters, so we
6175 need a comprehensive list of patterns for banner URLs here, and apply the
6176 <literal><link linkend="block">block</link></literal> action to them.
6179 First comes many generic patterns, which do most of the work, by
6180 matching typical domain and path name components of banners. Then comes
6181 a list of individual patterns for specific sites, which is omitted here
6182 to keep the example short:
6187 ##########################################################################
6188 # Block these fine banners:
6189 ##########################################################################
6190 { <link linkend="BLOCK">+block{Banner ads.}</link> }
6198 /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
6199 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/
6201 # Site-specific patterns (abbreviated):
6203 .hitbox.com</screen>
6207 It's quite remarkable how many advertisers actually call their banner
6208 servers ads.<replaceable>company</replaceable>.com, or call the directory
6209 in which the banners are stored simply <quote>banners</quote>. So the above
6210 generic patterns are surprisingly effective.
6213 But being very generic, they necessarily also catch URLs that we don't want
6214 to block. The pattern <literal>.*ads.</literal> e.g. catches
6215 <quote>nasty-<emphasis>ads</emphasis>.nasty-corp.com</quote> as intended,
6216 but also <quote>downlo<emphasis>ads</emphasis>.sourcefroge.net</quote> or
6217 <quote><emphasis>ads</emphasis>l.some-provider.net.</quote> So here come some
6218 well-known exceptions to the <literal>+<link linkend="BLOCK">block</link></literal>
6222 Note that these are exceptions to exceptions from the default! Consider the URL
6223 <quote>downloads.sourcefroge.net</quote>: Initially, all actions are deactivated,
6224 so it wouldn't get blocked. Then comes the defaults section, which matches the
6225 URL, but just deactivates the <literal><link linkend="BLOCK">block</link></literal>
6226 action once again. Then it matches <literal>.*ads.</literal>, an exception to the
6227 general non-blocking policy, and suddenly
6228 <literal><link linkend="BLOCK">+block</link></literal> applies. And now, it'll match
6229 <literal>.*loads.</literal>, where <literal><link linkend="BLOCK">-block</link></literal>
6230 applies, so (unless it matches <emphasis>again</emphasis> further down) it ends up
6231 with no <literal><link linkend="BLOCK">block</link></literal> action applying.
6236 ##########################################################################
6237 # Save some innocent victims of the above generic block patterns:
6238 ##########################################################################
6242 { -<link linkend="BLOCK">block</link> }
6243 adv[io]*. # (for advogato.org and advice.*)
6244 adsl. # (has nothing to do with ads)
6245 adobe. # (has nothing to do with ads either)
6246 ad[ud]*. # (adult.* and add.*)
6247 .edu # (universities don't host banners (yet!))
6248 .*loads. # (downloads, uploads etc)
6256 www.globalintersec.com/adv # (adv = advanced)
6257 www.ugu.com/sui/ugu/adv</screen>
6261 Filtering source code can have nasty side effects,
6262 so make an exception for our friends at sourceforge.net,
6263 and all paths with <quote>cvs</quote> in them. Note that
6264 <literal>-<link linkend="FILTER">filter</link></literal>
6265 disables <emphasis>all</emphasis> filters in one fell swoop!
6270 # Don't filter code!
6272 { -<link linkend="FILTER">filter</link> }
6277 .sourceforge.net</screen>
6281 The actual <filename>default.action</filename> is of course much more
6282 comprehensive, but we hope this example made clear how it works.
6287 <sect3><title>user.action</title>
6290 So far we are painting with a broad brush by setting general policies,
6291 which would be a reasonable starting point for many people. Now,
6292 you might want to be more specific and have customized rules that
6293 are more suitable to your personal habits and preferences. These would
6294 be for narrowly defined situations like your ISP or your bank, and should
6295 be placed in <filename>user.action</filename>, which is parsed after all other
6296 actions files and hence has the last word, over-riding any previously
6297 defined actions. <filename>user.action</filename> is also a
6298 <emphasis>safe</emphasis> place for your personal settings, since
6299 <filename>default.action</filename> is actively maintained by the
6300 <application>Privoxy</application> developers and you'll probably want
6301 to install updated versions from time to time.
6305 So let's look at a few examples of things that one might typically do in
6306 <filename>user.action</filename>:
6310 <!-- brief sample user.action here -->
6314 # My user.action file. <fred@example.com></screen>
6318 As <link linkend="aliases">aliases</link> are local to the actions
6319 file that they are defined in, you can't use the ones from
6320 <filename>default.action</filename>, unless you repeat them here:
6325 # Aliases are local to the file they are defined in.
6326 # (Re-)define aliases for this file:
6330 # These aliases just save typing later, and the alias names should
6331 # be self explanatory.
6333 +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
6334 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
6335 allow-all-cookies = -crunch-all-cookies -session-cookies-only
6336 allow-popups = -filter{all-popups}
6337 +block-as-image = +block{Blocked as image.} +handle-as-image
6338 -block-as-image = -block
6340 # These aliases define combinations of actions that are useful for
6341 # certain types of sites:
6343 fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referrer
6344 shop = -crunch-all-cookies allow-popups
6346 # Allow ads for selected useful free sites:
6348 allow-ads = -block -filter{banners-by-size} -filter{banners-by-link}
6350 # Alias for specific file types that are text, but might have conflicting
6351 # MIME types. We want the browser to force these to be text documents.
6352 handle-as-text = -<link linkend="FILTER">filter</link> +-<link linkend="content-type-overwrite">content-type-overwrite{text/plain}</link> +-<link linkend="FORCE-TEXT-MODE">force-text-mode</link> -<link linkend="HIDE-CONTENT-DISPOSITION">hide-content-disposition</link></screen>
6357 Say you have accounts on some sites that you visit regularly, and
6358 you don't want to have to log in manually each time. So you'd like
6359 to allow persistent cookies for these sites. The
6360 <literal>allow-all-cookies</literal> alias defined above does exactly
6361 that, i.e. it disables crunching of cookies in any direction, and the
6362 processing of cookies to make them only temporary.
6367 { allow-all-cookies }
6371 .redhat.com</screen>
6375 Your bank is allergic to some filter, but you don't know which, so you disable them all:
6380 { -<link linkend="FILTER">filter</link> }
6381 .your-home-banking-site.com</screen>
6385 Some file types you may not want to filter for various reasons:
6390 # Technical documentation is likely to contain strings that might
6391 # erroneously get altered by the JavaScript-oriented filters:
6396 # And this stupid host sends streaming video with a wrong MIME type,
6397 # so that Privoxy thinks it is getting HTML and starts filtering:
6399 stupid-server.example.com/</screen>
6403 Example of a simple <link linkend="BLOCK">block</link> action. Say you've
6404 seen an ad on your favourite page on example.com that you want to get rid of.
6405 You have right-clicked the image, selected <quote>copy image location</quote>
6406 and pasted the URL below while removing the leading http://, into a
6407 <literal>{ +block{} }</literal> section. Note that <literal>{ +handle-as-image
6408 }</literal> need not be specified, since all URLs ending in
6409 <literal>.gif</literal> will be tagged as images by the general rules as set
6410 in default.action anyway:
6415 { +<link linkend="BLOCK">block</link>{Nasty ads.} }
6416 www.example.com/nasty-ads/sponsor\.gif
6417 another.example.net/more/junk/here/</screen>
6421 The URLs of dynamically generated banners, especially from large banner
6422 farms, often don't use the well-known image file name extensions, which
6423 makes it impossible for <application>Privoxy</application> to guess
6424 the file type just by looking at the URL.
6425 You can use the <literal>+block-as-image</literal> alias defined above for
6427 Note that objects which match this rule but then turn out NOT to be an
6428 image are typically rendered as a <quote>broken image</quote> icon by the
6429 browser. Use cautiously.
6438 ar.atwola.com/</screen>
6442 Now you noticed that the default configuration breaks Forbes Magazine,
6443 but you were too lazy to find out which action is the culprit, and you
6444 were again too lazy to give <link linkend="contact">feedback</link>, so
6445 you just used the <literal>fragile</literal> alias on the site, and
6446 -- <emphasis>whoa!</emphasis> -- it worked. The <literal>fragile</literal>
6447 aliases disables those actions that are most likely to break a site. Also,
6448 good for testing purposes to see if it is <application>Privoxy</application>
6449 that is causing the problem or not. We later find other regular sites
6450 that misbehave, and add those to our personalized list of troublemakers:
6458 .mybank.com</screen>
6462 You like the <quote>fun</quote> text replacements in <filename>default.filter</filename>,
6463 but it is disabled in the distributed actions file.
6464 So you'd like to turn it on in your private,
6465 update-safe config, once and for all:
6470 { +<link linkend="filter-fun">filter{fun}</link> }
6471 / # For ALL sites!</screen>
6475 Note that the above is not really a good idea: There are exceptions
6476 to the filters in <filename>default.action</filename> for things that
6477 really shouldn't be filtered, like code on CVS->Web interfaces. Since
6478 <filename>user.action</filename> has the last word, these exceptions
6479 won't be valid for the <quote>fun</quote> filtering specified here.
6483 You might also worry about how your favourite free websites are
6484 funded, and find that they rely on displaying banner advertisements
6485 to survive. So you might want to specifically allow banners for those
6486 sites that you feel provide value to you:
6498 Note that <literal>allow-ads</literal> has been aliased to
6499 <literal>-<link linkend="block">block</link></literal>,
6500 <literal>-<link linkend="filter-banners-by-size">filter{banners-by-size}</link></literal>, and
6501 <literal>-<link linkend="filter-banners-by-link">filter{banners-by-link}</link></literal> above.
6505 Invoke another alias here to force an over-ride of the MIME type <literal>
6506 application/x-sh</literal> which typically would open a download type
6507 dialog. In my case, I want to look at the shell script, and then I can save
6508 it should I choose to.
6518 <filename>user.action</filename> is generally the best place to define
6519 exceptions and additions to the default policies of
6520 <filename>default.action</filename>. Some actions are safe to have their
6521 default policies set here though. So let's set a default policy to have a
6522 <quote>blank</quote> image as opposed to the checkerboard pattern for
6523 <emphasis>ALL</emphasis> sites. <quote>/</quote> of course matches all URL
6529 { +<link linkend="set-image-blocker">set-image-blocker{blank}</link> }
6530 / # ALL sites</screen>
6536 <!-- ~ End section ~ -->
6540 <!-- ~ End section ~ -->
6542 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
6544 <sect1 id="filter-file">
6545 <title>Filter Files</title>
6548 On-the-fly text substitutions need
6549 to be defined in a <quote>filter file</quote>. Once defined, they
6550 can then be invoked as an <quote>action</quote>.
6554 &my-app; supports three different filter actions:
6555 <literal><link linkend="filter">filter</link></literal> to
6556 rewrite the content that is send to the client,
6557 <literal><link linkend="client-header-filter">client-header-filter</link></literal>
6558 to rewrite headers that are send by the client, and
6559 <literal><link linkend="server-header-filter">server-header-filter</link></literal>
6560 to rewrite headers that are send by the server.
6564 &my-app; also supports two tagger actions:
6565 <literal><link linkend="client-header-tagger">client-header-tagger</link></literal>
6567 <literal><link linkend="server-header-tagger">server-header-tagger</link></literal>.
6568 Taggers and filters use the same syntax in the filter files, the difference
6569 is that taggers don't modify the text they are filtering, but use a rewritten
6570 version of the filtered text as tag. The tags can then be used to change the
6571 applying actions through sections with <link linkend="tag-pattern">tag-patterns</link>.
6576 Multiple filter files can be defined through the <literal> <link
6577 linkend="filterfile">filterfile</link></literal> config directive. The filters
6578 as supplied by the developers are located in
6579 <filename>default.filter</filename>. It is recommended that any locally
6580 defined or modified filters go in a separately defined file such as
6581 <filename>user.filter</filename>.
6585 Common tasks for content filters are to eliminate common annoyances in
6586 HTML and JavaScript, such as pop-up windows,
6587 exit consoles, crippled windows without navigation tools, the
6588 infamous <BLINK> tag etc, to suppress images with certain
6589 width and height attributes (standard banner sizes or web-bugs),
6590 or just to have fun.
6594 Enabled content filters are applied to any content whose
6595 <quote>Content Type</quote> header is recognised as a sign
6596 of text-based content, with the exception of <literal>text/plain</literal>.
6597 Use the <link linkend="FORCE-TEXT-MODE">force-text-mode</link> action
6598 to also filter other content.
6602 Substitutions are made at the source level, so if you want to <quote>roll
6603 your own</quote> filters, you should first be familiar with HTML syntax,
6604 and, of course, regular expressions.
6608 Just like the <link linkend="actions-file">actions files</link>, the
6609 filter file is organized in sections, which are called <emphasis>filters</emphasis>
6610 here. Each filter consists of a heading line, that starts with one of the
6611 <emphasis>keywords</emphasis> <literal>FILTER:</literal>,
6612 <literal>CLIENT-HEADER-FILTER:</literal> or <literal>SERVER-HEADER-FILTER:</literal>
6613 followed by the filter's <emphasis>name</emphasis>, and a short (one line)
6614 <emphasis>description</emphasis> of what it does. Below that line
6615 come the <emphasis>jobs</emphasis>, i.e. lines that define the actual
6616 text substitutions. By convention, the name of a filter
6617 should describe what the filter <emphasis>eliminates</emphasis>. The
6618 comment is used in the <ulink url="http://config.privoxy.org/">web-based
6619 user interface</ulink>.
6623 Once a filter called <replaceable>name</replaceable> has been defined
6624 in the filter file, it can be invoked by using an action of the form
6625 +<literal><link linkend="filter">filter</link>{<replaceable>name</replaceable>}</literal>
6626 in any <link linkend="actions-file">actions file</link>.
6630 Filter definitions start with a header line that contains the filter
6631 type, the filter name and the filter description.
6632 A content filter header line for a filter called <quote>foo</quote> could look
6637 <screen>FILTER: foo Replace all "foo" with "bar"</screen>
6641 Below that line, and up to the next header line, come the jobs that
6642 define what text replacements the filter executes. They are specified
6643 in a syntax that imitates <ulink url="http://www.perl.org/">Perl</ulink>'s
6644 <literal>s///</literal> operator. If you are familiar with Perl, you
6645 will find this to be quite intuitive, and may want to look at the
6646 PCRS documentation for the subtle differences to Perl behaviour. Most
6647 notably, the non-standard option letter <literal>U</literal> is supported,
6648 which turns the default to ungreedy matching.
6653 <ulink url="http://en.wikipedia.org/wiki/Regular_expressions"><quote>Regular
6654 Expressions</quote></ulink>, you might want to take a look at
6655 the <link linkend="regex">Appendix on regular expressions</link>, and
6656 see the <ulink url="http://perldoc.perl.org/perlre.html">Perl
6658 <ulink url="http://perldoc.perl.org/perlop.html">the
6659 <literal>s///</literal> operator's syntax</ulink> and <ulink
6660 url="http://perldoc.perl.org/perlre.html">Perl-style regular
6661 expressions</ulink> in general.
6662 The below examples might also help to get you started.
6666 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
6668 <sect2><title>Filter File Tutorial</title>
6670 Now, let's complete our <quote>foo</quote> content filter. We have already defined
6671 the heading, but the jobs are still missing. Since all it does is to replace
6672 <quote>foo</quote> with <quote>bar</quote>, there is only one (trivial) job
6677 <screen>s/foo/bar/</screen>
6681 But wait! Didn't the comment say that <emphasis>all</emphasis> occurrences
6682 of <quote>foo</quote> should be replaced? Our current job will only take
6683 care of the first <quote>foo</quote> on each page. For global substitution,
6684 we'll need to add the <literal>g</literal> option:
6688 <screen>s/foo/bar/g</screen>
6692 Our complete filter now looks like this:
6695 <screen>FILTER: foo Replace all "foo" with "bar"
6696 s/foo/bar/g</screen>
6700 Let's look at some real filters for more interesting examples. Here you see
6701 a filter that protects against some common annoyances that arise from JavaScript
6702 abuse. Let's look at its jobs one after the other:
6708 FILTER: js-annoyances Get rid of particularly annoying JavaScript abuse
6710 # Get rid of JavaScript referrer tracking. Test page: http://www.randomoddness.com/untitled.htm
6712 s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|Usg</screen>
6716 Following the header line and a comment, you see the job. Note that it uses
6717 <literal>|</literal> as the delimiter instead of <literal>/</literal>, because
6718 the pattern contains a forward slash, which would otherwise have to be escaped
6719 by a backslash (<literal>\</literal>).
6723 Now, let's examine the pattern: it starts with the text <literal><script.*</literal>
6724 enclosed in parentheses. Since the dot matches any character, and <literal>*</literal>
6725 means: <quote>Match an arbitrary number of the element left of myself</quote>, this
6726 matches <quote><script</quote>, followed by <emphasis>any</emphasis> text, i.e.
6727 it matches the whole page, from the start of the first <script> tag.
6731 That's more than we want, but the pattern continues: <literal>document\.referrer</literal>
6732 matches only the exact string <quote>document.referrer</quote>. The dot needed to
6733 be <emphasis>escaped</emphasis>, i.e. preceded by a backslash, to take away its
6734 special meaning as a joker, and make it just a regular dot. So far, the meaning is:
6735 Match from the start of the first <script> tag in a the page, up to, and including,
6736 the text <quote>document.referrer</quote>, if <emphasis>both</emphasis> are present
6737 in the page (and appear in that order).
6741 But there's still more pattern to go. The next element, again enclosed in parentheses,
6742 is <literal>.*</script></literal>. You already know what <literal>.*</literal>
6743 means, so the whole pattern translates to: Match from the start of the first <script>
6744 tag in a page to the end of the last <script> tag, provided that the text
6745 <quote>document.referrer</quote> appears somewhere in between.
6749 This is still not the whole story, since we have ignored the options and the parentheses:
6750 The portions of the page matched by sub-patterns that are enclosed in parentheses, will be
6751 remembered and be available through the variables <literal>$1, $2, ...</literal> in
6752 the substitute. The <literal>U</literal> option switches to ungreedy matching, which means
6753 that the first <literal>.*</literal> in the pattern will only <quote>eat up</quote> all
6754 text in between <quote><script</quote> and the <emphasis>first</emphasis> occurrence
6755 of <quote>document.referrer</quote>, and that the second <literal>.*</literal> will
6756 only span the text up to the <emphasis>first</emphasis> <quote></script></quote>
6757 tag. Furthermore, the <literal>s</literal> option says that the match may span
6758 multiple lines in the page, and the <literal>g</literal> option again means that the
6759 substitution is global.
6763 So, to summarize, the pattern means: Match all scripts that contain the text
6764 <quote>document.referrer</quote>. Remember the parts of the script from
6765 (and including) the start tag up to (and excluding) the string
6766 <quote>document.referrer</quote> as <literal>$1</literal>, and the part following
6767 that string, up to and including the closing tag, as <literal>$2</literal>.
6771 Now the pattern is deciphered, but wasn't this about substituting things? So
6772 lets look at the substitute: <literal>$1"Not Your Business!"$2</literal> is
6773 easy to read: The text remembered as <literal>$1</literal>, followed by
6774 <literal>"Not Your Business!"</literal> (<emphasis>including</emphasis>
6775 the quotation marks!), followed by the text remembered as <literal>$2</literal>.
6776 This produces an exact copy of the original string, with the middle part
6777 (the <quote>document.referrer</quote>) replaced by <literal>"Not Your
6778 Business!"</literal>.
6782 The whole job now reads: Replace <quote>document.referrer</quote> by
6783 <literal>"Not Your Business!"</literal> wherever it appears inside a
6784 <script> tag. Note that this job won't break JavaScript syntax,
6785 since both the original and the replacement are syntactically valid
6786 string objects. The script just won't have access to the referrer
6787 information anymore.
6791 We'll show you two other jobs from the JavaScript taming department, but
6792 this time only point out the constructs of special interest:
6797 # The status bar is for displaying link targets, not pointless blahblah
6799 s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig</screen>
6803 <literal>\s</literal> stands for whitespace characters (space, tab, newline,
6804 carriage return, form feed), so that <literal>\s*</literal> means: <quote>zero
6805 or more whitespace</quote>. The <literal>?</literal> in <literal>.*?</literal>
6806 makes this matching of arbitrary text ungreedy. (Note that the <literal>U</literal>
6807 option is not set). The <literal>['"]</literal> construct means: <quote>a single
6808 <emphasis>or</emphasis> a double quote</quote>. Finally, <literal>\1</literal> is
6809 a back-reference to the first parenthesis just like <literal>$1</literal> above,
6810 with the difference that in the <emphasis>pattern</emphasis>, a backslash indicates
6811 a back-reference, whereas in the <emphasis>substitute</emphasis>, it's the dollar.
6815 So what does this job do? It replaces assignments of single- or double-quoted
6816 strings to the <quote>window.status</quote> object with a dummy assignment
6817 (using a variable name that is hopefully odd enough not to conflict with
6818 real variables in scripts). Thus, it catches many cases where e.g. pointless
6819 descriptions are displayed in the status bar instead of the link target when
6820 you move your mouse over links.
6825 # Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html
6827 s/(<body [^>]*)onunload(.*>)/$1never$2/iU</screen>
6832 <ulink url="http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Events-eventgroupings-htmlevents">OnUnload
6833 event binding</ulink> in the HTML DOM was a <emphasis>CRIME</emphasis>.
6834 When I close a browser window, I want it to close and die. Basta.
6835 This job replaces the <quote>onunload</quote> attribute in
6836 <quote><body></quote> tags with the dummy word <literal>never</literal>.
6837 Note that the <literal>i</literal> option makes the pattern matching
6838 case-insensitive. Also note that ungreedy matching alone doesn't always guarantee
6839 a minimal match: In the first parenthesis, we had to use <literal>[^>]*</literal>
6840 instead of <literal>.*</literal> to prevent the match from exceeding the
6841 <body> tag if it doesn't contain <quote>OnUnload</quote>, but the page's
6846 The last example is from the fun department:
6851 FILTER: fun Fun text replacements
6853 # Spice the daily news:
6855 s/microsoft(?!\.com)/MicroSuck/ig</screen>
6859 Note the <literal>(?!\.com)</literal> part (a so-called negative lookahead)
6860 in the job's pattern, which means: Don't match, if the string
6861 <quote>.com</quote> appears directly following <quote>microsoft</quote>
6862 in the page. This prevents links to microsoft.com from being trashed, while
6863 still replacing the word everywhere else.
6868 # Buzzword Bingo (example for extended regex syntax)
6870 s* industry[ -]leading \
6872 | customer[ -]focused \
6873 | market[ -]driven \
6874 | award[ -]winning # Comments are OK, too! \
6875 | high[ -]performance \
6876 | solutions[ -]based \
6880 *<font color="red"><b>BINGO!</b></font> \
6885 The <literal>x</literal> option in this job turns on extended syntax, and allows for
6886 e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting.
6894 <!-- ~~~~~~~~ New section Header ~~~~~~~~~ -->
6896 <sect2 id="predefined-filters"><title>The Pre-defined Filters</title>
6900 Note each filter is also listed in the +filter action section above. Please
6901 keep these listings in sync.
6906 The distribution <filename>default.filter</filename> file contains a selection of
6907 pre-defined filters for your convenience:
6912 <term><emphasis>js-annoyances</emphasis></term>
6915 The purpose of this filter is to get rid of particularly annoying JavaScript abuse.
6920 replaces JavaScript references to the browser's referrer information
6921 with the string "Not Your Business!". This compliments the <literal><link
6922 linkend="hide-referrer">hide-referrer</link></literal> action on the content level.
6927 removes the bindings to the DOM's
6928 <ulink url="http://www.w3.org/TR/2000/REC-DOM-Level-2-Events-20001113/events.html#Events-eventgroupings-htmlevents">unload
6929 event</ulink> which we feel has no right to exist and is responsible for most <quote>exit consoles</quote>, i.e.
6930 nasty windows that pop up when you close another one.
6935 removes code that causes new windows to be opened with undesired properties, such as being
6936 full-screen, non-resizeable, without location, status or menu bar etc.
6942 Use with caution. This is an aggressive filter, and can break sites that
6943 rely heavily on JavaScript.
6949 <term><emphasis>js-events</emphasis></term>
6952 This is a very radical measure. It removes virtually all JavaScript event bindings, which
6953 means that scripts can not react to user actions such as mouse movements or clicks, window
6954 resizing etc, anymore. Use with caution!
6957 We <emphasis>strongly discourage</emphasis> using this filter as a default since it breaks
6958 many legitimate scripts. It is meant for use only on extra-nasty sites (should you really
6965 <term><emphasis>html-annoyances</emphasis></term>
6968 This filter will undo many common instances of HTML based abuse.
6971 The <literal>BLINK</literal> and <literal>MARQUEE</literal> tags
6972 are neutralized (yeah baby!), and browser windows will be created as
6973 resizeable (as of course they should be!), and will have location,
6974 scroll and menu bars -- even if specified otherwise.
6980 <term><emphasis>content-cookies</emphasis></term>
6983 Most cookies are set in the HTTP dialog, where they can be intercepted
6985 <literal><link linkend="crunch-incoming-cookies">crunch-incoming-cookies</link></literal>
6986 and <literal><link linkend="crunch-outgoing-cookies">crunch-outgoing-cookies</link></literal>
6987 actions. But web sites increasingly make use of HTML meta tags and JavaScript
6988 to sneak cookies to the browser on the content level.
6991 This filter disables most HTML and JavaScript code that reads or sets
6992 cookies. It cannot detect all clever uses of these types of code, so it
6993 should not be relied on as an absolute fix. Use it wherever you would also
6994 use the cookie crunch actions.
7000 <term><emphasis>refresh tags</emphasis></term>
7003 Disable any refresh tags if the interval is greater than nine seconds (so
7004 that redirections done via refresh tags are not destroyed). This is useful
7005 for dial-on-demand setups, or for those who find this HTML feature
7012 <term><emphasis>unsolicited-popups</emphasis></term>
7015 This filter attempts to prevent only <quote>unsolicited</quote> pop-up
7016 windows from opening, yet still allow pop-up windows that the user
7017 has explicitly chosen to open. It was added in version 3.0.1,
7018 as an improvement over earlier such filters.
7021 Technical note: The filter works by redefining the window.open JavaScript
7022 function to a dummy function, <literal>PrivoxyWindowOpen()</literal>,
7023 during the loading and rendering phase of each HTML page access, and
7024 restoring the function afterward.
7027 This is recommended only for browsers that cannot perform this function
7028 reliably themselves. And be aware that some sites require such windows
7029 in order to function normally. Use with caution.
7035 <term><emphasis>all-popups</emphasis></term>
7038 Attempt to prevent <emphasis>all</emphasis> pop-up windows from opening.
7039 Note this should be used with even more discretion than the above, since
7040 it is more likely to break some sites that require pop-ups for normal
7041 usage. Use with caution.
7047 <term><emphasis>img-reorder</emphasis></term>
7050 This is a helper filter that has no value if used alone. It makes the
7051 <literal>banners-by-size</literal> and <literal>banners-by-link</literal>
7052 (see below) filters more effective and should be enabled together with them.
7058 <term><emphasis>banners-by-size</emphasis></term>
7061 This filter removes image tags purely based on what size they are. Fortunately
7062 for us, many ads and banner images tend to conform to certain standardized
7063 sizes, which makes this filter quite effective for ad stripping purposes.
7066 Occasionally this filter will cause false positives on images that are not ads,
7067 but just happen to be of one of the standard banner sizes.
7070 Recommended only for those who require extreme ad blocking. The default
7071 block rules should catch 95+% of all ads <emphasis>without</emphasis> this filter enabled.
7077 <term><emphasis>banners-by-link</emphasis></term>
7080 This is an experimental filter that attempts to kill any banners if
7081 their URLs seem to point to known or suspected click trackers. It is currently
7082 not of much value and is not recommended for use by default.
7088 <term><emphasis>webbugs</emphasis></term>
7091 Webbugs are small, invisible images (technically 1X1 GIF images), that
7092 are used to track users across websites, and collect information on them.
7093 As an HTML page is loaded by the browser, an embedded image tag causes the
7094 browser to contact a third-party site, disclosing the tracking information
7095 through the requested URL and/or cookies for that third-party domain, without
7096 the user ever becoming aware of the interaction with the third-party site.
7097 HTML-ized spam also uses a similar technique to verify email addresses.
7100 This filter removes the HTML code that loads such <quote>webbugs</quote>.
7106 <term><emphasis>tiny-textforms</emphasis></term>
7109 A rather special-purpose filter that can be used to enlarge textareas (those
7110 multi-line text boxes in web forms) and turn off hard word wrap in them.
7111 It was written for the sourceforge.net tracker system where such boxes are
7112 a nuisance, but it can be handy on other sites, too.
7115 It is not recommended to use this filter as a default.
7121 <term><emphasis>jumping-windows</emphasis></term>
7124 Many consider windows that move, or resize themselves to be abusive. This filter
7125 neutralizes the related JavaScript code. Note that some sites might not display
7126 or behave as intended when using this filter. Use with caution.
7132 <term><emphasis>frameset-borders</emphasis></term>
7135 Some web designers seem to assume that everyone in the world will view their
7136 web sites using the same browser brand and version, screen resolution etc,
7137 because only that assumption could explain why they'd use static frame sizes,
7138 yet prevent their frames from being resized by the user, should they be too
7139 small to show their whole content.
7142 This filter removes the related HTML code. It should only be applied to sites
7149 <term><emphasis>demoronizer</emphasis></term>
7152 Many Microsoft products that generate HTML use non-standard extensions (read:
7153 violations) of the ISO 8859-1 aka Latin-1 character set. This can cause those
7154 HTML documents to display with errors on standard-compliant platforms.
7157 This filter translates the MS-only characters into Latin-1 equivalents.
7158 It is not necessary when using MS products, and will cause corruption of
7159 all documents that use 8-bit character sets other than Latin-1. It's mostly
7160 worthwhile for Europeans on non-MS platforms, if weird garbage characters
7161 sometimes appear on some pages, or user agents that don't correct for this on
7164 My version of Mozilla (ancient) shows litte square boxes for quote
7165 characters, and apostrophes on moronized pages. So many pages have this, I
7166 can read them fine now. HB 08/27/06
7173 <term><emphasis>shockwave-flash</emphasis></term>
7176 A filter for shockwave haters. As the name suggests, this filter strips code
7177 out of web pages that is used to embed shockwave flash objects.
7185 <term><emphasis>quicktime-kioskmode</emphasis></term>
7188 Change HTML code that embeds Quicktime objects so that kioskmode, which
7189 prevents saving, is disabled.
7195 <term><emphasis>fun</emphasis></term>
7198 Text replacements for subversive browsing fun. Make fun of your favorite
7199 Monopolist or play buzzword bingo.
7205 <term><emphasis>crude-parental</emphasis></term>
7208 A demonstration-only filter that shows how <application>Privoxy</application>
7209 can be used to delete web content on a keyword basis.
7215 <term><emphasis>ie-exploits</emphasis></term>
7218 An experimental collection of text replacements to disable malicious HTML and JavaScript
7219 code that exploits known security holes in Internet Explorer.
7222 Presently, it only protects against Nimda and a cross-site scripting bug, and
7223 would need active maintenance to provide more substantial protection.
7229 <term><emphasis>site-specifics</emphasis></term>
7232 Some web sites have very specific problems, the cure for which doesn't apply
7233 anywhere else, or could even cause damage on other sites.
7236 This is a collection of such site-specific cures which should only be applied
7237 to the sites they were intended for, which is what the supplied
7238 <filename>default.action</filename> file does. Users shouldn't need to change
7239 anything regarding this filter.
7245 <term><emphasis>google</emphasis></term>
7248 A CSS based block for Google text ads. Also removes a width limitation
7249 and the toolbar advertisement.
7255 <term><emphasis>yahoo</emphasis></term>
7258 Another CSS based block, this time for Yahoo text ads. And removes
7259 a width limitation as well.
7265 <term><emphasis>msn</emphasis></term>
7268 Another CSS based block, this time for MSN text ads. And removes
7269 tracking URLs, as well as a width limitation.
7275 <term><emphasis>blogspot</emphasis></term>
7278 Cleans up some Blogspot blogs. Read the fine print before using this one!
7281 This filter also intentionally removes some navigation stuff and sets the
7282 page width to 100%. As a result, some rounded <quote>corners</quote> would
7283 appear to early or not at all and as fixing this would require a browser
7284 that understands background-size (CSS3), they are removed instead.
7290 <term><emphasis>xml-to-html</emphasis></term>
7293 Server-header filter to change the Content-Type from xml to html.
7299 <term><emphasis>html-to-xml</emphasis></term>
7302 Server-header filter to change the Content-Type from html to xml.
7308 <term><emphasis>no-ping</emphasis></term>
7311 Removes the non-standard <literal>ping</literal> attribute from
7312 anchor and area HTML tags.
7318 <term><emphasis>hide-tor-exit-notation</emphasis></term>
7321 Client-header filter to remove the <command>Tor</command> exit node notation
7322 found in Host and Referer headers.
7325 If &my-app; and <command>Tor</command> are chained and &my-app;
7326 is configured to use socks4a, one can use <quote>http://www.example.org.foobar.exit/</quote>
7327 to access the host <quote>www.example.org</quote> through the
7328 <command>Tor</command> exit node <quote>foobar</quote>.
7331 As the HTTP client isn't aware of this notation, it treats the
7332 whole string <quote>www.example.org.foobar.exit</quote> as host and uses it
7333 for the <quote>Host</quote> and <quote>Referer</quote> headers. From the
7334 server's point of view the resulting headers are invalid and can cause problems.
7337 An invalid <quote>Referer</quote> header can trigger <quote>hot-linking</quote>
7338 protections, an invalid <quote>Host</quote> header will make it impossible for
7339 the server to find the right vhost (several domains hosted on the same IP address).
7342 This client-header filter removes the <quote>foo.exit</quote> part in those headers
7343 to prevent the mentioned problems. Note that it only modifies
7344 the HTTP headers, it doesn't make it impossible for the server
7345 to detect your <command>Tor</command> exit node based on the IP address
7346 the request is coming from.
7353 <term><emphasis> </emphasis></term>
7367 <!-- ~ End section ~ -->
7371 <!-- ~~~~~ New section ~~~~~ -->
7373 <sect1 id="templates">
7374 <title>Privoxy's Template Files</title>
7376 All <application>Privoxy</application> built-in pages, i.e. error pages such as the
7377 <ulink url="http://show-the-404-error.page"><quote>404 - No Such Domain</quote>
7378 error page</ulink>, the <ulink
7379 url="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"><quote>BLOCKED</quote>
7381 and all pages of its <ulink url="http://config.privoxy.org/">web-based
7382 user interface</ulink>, are generated from <emphasis>templates</emphasis>.
7383 (<application>Privoxy</application> must be running for the above links to work as
7388 These templates are stored in a subdirectory of the <link linkend="confdir">configuration
7389 directory</link> called <filename>templates</filename>. On Unixish platforms,
7391 <ulink url="file:///etc/privoxy/templates/"><filename>/etc/privoxy/templates/</filename></ulink>.
7395 The templates are basically normal HTML files, but with place-holders (called symbols
7396 or exports), which <application>Privoxy</application> fills at run time. It
7397 is possible to edit the templates with a normal text editor, should you want
7398 to customize them. (<emphasis>Not recommended for the casual
7399 user</emphasis>). Should you create your own custom templates, you should use
7400 the <filename>config</filename> setting <link linkend="templdir">templdir</link>
7401 to specify an alternate location, so your templates do not get overwritten
7405 Note that just like in configuration files, lines starting
7406 with <literal>#</literal> are ignored when the templates are filled in.
7410 The place-holders are of the form <literal>@name@</literal>, and you will
7411 find a list of available symbols, which vary from template to template,
7412 in the comments at the start of each file. Note that these comments are not
7413 always accurate, and that it's probably best to look at the existing HTML
7414 code to find out which symbols are supported and what they are filled in with.
7418 A special application of this substitution mechanism is to make whole
7419 blocks of HTML code disappear when a specific symbol is set. We use this
7420 for many purposes, one of them being to include the beta warning in all
7421 our user interface (CGI) pages when <application>Privoxy</application>
7422 is in an alpha or beta development stage:
7427 <!-- @if-unstable-start -->
7429 ... beta warning HTML code goes here ...
7431 <!-- if-unstable-end@ --></screen>
7435 If the "unstable" symbol is set, everything in between and including
7436 <literal>@if-unstable-start</literal> and <literal>if-unstable-end@</literal>
7437 will disappear, leaving nothing but an empty comment:
7441 <screen><!-- --></screen>
7445 There's also an if-then-else construct and an <literal>#include</literal>
7446 mechanism, but you'll sure find out if you are inclined to edit the
7451 All templates refer to a style located at
7452 <ulink url="http://config.privoxy.org/send-stylesheet"><literal>http://config.privoxy.org/send-stylesheet</literal></ulink>.
7453 This is, of course, locally served by <application>Privoxy</application>
7454 and the source for it can be found and edited in the
7455 <filename>cgi-style.css</filename> template.
7460 <!-- ~ End section ~ -->
7464 <!-- ~~~~~ New section ~~~~~ -->
7466 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
7469 <!-- Include contacting.sgml boilerplate: -->
7471 <!-- end boilerplate -->
7475 <!-- ~ End section ~ -->
7478 <!-- ~~~~~ New section ~~~~~ -->
7479 <sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
7481 <!-- Include copyright.sgml: -->
7483 <!-- end copyright -->
7485 <!-- ~~~~~ New section ~~~~~ -->
7486 <sect2><title>License</title>
7487 <!-- Include copyright.sgml: -->
7489 <!-- end copyright -->
7491 <!-- ~ End section ~ -->
7494 <!-- ~~~~~ New section ~~~~~ -->
7496 <sect2 id="history"><title>History</title>
7497 <!-- Include history.sgml: -->
7499 <!-- end history -->
7502 <sect2 id="authors"><title>Authors</title>
7503 <!-- Include p-authors.sgml: -->
7505 <!-- end authors -->
7510 <!-- ~ End section ~ -->
7513 <!-- ~~~~~ New section ~~~~~ -->
7514 <sect1 id="seealso"><title>See Also</title>
7515 <!-- Include seealso.sgml: -->
7517 <!-- end seealso -->
7522 <!-- ~~~~~ New section ~~~~~ -->
7523 <sect1 id="appendix"><title>Appendix</title>
7526 <!-- ~~~~~ New section ~~~~~ -->
7528 <title>Regular Expressions</title>
7530 <application>Privoxy</application> uses Perl-style <quote>regular
7531 expressions</quote> in its <link linkend="actions-file">actions
7532 files</link> and <link linkend="filter-file">filter file</link>,
7533 through the <ulink url="http://www.pcre.org/">PCRE</ulink> and
7536 <ulink url="http://www.oesterhelt.org/pcrs/">PCRS</ulink> libraries.
7538 <application>PCRS</application> libraries.
7542 If you are reading this, you probably don't understand what <quote>regular
7543 expressions</quote> are, or what they can do. So this will be a very brief
7544 introduction only. A full explanation would require a <ulink
7545 url="http://www.oreilly.com/catalog/regex/">book</ulink> ;-)
7549 Regular expressions provide a language to describe patterns that can be
7550 run against strings of characters (letter, numbers, etc), to see if they
7551 match the string or not. The patterns are themselves (sometimes complex)
7552 strings of literal characters, combined with wild-cards, and other special
7553 characters, called meta-characters. The <quote>meta-characters</quote> have
7554 special meanings and are used to build complex patterns to be matched against.
7555 Perl Compatible Regular Expressions are an especially convenient
7556 <quote>dialect</quote> of the regular expression language.
7560 To make a simple analogy, we do something similar when we use wild-card
7561 characters when listing files with the <command>dir</command> command in DOS.
7562 <literal>*.*</literal> matches all filenames. The <quote>special</quote>
7563 character here is the asterisk which matches any and all characters. We can be
7564 more specific and use <literal>?</literal> to match just individual
7565 characters. So <quote>dir file?.text</quote> would match
7566 <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
7567 matching, using a similar technique to <quote>regular expressions</quote>!
7571 Regular expressions do essentially the same thing, but are much, much more
7572 powerful. There are many more <quote>special characters</quote> and ways of
7573 building complex patterns however. Let's look at a few of the common ones,
7574 and then some examples:
7579 <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
7580 <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
7582 </simplelist></para>
7586 <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
7589 </simplelist></para>
7593 <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
7596 </simplelist></para>
7600 <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
7603 </simplelist></para>
7607 <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
7608 the following character should be taken literally. This is used where one of the
7609 special characters (e.g. <quote>.</quote>) needs to be taken literally and
7610 not as a special meta-character. Example: <quote>example\.com</quote>, makes
7611 sure the period is recognized only as a period (and not expanded to its
7612 meta-character meaning of any single character).
7614 </simplelist></para>
7618 <emphasis>[ ]</emphasis> - Characters enclosed in brackets will be matched if
7619 any of the enclosed characters are encountered. For instance, <quote>[0-9]</quote>
7620 matches any numeric digit (zero through nine). As an example, we can combine
7621 this with <quote>+</quote> to match any digit one of more times: <quote>[0-9]+</quote>.
7623 </simplelist></para>
7627 <emphasis>( )</emphasis> - parentheses are used to group a sub-expression,
7628 or multiple sub-expressions.
7630 </simplelist></para>
7634 <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
7635 <quote>or</quote> conditional statement. A match is successful if the
7636 sub-expression on either side of <quote>|</quote> matches. As an example:
7637 <quote>/(this|that) example/</quote> uses grouping and the bar character
7638 and would match either <quote>this example</quote> or <quote>that
7639 example</quote>, and nothing else.
7641 </simplelist></para>
7644 These are just some of the ones you are likely to use when matching URLs with
7645 <application>Privoxy</application>, and is a long way from a definitive
7646 list. This is enough to get us started with a few simple examples which may
7647 be more illuminating:
7651 <emphasis><literal>/.*/banners/.*</literal></emphasis> - A simple example
7652 that uses the common combination of <quote>.</quote> and <quote>*</quote> to
7653 denote any character, zero or more times. In other words, any string at all.
7654 So we start with a literal forward slash, then our regular expression pattern
7655 (<quote>.*</quote>) another literal forward slash, the string
7656 <quote>banners</quote>, another forward slash, and lastly another
7657 <quote>.*</quote>. We are building
7658 a directory path here. This will match any file with the path that has a
7659 directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
7660 any characters, and this could conceivably be more forward slashes, so it
7661 might expand into a much longer looking path. For example, this could match:
7662 <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
7663 <quote>/banners/annoying.html</quote>, or almost an infinite number of other
7664 possible combinations, just so it has <quote>banners</quote> in the path
7669 And now something a little more complex:
7673 <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> -
7674 We have several literal forward slashes again (<quote>/</quote>), so we are
7675 building another expression that is a file path statement. We have another
7676 <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
7677 it matches our expression. The only true literal that <emphasis>must
7678 match</emphasis> our pattern is <application>adv</application>, together with
7679 the forward slashes. What comes after the <quote>adv</quote> string is the
7684 Remember the <quote>?</quote> means the preceding expression (either a
7685 literal character or anything grouped with <quote>(...)</quote> in this case)
7686 can exist or not, since this means either zero or one match. So
7687 <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
7688 individual sub-expressions: <quote>(er)</quote>,
7689 <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
7690 means <quote>or</quote>. We have two of those. For instance,
7691 <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote>
7692 <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
7693 attempt at matching as many variations of <quote>advertisement</quote>, and
7694 similar, as possible. So this would expand to match just <quote>adv</quote>,
7695 or <quote>advert</quote>, or <quote>adverts</quote>, or
7696 <quote>advertising</quote>, or <quote>advertisement</quote>, or
7697 <quote>advertisements</quote>. You get the idea. But it would not match
7698 <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
7699 changing our regular expression to:
7700 <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
7705 <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again
7706 another path statement with forward slashes. Anything in the square brackets
7707 <quote>[ ]</quote> can be matched. This is using <quote>0-9</quote> as a
7708 shorthand expression to mean any digit one through nine. It is the same as
7709 saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
7710 means one or more of the preceding expression must be included. The preceding
7711 expression here is what is in the square brackets -- in this case, any digit
7712 one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>.
7713 This includes a <quote>|</quote>, so this needs to match the expression on
7714 either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
7715 side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
7716 since the <quote>?</quote> means the letter <quote>e</quote> is optional and
7717 can be matched once or not at all. So we are building an expression here to
7718 match image GIF or JPEG type image file. It must include the literal
7719 string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
7720 (which is now a literal, and not a special character, since it is escaped
7721 with <quote>\</quote>), and lastly either <quote>gif</quote>, or
7722 <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
7723 include: <quote>//advert1.jpg</quote>,
7724 <quote>/nasty/ads/advert1234.gif</quote>,
7725 <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
7726 <quote>advert1.gif</quote> (no leading slash), or
7727 <quote>/adverts232.jpg</quote> (the expression does not include an
7728 <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
7729 in the expression anywhere).
7733 We are barely scratching the surface of regular expressions here so that you
7734 can understand the default <application>Privoxy</application>
7735 configuration files, and maybe use this knowledge to customize your own
7736 installation. There is much, much more that can be done with regular
7737 expressions. Now that you know enough to get started, you can learn more on
7742 More reading on Perl Compatible Regular expressions:
7743 <ulink url="http://perldoc.perl.org/perlre.html">http://perldoc.perl.org/perlre.html</ulink>
7747 For information on regular expression based substitutions and their applications
7748 in filters, please see the <link linkend="filter-file">filter file tutorial</link>
7753 <!-- ~ End section ~ -->
7756 <!-- ~~~~~ New section ~~~~~ -->
7758 <title>Privoxy's Internal Pages</title>
7761 Since <application>Privoxy</application> proxies each requested
7762 web page, it is easy for <application>Privoxy</application> to
7763 trap certain special URLs. In this way, we can talk directly to
7764 <application>Privoxy</application>, and see how it is
7765 configured, see how our rules are being applied, change these
7766 rules and other configuration options, and even turn
7767 <application>Privoxy's</application> filtering off, all with
7773 The URLs listed below are the special ones that allow direct access
7774 to <application>Privoxy</application>. Of course,
7775 <application>Privoxy</application> must be running to access these. If
7776 not, you will get a friendly error message. Internet access is not
7789 <ulink url="http://config.privoxy.org/">http://config.privoxy.org/</ulink>
7793 There is a shortcut: <ulink url="http://p.p/">http://p.p/</ulink> (But it
7794 doesn't provide a fall-back to a real page, in case the request is not
7795 sent through <application>Privoxy</application>)
7801 Show information about the current configuration, including viewing and
7802 editing of actions files:
7806 <ulink url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status</ulink>
7813 Show the source code version numbers:
7817 <ulink url="http://config.privoxy.org/show-version">http://config.privoxy.org/show-version</ulink>
7824 Show the browser's request headers:
7828 <ulink url="http://config.privoxy.org/show-request">http://config.privoxy.org/show-request</ulink>
7835 Show which actions apply to a URL and why:
7839 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
7846 Toggle Privoxy on or off. This feature can be turned off/on in the main
7847 <filename>config</filename> file. When toggled <quote>off</quote>, <quote>Privoxy</quote>
7848 continues to run, but only as a pass-through proxy, with no actions taking
7853 <ulink url="http://config.privoxy.org/toggle">http://config.privoxy.org/toggle</ulink>
7857 Short cuts. Turn off, then on:
7861 <ulink url="http://config.privoxy.org/toggle?set=disable">http://config.privoxy.org/toggle?set=disable</ulink>
7866 <ulink url="http://config.privoxy.org/toggle?set=enable">http://config.privoxy.org/toggle?set=enable</ulink>
7875 These may be bookmarked for quick reference. See next.
7879 <sect3 id="bookmarklets">
7880 <title>Bookmarklets</title>
7882 Below are some <quote>bookmarklets</quote> to allow you to easily access a
7883 <quote>mini</quote> version of some of <application>Privoxy's</application>
7884 special pages. They are designed for MS Internet Explorer, but should work
7885 equally well in Netscape, Mozilla, and other browsers which support
7886 JavaScript. They are designed to run directly from your bookmarks - not by
7887 clicking the links below (although that should work for testing).
7890 To save them, right-click the link and choose <quote>Add to Favorites</quote>
7891 (IE) or <quote>Add Bookmark</quote> (Netscape). You will get a warning that
7892 the bookmark <quote>may not be safe</quote> - just click OK. Then you can run the
7893 Bookmarklet directly from your favorites/bookmarks. For even faster access,
7894 you can put them on the <quote>Links</quote> bar (IE) or the <quote>Personal
7895 Toolbar</quote> (Netscape), and run them with a single click.
7904 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>
7911 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>
7918 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)
7925 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>
7931 <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>
7937 <ulink url="javascript:void(window.open('http://config.privoxy.org/show-url-info?url='+escape(location.href),'Why').focus());">Privoxy - Why?</ulink>
7944 Credit: The site which gave us the general idea for these bookmarklets is
7945 <ulink url="http://www.bookmarklets.com/">www.bookmarklets.com</ulink>. They
7946 have more information about bookmarklets.
7955 <!-- ~~~~~ New section ~~~~~ -->
7957 <title>Chain of Events</title>
7959 Let's take a quick look at how some of <application>Privoxy's</application>
7960 core features are triggered, and the ensuing sequence of events when a web
7961 page is requested by your browser:
7968 First, your web browser requests a web page. The browser knows to send
7969 the request to <application>Privoxy</application>, which will in turn,
7970 relay the request to the remote web server after passing the following
7976 <application>Privoxy</application> traps any request for its own internal CGI
7977 pages (e.g <ulink url="http://p.p/">http://p.p/</ulink>) and sends the CGI page back to the browser.
7982 Next, <application>Privoxy</application> checks to see if the URL
7984 linkend="BLOCK"><quote>+block</quote></link> patterns. If
7985 so, the URL is then blocked, and the remote web server will not be contacted.
7986 <link linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>
7988 <link linkend="HANDLE-AS-EMPTY-DOCUMENT"><quote>+handle-as-empty-document</quote></link>
7989 are then checked, and if there is no match, an
7990 HTML <quote>BLOCKED</quote> page is sent back to the browser. Otherwise, if
7991 it does match, an image is returned for the former, and an empty text
7992 document for the latter. The type of image would depend on the setting of
7993 <link linkend="SET-IMAGE-BLOCKER"><quote>+set-image-blocker</quote></link>
7994 (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere).
7999 Untrusted URLs are blocked. If URLs are being added to the
8000 <filename>trust</filename> file, then that is done.
8005 If the URL pattern matches the <link
8006 linkend="FAST-REDIRECTS"><quote>+fast-redirects</quote></link> action,
8007 it is then processed. Unwanted parts of the requested URL are stripped.
8012 Now the rest of the client browser's request headers are processed. If any
8013 of these match any of the relevant actions (e.g. <link
8014 linkend="HIDE-USER-AGENT"><quote>+hide-user-agent</quote></link>,
8015 etc.), headers are suppressed or forged as determined by these actions and
8021 Now the web server starts sending its response back (i.e. typically a web
8027 First, the server headers are read and processed to determine, among other
8028 things, the MIME type (document type) and encoding. The headers are then
8029 filtered as determined by the
8030 <link linkend="CRUNCH-INCOMING-COOKIES"><quote>+crunch-incoming-cookies</quote></link>,
8031 <link linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>,
8032 and <link linkend="DOWNGRADE-HTTP-VERSION"><quote>+downgrade-http-version</quote></link>
8038 If any <link linkend="FILTER"><quote>+filter</quote></link> action
8040 linkend="DEANIMATE-GIFS"><quote>+deanimate-gifs</quote></link>
8041 action applies (and the document type fits the action), the rest of the page is
8042 read into memory (up to a configurable limit). Then the filter rules (from
8043 <filename>default.filter</filename> and any other filter files) are
8044 processed against the buffered content. Filters are applied in the order
8045 they are specified in one of the filter files. Animated GIFs, if present,
8046 are reduced to either the first or last frame, depending on the action
8047 setting.The entire page, which is now filtered, is then sent by
8048 <application>Privoxy</application> back to your browser.
8051 If neither a <link linkend="FILTER"><quote>+filter</quote></link> action
8053 linkend="DEANIMATE-GIFS"><quote>+deanimate-gifs</quote></link>
8054 matches, then <application>Privoxy</application> passes the raw data through
8055 to the client browser as it becomes available.
8060 As the browser receives the now (possibly filtered) page content, it
8061 reads and then requests any URLs that may be embedded within the page
8062 source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g.
8063 frames), sounds, etc. For each of these objects, the browser issues a
8064 separate request (this is easily viewable in <application>Privoxy's</application>
8065 logs). And each such request is in turn processed just as above. Note that a
8066 complex web page will have many, many such embedded URLs. If these
8067 secondary requests are to a different server, then quite possibly a very
8068 differing set of actions is triggered.
8075 NOTE: This is somewhat of a simplistic overview of what happens with each URL
8076 request. For the sake of brevity and simplicity, we have focused on
8077 <application>Privoxy's</application> core features only.
8083 <!-- ~~~~~ New section ~~~~~ -->
8084 <sect2 id="actionsanat">
8085 <title>Troubleshooting: Anatomy of an Action</title>
8088 The way <application>Privoxy</application> applies
8089 <link linkend="ACTIONS">actions</link> and <link linkend="FILTER">filters</link>
8090 to any given URL can be complex, and not always so
8091 easy to understand what is happening. And sometimes we need to be able to
8092 <emphasis>see</emphasis> just what <application>Privoxy</application> is
8093 doing. Especially, if something <application>Privoxy</application> is doing
8094 is causing us a problem inadvertently. It can be a little daunting to look at
8095 the actions and filters files themselves, since they tend to be filled with
8096 <link linkend="regex">regular expressions</link> whose consequences are not
8101 One quick test to see if <application>Privoxy</application> is causing a problem
8102 or not, is to disable it temporarily. This should be the first troubleshooting
8103 step. See <link linkend="bookmarklets">the Bookmarklets</link> section on a quick
8104 and easy way to do this (be sure to flush caches afterward!). Looking at the
8105 logs is a good idea too. (Note that both the toggle feature and logging are
8106 enabled via <filename>config</filename> file settings, and may need to be
8107 turned <quote>on</quote>.)
8110 Another easy troubleshooting step to try is if you have done any
8111 customization of your installation, revert back to the installed
8112 defaults and see if that helps. There are times the developers get complaints
8113 about one thing or another, and the problem is more related to a customized
8114 configuration issue.
8118 <application>Privoxy</application> also provides the
8119 <ulink url="http://config.privoxy.org/show-url-info">http://config.privoxy.org/show-url-info</ulink>
8120 page that can show us very specifically how <application>actions</application>
8121 are being applied to any given URL. This is a big help for troubleshooting.
8125 First, enter one URL (or partial URL) at the prompt, and then
8126 <application>Privoxy</application> will tell us
8127 how the current configuration will handle it. This will not
8128 help with filtering effects (i.e. the <link
8129 linkend="FILTER"><quote>+filter</quote></link> action) from
8130 one of the filter files since this is handled very
8131 differently and not so easy to trap! It also will not tell you about any other
8132 URLs that may be embedded within the URL you are testing. For instance, images
8133 such as ads are expressed as URLs within the raw page source of HTML pages. So
8134 you will only get info for the actual URL that is pasted into the prompt area
8135 -- not any sub-URLs. If you want to know about embedded URLs like ads, you
8136 will have to dig those out of the HTML source. Use your browser's <quote>View
8137 Page Source</quote> option for this. Or right click on the ad, and grab the
8142 Let's try an example, <ulink url="http://google.com">google.com</ulink>,
8143 and look at it one section at a time in a sample configuration (your real
8144 configuration may vary):
8149 Matches for http://www.google.com:
8151 In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
8153 {+deanimate-gifs {last}
8154 +fast-redirects {check-decoded-url}
8155 +filter {refresh-tags}
8156 +filter {img-reorder}
8157 +filter {banners-by-size}
8159 +filter {jumping-windows}
8160 +filter {ie-exploits}
8161 +hide-forwarded-for-headers
8162 +hide-from-header {block}
8163 +hide-referrer {forge}
8164 +session-cookies-only
8165 +set-image-blocker {pattern}
8168 { -session-cookies-only }
8174 In file: user.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
8175 (no matches in this file)
8180 This is telling us how we have defined our
8181 <link linkend="ACTIONS"><quote>actions</quote></link>, and
8182 which ones match for our test case, <quote>google.com</quote>.
8183 Displayed is all the actions that are available to us. Remember,
8184 the <literal>+</literal> sign denotes <quote>on</quote>. <literal>-</literal>
8185 denotes <quote>off</quote>. So some are <quote>on</quote> here, but many
8186 are <quote>off</quote>. Each example we try may provide a slightly different
8187 end result, depending on our configuration directives.
8191 is for our <filename>default.action</filename> file. The large, multi-line
8192 listing, is how the actions are set to match for all URLs, i.e. our default
8193 settings. If you look at your <quote>actions</quote> file, this would be the
8194 section just below the <quote>aliases</quote> section near the top. This
8195 will apply to all URLs as signified by the single forward slash at the end
8196 of the listing -- <quote> / </quote>.
8200 But we have defined additional actions that would be exceptions to these general
8201 rules, and then we list specific URLs (or patterns) that these exceptions
8202 would apply to. Last match wins. Just below this then are two explicit
8203 matches for <quote>.google.com</quote>. The first is negating our previous
8204 cookie setting, which was for <link
8205 linkend="SESSION-COOKIES-ONLY"><quote>+session-cookies-only</quote></link>
8206 (i.e. not persistent). So we will allow persistent cookies for google, at
8207 least that is how it is in this example. The second turns
8208 <emphasis>off</emphasis> any <link
8209 linkend="FAST-REDIRECTS"><quote>+fast-redirects</quote></link>
8210 action, allowing this to take place unmolested. Note that there is a leading
8211 dot here -- <quote>.google.com</quote>. This will match any hosts and
8212 sub-domains, in the google.com domain also, such as
8213 <quote>www.google.com</quote> or <quote>mail.google.com</quote>. But it would not
8214 match <quote>www.google.de</quote>! So, apparently, we have these two actions
8215 defined as exceptions to the general rules at the top somewhere in the lower
8216 part of our <filename>default.action</filename> file, and
8217 <quote>google.com</quote> is referenced somewhere in these latter sections.
8221 Then, for our <filename>user.action</filename> file, we again have no hits.
8222 So there is nothing google-specific that we might have added to our own, local
8223 configuration. If there was, those actions would over-rule any actions from
8224 previously processed files, such as <filename>default.action</filename>.
8225 <filename>user.action</filename> typically has the last word. This is the
8226 best place to put hard and fast exceptions,
8230 And finally we pull it all together in the bottom section and summarize how
8231 <application>Privoxy</application> is applying all its <quote>actions</quote>
8232 to <quote>google.com</quote>:
8243 -client-header-filter{hide-tor-exit-notation}
8244 -content-type-overwrite
8245 -crunch-client-header
8246 -crunch-if-none-match
8247 -crunch-incoming-cookies
8248 -crunch-outgoing-cookies
8249 -crunch-server-header
8250 +deanimate-gifs {last}
8251 -downgrade-http-version
8254 -filter {content-cookies}
8255 -filter {all-popups}
8256 -filter {banners-by-link}
8257 -filter {tiny-textforms}
8258 -filter {frameset-borders}
8259 -filter {demoronizer}
8260 -filter {shockwave-flash}
8261 -filter {quicktime-kioskmode}
8263 -filter {crude-parental}
8264 -filter {site-specifics}
8265 -filter {js-annoyances}
8266 -filter {html-annoyances}
8267 +filter {refresh-tags}
8268 -filter {unsolicited-popups}
8269 +filter {img-reorder}
8270 +filter {banners-by-size}
8272 +filter {jumping-windows}
8273 +filter {ie-exploits}
8280 -handle-as-empty-document
8282 -hide-accept-language
8283 -hide-content-disposition
8284 +hide-forwarded-for-headers
8285 +hide-from-header {block}
8286 -hide-if-modified-since
8287 +hide-referrer {forge}
8290 -overwrite-last-modified
8291 -prevent-compression
8293 -server-header-filter{xml-to-html}
8294 -server-header-filter{html-to-xml}
8295 -session-cookies-only
8296 +set-image-blocker {pattern} </screen>
8300 Notice the only difference here to the previous listing, is to
8301 <quote>fast-redirects</quote> and <quote>session-cookies-only</quote>,
8302 which are activated specifically for this site in our configuration,
8303 and thus show in the <quote>Final Results</quote>.
8307 Now another example, <quote>ad.doubleclick.net</quote>:
8313 { +block{Domains starts with "ad"} }
8316 { +block{Domain contains "ad"} }
8319 { +block{Doubleclick banner server} +handle-as-image }
8320 .[a-vx-z]*.doubleclick.net
8325 We'll just show the interesting part here - the explicit matches. It is
8326 matched three different times. Two <quote>+block{}</quote> sections,
8327 and a <quote>+block{} +handle-as-image</quote>,
8328 which is the expanded form of one of our aliases that had been defined as:
8329 <quote>+block-as-image</quote>. (<link
8330 linkend="ALIASES"><quote>Aliases</quote></link> are defined in
8331 the first section of the actions file and typically used to combine more
8336 Any one of these would have done the trick and blocked this as an unwanted
8337 image. This is unnecessarily redundant since the last case effectively
8338 would also cover the first. No point in taking chances with these guys
8339 though ;-) Note that if you want an ad or obnoxious
8340 URL to be invisible, it should be defined as <quote>ad.doubleclick.net</quote>
8341 is done here -- as both a <link
8342 linkend="BLOCK"><quote>+block{}</quote></link>
8343 <emphasis>and</emphasis> an
8344 <link linkend="HANDLE-AS-IMAGE"><quote>+handle-as-image</quote></link>.
8345 The custom alias <quote><literal>+block-as-image</literal></quote> just
8346 simplifies the process and make it more readable.
8350 One last example. Let's try <quote>http://www.example.net/adsl/HOWTO/</quote>.
8351 This one is giving us problems. We are getting a blank page. Hmmm ...
8357 Matches for http://www.example.net/adsl/HOWTO/:
8359 In file: default.action <guibutton>[ View ]</guibutton> <guibutton>[ Edit ]</guibutton>
8363 -client-header-filter{hide-tor-exit-notation}
8364 -content-type-overwrite
8365 -crunch-client-header
8366 -crunch-if-none-match
8367 -crunch-incoming-cookies
8368 -crunch-outgoing-cookies
8369 -crunch-server-header
8371 -downgrade-http-version
8372 +fast-redirects {check-decoded-url}
8374 -filter {content-cookies}
8375 -filter {all-popups}
8376 -filter {banners-by-link}
8377 -filter {tiny-textforms}
8378 -filter {frameset-borders}
8379 -filter {demoronizer}
8380 -filter {shockwave-flash}
8381 -filter {quicktime-kioskmode}
8383 -filter {crude-parental}
8384 -filter {site-specifics}
8385 -filter {js-annoyances}
8386 -filter {html-annoyances}
8387 +filter {refresh-tags}
8388 -filter {unsolicited-popups}
8389 +filter {img-reorder}
8390 +filter {banners-by-size}
8392 +filter {jumping-windows}
8393 +filter {ie-exploits}
8400 -handle-as-empty-document
8402 -hide-accept-language
8403 -hide-content-disposition
8404 +hide-forwarded-for-headers
8405 +hide-from-header{block}
8406 +hide-referer{forge}
8408 -overwrite-last-modified
8409 +prevent-compression
8411 -server-header-filter{xml-to-html}
8412 -server-header-filter{html-to-xml}
8413 +session-cookies-only
8414 +set-image-blocker{blank} }
8417 { +block{Path contains "ads".} +handle-as-image }
8423 Ooops, the <quote>/adsl/</quote> is matching <quote>/ads</quote> in our
8424 configuration! But we did not want this at all! Now we see why we get the
8425 blank page. It is actually triggering two different actions here, and
8426 the effects are aggregated so that the URL is blocked, and &my-app; is told
8427 to treat the block as if it were an image. But this is, of course, all wrong.
8428 We could now add a new action below this (or better in our own
8429 <filename>user.action</filename> file) that explicitly
8430 <emphasis>un</emphasis> blocks (
8431 <link linkend="BLOCK"><quote>{-block}</quote></link>) paths with
8432 <quote>adsl</quote> in them (remember, last match in the configuration
8433 wins). There are various ways to handle such exceptions. Example:
8445 Now the page displays ;-)
8446 Remember to flush your browser's caches when making these kinds of changes to
8447 your configuration to insure that you get a freshly delivered page! Or, try
8448 using <literal>Shift+Reload</literal>.
8452 But now what about a situation where we get no explicit matches like
8459 { +block{Path starts with "ads".} +handle-as-image }
8465 That actually was very helpful and pointed us quickly to where the problem
8466 was. If you don't get this kind of match, then it means one of the default
8467 rules in the first section of <filename>default.action</filename> is causing
8468 the problem. This would require some guesswork, and maybe a little trial and
8469 error to isolate the offending rule. One likely cause would be one of the
8470 <link linkend="FILTER"><quote>+filter</quote></link> actions.
8471 These tend to be harder to troubleshoot.
8472 Try adding the URL for the site to one of aliases that turn off
8473 <link linkend="FILTER"><quote>+filter</quote></link>:
8481 .worldpay.com # for quietpc.com
8489 <quote><literal>{ shop }</literal></quote> is an <quote>alias</quote> that expands to
8490 <quote><literal>{ -filter -session-cookies-only }</literal></quote>.
8491 Or you could do your own exception to negate filtering:
8499 # Disable ALL filter actions for sites in this section
8507 This would turn off all filtering for these sites. This is best
8508 put in <filename>user.action</filename>, for local site
8509 exceptions. Note that when a simple domain pattern is used by itself (without
8510 the subsequent path portion), all sub-pages within that domain are included
8511 automatically in the scope of the action.
8515 Images that are inexplicably being blocked, may well be hitting the
8516 <link linkend="FILTER-BANNERS-BY-SIZE"><quote>+filter{banners-by-size}</quote></link>
8518 that images of certain sizes are ad banners (works well
8519 <emphasis>most of the time</emphasis> since these tend to be standardized).
8523 <quote><literal>{ fragile }</literal></quote> is an alias that disables most
8524 actions that are the most likely to cause trouble. This can be used as a
8525 last resort for problem sites.
8531 # Handle with care: easy to break
8533 mybank.example.com</screen>
8538 <emphasis>Remember to flush caches!</emphasis> Note that the
8539 <literal>mail.google</literal> reference lacks the TLD portion (e.g.
8540 <quote>.com</quote>). This will effectively match any TLD with
8541 <literal>google</literal> in it, such as <literal>mail.google.de.</literal>,
8545 If this still does not work, you will have to go through the remaining
8546 actions one by one to find which one(s) is causing the problem.
8555 This program is free software; you can redistribute it
8556 and/or modify it under the terms of the GNU General
8557 Public License as published by the Free Software
8558 Foundation; either version 2 of the License, or (at
8559 your option) any later version.
8561 This program is distributed in the hope that it will
8562 be useful, but WITHOUT ANY WARRANTY; without even the
8563 implied warranty of MERCHANTABILITY or FITNESS FOR A
8564 PARTICULAR PURPOSE. See the GNU General Public
8565 License for more details.
8567 The GNU General Public License should be included with
8568 this file. If not, you can view it at
8569 http://www.gnu.org/copyleft/gpl.html
8570 or write to the Free Software Foundation, Inc.,
8571 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
8574 $Log: user-manual.sgml,v $
8575 Revision 2.69 2008/03/29 12:14:25 fabiankeil
8576 Remove send-wafer and send-vanilla-wafer actions.
8578 Revision 2.68 2008/03/28 15:13:43 fabiankeil
8579 Remove inspect-jpegs action.
8581 Revision 2.67 2008/03/27 18:31:21 fabiankeil
8582 Remove kill-popups action.
8584 Revision 2.66 2008/03/06 16:33:47 fabiankeil
8585 If limit-connect isn't used, don't limit CONNECT requests to port 443.
8587 Revision 2.65 2008/03/04 18:30:40 fabiankeil
8588 Remove the treat-forbidden-connects-like-blocks action. We now
8589 use the "blocked" page for forbidden CONNECT requests by default.
8591 Revision 2.64 2008/03/01 14:10:28 fabiankeil
8592 Use new block syntax. Still needs some polishing.
8594 Revision 2.63 2008/02/22 05:50:37 markm68k
8597 Revision 2.62 2008/02/11 11:52:23 hal9
8598 Fix entity ... s/&/&
8600 Revision 2.61 2008/02/11 03:41:47 markm68k
8601 more updates for mac os x
8603 Revision 2.60 2008/02/11 03:40:25 markm68k
8604 more updates for mac os x
8606 Revision 2.59 2008/02/11 00:52:34 markm68k
8607 reflect new changes for mac os x
8609 Revision 2.58 2008/02/03 21:37:40 hal9
8610 Apply patch from Mark: s/OSX/OS X/
8612 Revision 2.57 2008/02/03 19:10:14 fabiankeil
8613 Mention forward-socks5.
8615 Revision 2.56 2008/01/31 19:11:35 fabiankeil
8616 Let the +client-header-filter{hide-tor-exit-notation} example apply
8617 to all requests as "tainted" Referers aren't limited to exit TLDs.
8619 Revision 2.55 2008/01/19 21:26:37 hal9
8620 Add IE7 to configuration section per Gerry.
8622 Revision 2.54 2008/01/19 17:52:39 hal9
8623 Re-commit to fix various minor issues for new release.
8625 Revision 2.53 2008/01/19 15:03:05 hal9
8626 Doc sources tagged for 3.0.8 release.
8628 Revision 2.52 2008/01/17 01:49:51 hal9
8629 Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
8632 Revision 2.51 2007/12/23 16:48:24 fabiankeil
8633 Use more precise example descriptions for the mysterious domain patterns.
8635 Revision 2.50 2007/12/08 12:44:36 fabiankeil
8636 - Remove already commented out pre-3.0.7 changes.
8637 - Update the "new log defaults" paragraph.
8639 Revision 2.49 2007/12/06 18:21:55 fabiankeil
8640 Update hide-forwarded-for-headers description.
8642 Revision 2.48 2007/11/24 19:07:17 fabiankeil
8643 - Mention request rewriting.
8644 - Enable the conditional-forge paragraph.
8647 Revision 2.47 2007/11/18 14:59:47 fabiankeil
8648 A few "Note to Upgraders" updates.
8650 Revision 2.46 2007/11/17 17:24:44 fabiankeil
8651 - Use new action defaults.
8652 - Minor fixes and rewordings.
8654 Revision 2.45 2007/11/16 11:48:46 hal9
8655 Fix one typo, and add a couple of small refinements.
8657 Revision 2.44 2007/11/15 03:30:20 hal9
8658 Results of spell check.
8660 Revision 2.43 2007/11/14 18:45:39 fabiankeil
8661 - Mention some more contributors in the "New in this Release" list.
8664 Revision 2.42 2007/11/12 03:32:40 hal9
8665 Updates for "What's New" and "Notes to Upgraders". Various other changes in
8666 preparation for new release. User Manual is almost ready.
8668 Revision 2.41 2007/11/11 16:32:11 hal9
8669 This is primarily syncing What's New and Note to Upgraders sections with the many
8670 new features and changes (gleaned from memory but mostly from ChangeLog).
8672 Revision 2.40 2007/11/10 17:10:59 fabiankeil
8673 In the first third of the file, mention several times that
8674 the action editor is disabled by default in 3.0.7 beta and later.
8676 Revision 2.39 2007/11/05 02:34:49 hal9
8677 Various changes in preparation for the upcoming release. Much yet to be done.
8679 Revision 2.38 2007/09/22 16:01:42 fabiankeil
8680 Update embedded show-url-info output.
8682 Revision 2.37 2007/08/27 16:09:55 fabiankeil
8683 Fix pre-chroot-nslookup description which I failed to
8684 copy and paste properly. Reported by Stephen Gildea.
8686 Revision 2.36 2007/08/26 16:47:14 fabiankeil
8687 Add Stephen Gildea's pre-chroot-nslookup patch [#1276666],
8688 extensive comments moved to user manual.
8690 Revision 2.35 2007/08/26 14:59:49 fabiankeil
8691 Minor rewordings and fixes.
8693 Revision 2.34 2007/08/05 15:19:50 fabiankeil
8694 - Don't claim HTTP/1.1 compliance.
8695 - Use $ in some of the path pattern examples.
8696 - Use a hide-user-agent example argument without
8697 leading and trailing space.
8698 - Make it clear that the cookie actions work with
8700 - Rephrase the inspect-jpegs text to underline
8701 that it's only meant to protect against a single
8704 Revision 2.33 2007/07/27 10:57:35 hal9
8705 Add references for user-agent strings for hide-user-agenet
8707 Revision 2.32 2007/06/07 12:36:22 fabiankeil
8708 Apply Roland's 29_usermanual.dpatch to fix a bunch
8709 of syntax errors I collected over the last months.
8711 Revision 2.31 2007/06/02 14:01:37 fabiankeil
8712 Start to document forward-override{}.
8714 Revision 2.30 2007/04/25 15:10:36 fabiankeil
8715 - Describe installation for FreeBSD.
8716 - Start to document taggers and tag patterns.
8717 - Don't confuse devils and daemons.
8719 Revision 2.29 2007/04/05 11:47:51 fabiankeil
8720 Some updates regarding header filtering,
8721 handling of compressed content and redirect's
8722 support for pcrs commands.
8724 Revision 2.28 2006/12/10 23:42:48 hal9
8725 Fix various typos reported by Adam P. Thanks.
8727 Revision 2.27 2006/11/14 01:57:47 hal9
8728 Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
8731 Revision 2.26 2006/10/24 11:16:44 hal9
8734 Revision 2.25 2006/10/18 10:50:33 hal9
8735 Add note that since filters are off in Cautious, compression is ON. Turn off
8736 compression to make filters work on all sites.
8738 Revision 2.24 2006/10/03 11:13:54 hal9
8739 More references to the new filters. Include html this time around.
8741 Revision 2.23 2006/10/02 22:43:53 hal9
8742 Contains new filter definitions from Fabian, and few other miscellaneous
8745 Revision 2.22 2006/09/22 01:27:55 hal9
8746 Final commit of probably various minor changes here and there. Unless
8747 something changes this should be ready for pending release.
8749 Revision 2.21 2006/09/20 03:21:36 david__schmidt
8750 Just the tiniest tweak. Wafer thin!
8752 Revision 2.20 2006/09/10 14:53:54 hal9
8753 Results of spell check. User manual has some updates to standard.actions file
8756 Revision 2.19 2006/09/08 12:19:02 fabiankeil
8757 Adjust hide-if-modified-since example values
8758 to reflect the recent changes.
8760 Revision 2.18 2006/09/08 02:38:57 hal9
8762 -Fix a number of broken links.
8763 -Migrate the new Windows service command line options, and reference as
8765 -Rebuild so that can be used with the new "user-manual" config capabilities.
8768 Revision 2.17 2006/09/05 13:25:12 david__schmidt
8769 Add Windows service invocation stuff (duplicated) in FAQ and in user manual under Windows startup. One probably ought to reference the other.
8771 Revision 2.16 2006/09/02 12:49:37 hal9
8772 Various small updates for new actions, filterfiles, etc.
8774 Revision 2.15 2006/08/30 11:15:22 hal9
8775 More work on the new actions, especially filter-*-headers, and What's New
8776 section. User Manual is close to final form for 3.0.4 release. Some tinkering
8777 and proof reading left to do.
8779 Revision 2.14 2006/08/29 10:59:36 hal9
8780 Add a "Whats New in this release" Section. Further work on multiple filter
8781 files, and assorted other minor changes.
8783 Revision 2.13 2006/08/22 11:04:59 hal9
8784 Silence warnings and errors. This should build now. New filters were only
8785 stubbed in. More to be done.
8787 Revision 2.12 2006/08/14 08:40:39 fabiankeil
8788 Documented new actions that were part of
8789 the "minor Privoxy improvements".
8791 Revision 2.11 2006/07/18 14:48:51 david__schmidt
8792 Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
8793 with what was really the latest development (the v_3_0_branch branch)
8795 Revision 1.123.2.43 2005/05/23 09:59:10 hal9
8798 Revision 1.123.2.42 2004/12/04 14:39:57 hal9
8799 Fix two minor typos per bug SF report.
8801 Revision 1.123.2.41 2004/03/23 12:58:42 oes
8804 Revision 1.123.2.40 2004/02/27 12:48:49 hal9
8805 Add comment re: redirecting to local file system for set-image-blocker may
8806 is dependent on browser.
8808 Revision 1.123.2.39 2004/01/30 22:31:40 oes
8809 Added a hint re bookmarklets to Quickstart section
8811 Revision 1.123.2.38 2004/01/30 16:47:51 oes
8812 Some minor clarifications
8814 Revision 1.123.2.37 2004/01/29 22:36:11 hal9
8815 Updates for no longer filtering text/plain, and demoronizer default settings,
8816 and copyright notice dates.
8818 Revision 1.123.2.36 2003/12/10 02:26:26 hal9
8819 Changed the demoronizer filter description.
8821 Revision 1.123.2.35 2003/11/06 13:36:37 oes
8822 Updated link to nightly CVS tarball
8824 Revision 1.123.2.34 2003/06/26 23:50:16 hal9
8825 Add a small bit on filtering and problems re: source code being corrupted.
8827 Revision 1.123.2.33 2003/05/08 18:17:33 roro
8828 Use apt-get instead of dpkg to install Debian package, which is more
8829 solid, uses the correct and most recent Debian version automatically.
8831 Revision 1.123.2.32 2003/04/11 03:13:57 hal9
8832 Add small note about only one filterfile (as opposed to multiple actions
8835 Revision 1.123.2.31 2003/03/26 02:03:43 oes
8836 Updated hard-coded copyright dates
8838 Revision 1.123.2.30 2003/03/24 12:58:56 hal9
8839 Add new section on Predefined Filters.
8841 Revision 1.123.2.29 2003/03/20 02:45:29 hal9
8842 More problems with \-\-chroot causing markup problems :(
8844 Revision 1.123.2.28 2003/03/19 00:35:24 hal9
8845 Manual edit of revision log because 'chroot' (even inside a comment) was
8846 causing Docbook to hang here (due to double hyphen and the processor thinking
8849 Revision 1.123.2.27 2003/03/18 19:37:14 oes
8850 s/Advanced|Radical/Adventuresome/g to avoid complaints re fun filter
8852 Revision 1.123.2.26 2003/03/17 16:50:53 oes
8853 Added documentation for new chroot option
8855 Revision 1.123.2.25 2003/03/15 18:36:55 oes
8856 Adapted to the new filters
8858 Revision 1.123.2.24 2002/11/17 06:41:06 hal9
8859 Move default profiles table from FAQ to U-M, and other minor related changes.
8862 Revision 1.123.2.23 2002/10/21 02:32:01 hal9
8863 Updates to the user.action examples section. A few new ones.
8865 Revision 1.123.2.22 2002/10/12 00:51:53 hal9
8866 Add demoronizer to filter section.
8868 Revision 1.123.2.21 2002/10/10 04:09:35 hal9
8869 s/Advanced/Radical/ and added very brief note.
8871 Revision 1.123.2.20 2002/10/10 03:49:21 hal9
8872 Add notes to session-cookies-only and Quickstart about pre-existing
8873 cookies. Also, note content-cookies work differently.
8875 Revision 1.123.2.19 2002/09/26 01:25:36 hal9
8876 More explanation on Privoxy patterns, more on content-cookies and SSL.
8878 Revision 1.123.2.18 2002/08/22 23:47:58 hal9
8879 Add 'Documentation' to Privoxy Menu shot in Configuration section to match
8882 Revision 1.123.2.17 2002/08/18 01:13:05 hal9
8883 Spell checked (only one typo this time!).
8885 Revision 1.123.2.16 2002/08/09 19:20:54 david__schmidt
8886 Update to Mac OS X startup script name
8888 Revision 1.123.2.15 2002/08/07 17:32:11 oes
8889 Converted some internal links from ulink to link for PDF creation; no content changed
8891 Revision 1.123.2.14 2002/08/06 09:16:13 oes
8892 Nits re: actions file download
8894 Revision 1.123.2.13 2002/08/02 18:23:19 g_sauthoff
8895 Just 2 small corrections to the Gentoo sections
8897 Revision 1.123.2.12 2002/08/02 18:17:21 g_sauthoff
8898 Added 2 Gentoo sections
8900 Revision 1.123.2.11 2002/07/26 15:20:31 oes
8901 - Added version info to title
8902 - Added info on new filters
8903 - Revised parts of the filter file tutorial
8904 - Added info on where to get updated actions files
8906 Revision 1.123.2.10 2002/07/25 21:42:29 hal9
8907 Add brief notes on not proxying non-HTTP protocols.
8909 Revision 1.123.2.9 2002/07/11 03:40:28 david__schmidt
8911 Updated Mac OS X sections due to installation location change
8913 Revision 1.123.2.8 2002/06/09 16:36:32 hal9
8914 Clarifications on filtering and MIME. Hardcode 'latest release' in index.html.
8916 Revision 1.123.2.7 2002/06/09 00:29:34 hal9
8917 Touch ups on filtering, in actions section and Anatomy.
8919 Revision 1.123.2.6 2002/06/06 23:11:03 hal9
8920 Fix broken link. Linkchecked all docs.
8922 Revision 1.123.2.5 2002/05/29 02:01:02 hal9
8923 This is break out of the entire config section from u-m, so it can
8924 eventually be used to generate the comments, etc in the main config file
8925 so that these are in sync with each other.
8927 Revision 1.123.2.4 2002/05/27 03:28:45 hal9
8928 Ooops missed something from David.
8930 Revision 1.123.2.3 2002/05/27 03:23:17 hal9
8931 Fix FIXMEs for OS2 and Mac OS X startup. Fix Redhat typos (should be Red Hat).
8932 That's a wrap, I think.
8934 Revision 1.123.2.2 2002/05/26 19:02:09 hal9
8935 Move Amiga stuff around to take of FIXME in start up section.
8937 Revision 1.123.2.1 2002/05/26 17:04:25 hal9
8938 -Spellcheck, very minor edits, and sync across branches
8940 Revision 1.123 2002/05/24 23:19:23 hal9
8941 Include new image (Proxy setup). More fun with guibutton.
8942 Minor corrections/clarifications here and there.
8944 Revision 1.122 2002/05/24 13:24:08 oes
8945 Added Bookmarklet for one-click pre-filled access to show-url-info
8947 Revision 1.121 2002/05/23 23:20:17 oes
8948 - Changed more (all?) references to actions to the
8949 <literal><link> style.
8950 - Small fixes in the actions chapter
8951 - Small clarifications in the quickstart to ad blocking
8952 - Removed <emphasis> from <title>s since the new doc CSS
8953 renders them red (bad in TOC).
8955 Revision 1.120 2002/05/23 19:16:43 roro
8956 Correct Debian specials (installation and startup).
8958 Revision 1.119 2002/05/22 17:17:05 oes
8961 Revision 1.118 2002/05/21 04:54:55 hal9
8962 -New Section: Quickstart to Ad Blocking
8963 -Reformat Actions Anatomy to match new CGI layout
8965 Revision 1.117 2002/05/17 13:56:16 oes
8966 - Reworked & extended Templates chapter
8967 - Small changes to Regex appendix
8968 - #included authors.sgml into (C) and hist chapter
8970 Revision 1.116 2002/05/17 03:23:46 hal9
8971 Fixing merge conflict in Quickstart section.
8973 Revision 1.115 2002/05/16 16:25:00 oes
8974 Extended the Filter File chapter & minor fixes
8976 Revision 1.114 2002/05/16 09:42:50 oes
8977 More ulink->link, added some hints to Quickstart section
8979 Revision 1.113 2002/05/15 21:07:25 oes
8980 Extended and further commented the example actions files
8982 Revision 1.112 2002/05/15 03:57:14 hal9
8983 Spell check. A few minor edits here and there for better syntax and
8986 Revision 1.111 2002/05/14 23:01:36 oes
8989 Revision 1.110 2002/05/14 19:10:45 oes
8990 Restored alphabetical order of actions
8992 Revision 1.109 2002/05/14 17:23:11 oes
8993 Renamed the prevent-*-cookies actions, extended aliases section and moved it before the example AFs
8995 Revision 1.108 2002/05/14 15:29:12 oes
8996 Completed proofreading the actions chapter
8998 Revision 1.107 2002/05/12 03:20:41 hal9
8999 Small clarifications for 127.0.0.1 vs localhost for listen-address since this
9000 apparently an important distinction for some OS's.
9002 Revision 1.106 2002/05/10 01:48:20 hal9
9003 This is mostly proposed copyright/licensing additions and changes. Docs
9004 are still GPL, but licensing and copyright are more visible. Also, copyright
9005 changed in doc header comments (eliminate references to JB except FAQ).
9007 Revision 1.105 2002/05/05 20:26:02 hal9
9008 Sorting out license vs copyright in these docs.
9010 Revision 1.104 2002/05/04 08:44:45 swa
9013 Revision 1.103 2002/05/04 00:40:53 hal9
9014 -Remove the TOC first page kludge. It's fixed proper now in ldp.dsl.in.
9015 -Some minor additions to Quickstart.
9017 Revision 1.102 2002/05/03 17:46:00 oes
9018 Further proofread & reactivated short build instructions
9020 Revision 1.101 2002/05/03 03:58:30 hal9
9021 Move the user-manual config directive to top of section. Add note about
9022 Privoxy needing read permissions for configs, and write for logs.
9024 Revision 1.100 2002/04/29 03:05:55 hal9
9025 Add clarification on differences of new actions files.
9027 Revision 1.99 2002/04/28 16:59:05 swa
9028 more structure in starting section
9030 Revision 1.98 2002/04/28 05:43:59 hal9
9031 This is the break up of configuration.html into multiple files. This
9032 will probably break links elsewhere :(
9034 Revision 1.97 2002/04/27 21:04:42 hal9
9035 -Rewrite of Actions File example.
9036 -Add section for user-manual directive in config.
9038 Revision 1.96 2002/04/27 05:32:00 hal9
9039 -Add short section to Filter Files to tie in with +filter action.
9040 -Start rewrite of examples in Actions Examples (not finished).
9042 Revision 1.95 2002/04/26 17:23:29 swa
9043 bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
9045 Revision 1.94 2002/04/26 05:24:36 hal9
9046 -Add most of Andreas suggestions to Chain of Events section.
9047 -A few other minor corrections and touch up.
9049 Revision 1.92 2002/04/25 18:55:13 hal9
9050 More catchups on new actions files, and new actions names.
9051 Other assorted cleanups, and minor modifications.
9053 Revision 1.91 2002/04/24 02:39:31 hal9
9054 Add 'Chain of Events' section.
9056 Revision 1.90 2002/04/23 21:41:25 hal9
9057 Linuxconf is deprecated on RH, substitute chkconfig.
9059 Revision 1.89 2002/04/23 21:05:28 oes
9060 Added hint for startup on Red Hat
9062 Revision 1.88 2002/04/23 05:37:54 hal9
9063 Add AmigaOS install stuff.
9065 Revision 1.87 2002/04/23 02:53:15 david__schmidt
9066 Updated Mac OS X installation section
9067 Added a few English tweaks here an there
9069 Revision 1.86 2002/04/21 01:46:32 hal9
9070 Re-write actions section.
9072 Revision 1.85 2002/04/18 21:23:23 hal9
9073 Fix ugly typo (mine).
9075 Revision 1.84 2002/04/18 21:17:13 hal9
9076 Spell Redhat correctly (ie Red Hat). A few minor grammar corrections.
9078 Revision 1.83 2002/04/18 18:21:12 oes
9079 Added RPM install detail
9081 Revision 1.82 2002/04/18 12:04:50 oes
9084 Revision 1.81 2002/04/18 11:50:24 oes
9085 Extended Install section - needs fixing by packagers
9087 Revision 1.80 2002/04/18 10:45:19 oes
9088 Moved text to buildsource.sgml, renamed some filters, details
9090 Revision 1.79 2002/04/18 03:18:06 hal9
9091 Spellcheck, and minor touchups.
9093 Revision 1.78 2002/04/17 18:04:16 oes
9096 Revision 1.77 2002/04/17 13:51:23 oes
9097 Proofreading, part one
9099 Revision 1.76 2002/04/16 04:25:51 hal9
9100 -Added 'Note to Upgraders' and re-ordered the 'Quickstart' section.
9101 -Note about proxy may need requests to re-read config files.
9103 Revision 1.75 2002/04/12 02:08:48 david__schmidt
9104 Remove OS/2 building info... it is already in the developer-manual
9106 Revision 1.74 2002/04/11 00:54:38 hal9
9107 Add small section on submitting actions.
9109 Revision 1.73 2002/04/10 18:45:15 swa
9112 Revision 1.72 2002/04/10 04:06:19 hal9
9113 Added actions feedback to Bookmarklets section
9115 Revision 1.71 2002/04/08 22:59:26 hal9
9116 Version update. Spell chkconfig correctly :)
9118 Revision 1.70 2002/04/08 20:53:56 swa
9121 Revision 1.69 2002/04/06 05:07:29 hal9
9122 -Add privoxy-man-page.sgml, for man page.
9123 -Add authors.sgml for AUTHORS (and p-authors.sgml)
9124 -Reworked various aspects of various docs.
9125 -Added additional comments to sub-docs.
9127 Revision 1.68 2002/04/04 18:46:47 swa
9128 consistent look. reuse of copyright, history et. al.
9130 Revision 1.67 2002/04/04 17:27:57 swa
9131 more single file to be included at multiple points. make maintaining easier
9133 Revision 1.66 2002/04/04 06:48:37 hal9
9134 Structural changes to allow for conditional inclusion/exclusion of content
9135 based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And
9136 definition of internal entities, e.g. 'entity p-version "2.9.13"' that will
9137 eventually be set by Makefile.
9138 More boilerplate text for use across multiple docs.
9140 Revision 1.65 2002/04/03 19:52:07 swa
9141 enhance squid section due to user suggestion
9143 Revision 1.64 2002/04/03 03:53:43 hal9
9144 A few minor bug fixes, and touch ups. Ready for review.
9146 Revision 1.63 2002/04/01 16:24:49 hal9
9147 Define entities to include boilerplate text. See doc/source/*.
9149 Revision 1.62 2002/03/30 04:15:53 hal9
9150 - Fix privoxy.org/config links.
9151 - Paste in Bookmarklets from Toggle page.
9152 - Move Quickstart nearer top, and minor rework.
9154 Revision 1.61 2002/03/29 01:31:08 hal9
9157 Revision 1.60 2002/03/27 01:57:34 hal9
9158 Added more to Anatomy section.
9160 Revision 1.59 2002/03/27 00:54:33 hal9
9161 Touch up intro for new name.
9163 Revision 1.58 2002/03/26 22:29:55 swa
9164 we have a new homepage!
9166 Revision 1.57 2002/03/24 20:33:30 hal9
9167 A few minor catch ups with name change.
9169 Revision 1.56 2002/03/24 16:17:06 swa
9170 configure needs to be generated.
9172 Revision 1.55 2002/03/24 16:08:08 swa
9173 we are too lazy to make a block-built
9174 privoxy logo. hence removed the option.
9176 Revision 1.54 2002/03/24 15:46:20 swa
9177 name change related issue.
9179 Revision 1.53 2002/03/24 11:51:00 swa
9180 name change. changed filenames.
9182 Revision 1.52 2002/03/24 11:01:06 swa
9185 Revision 1.51 2002/03/23 15:13:11 swa
9186 renamed every reference to the old name with foobar.
9187 fixed "application foobar application" tag, fixed
9188 "the foobar" with "foobar". left junkbustser in cvs
9189 comments and remarks to history untouched.
9191 Revision 1.50 2002/03/23 05:06:21 hal9
9194 Revision 1.49 2002/03/21 17:01:05 hal9
9195 New section in Appendix.
9197 Revision 1.48 2002/03/12 06:33:01 hal9
9198 Catching up to Andreas and re_filterfile changes.
9200 Revision 1.47 2002/03/11 13:13:27 swa
9201 correct feedback channels
9203 Revision 1.46 2002/03/10 00:51:08 hal9
9204 Added section on JB internal pages in Appendix.
9206 Revision 1.45 2002/03/09 17:43:53 swa
9209 Revision 1.44 2002/03/09 17:08:48 hal9
9210 New section on Jon's actions file editor, and move some stuff around.
9212 Revision 1.43 2002/03/08 00:47:32 hal9
9213 Added imageblock{pattern}.
9215 Revision 1.42 2002/03/07 18:16:55 swa
9218 Revision 1.41 2002/03/07 16:46:43 hal9
9219 Fix a few markup problems for jade.
9221 Revision 1.40 2002/03/07 16:28:39 swa
9222 provide correct feedback channels
9224 Revision 1.39 2002/03/06 16:19:28 hal9
9225 Note on perceived filtering slowdown per FR.
9227 Revision 1.38 2002/03/05 23:55:14 hal9
9228 Stupid I did it again. Double hyphen in comment breaks jade.
9230 Revision 1.37 2002/03/05 23:53:49 hal9
9231 jade barfs on '- -' embedded in comments. - -user option broke it.
9233 Revision 1.36 2002/03/05 22:53:28 hal9
9234 Add new - - user option.
9236 Revision 1.35 2002/03/05 00:17:27 hal9
9237 Added section on command line options.
9239 Revision 1.34 2002/03/04 19:32:07 oes
9240 Changed default port to 8118
9242 Revision 1.33 2002/03/03 19:46:13 hal9
9243 Emphasis on where/how to report bugs, etc
9245 Revision 1.32 2002/03/03 09:26:06 joergs
9246 AmigaOS changes, config is now loaded from PROGDIR: instead of
9247 AmiTCP:db/junkbuster/ if no configuration file is specified on the
9250 Revision 1.31 2002/03/02 22:45:52 david__schmidt
9253 Revision 1.30 2002/03/02 22:00:14 hal9
9254 Updated 'New Features' list. Ran through spell-checker.
9256 Revision 1.29 2002/03/02 20:34:07 david__schmidt
9257 Update OS/2 build section
9259 Revision 1.28 2002/02/24 14:34:24 jongfoster
9260 Formatting changes. Now changing the doctype to DocBook XML 4.1
9261 will work - no other changes are needed.
9263 Revision 1.27 2002/01/11 14:14:32 hal9
9264 Added a very short section on Templates
9266 Revision 1.26 2002/01/09 20:02:50 hal9
9267 Fix bug re: auto-detect config file changes.
9269 Revision 1.25 2002/01/09 18:20:30 hal9
9270 Touch ups for *.action files.
9272 Revision 1.24 2001/12/02 01:13:42 hal9
9275 Revision 1.23 2001/12/02 00:20:41 hal9
9276 Updates for recent changes.
9278 Revision 1.22 2001/11/05 23:57:51 hal9
9279 Minor update for startup now daemon mode.
9281 Revision 1.21 2001/10/31 21:11:03 hal9
9282 Correct 2 minor errors
9284 Revision 1.18 2001/10/24 18:45:26 hal9
9285 *** empty log message ***
9287 Revision 1.17 2001/10/24 17:10:55 hal9
9288 Catching up with Jon's recent work, and a few other things.
9290 Revision 1.16 2001/10/21 17:19:21 swa
9291 wrong url in documentation
9293 Revision 1.15 2001/10/14 23:46:24 hal9
9294 Various minor changes. Fleshed out SEE ALSO section.
9296 Revision 1.13 2001/10/10 17:28:33 hal9
9299 Revision 1.12 2001/09/28 02:57:04 hal9
9302 Revision 1.11 2001/09/28 02:25:20 hal9
9305 Revision 1.9 2001/09/27 23:50:29 hal9
9306 A few changes. A short section on regular expression in appendix.
9308 Revision 1.8 2001/09/25 00:34:59 hal9
9309 Some additions, and re-arranging.
9311 Revision 1.7 2001/09/24 14:31:36 hal9
9314 Revision 1.6 2001/09/24 14:10:32 hal9
9315 Including David's OS/2 installation instructions.
9317 Revision 1.2 2001/09/13 15:27:40 swa
9320 Revision 1.1 2001/09/12 15:36:41 swa
9321 source files for junkbuster documentation
9323 Revision 1.3 2001/09/10 17:43:59 swa
9324 first proposal of a structure.
9326 Revision 1.2 2001/06/13 14:28:31 swa
9327 docs should have an author.
9329 Revision 1.1 2001/06/13 14:20:37 swa
9330 first import of project's documentation for the webserver.