X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=70979575fb88926678af78c778ecfdfc7464049f;hp=8bc750849ea65c71e32651c242476620f76a1115;hb=d74ec2c8f9726f42df2ce1e45749d74dee43b781;hpb=1ebaf56647ca9a7fdcc9c55a78cb740f31a6cd1d diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 8bc75084..70979575 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -11,8 +11,8 @@ - - + + @@ -32,9 +32,9 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.124 2002/05/29 02:01:02 hal9 Exp $ + $Id: user-manual.sgml,v 2.13 2006/08/22 11:04:59 hal9 Exp $ - Copyright (C) 2001, 2002 Privoxy Developers + Copyright (C) 2001- 2006 Privoxy Developers See LICENSE. ======================================================================== @@ -47,18 +47,18 @@
-Privoxy User Manual +Privoxy &p-version; User Manual - Copyright &my-copy; 2001, 2002 by - Privoxy Developers + Copyright &my-copy; 2001 - 2004 by + Privoxy Developers -$Id: user-manual.sgml,v 1.124 2002/05/29 02:01:02 hal9 Exp $ +$Id: user-manual.sgml,v 2.13 2006/08/22 11:04:59 hal9 Exp $ @@ -109,7 +98,7 @@ Hal. You can find the latest version of the User Manual at http://www.privoxy.org/user-manual/. - Please see the Contact section on how to + Please see the Contact section on how to contact the developers. @@ -222,10 +211,9 @@ automatically start Privoxy in the boot process. Debian - DEBs can be installed with dpkg -i - privoxy_&p-version;-1.deb, and will use - /etc/privoxy for the location of configuration - files. + DEBs can be installed with apt-get install privoxy, + and will use /etc/privoxy for the location of + configuration files. @@ -235,8 +223,7 @@ automatically start Privoxy in the boot process. Just double-click the installer, which will guide you through the installation process. You will find the configuration files - in the same directory as you installed Privoxy in. We do not - use the registry of Windows. + in the same directory as you installed Privoxy in. @@ -277,17 +264,32 @@ automatically start Privoxy in the boot process. -Max OSX - - Unzip the downloaded package (you can either double-click on the file - in the finder, or on the desktop if you downloaded it there). Then, - double-click on the package installer icon and follow the installation - process. - Privoxy will be installed in the subdirectory - /Applications/Privoxy.app. - Privoxy will set itself up to start - automatically on system bring-up via - /System/Library/StartupItems/Privoxy. +Mac OSX + + Unzip the downloaded file (you can either double-click on the file + from the finder, or from the desktop if you downloaded it there). + Then, double-click on the package installer icon named + Privoxy.pkg + and follow the installation process. + Privoxy will be installed in the folder + /Library/Privoxy. + It will start automatically whenever you start up. To prevent it from + starting automatically, remove or rename the folder + /Library/StartupItems/Privoxy. + + + To start Privoxy by hand, double-click on + StartPrivoxy.command in the + /Library/Privoxy folder. + Or, type this command in the Terminal: + + + + /Library/Privoxy/StartPrivoxy.command + + + + You will be prompted for the administrator password. @@ -300,6 +302,28 @@ automatically start Privoxy in the boot process. remove this directory. + + +Gentoo + + Gentoo source packages (Ebuilds) for Privoxy are + contained in the Gentoo Portage Tree (they are not on the download page, + but there is a Gentoo section, where you can see when a new + Privoxy Version is added to the Portage Tree). + + + Before installing Privoxy under Gentoo just do + first emerge rsync to get the latest changes from the + Portage tree. With emerge privoxy you install the latest + version. + + + Configuration files are in /etc/privoxy, the + documentation is in /usr/share/doc/privoxy-&p-version; + and the Log directory is in /var/log/privoxy. + + + @@ -315,9 +339,13 @@ automatically start Privoxy in the boot process. If you like to live on the bleeding edge and are not afraid of using possibly unstable development versions, you can check out the up-to-the-minute version directly from the - CVS repository or simply download the nightly CVS + CVS repository. + @@ -325,82 +353,190 @@ automatically start Privoxy in the boot process. + +Keeping your Installation Up-to-Date + + As user feedback comes in and development continues, we will make updated versions + of both the main actions file (as a separate + package) and the software itself (including the actions file) available for + download. + + + + If you wish to receive an email notification whenever we release updates of + Privoxy or the actions file, subscribe + to our announce mailing list, ijbswa-announce@lists.sourceforge.net. + + + + In order not to lose your personal changes and adjustments when updating + to the latest default.action file we strongly + recommend that you use user.action for your + customization of Privoxy. See the Chapter on actions files for details. + + + + - -Note to Upgraders - - There are very significant changes from earlier - Junkbuster versions to the current - Privoxy. The number, names, syntax, and - purposes of configuration files have substantially changed. - Junkbuster 2.0.x configuration - files will not migrate, Junkbuster 2.9.x - and Privoxy configurations will need to be - ported. The functionalities of the old blockfile, - cookiefile and imagelist - are now combined into the actions - files. - default.action, is the main actions file. Local - exceptions should best be put into user.action. - + +What's New in this Release - A filter file (typically - default.filter) is new as of Privoxy - 2.9.x, and provides some of the new sophistication (explained - below). config is much the same as before. + There are many new features in Privoxy &p-version; + : + - If upgrading from a 2.0.x version, you will have to use the new config - files, and possibly adapt any personal rules from your older files. - When porting personal rules over from the old blockfile - to the new actions files, please note that even the pattern syntax has - changed. If upgrading from 2.9.x development versions, it is still - recommended to use the new configuration files. + + + + Mulitiple filter files can now be specifed in config. + + + + + + There are a number of new actions: + + + + + + + + content-type-overwrite + + + + + crunch-client-header + + + + + crunch-if-none-match + + + + + crunch-server-header + + + + + fast-redirects + + + + + force-text-mode + + + + + handle-as-empty-document + + + + + hide-accept-language + + + + + hide-content-disposition + + + + + hide-if-modified-since + + + + + hide-referrer + + + + + inspect-jpegs + + + + + overwrite-last-modified + + + + + redirect + + + + + treat-forbidden-connects-like-blocks + + + + + + + + + + + MS-Windows versions can now be installed and + started as a service. + + + + + + In addition, there are various bug fixes and enhancements, including + error pages are no longer cached, better DNS error handling, and logging + improvements. + + + + + + + + + +Note to Upgraders + - A quick list of things to be aware of before upgrading: + A quick list of things to be aware of before upgrading from earlier + versions of Privoxy: - - - The default listening port is now 8118 due to a conflict with another - service (NAS). - - - Some installers may remove earlier versions completely. Save any - important configuration files! + Some installers may remove earlier versions completely, including + configuration files. Save any important configuration files! - - Privoxy is controllable with a web browser - at the special URL: http://config.privoxy.org/ - (Shortcut: http://p.p/). Many - aspects of configuration can be done here, including temporarily disabling - Privoxy. - - - - - The primary configuration files for cookie management, ad and banner - blocking, and many other aspects of Privoxy - configuration are the actions - files. It is strongly recommended to become familiar with the new - actions concept below, before modifying these files. Locally defined rules - should go into user.action. + + What constitutes a default configuration has changed, + and you may want to review which actions are on by + default. This is primarily a matter of emphasis, but some features + you may have been used to, may now be off by default. - + + @@ -412,6 +548,7 @@ automatically start Privoxy in the boot process. + @@ -419,13 +556,6 @@ automatically start Privoxy in the boot process. - - - If upgrading, from versions before 2.9.16, please back up any configuration - files. See the Note to Upgraders Section. - - - Install Privoxy. See the Set your browser to use Privoxy as HTTP and - HTTPS proxy by setting the proxy configuration for address of + HTTPS (SSL) proxy by setting the proxy configuration for address of 127.0.0.1 and port 8118. (Junkbuster and earlier versions of Privoxy used port 8000.) See the section Flush your browser's disk and memory caches, to remove any cached ad images. + If using Privoxy to manage cookies, you should + remove any currently stored cookies too. @@ -484,7 +616,7 @@ automatically start Privoxy in the boot process. linkend="quickstart-ad-blocking">next section for a quick introduction to how Privoxy blocks ads and banners.]]> - + @@ -502,6 +634,14 @@ automatically start Privoxy in the boot process. + + + For easy access to Privoxy's most important controls, drag the provided + Bookmarklets into your browser's + personal toolbar. + + + Please see the section Contacting the @@ -512,7 +652,7 @@ automatically start Privoxy in the boot process. - Now enjoy surfing with enhanced comfort and privacy! + Now enjoy surfing with enhanced control, comfort and privacy! @@ -777,6 +917,10 @@ automatically start Privoxy in the boot process. 127.0.0.1 (or localhost) for the proxy address, and port 8118 (earlier versions used port 8000). This is the one configuration step that must be done! + + Please note that Privoxy can only proxy HTTP and + HTTPS traffic. It will not work with FTP or other protocols. + @@ -792,11 +936,32 @@ automatically start Privoxy in the boot process. + + + With Firefox, this can be set under: + + + + + + Tools + |_ + Options + |_ + General + |_ + Connection Settings + |_ + Manual Proxy Configuration + + + With Netscape (and Mozilla), this can be set under: - + + @@ -841,7 +1006,7 @@ automatically start Privoxy in the boot process. - Privoxy is typically started by specifying the + Privoxy itself is typically started by specifying the main configuration file to be used on the command line. If no configuration file is specified on the command line, Privoxy will look for a file named config in the current @@ -924,16 +1089,21 @@ Example Unix startup command: -MAX OSX +Mac OSX During installation, Privoxy is configured to - start automatically when the system restarts. You can start it manually - through the Terminal with these commands: + start automatically when the system restarts. To start Privoxy by hand, + double-click on the StartPrivoxy.command icon in the + /Library/Privoxy folder. Or, type this command + in the Terminal: - cd /Applications/Privoxy.app - ./privoxy + /Library/Privoxy/StartPrivoxy.command + + + + You will be prompted for the administrator password. @@ -951,11 +1121,34 @@ Example Unix startup command: + +Gentoo + + A script is again used. It will use the file /etc/privoxy/config + as its main configuration file. + + + + /etc/init.d/privoxy start + + + + Note that Privoxy is not automatically started at + boot time by default. You can change this with the rc-update + command. + + + + rc-update add privoxy default + + + + @@ -1109,7 +1302,20 @@ must find a better place for this paragraph USER, and if included the GID of GROUP. Exit if the privileges are not sufficient to do so. Unix only. - + + + + --chroot + + + + Before changing to the user ID given in the --user option, + chroot to that user's home directory, i.e. make the kernel pretend to the Privoxy + process that the directory tree starts there. If set up carefully, this can limit + the impact of possible vulnerabilities in Privoxy to the files contained in that hierarchy. + Unix only. + + configfile @@ -1178,6 +1384,10 @@ must find a better place for this paragraph         ▪  Toggle Privoxy on or off + +         ▪  Documentation + @@ -1272,11 +1482,17 @@ must find a better place for this paragraph - default.filter (the filter + Filter files (the filter file) can be used to re-write the raw page content, including viewable text as well as embedded HTML and JavaScript, and whatever else lurks on any given web page. The filtering jobs are only pre-defined here; - whether to apply them or not is up to the actions files. + whether to apply them or not is up to the actions files. + default.filter includes various filters made + available for use by the developers. Some are much more intrusive than + others, and all should be used with caution. You may define additional + filter files in config as you can with + actions files. We suggest user.filter for any + locally defined filters or customizations. @@ -1294,7 +1510,7 @@ must find a better place for this paragraph - The actions files and default.filter + The actions files and filter files can use Perl style regular expressions for maximum flexibility. @@ -1345,8 +1561,8 @@ must find a better place for this paragraph Privoxy takes for which URLs, and thus determine how ad images, cookies and various other aspects of HTTP content and transactions are handled, and on which sites (or even parts thereof). There - are three such files included with Privoxy (as of - version 2.9.15), with differing purposes: + are three such files included with Privoxy + with differing purposes: @@ -1358,8 +1574,8 @@ must find a better place for this paragraph provide a base level of functionality for Privoxy's array of features. So it is a set of broad rules that should work reasonably well for users everywhere. - This is the file that the developers are keeping updated, and making - available to users. + This is the file that the developers are keeping updated, and making available to users. @@ -1379,14 +1595,149 @@ must find a better place for this paragraph you select them explicitly in the editor. It is not recommend to edit this file. + + The default profiles, and their associated actions, as pre-defined in + standard.action are: + + + Default Configurations + + + + + + + + Feature + Cautious + Medium + Adventuresome + + + + + + + + + + + + + + Ad-blocking by URL + yes + yes + yes + + + + Ad-filtering by size + yes + yes + yes + + + + GIF de-animation + no + yes + yes + + + + Referer forging + no + yes + yes + + + + Cookie handling + none + session-only + kill + + + + Pop-up killing + unsolicited + unsolicited + all + + + + Fast redirects + no + no + yes + + + + HTML taming + yes + yes + yes + + + + JavaScript taming + yes + yes + yes + + + + Web-bug killing + yes + yes + yes + + + + Fun text replacements + no + no + yes + + + + Image tag reordering + no + no + yes + + + + Ad-filtering by link + no + no + yes + + + + Demoronizer + no + no + yes + + + + + +
+
+
The list of actions files to be used are defined in the main configuration - file, and are processed in the order they are defined. The content of these - can all be viewed and edited from default.action is typically process before + user.action). The content of these can all be viewed and + edited from http://config.privoxy.org/show-status. @@ -1424,10 +1775,10 @@ must find a better place for this paragraph certainly a matter of personal taste. In general, it can be said that the more aggressive your default settings (in the top section of the actions file) are, the more exceptions for trusted sites you - will have to make later. If, for example, you want to kill popup windows per + will have to make later. If, for example, you want to crunch all cookies per default, you'll have to make exceptions from that rule for sites that you - regularly use and that require popups for actually useful content, like maybe - your bank, favorite shop, or newspaper. + regularly use and that require cookies for actually useful puposes, like maybe + your bank, favorite shop, or newspaper. @@ -1447,7 +1798,10 @@ must find a better place for this paragraph url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status. The editor allows both fine-grained control over every single feature on a per-URL basis, and easy choosing from wholesale sets of defaults like - Cautious, Medium or Advanced. + Cautious, Medium or Adventuresome. + Warning: the Adventuresome setting is not only more aggressive, + but includes settings that are fun and subversive, and which some may find of + dubious merit! @@ -1471,15 +1825,15 @@ must find a better place for this paragraph To determine which actions apply to a request, the URL of the request is - compared to all patterns in each action file file. Every time it matches, the list of + compared to all patterns in each action file file. Every time it matches, the list of applicable actions for the URL is incrementally updated, using the heading of the section in which the pattern is located. If multiple matches for the same URL set the same action differently, the last match wins. If not, the effects are aggregated. E.g. a URL might match a regular section with a heading line of { - +handle-as-image }, + +handle-as-image }, then later another one with just { - +block }, resulting + +block }, resulting in both actions to apply. @@ -1497,10 +1851,23 @@ must find a better place for this paragraph Patterns + + As mentioned, Privoxy uses patterns + to determine what actions might apply to which sites and pages your browser + attempts to access. These patterns use wild card type + pattern matching to achieve a high degree of + flexibility. This allows one expression to be expanded and potentially match + against many similar patterns. + + - Generally, a pattern has the form <domain>/<path>, - where both the <domain> and <path> - are optional. (This is why the pattern / matches all URLs). + Generally, a Privoxy pattern has the form + <domain>/<path>, where both the + <domain> and <path> are + optional. (This is why the special / pattern matches all + URLs). Note that the protocol portion of the URL pattern (e.g. + http://) should not be included in + the pattern. This is assumed already! @@ -1965,17 +2332,19 @@ must find a better place for this paragraph + - -crunch-incoming-cookies + + +content-type-overwrite Typical use: - - Prevent the web server from setting any cookies on your system - + Stop useless download menus from popping up, or change the browser's rendering mode @@ -1983,7 +2352,7 @@ must find a better place for this paragraph Effect: - Deletes any Set-Cookie: HTTP headers from server replies. + Replaces the Content-Type: HTTP server header. @@ -1992,7 +2361,7 @@ must find a better place for this paragraph Type: - Boolean. + Parameterized. @@ -2000,8 +2369,8 @@ must find a better place for this paragraph Parameter: - N/A - + Any string. + @@ -2009,24 +2378,66 @@ must find a better place for this paragraph Notes: - This action is only concerned with incoming cookies. For - outgoing cookies, use - crunch-outgoing-cookies. - Use both to disable cookies completely. + The Content-Type: HTTP server header is used by the + browser to decide what to do with the document. The value of this + header can cause the browser to open a download menu instead of + displaying the document by itself, even if the document's format is + supported by the browser. - It makes no sense at all to use this action in conjunction - with the session-cookies-only action, - since it would prevent the session cookies from being set. + The declared content type can also affect which rendering mode + the browser chooses. If XHTML is delivered as text/html, + many browsers treat it as yet another broken HTML document. + If it is send as application/xml, browsers with + XHTML support will only display it, if the syntax is correct. + + + If you see a web site that proudly uses XHTML buttons, but sets + Content-Type: text/html, you can use Privoxy + to overwrite it with application/xml and validate + the web master's claim inside your XHTML-supporting browser. + If the syntax is incorrect, the browser will complain loudly. + + + You can also go the opposite direction: if your browser prints + error messages instead of rendering a document falsely declared + as XHTML, you can overwrite the content type with + text/html and have it rendered as broken HTML document. + + + By default content-type-overwrite only replaces + Content-Type: headers that look like some kind of text. + If you want to overwrite it unconditionally, you have to combine it with + force-text-mode. + This limitation exists for a reason, think twice before circumventing it. + + + Most of the time it's easier to enable + filter-server-headers + and replace this action with a custom regular expression. It allows you + to activate it for every document of a certain site and it will still + only replace the content types you aimed at. + + + Of course you can apply content-type-overwrite + to a whole site and then make URL based exceptions, but it's a lot + more work to get the same precision. - Example usage: + Example usage (sections): - - +crunch-incoming-cookies + + # Check if www.example.net/ really uses valid XHTML +{+content-type-overwrite {application/xml}} +www.example.net/ +# but leave the content type unmodified if the URL looks like a style sheet +{-content-type-overwrite} +www.example.net/*.\.css$ +www.example.net/*.style + @@ -2035,16 +2446,17 @@ must find a better place for this paragraph - -crunch-outgoing-cookies + + +crunch-server-header Typical use: - - Prevent the web server from reading any cookies from your system - + Remove a client header Privoxy has no dedicated action for. @@ -2052,7 +2464,7 @@ must find a better place for this paragraph Effect: - Deletes any Cookie: HTTP headers from client requests. + Deletes every header send by the client that contains the string the user supplied as parameter. @@ -2061,7 +2473,7 @@ must find a better place for this paragraph Type: - Boolean. + Parameterized. @@ -2069,8 +2481,8 @@ must find a better place for this paragraph Parameter: - N/A - + Any string. + @@ -2078,41 +2490,57 @@ must find a better place for this paragraph Notes: - This action is only concerned with outgoing cookies. For - incoming cookies, use - crunch-incoming-cookies. - Use both to disable cookies completely. + This action allows you to block client headers for which no dedicated + Privoxy action exists. + Privoxy will remove every client header that + contains the string you supplied as parameter. - It makes no sense at all to use this action in conjunction - with the session-cookies-only action, - since it would prevent the session cookies from being read. + Regular expressions are not supported and you can't + use this action to block different headers in the same request, unless + they contain the same string. + + crunch-client-header is only meant for quick tests. + If you have to block several different headers, or only want to modify + parts of them, you should enable + filter-client-headers + and create your own filter. + + + + Don't block any header without understanding the consequences. + + - Example usage: + Example usage (section): - - +crunch-outgoing-cookies + + # Block the non-existent "Privacy-Violation:" client header +{+crunch-client-header {Privacy-Violation:}} +/ + - - -deanimate-gifs - + +crunch-if-none-match + Typical use: - Stop those annoying, distracting animated GIF images. + Prevent yet another way to track the user's steps between sessions. @@ -2120,16 +2548,16 @@ must find a better place for this paragraph Effect: - De-animate GIF animations, i.e. reduce them to their first or last image. + Deletes the If-None-Match: HTTP client header. Type: - + - Parameterized. + Boolean. @@ -2137,8 +2565,8 @@ must find a better place for this paragraph Parameter: - last or first - + N/A + @@ -2146,41 +2574,344 @@ must find a better place for this paragraph Notes: - This will also shrink the images considerably (in bytes, not pixels!). If - the option first is given, the first frame of the animation - is used as the replacement. If last is given, the last - frame of the animation is used instead, which probably makes more sense for - most banner animations, but also has the risk of not showing the entire - last frame (if it is only a delta to an earlier frame). + Removing the If-None-Match: HTTP client header + is useful for filter testing, where you want to force a real + reload instead of getting status code 304 which + would cause the browser to use a cached copy of the page. - You can safely use this action with patterns that will also match non-GIF - objects, because no attempt will be made at anything that doesn't look like - a GIF. + It is also useful to make sure the header isn't used as a cookie + replacement. + + + Blocking the If-None-Match: header shouldn't cause any + caching problems, as long as the If-Modified-Since: header + isn't blocked as well. + + + It is recommended to use this action together with + hide-if-modified-since + and + overwrite-last-modified. - Example usage: + Example usage (section): - +deanimate-gifs{last} - + # Let the browser revalidate cached documents without being tracked across sessions +{+hide-if-modified-since {-1} \ ++overwrite-last-modified {randomize} \ ++crunch-if-none-match} +/ + + - -downgrade-http-version + +crunch-incoming-cookies Typical use: - Work around (very rare) problems with HTTP/1.1 + + Prevent the web server from setting any cookies on your system + + + + + + Effect: + + + Deletes any Set-Cookie: HTTP headers from server replies. + + + + + + Type: + + + Boolean. + + + + + Parameter: + + + N/A + + + + + + Notes: + + + This action is only concerned with incoming cookies. For + outgoing cookies, use + crunch-outgoing-cookies. + Use both to disable cookies completely. + + + It makes no sense at all to use this action in conjunction + with the session-cookies-only action, + since it would prevent the session cookies from being set. See also + filter-content-cookies. + + + + + + Example usage: + + + +crunch-incoming-cookies + + + + + + + + + +crunch-server-header + + + + Typical use: + + Remove a server header Privoxy has no dedicated action for. + + + + + Effect: + + + Deletes every header sent by the server that contains the string the user supplied as parameter. + + + + + + Type: + + + Parameterized. + + + + + Parameter: + + + Any string. + + + + + + Notes: + + + This action allows you to block server headers for which no dedicated + Privoxy action exists. Privoxy + will remove every server header that contains the string you supplied as parameter. + + + Regular expressions are not supported and you can't + use this action to block different headers in the same request, unless + they contain the same string. + + + crunch-server-header is only meant for quick tests. + If you have to block several different headers, or only want to modify + parts of them, you should enable + filter-server-headers + and create your own filter. + + + + Don't block any header without understanding the consequences. + + + + + + + Example usage (section): + + + # Crunch server headers that try to prevent caching +{+crunch-server-header {no-cache}} +/ + + + + + + + + + +crunch-outgoing-cookies + + + + Typical use: + + + Prevent the web server from reading any cookies from your system + + + + + + Effect: + + + Deletes any Cookie: HTTP headers from client requests. + + + + + + Type: + + + Boolean. + + + + + Parameter: + + + N/A + + + + + + Notes: + + + This action is only concerned with outgoing cookies. For + incoming cookies, use + crunch-incoming-cookies. + Use both to disable cookies completely. + + + It makes no sense at all to use this action in conjunction + with the session-cookies-only action, + since it would prevent the session cookies from being read. + + + + + + Example usage: + + + +crunch-outgoing-cookies + + + + + + + + + + +deanimate-gifs + + + + Typical use: + + Stop those annoying, distracting animated GIF images. + + + + + Effect: + + + De-animate GIF animations, i.e. reduce them to their first or last image. + + + + + + Type: + + + Parameterized. + + + + + Parameter: + + + last or first + + + + + + Notes: + + + This will also shrink the images considerably (in bytes, not pixels!). If + the option first is given, the first frame of the animation + is used as the replacement. If last is given, the last + frame of the animation is used instead, which probably makes more sense for + most banner animations, but also has the risk of not showing the entire + last frame (if it is only a delta to an earlier frame). + + + You can safely use this action with patterns that will also match non-GIF + objects, because no attempt will be made at anything that doesn't look like + a GIF. + + + + + + Example usage: + + + +deanimate-gifs{last} + + + + + + + + +downgrade-http-version + + + + Typical use: + + Work around (very rare) problems with HTTP/1.1 @@ -2195,7 +2926,479 @@ must find a better place for this paragraph Type: - + + + Boolean. + + + + + Parameter: + + + N/A + + + + + + Notes: + + + This is a left-over from the time when Privoxy + didn't support important HTTP/1.1 features well. It is left here for the + unlikely case that you experience HTTP/1.1 related problems with some server + out there. Not all (optional) HTTP/1.1 features are supported yet, so there + is a chance you might need this action. + + + + + + Example usage (section): + + + {+downgrade-http-version} +problem-host.example.com + + + + + + + + + +fast-redirects + + + + Typical use: + + Fool some click-tracking scripts and speed up indirect links. + + + + + Effect: + + + Detects redirection URLs and redirects the browser without contacting + the redirection server first. + + + + + + Type: + + + Parameterized. + + + + + Parameter: + + + + + simple-check to just search for the string http:// + to detect redirection URLs. + + + + + check-decoded-url to decode URLs (if necessary) before searching + for redirection URLs. + + + + + + + + Notes: + + + Many sites, like yahoo.com, don't just link to other sites. Instead, they + will link to some script on their own servers, giving the destination as a + parameter, which will then redirect you to the final target. URLs + resulting from this scheme typically look like: + http://www.example.org/click-tracker.cgi?target=http%3a//www.example.net/. + + + Sometimes, there are even multiple consecutive redirects encoded in the + URL. These redirections via scripts make your web browsing more traceable, + since the server from which you follow such a link can see where you go + to. Apart from that, valuable bandwidth and time is wasted, while your + browser asks the server for one redirect after the other. Plus, it feeds + the advertisers. + + + This feature is currently not very smart and is scheduled for improvement. + If it is enabled by default, you will have to create some exceptions to + this action. It can lead to failures in several ways: + + + Not every URLs with other URLs as parameters is evil. + Some sites offer a real service that requires this information to work. + For example a validation service needs to know, which document to validate. + fast-redirects assumes that every URL parameter that + looks like another URL is a redirection target, and will always redirect to + the last one. Most of the time the assumption is correct, but if it isn't, + the user gets redirected anyway. + + + Another failure occurs if the URL contains other parameters after the URL parameter. + The URL: + http://www.example.org/?redirect=http%3a//www.example.net/&foo=bar. + contains the redirection URL http://www.example.net/, + followed by another parameter. fast-redirects doesn't know that + and will cause a redirect to http://www.example.net/&foo=bar. + Depending on the target server configuration, the parameter will be silently ignored + or lead to a page not found error. It is possible to fix these redirected + requests with filter-client-headers + but it requires a little effort. + + + To detect a redirection URL, fast-redirects only + looks for the string http://, either in plain text + (invalid but often used) or encoded as http%3a//. + Some sites use their own URL encoding scheme, encrypt the address + of the target server or replace it with a database id. In theses cases + fast-redirects is fooled and the request reaches the + redirection server where it probably gets logged. + + + + + + Example usage: + + + +fast-redirects{simple-check} + + + +fast-redirects{check-decoded-url} + + + + + + + + + + +filter + + + + Typical use: + + Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements, etc. + + + + + Effect: + + + All files of text-based type, most notably HTML and JavaScript, to which this + action applies, are filtered on-the-fly through the specified regular expression + based substitutions. (Note: as of version 3.0.3 plain text documents + are exempted from filtering, because web servers often use the + text/plain MIME type for all files whose type they + don't know.) + + + + + + Type: + + + Parameterized. + + + + + Parameter: + + + The name of a filter, as defined in the filter file. + Filters can be defined in one or more files as defined by the + filterfile + option in the config file. + default.filter is the collection of filters + supplied by the developers. Locally defined filters should go + in their own file, such as user.filter. + + + When used in its negative form, + and without parameters, filtering is completely disabled. + + + + + + Notes: + + + For your convenience, there are a number of pre-defined filters available + in the distribution filter file that you can use. See the examples below for + a list. + + + Filtering requires buffering the page content, which may appear to + slow down page rendering since nothing is displayed until all content has + passed the filters. (It does not really take longer, but seems that way + since the page is not incrementally displayed.) This effect will be more + noticeable on slower connections. + + + This is very powerful feature, and rolling your own + filters requires a knowledge of regular expressions and HTML. + + + The amount of data that can be filtered is limited to the + buffer-limit + option in the main config file. The + default is 4096 KB (4 Megs). Once this limit is exceeded, the buffered + data, and all pending data, is passed through unfiltered. + + + Inadequate MIME types, such as zipped files, are not filtered at all. + (Again, only text-based types except plain text). Encrypted SSL data + (from HTTPS servers) cannot be filtered either, since this would violate + the integrity of the secure transaction. In some situations it might + be necessary to protect certain text, like source code, from filtering + by defining appropriate -filter sections. + + + At this time, Privoxy cannot (yet!) uncompress compressed + documents. If you want filtering to work on all documents, even those that + would normally be sent compressed, use the + prevent-compression + action in conjunction with filter. + + + Filtering can achieve some of the same effects as the + block + action, i.e. it can be used to block ads and banners. But the mechanism + works quite differently. One effective use, is to block ad banners + based on their size (see below), since many of these seem to be somewhat + standardized. + + + Feedback with suggestions for new or + improved filters is particularly welcome! + + + The below list has only the names and a one-line description of each + predefined filter. There are more + verbose explanations of what these filters do in the filter file chapter. + + + + + + Example usage (with filters from the distribution default.filter file). + See the Predefined Filters section for + more explanation on each: + + + + +filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse + + + + +filter{js-events} # Kill all JS event bindings (Radically destructive! Only for extra nasty sites) + + + + +filter{html-annoyances} # Get rid of particularly annoying HTML abuse + + + + +filter{content-cookies} # Kill cookies that come in the HTML or JS content + + + + +filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups) + + + + +filter{unsolicited-popups} # Disable only unsolicited pop-up windows + + + + +filter{all-popups} # Kill all popups in JavaScript and HTML + + + + +filter{img-reorder} # Reorder attributes in <img> tags to make the banners-by-* filters more effective + + + + +filter{banners-by-size} # Kill banners by size + + + + +filter{banners-by-link} # Kill banners by their links to known clicktrackers + + + + +filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking) + + + + +filter{tiny-textforms} # Extend those tiny textareas up to 40x80 and kill the hard wrap + + + + +filter{jumping-windows} # Prevent windows from resizing and moving themselves + + + + +filter{frameset-borders} # Give frames a border and make them resizable + + + + +filter{demoronizer} # Fix MS's non-standard use of standard charsets + + + + +filter{shockwave-flash} # Kill embedded Shockwave Flash objects + + + + +filter{quicktime-kioskmode} # Make Quicktime movies saveable + + + + +filter{fun} # Text replacements for subversive browsing fun! + + + + +filter{crude-parental} # Crude parental filtering (demo only) + + + + +filter{ie-exploits} # Disable some known Internet Explorer bug exploits + + + + + + + + + +force-text-mode + + + + Typical use: + + Force Privoxy to treat a document as if it was in some kind of text format. + + + + + Effect: + + + Declares a document as text, even if the Content-Type: isn't detected as such. + + + + + + Type: + + + Boolean. + + + + + Parameter: + + + N/A + + + + + + Notes: + + + As explained above, + Privoxy tries to only filter files that are + in some kind of text format. The same restrictions apply to + content-type-overwrite. + force-text-mode declares a document as text, + without looking at the Content-Type: first. + + + + Think twice before activating this action. Filtering binary data + with regular expressions can cause file damage. + + + + + + + Example usage: + + + ++force-text-mode + + + + + + + + + + +handle-as-empty-document + + + + Typical use: + + Mark URLs that should be replaced by empty documents if they get blocked + + + + + Effect: + + + This action alone doesn't do anything noticeable. It just marks URLs. + If the block action also applies, + the presence or absence of this mark decides whether an HTML blocked + page, or an empty document will be sent to the client as a substitute for the blocked content. + The empty document isn't literally empty, but actually contains a single space. + + + + + + Type: + Boolean. @@ -2209,42 +3412,48 @@ must find a better place for this paragraph - - + + Notes: - This is a left-over from the time when Privoxy - didn't support important HTTP/1.1 features well. It is left here for the - unlikely case that you experience HTTP/1.1 related problems with some server - out there. Not all (optional) HTTP/1.1 features are supported yet, so there - is a chance you might need this action. + Some browsers complain about syntax errors if JavaScript documents + are blocked with Privoxy's + default HTML page; this option can be used to silence them. + + + The content type for the empty document can be specified with + content-type-overwrite{}, + but usually this isn't necessary. - Example usage (section): + Example usage: - - {+downgrade-http-version} -problem-host.example.com - + + # Block all documents on example.org that end with ".js", +# but send an empty document instead of the usual HTML message. +{+block +handle-as-empty-document} +example.org/.*\.js$ + + - + - -fast-redirects + +handle-as-image Typical use: - Fool some click-tracking scripts and speed up indirect links + Mark URLs as belonging to images (so they'll be replaced by imagee if they get blocked) @@ -2252,14 +3461,19 @@ problem-host.example.com Effect: - Cut off all but the last valid URL from requests. + This action alone doesn't do anything noticeable. It just marks URLs as images. + If the block action also applies, + the presence or absence of this mark decides whether an HTML blocked + page, or a replacement image (as determined by the set-image-blocker action) will be sent to the + client as a substitute for the blocked content. Type: - + Boolean. @@ -2273,57 +3487,65 @@ problem-host.example.com - + Notes: - - Many sites, like yahoo.com, don't just link to other sites. Instead, they - will link to some script on their own servers, giving the destination as a - parameter, which will then redirect you to the final target. URLs - resulting from this scheme typically look like: - http://some.place/click-tracker.cgi?target=http://some.where.else. - - Sometimes, there are even multiple consecutive redirects encoded in the - URL. These redirections via scripts make your web browsing more traceable, - since the server from which you follow such a link can see where you go - to. Apart from that, valuable bandwidth and time is wasted, while your - browser ask the server for one redirect after the other. Plus, it feeds - the advertisers. + The below generic example section is actually part of default.action. + It marks all URLs with well-known image file name extensions as images and should + be left intact. - This feature is currently not very smart and is scheduled for improvement. - It is likely to break some sites. You should expect to need possibly - many exceptions to this action, if it is enabled by default in - default.action. Some sites just don't work without - it. + Users will probably only want to use the handle-as-image action in conjunction with + block, to block sources of banners, whose URLs don't + reflect the file type, like in the second example section. + + + Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad + frames require an HTML page to be sent, or they won't display properly. + Forcing handle-as-image in this situation will not replace the + ad frame with an image, but lead to error messages. - Example usage: + Example usage (sections): - - {+fast-redirects} - + + # Generic image extensions: +# +{+handle-as-image} +/.*\.(gif|jpg|jpeg|png|bmp|ico)$ + +# These don't look like images, but they're banners and should be +# blocked as images: +# +{+block +handle-as-image} +some.nasty-banner-server.com/junk.cgi?output=trash + +# Banner source! Who cares if they also have non-image content? +ad.doubleclick.net + + - - -filter - + +hide-accept-language + Typical use: - Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements, etc. + Pretend to use different language settings. @@ -2331,15 +3553,14 @@ problem-host.example.com Effect: - Text documents, including HTML and JavaScript, to which this action applies, are filtered on-the-fly - through the specified regular expression based substitutions. + Deletes or replaces the Accept-Language: HTTP header in client requests. Type: - + Parameterized. @@ -2349,11 +3570,8 @@ problem-host.example.com Parameter: - The name of a filter, as defined in the filter file - (typically default.filter, set by the - filterfile - option in the config file) - + Keyword: block, or any user defined value. + @@ -2361,90 +3579,127 @@ problem-host.example.com Notes: - For your convenience, there are a bunch of pre-defined filters available - in the distribution filter file that you can use. See the example below for - a list. - - - This is potentially a very powerful feature! But rolling your own - filters requires a knowledge of regular expressions and HTML. - - - Filtering requires buffering the page content, which may appear to - slow down page rendering since nothing is displayed until all content has - passed the filters. (It does not really take longer, but seems that way - since the page is not incrementally displayed.) This effect will be more - noticeable on slower connections. + Faking the browser's language settings can be useful to make a + foreign User-Agent set with + hide-user-agent + more believable. - At this time, Privoxy cannot (yet!) uncompress compressed - documents. If you want filtering to work on all documents, even those that - would normally be sent compressed, use the - prevent-compression - action in conjunction with filter. + However some sites with content in different languages check the + Accept-Language: to decide which one to take by default. + Sometimes it isn't possible to later switch to another language without + changing the Accept-Language: header first. - Filtering can achieve some of the effects as the - block - action, i.e. it can be used to block ads and banners. + Therefore it's a good idea to either only change the + Accept-Language: header to languages you understand, + or to languages that aren't wide spread. - Feedback with suggestions for new or improved filters is particularly - welcome! + Before setting the Accept-Language: header + to a rare language, you should consider that it helps to + make your requests unique and thus easier to trace. + If you don't plan to change this header frequently, + you should stick to a common language. - Example usage (with filters from the distribution default.filter file): + Example usage (section): - - - +filter{html-annoyances} # Get rid of particularly annoying HTML abuse. - - - - +filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse - - - - +filter{banners-by-size} # Kill banners by size (very efficient!) - - - - +filter{content-cookies} # Kill cookies that come sneaking in the HTML or JS content - - - - +filter{popups} # Kill all popups in JS and HTML + + # Pretend to use Canadian language settings. +{+hide-accept-language{en-ca} \ ++hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv:1.8.0.4) Gecko/20060628 Firefox/1.5.0.4} \ +} +/ + + + + + + + + +hide-content-disposition + + + + Typical use: + + Prevent download menus for content you prefer to view inside the browser. + + + + + Effect: + - - +filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking) + Deletes or replaces the Content-Disposition: HTTP header set by some servers. + + + + + Type: + + + Parameterized. + + + + + Parameter: + - - +filter{fun} # Text replacements for subversive browsing fun! - + Keyword: block, or any user defined value. + + + + + + Notes: + - - +filter{frameset-borders} # Give frames a border and make them resizeable + Some servers set the Content-Disposition: HTTP header for + documents they assume you want to save locally before viewing them. + The Content-Disposition: header contains the file name + the browser is supposed to use by default. - - +filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups) + In most browsers that understand this header, it makes it impossible to + just view the document, without downloading it first, + even if it's just a simple text file or an image. - - +filter{nimda} # Remove Nimda (virus) code. + Removing the Content-Disposition: header helps + to prevent this annoyance, but some browsers additionally check the + Content-Type: header, before they decide if they can + display a document without saving it first. In these cases, you have + to change this header as well, before the browser stops displaying + download menus. - - +filter{shockwave-flash} # Kill embedded Shockwave Flash objects + It is also possible to change the server's file name suggestion + to another one, but in most cases it isn't worth the time to set + it up. - - - +filter{crude-parental} # Kill all web pages that contain the words "sex" or "warez" + + + + + Example usage: + + + # Disarm the download link in Sourceforge's patch tracker +{-filter\ ++content-type-overwrite {text/plain}\ ++hide-content-disposition {block} } +.sourceforge.net/tracker/download.php @@ -2453,14 +3708,16 @@ problem-host.example.com - -handle-as-image - + +hide-if-modified-since + Typical use: - Mark URLs as belonging to images (so they'll be replaced by images if they get blocked) + Prevent yet another way to track the user's steps between sessions. @@ -2468,12 +3725,7 @@ problem-host.example.com Effect: - This action alone doesn't do anything noticeable. It just marks URLs as images. - If the block action also applies, - the presence or absence of this mark decides whether an HTML blocked - page, or a replacement image (as determined by the set-image-blocker action) will be sent to the - client as a substitute for the blocked content. + Deletes the If-Modified-Since: HTTP client header or modifies its value. @@ -2482,7 +3734,7 @@ problem-host.example.com Type: - Boolean. + Parameterized. @@ -2490,8 +3742,8 @@ problem-host.example.com Parameter: - N/A - + Keyword: block, or a user defined value that specifies a range of hours. + @@ -2499,42 +3751,43 @@ problem-host.example.com Notes: - The below generic example section is actually part of default.action. - It marks all URLs with well-known image file name extensions as images and should - be left intact. + Removing this header is useful for filter testing, where you want to force a real + reload instead of getting status code 304, which would cause the + browser to use a cached copy of the page. - Users will probably only want to use the handle-as-image action in conjunction with - block, to block sources of banners, whose URLs don't - reflect the file type, like in the second example section. + Instead of removing the header, hide-if-modified-since can + also add or substract a random amount of time to/from the headers value. + You specify a range of hours were the random factor should be chosen from and + Privoxy does the rest. A negative value means + subtracting, a positive value adding. - Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad - frames require an HTML page to be sent, or they won't display properly. - Forcing handle-as-image in this situation will not replace the - ad frame with an image, but lead to error messages. + Randomizing the value of the If-Modified-Since: makes + sure it isn't used as a cookie replacement, but you will run into + caching problems if the random range is too high. + + + It is a good idea to only use a small negative value and let + overwrite-last-modified + handle the greater changes. + + + It is also recommended to use this action together with + crunch-if-none-match. - Example usage (sections): - - - # Generic image extensions: -# -{+handle-as-image} -/.*\.(gif|jpg|jpeg|png|bmp|ico)$ - -# These don't look like images, but they're banners and should be -# blocked as images: -# -{+block +handle-as-image} -some.nasty-banner-server.com/junk.cgi?output=trash - -# Banner source! Who cares if they also have non-image content? -ad.doubleclick.net - + Example usage (section): + + + # Let the browser revalidate without being tracked across sessions +{+hide-if-modified-since {-1}\ ++overwrite-last-modified {randomize}\ ++crunch-if-none-match} +/ @@ -2545,7 +3798,9 @@ ad.doubleclick.net hide-forwarded-for-headers - + Typical use: @@ -2715,7 +3970,10 @@ ad.doubleclick.net - block to delete the header completely. + conditional-block to delete the header completely if the host has changed. + + + block to delete the header unconditionally. forge to pretend to be coming from the homepage of the server we are talking to. @@ -2731,18 +3989,37 @@ ad.doubleclick.net Notes: - forge is the preferred option here, since some servers will - not send images back otherwise, in an attempt to prevent their valuable - content from being embedded elsewhere (and hence, without being surrounded - by their banners). + conditional-block is the only parameter, + that isn't easily detected in the server's log file. If it blocks the + referrer, the request will look like the visitor used a bookmark or + typed in the address directly. + + + Leaving the referrer unmodified for requests on the same host + allows the server owner to see the visitor's click path, + but in most cases she could also get that information by comparing + other parts of the log file: for example the User-Agent if it isn't + a very common one, or the user's IP address if it doesn't change between + different requests. + + + Always blocking the referrer, or using a custom one, can lead to + failures on servers that check the referrer before they answer any + requests, in an attempt to prevent their valuable content from being + embedded or linked to elsewhere. + + + Both conditional-block and forge + will work with referrer checks, as long as content and valid referring page + are on the same host. Most of the time that's the case. + + + hide-referer is an alternate spelling of + hide-referrer and the two can be can be freely + substituted with each other. (referrer is the + correct English spelling, however the HTTP specification has a bug - it + requires it to be spelled as referer.) - - hide-referer is an alternate spelling of - hide-referrer and the two can be can be freely - substituted with each other. (referrer is the - correct English spelling, however the HTTP specification has a bug - it - requires it to be spelled as referer.) - @@ -2803,11 +4080,14 @@ ad.doubleclick.net - This breaks many web sites that depend on looking at this header in order - to customize their content for different browsers (which, by the - way, is NOT a smart way to do + This can lead to problems on web sites that depend on looking at this header in + order to customize their content for different browsers (which, by the + way, is NOT the right thing to do: good web sites + work browser-independently). + @@ -2841,6 +4121,73 @@ ad.doubleclick.net + + +inspect-jpegs + + + + Typical use: + + To protect against the MS buffer over-run in JPEG processing + + + + + Effect: + + + To protect against a known exploit + + + + + + Type: + + + Boolean. + + + + + Parameter: + + + N/A + + + + + + Notes: + + + See Microsoft Security Bulletin MS04-028. JPEG images are one of the most + common image types found across the Internet. The exploit as described can + allow execution of code on the target system, giving an attacker access + to the system in question by merely planting an altered JPEG image, which + would have no obvious indications of what lurks inside. This action + prevents unwanted intrusion. + + + + + + + Example usage: + + +inspect-jpegs + + + + + + + + kill-popups<anchor id="kill-popup"> @@ -2849,7 +4196,7 @@ ad.doubleclick.net Typical use: - Eliminate those annoying pop-up windows + Eliminate those annoying pop-up windows (deprecated) @@ -2884,13 +4231,15 @@ ad.doubleclick.net Notes: - This action is easily confused with the built-in, hardwired filter + This action is basically a built-in, hardwired special-purpose filter action, but there are important differences: For kill-popups, the document need not be buffered, so it can be incrementally rendered while downloading. But kill-popups doesn't catch as many pop-ups as filter{popups} - does. + linkend="FILTER-ALL-POPUPS">filter{all-popups} + does and is not as smart as filter{unsolicited-popups} + is. Think of it as a fast and efficient replacement for a filter that you @@ -2901,9 +4250,12 @@ ad.doubleclick.net the kill-popups action over its filter equivalent. - Killing all pop-ups is a dangerous business. Many shops and banks rely on - pop-ups to display forms, shopping carts etc, and killing only the unwanted pop-ups - would require artificial intelligence in Privoxy. + Killing all pop-ups unconditionally is problematic. Many shops and banks rely on + pop-ups to display forms, shopping carts etc, and the filter{unsolicited-popups} + does a fairly good job of catching only the unwanted ones. + + If the only kind of pop-ups that you want to kill are exit consoles (those really nasty windows that appear when you close an other one), you might want to use @@ -2939,7 +4291,7 @@ ad.doubleclick.net Typical use: - Prevent abuse of Privoxy as a TCP proxy relay + Prevent abuse of Privoxy as a TCP proxy relay or disable SSL for untrusted sites @@ -2989,8 +4341,12 @@ ad.doubleclick.net abused as TCP relays very easily. - If you don't know what any of this means, there probably is no reason to - change this one, since the default is already very restrictive. + Privoxy relays HTTPS traffic without seeing + the decoded content. Websites can leverage this limitation to circumvent Privoxy's + filters. By specifying an invalid port range you can disable HTTPS entirely. + If you plan to disable SSL by default, consider enabling + treat-forbidden-connects-like-blocks + as well, to be able to quickly create exceptions. @@ -3005,7 +4361,8 @@ ad.doubleclick.net +limit-connect{443} # This is the default and need not be specified. +limit-connect{80,443} # Ports 80 and 443 are OK. +limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK. -+limit-connect{-} # All ports are OK (gaping security hole!) ++limit-connect{-} # All ports are OK ++limit-connect{,} # No HTTPS traffic is allowed @@ -3022,7 +4379,7 @@ ad.doubleclick.net Ensure that servers send the content uncompressed, so it can be - passed through filters + passed through filters. @@ -3031,7 +4388,7 @@ ad.doubleclick.net Effect: - Adds a header to the request that asks for uncompressed transfer. + Removes the Accept-Encoding header which can be used to ask for compressed transfer. @@ -3101,6 +4458,183 @@ www.pclinuxonline.com + + +overwrite-last-modified + + + + Typical use: + + Prevent yet another way to track the user's steps between sessions. + + + + + Effect: + + + Deletes the Last-Modified: HTTP server header or modifies its value. + + + + + + Type: + + + Parameterized. + + + + + Parameter: + + + One of the keywords: block, reset-to-request-time + and randomize + + + + + + Notes: + + + Removing the Last-Modified: header is useful for filter + testing, where you want to force a real reload instead of getting status + code 304, which would cause the browser to reuse the old + version of the page. + + + The randomize option overwrites the value of the + Last-Modified: header with a randomly chosen time + between the original value and the current time. In theory the server + could send each document with a different Last-Modified: + header to track visits without using cookies. Randomize + makes it impossible and the browser can still revalidate cached documents. + + + reset-to-request-time overwrites the value of the + Last-Modified: header with the current time. You could use + this option together with + hided-if-modified-since + to further customize your random range. + + + The preferred parameter here is randomize. It is safe + to use, as long as the time settings are more or less correct. + If the server sets the Last-Modified: header to the time + of the request, the random range becomes zero and the value stays the same. + Therefore you should later randomize it a second time with + hided-if-modified-since, + just to be sure. + + + It is also recommended to use this action together with + crunch-if-none-match. + + + + + + Example usage: + + + # Let the browser revalidate without being tracked across sessions +{+hide-if-modified-since {-1}\ ++overwrite-last-modified {randomize}\ ++crunch-if-none-match} +/ + + + + + + + + + +redirect + + + + Typical use: + + + Redirect requests to other sites. + + + + + + Effect: + + + Convinces the browser that the requested document has been moved + to another location and the browser should get it from there. + + + + + + Type: + + + Parameterized + + + + + Parameter: + + + Any URL. + + + + + + Notes: + + + This action is useful to replace whole documents with your own + ones. For that to work, they have to be available on another server. + + + You can do the same by combining the actions + block, + handle-as-image and + set-image-blocker{URL}. + It doesn't sound right for non-image documents, and that's why this action + was created. + + + This action will be ignored if you use it together with + block. + + + + + + Example usage: + + + # Replace example.com's style sheet with another one +{+redirect{http://localhost/css-replacements/example.com.css}} +example.com/stylesheet.css + + + + + + + + send-vanilla-wafer @@ -3242,7 +4776,8 @@ my-internal-testing-server.void Typical use: - Allow only temporary session cookies (for the current browser session only). + Allow only temporary session cookies (for the current + browser session only). @@ -3251,8 +4786,9 @@ my-internal-testing-server.void Effect: - Deletes the expires field from Set-Cookie: server headers. - Most browsers will not store such cookies permanently and forget them in between sessions. + Deletes the expires field from Set-Cookie: + server headers. Most browsers will not store such cookies permanently and + forget them in between sessions. @@ -3299,6 +4835,17 @@ my-internal-testing-server.void Note that it is up to the browser how it handles such cookies without an expires field. If you use an exotic browser, you might want to try it out to be sure. + + This setting also has no effect on cookies that may have been stored + previously by the browser before starting Privoxy. + These would have to be removed manually. + + + Privoxy also uses + the content-cookies filter + to block some types of cookies. Content cookies are not effected by + session-cookies-only. + @@ -3370,7 +4917,8 @@ my-internal-testing-server.void target-url to send a redirect to target-url. You can redirect - to any image anywhere, even in your local filesystem (via file:/// URL). + to any image anywhere, even in your local filesystem via file:/// URL. + (But note that not all browsers support redirecting to a local file system). A good application of redirects is to use special Privoxy-built-in @@ -3427,6 +4975,89 @@ my-internal-testing-server.void + + +treat-forbidden-connects-like-blocks + + + + Typical use: + + Block forbidden connects with an easy to find error message. + + + + + Effect: + + + If this action is enabled, Privoxy no longer + makes a difference between forbidden connects and ordinary blocks. + + + + + + Type: + + + Boolean + + + + + Parameter: + + N/A + + + + + Notes: + + + By default Privoxy answers + forbidden Connect requests + with a short error message inside the headers. If the browser doesn't display + headers (most don't), you just see an empty page. + + + With this action enabled, Privoxy displays + the message that is used for ordinary blocks instead. If you decide + to make an exception for the page in question, you can do so by + following the See why link. + + + For Connect requests the clients tell + Privoxy which host they are interested + in, but not which document they plan to get later. As a result, the + Go there anyway link becomes rather useless: + it lets the client request the home page of the forbidden host + through unencrypted HTTP, still using the port of the last request. + + + If you previously configured Privoxy to do the + request through a SSL tunnel, everything will work. Most likely you haven't + and the server will responds with an error message because it is expecting + HTTPS. + + + + + + Example usage: + + + +treat-forbidden-connects-like-blocks + + + + + + + Summary @@ -3500,16 +5131,16 @@ my-internal-testing-server.void # These aliases just save typing later: # (Note that some already use other aliases!) # - +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies - -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies + +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies + -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies block-as-image = +block +handle-as-image - mercy-for-cookies = -crunch-all-cookies -session-cookies-only + mercy-for-cookies = -crunch-all-cookies -session-cookies-only -filter{content-cookies} # These aliases define combinations of actions # that are useful for certain types of sites: # - fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups - shop = -crunch-all-cookies -filter{popups} -kill-popups + fragile = -block -filter -crunch-all-cookies -fast-redirects -hide-referrer -kill-popups + shop = -crunch-all-cookies -filter{all-popups} -kill-popups # Short names for other aliases, for really lazy people ;-) # @@ -3543,7 +5174,7 @@ my-internal-testing-server.void # These shops require pop-ups: # - {shop -kill-popups -filter{popups}} + {shop -kill-popups -filter{all-popups}} .dabs.com .overclockers.co.uk @@ -3554,7 +5185,9 @@ my-internal-testing-server.void in order to function properly. - + Actions Files Tutorial @@ -3575,7 +5208,7 @@ Every config file should start with a short comment stating its purpose: - # Sample default.action file <developers@privoxy.org> + # Sample default.action file <ijbswa-developers@lists.sourceforge.net> @@ -3607,19 +5240,19 @@ that also explains why and how aliases are used: ########################################################################## {{alias}} -# These aliases just save typing later: -# (Note that some already use other aliases!) -# -+crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies --crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies -block-as-image = +block +handle-as-image -mercy-for-cookies = -crunch-all-cookies -session-cookies-only + # These aliases just save typing later: + # (Note that some already use other aliases!) + # + +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies + -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies + block-as-image = +block +handle-as-image + mercy-for-cookies = -crunch-all-cookies -session-cookies-only -filter{content-cookies} -# These aliases define combinations of actions -# that are useful for certain types of sites: -# -fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups -shop = mercy-for-cookies -filter{popups} -kill-popups + # These aliases define combinations of actions + # that are useful for certain types of sites: + # + fragile = -block -filter -crunch-all-cookies -fast-redirects -hide-referrer -kill-popups + shop = -crunch-all-cookies -filter{all-popups} -kill-popups @@ -3662,17 +5295,26 @@ shop = mercy-for-cookies -filter{popups} -kill-popups +deanimate-gifs \ -downgrade-http-version \ +fast-redirects \ - +filter{html-annoyances} \ +filter{js-annoyances} \ + -filter{js-events} \ + +filter{html-annoyances} \ -filter{content-cookies} \ - +filter{popups} \ - +filter{webbugs} \ - -filter{refresh-tags} \ - -filter{fun} \ - +filter{nimda} \ + +filter{refresh-tags} \ + +filter{unsolicited-popups} \ + -filter{all-popups} \ + +filter{img-reorder} \ +filter{banners-by-size} \ + -filter{banners-by-link} \ + +filter{webbugs} \ + -filter{tiny-textforms} \ + +filter{jumping-windows} \ + -filter{frameset-borders} \ + -filter{demoronizer} \ -filter{shockwave-flash} \ + -filter{quicktime-kioskmode} \ + -filter{fun} \ -filter{crude-parental} \ + +filter{ie-exploits} \ -handle-as-image \ +hide-forwarded-for-headers \ +hide-from-header{block} \ @@ -3696,8 +5338,6 @@ shop = mercy-for-cookies -filter{popups} -kill-popups like not blocking (which is understandably the default!) need exceptions, i.e. we need to specify explicitly what we want to block in later sections. - We will also want to make exceptions from our general pop-up-killing, - and use our defined aliases for that. @@ -3739,13 +5379,15 @@ shop = mercy-for-cookies -filter{popups} -kill-popups .scan.co.uk + + The fast-redirects action, which we enabled per default above, breaks some sites. So disable @@ -3989,14 +5633,31 @@ www.ugu.com/sui/ugu/adv +# Aliases are local to the file they are defined in. # (Re-)define aliases for this file: # {{alias}} +# +# These aliases just save typing later, and the alias names should +# be self explanatory. +# ++crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies -mercy-for-cookies = -crunch-all-cookies -session-cookies-only -fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups -shop = mercy-for-cookies -filter{popups} -kill-popups -allow-ads = -block -filter{banners-by-size} # (see below) + allow-all-cookies = -crunch-all-cookies -session-cookies-only + allow-popups = -filter{all-popups} -kill-popups ++block-as-image = +block +handle-as-image +-block-as-image = -block + +# These aliases define combinations of actions that are useful for +# certain types of sites: +# +fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referrer -kill-popups +shop = -crunch-all-cookies allow-popups + +# Allow ads for selected useful free sites: +# +allow-ads = -block -filter{banners-by-size} -filter{banners-by-link} + @@ -4004,61 +5665,97 @@ allow-ads = -block -filter{banners-by-size} # (see below) Say you have accounts on some sites that you visit regularly, and you don't want to have to log in manually each time. So you'd like to allow persistent cookies for these sites. The - mercy-for-cookies alias defined above does exactly - that, i.e. it disables crunching of cookies in any direction, and - processing of cookies to make them temporary. + allow-all-cookies alias defined above does exactly + that, i.e. it disables crunching of cookies in any direction, and the + processing of cookies to make them only temporary. -{ mercy-for-cookies } +{ allow-all-cookies } +sourceforge.net sunsolve.sun.com -slashdot.org +.slashdot.org .yahoo.com .msdn.microsoft.com .redhat.com - Your bank needs popups and is allergic to some filter, but you don't - know which, so you disable them all: + Your bank is allergic to some filter, but you don't know which, so you disable them all: -{ -filter -kill-popups } +{ -filter } .your-home-banking-site.com - While browsing the web with Privoxy you - noticed some ads that sneaked through, but you were too lazy to - report them through our fine and easy feedback - system, so you have added them here: + Some file types you may not want to filter for various reasons: + + + + +# Technical documentation is likely to contain strings that might +# erroneously get altered by the JavaScript-oriented filters: +# +.tldp.org +/(.*/)?selfhtml/ + +# And this stupid host sends streaming video with a wrong MIME type, +# so that Privoxy thinks it is getting HTML and starts filtering: +# +stupid-server.example.com/ + + + + Example of a simple block action. Say you've + seen an ad on your favourite page on example.com that you want to get rid of. + You have right-clicked the image, selected copy image location + and pasted the URL below while removing the leading http://, into a + { +block } section. Note that { +handle-as-image + } need not be specified, since all URLs ending in + .gif will be tagged as images by the general rules as set + in default.action anyway: { +block } -www.a-popular-site.com/some/unobvious/path +www.example.com/nasty-ads/sponsor.gif another.popular.site.net/more/junk/here/ - Note that, assuming the banners in the above example have regular image - extensions (most do), - +handle-as-image - need not be specified, since all URLs ending in these extensions will - already have been tagged as images in the relevant section of - default.action by now. + The URLs of dynamically generated banners, especially from large banner + farms, often don't use the well-known image file name extensions, which + makes it impossible for Privoxy to guess + the file type just by looking at the URL. + You can use the +block-as-image alias defined above for + these cases. + Note that objects which match this rule but then turn out NOT to be an + image are typically rendered as a broken image icon by the + browser. Use cautiously. - Then you noticed that the default configuration breaks Forbes Magazine, + +{ +block-as-image } +.doubleclick.net +/Realmedia/ads/ +ar.atwola.com/ + + + + Now you noticed that the default configuration breaks Forbes Magazine, but you were too lazy to find out which action is the culprit, and you were again too lazy to give feedback, so you just used the fragile alias on the site, and - -- whoa! -- it worked: + -- whoa! -- it worked. The fragile + aliases disables those actions that are most likely to break a site. Also, + good for testing purposes to see if it is Privoxy + that is causing the problem or not. @@ -4089,7 +5786,7 @@ another.popular.site.net/more/junk/here/ - Finally, you might think about how your favourite free websites are + You might also worry about how your favourite free websites are funded, and find that they rely on displaying banner advertisements to survive. So you might want to specifically allow banners for those sites that you feel provide value to you: @@ -4105,10 +5802,27 @@ another.popular.site.net/more/junk/here/ Note that allow-ads has been aliased to - -block - -filter{banners-by-size} - above. + -block, + -filter{banners-by-size}, and + -filter{banners-by-link} above. + + + + user.action is generally the best place to define + exceptions and additions to the default policies of + default.action. Some actions are safe to have their + default policies set here though. So let's set a default policy to have a + blank image as opposed to the checkerboard pattern for + ALL sites. / of course matches all URL + paths and patterns: + + + + +{ +set-image-blocker{blank} } +/ # ALL sites + @@ -4121,20 +5835,24 @@ another.popular.site.net/more/junk/here/ -The Filter File +Filter Files All text substitutions that can be invoked through the - filter action - must first be defined in the filter file, which is typically - called default.filter and which can be - selected through the + filter action which + must first be defined in a filter file, such as + default.filter. Mulitple filter files can be + defined through the filterfile config - option. + option. The filters as supplied by the developers will be found in + default.filter. It is recommended that any locally + defined or modified filters go in a separately defined file such as + user.filter. + - Typical reasons for doing such substitutions are to eliminate + Typical reasons for doing these kinds of substitutions are to eliminate common annoyances in HTML and JavaScript, such as pop-up windows, exit consoles, crippled windows without navigation tools, the infamous <BLINK> tag etc, to suppress images with certain @@ -4143,11 +5861,11 @@ another.popular.site.net/more/junk/here/ - Filtering works on any text-based document type, including plain - text, HTML, JavaScript, CSS etc. (all text/* - MIME types). Substitutions are made at the source level, so if - you want to roll your own filters, you should be - familiar with HTML syntax. + Filtering works on any text-based document type, including + HTML, JavaScript, CSS etc. (all text/* + MIME types, except text/plain). + Substitutions are made at the source level, so if you want to roll + your own filters, you should be familiar with HTML syntax. @@ -4186,10 +5904,9 @@ another.popular.site.net/more/junk/here/ in a syntax that imitates Perl's s/// operator. If you are familiar with Perl, you will find this to be quite intuitive, and may want to look at the - PCRS man page - for the subtle differences to Perl behaviour. Most notably, the non-standard - option letter U is supported, which turns the default - to ungreedy matching. + PCRS documentation for the subtle differences to Perl behaviour. Most + notably, the non-standard option letter U is supported, + which turns the default to ungreedy matching. @@ -4204,6 +5921,7 @@ another.popular.site.net/more/junk/here/ The below examples might also help to get you started. + Filter File Tutorial @@ -4308,119 +6026,493 @@ s|(<script.*)document\.referrer(.*</script>)|$1"Not Your Business!"$2|U that string, up to and including the closing tag, as $2. - - Now the pattern is deciphered, but wasn't this about substituting things? So - lets look at the substitute: $1"Not Your Business!"$2 is - easy to read: The text remembered as $1, followed by - "Not Your Business!" (including - the quotation marks!), followed by the text remembered as $2. - This produces an exact copy of the original string, with the middle part - (the document.referrer) replaced by "Not Your - Business!". - + + Now the pattern is deciphered, but wasn't this about substituting things? So + lets look at the substitute: $1"Not Your Business!"$2 is + easy to read: The text remembered as $1, followed by + "Not Your Business!" (including + the quotation marks!), followed by the text remembered as $2. + This produces an exact copy of the original string, with the middle part + (the document.referrer) replaced by "Not Your + Business!". + + + + The whole job now reads: Replace document.referrer by + "Not Your Business!" wherever it appears inside a + <script> tag. Note that this job won't break JavaScript syntax, + since both the original and the replacement are syntactically valid + string objects. The script just won't have access to the referrer + information anymore. + + + + We'll show you two other jobs from the JavaScript taming department, but + this time only point out the constructs of special interest: + + + + +# The status bar is for displaying link targets, not pointless blahblah +# +s/window\.status\s*=\s*(['"]).*?\1/dUmMy=1/ig + + + + \s stands for whitespace characters (space, tab, newline, + carriage return, form feed), so that \s* means: zero + or more whitespace. The ? in .*? + makes this matching of arbitrary text ungreedy. (Note that the U + option is not set). The ['"] construct means: a single + or a double quote. Finally, \1 is + a backreference to the first parenthesis just like $1 above, + with the difference that in the pattern, a backslash indicates + a backreference, whereas in the substitute, it's the dollar. + + + + So what does this job do? It replaces assignments of single- or double-quoted + strings to the window.status object with a dummy assignment + (using a variable name that is hopefully odd enough not to conflict with + real variables in scripts). Thus, it catches many cases where e.g. pointless + descriptions are displayed in the status bar instead of the link target when + you move your mouse over links. + + + + +# Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html +# +s/(<body [^>]*)onunload(.*>)/$1never$2/iU + + + + Including the + OnUnload + event binding in the HTML DOM was a CRIME. + When I close a browser window, I want it to close and die. Basta. + This job replaces the onunload attribute in + <body> tags with the dummy word never. + Note that the i option makes the pattern matching + case-insensitive. Also note that ungreedy matching alone doesn't always guarantee + a minimal match: In the first parenthesis, we had to use [^>]* + instead of .* to prevent the match from exceeding the + <body> tag if it doesn't contain OnUnload, but the page's + content does. + + + + The last example is from the fun department: + + + + +FILTER: fun Fun text replacements + +# Spice the daily news: +# +s/microsoft(?!\.com)/MicroSuck/ig + + + + Note the (?!\.com) part (a so-called negative lookahead) + in the job's pattern, which means: Don't match, if the string + .com appears directly following microsoft + in the page. This prevents links to microsoft.com from being trashed, while + still replacing the word everywhere else. + + + + +# Buzzword Bingo (example for extended regex syntax) +# +s* industry[ -]leading \ +| cutting[ -]edge \ +| customer[ -]focused \ +| market[ -]driven \ +| award[ -]winning # Comments are OK, too! \ +| high[ -]performance \ +| solutions[ -]based \ +| unmatched \ +| unparalleled \ +| unrivalled \ +*<font color="red"><b>BINGO!</b></font> \ +*igx + + + + The x option in this job turns on extended syntax, and allows for + e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting. + + + + You get the idea? + + + + + +The Pre-defined Filters + + + + +The distribution default.filter file contains a selection of +pre-defined filters for your convenience: + + + + + js-annoyances + + + The purpose of this filter is to get rid of particularly annoying JavaScript abuse. + To that end, it + + + + replaces JavaScript references to the browser's referrer information + with the string "Not Your Business!". This compliments the hide-referrer action on the content level. + + + + + removes the bindings to the DOM's + unload + event which we feel has no right to exist and is responsible for most exit consoles, i.e. + nasty windows that pop up when you close another one. + + + + + removes code that causes new windows to be opened with undesired properties, such as being + full-screen, non-resizable, without location, status or menu bar etc. + + + + + + + + + js-events + + + This is a very radical measure. It removes virtually all JavaScript event bindings, which + means that scripts can not react to user actions such as mouse movements or clicks, window + resizing etc, anymore. + + + We strongly discourage using this filter as a default since it breaks + many legitimate scripts. It is meant for use only on extra-nasty sites (should you really + need to go there). + + + + + + html-annoyances + + + This filter will undo many common instances of HTML based abuse. + + + The BLINK and MARQUEE tags + are neutralized (yeah baby!), and browser windows will be created as + resizable (as of course they should be!), and will have location, + scroll and menu bars -- even if specified otherwise. + + + + + + content-cookies + + + Most cookies are set in the HTTP dialogue, where they can be intercepted + by the + crunch-incoming-cookies + and crunch-outgoing-cookies + actions. But web sites increasingly make use of HTML meta tags and JavaScript + to sneak cookies to the browser on the content level. + + + This filter disables HTML and JavaScript code that reads or sets cookies. Use + it wherever you would also use the cookie crunch actions. + + + + + + refresh tags + + + Disable any refresh tags if the interval is greater than nine seconds (so + that redirections done via refresh tags are not destroyed). This is useful + for dial-on-demand setups, or for those who find this HTML feature + annoying. + + + + + + unsolicited-popups + + + This filter attempts to prevent only unsolicited pop-up + windows from opening, yet still allow pop-up windows that the user + has explicitly chosen to open. It was added in version 3.0.1, + as an improvement over earlier such filters. + + + Technical note: The filter works by redefining the window.open JavaScript + function to a dummy function during the loading and rendering phase of each + HTML page access, and restoring the function afterwards. + + + + + + all-popups + + + Attempt to prevent all pop-up windows from opening. + Note this should be used with more discretion than the above, since it is + more likely to break some sites that require pop-ups for normal usage. Use + with caution. + + + + + + img-reorder + + + This is a helper filter that has no value if used alone. It makes the + banners-by-size and banners-by-link + (see below) filters more effective and should be enabled together with them. + + + + + + banners-by-size + + + This filter removes image tags purely based on what size they are. Fortunately + for us, many ads and banner images tend to conform to certain standardized + sizes, which makes this filter quite effective for ad stripping purposes. + + + Occasionally this filter will cause false positives on images that are not ads, + but just happen to be of one of the standard banner sizes. + + + + + + banners-by-link + + + This is an experimental filter that attempts to kill any banners if + their URLs seem to point to known or suspected click trackers. It is currently + not of much value and is not recommended for use by default. + + + - - The whole job now reads: Replace document.referrer by - "Not Your Business!" wherever it appears inside a - <script> tag. Note that this job won't break JavaScript syntax, - since both the original and the replacement are syntactically valid - string objects. The script just won't have access to the referrer - information anymore. - + + webbugs + + + Webbugs are small, invisible images (technically 1X1 GIF images), that + are used to track users across websites, and collect information on them. + As an HTML page is loaded by the browser, an embedded image tag causes the + browser to contact a third-party site, disclosing the tracking information + through the requested URL and/or cookies for that third-party domain, without + the use ever becoming aware of the interaction with the third-party site. + HTML-ized spam also uses a similar technique to verify email addresses. + + + This filter removes the HTML code that loads such webbugs. + + + - - We'll show you two other jobs from the JavaScript taming department, but - this time only point out the constructs of special interest: - + + tiny-textforms + + + A rather special-purpose filter that can be used to enlarge textareas (those + multi-line text boxes in web forms) and turn off hard word wrap in them. + It was written for the sourceforge.net tracker system where such boxes are + a nuisance, but it can be handy on other sites, too. + + + It is not recommended to use this filter as a default. + + + - - -# The status bar is for displaying link targets, not pointless blahblah -# -s/window\.status\s*=\s*['"].*?['"]/dUmMy=1/ig - + + jumping-windows + + + Many consider windows that move, or resize themselves to be abusive. This filter + neutralizes the related JavaScript code. Note that some sites might not display + or behave as intended when using this filter. + + + - - \s stands for whitespace characters (space, tab, newline, - carriage return, form feed), so that \s* means: zero - or more whitespace. The ? in .*? - makes this matching of arbitrary text ungreedy. (Note that the U - option is not set). The ['"] construct means: a single - or a double quote. - + + frameset-borders + + + Some web designers seem to assume that everyone in the world will view their + web sites using the same browser brand and version, screen resolution etc, + because only that assumption could explain why they'd use static frame sizes, + yet prevent their frames from being resized by the user, should they be too + small to show their whole content. + + + This filter removes the related HTML code. It should only be applied to sites + which need it. + + + - - So what does this job do? It replaces assignments of single- or double-quoted - strings to the window.status object with a dummy assignment - (using a variable name that is hopefully odd enough not to conflict with - real variables in scripts). Thus, it catches many cases where e.g. pointless - descriptions are displayed in the status bar instead of the link target when - you move your mouse over links. - + + demoronizer + + + Many Microsoft products that generate HTML use non-standard extensions (read: + violations) of the ISO 8859-1 aka Latin-1 character set. This can cause those + HTML documents to display with errors on standard-compliant platforms. + + + This filter translates the MS-only characters into Latin-1 equivalents. + It is not necessary when using MS products, and will cause corruption of + all documents that use 8-bit character sets other than Latin-1. It's mostly + worthwhile for Europeans on non-MS platforms, if wierd garbage characters + sometimes appear on some pages, or user agents that don't correct for this on + the fly. + + + + - - -# Kill OnUnload popups. Yummy. Test: http://www.zdnet.com/zdsubs/yahoo/tree/yfs.html -# -s/(<body .*)onunload(.*>)/$1never$2/iU - + + shockwave-flash + + + A filter for shockwave haters. As the name suggests, this filter strips code + out of web pages that is used to embed shockwave flash objects. + + + + + - - Including the - OnUnload - event binding in the HTML DOM was a CRIME. - When I close a browser window, I want it to close and die. Basta. - This job replaces the onunload attribute in - <body> tags with the dummy word never. - Note that the i option makes the pattern matching - case-insensitive. - + + quicktime-kioskmode + + + Change HTML code that embeds Quicktime objects so that kioskmode, which + prevents saving, is disabled. + + + - - The last example is from the fun department: - + + fun + + + Text replacements for subversive browsing fun. Make fun of your favorite + Monopolist or play buzzword bingo. + + + - - -FILTER: fun Fun text replacements + + crude-parental + + + A demonstration-only filter that shows how Privoxy + can be used to delete web content on a keyword basis. + + + -# Spice the daily news: -# -s/microsoft(?!\.com)/MicroSuck/ig - + + ie-exploits + + + A collection of text replacements to disable malicious HTML and JavaScript + code that exploits known security holes in Internet Explorer. + + + Presently, it only protects against Nimda and a cross-site scripting bug, and + would need active maintenance to provide more substantial protection. + + + - - Note the (?!\.com) part (a so-called negative lookahead) - in the job's pattern, which means: Don't match, if the string - .com appears directly following microsoft - in the page. This prevents links to microsoft.com from being messed, while - still replacing the word everywhere else. - + + site-specifics + + + Some web sites have very specific problems, the cure for which doesn't apply + anywhere else, or could even cause damage on other sites. + + + This is a collection of such site-specific cures which should only be applied + to the sites they were intended for, which is what the supplied + default.action file does. Users shouldn't need to change + anything regarding this filter. + + + - - -# Buzzword Bingo (example for extended regex syntax) -# -s* industry[ -]leading \ -| cutting[ -]edge \ -| award[ -]winning # Comments are OK, too! \ -| high[ -]performance \ -| solutions[ -]based \ -| unmatched \ -| unparalleled \ -| unrivalled \ -*<font color="red"><b>BINGO!</b></font> \ -*igx - + + filter-server-headers + + + + + - - The x option in this job turns on extended syntax, and allows for - e.g. the liberal use of (non-interpreted!) whitespace for nicer formatting. - + + filter-client-headers + + + + + + + + - - You get the idea? - @@ -4473,7 +6565,7 @@ s* industry[ -]leading \ blocks of HTML code disappear when a specific symbol is set. We use this for many purposes, one of them being to include the beta warning in all our user interface (CGI) pages when Privoxy - in in an alpha or beta development stage: + is in an alpha or beta development stage: @@ -4585,7 +6677,11 @@ Requests expressions in its actions files and filter file, through the PCRE and + + PCRS libraries. @@ -4973,12 +7069,13 @@ Requests 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 - + Privoxy - Why? @@ -4989,7 +7086,7 @@ Requests Credit: The site which gave us the general idea for these bookmarklets is - www.bookmarklets.com. They + www.bookmarklets.com. They have more information about bookmarklets. @@ -5069,7 +7166,7 @@ Requests First, the server headers are read and processed to determine, among other things, the MIME type (document type) and encoding. The headers are then - filtered as deterimined by the + filtered as determined by the +crunch-incoming-cookies, +session-cookies-only, and +downgrade-http-version @@ -5091,8 +7188,8 @@ Requests action applies (and the document type fits the action), the rest of the page is read into memory (up to a configurable limit). Then the filter rules (from default.filter) are processed against the buffered - content. Filters are applied in the order they are specified in the - default.filter file. Animated GIFs, if present, are + content. Filters are applied in the order they are specified in one of the + filter files. Animated GIFs, if present, are reduced to either the first or last frame, depending on the action setting.The entire page, which is now filtered, is then sent by Privoxy back to your browser. @@ -5143,7 +7240,8 @@ Requests One quick test to see if Privoxy is causing a problem or not, is to disable it temporarily. This should be the first troubleshooting step. See the Bookmarklets section on a quick - and easy way to do this (be sure to flush caches afterward!). + and easy way to do this (be sure to flush caches afterward!). Looking at the + logs is a good idea too. @@ -5159,7 +7257,7 @@ Requests how the current configuration will handle it. This will not help with filtering effects (i.e. the +filter action) from - the default.filter file since this is handled very + one of the filter files since this is handled very differently and not so easy to trap! It also will not tell you about any other URLs that may be embedded within the URL you are testing. For instance, images such as ads are expressed as URLs within the raw page source of HTML pages. So @@ -5309,7 +7407,8 @@ In file: user.action [ View ] [ Edit ] Notice the only difference here to the previous listing, is to - fast-redirects and session-cookies-only. + fast-redirects and session-cookies-only, + which are actived specifically for this site in our configuration. @@ -5439,8 +7538,9 @@ In file: user.action [ View ] [ Edit ]{+filter} actions. Try - adding the URL for the site to one of aliases that turn off +filter: + One likely cause would be one of the {+filter} actions. These + tend to be harder to troubleshoot. Try adding the URL for the site to one of + aliases that turn off +filter: @@ -5471,8 +7571,16 @@ In file: user.action [ View ] [ Edit ] - This would probably be most appropriately put in user.action, - for local site exceptions. + This would turn off all filtering for that site. This would probably be most + appropriately put in user.action, for local site + exceptions. + + + + Images that are inexplicably being blocked, may well be hitting the + +filter{banners-by-size} rule, which assumes + that images of certain sizes are ad banners (works well most of the time + since these tend to be standardized). @@ -5507,6 +7615,145 @@ In file: user.action [ View ] [ Edit ]