X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=4cbf7e65c9194eabddfb1c3a070d4c5b54180bda;hb=5a73e418fa170b0362734c9da5f4921cd413e5f5;hp=09fd525f1d141d5a72dfc773b1073907a14e2f22;hpb=86843fe49327d314678892f9114b061b0615c481;p=privoxy.git diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 09fd525f..4cbf7e65 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -1,5 +1,5 @@ + @@ -25,7 +25,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.86 2002/04/21 01:46:32 hal9 Exp $ + $Id: user-manual.sgml,v 1.92 2002/04/25 18:55:13 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -46,7 +46,7 @@ Privoxy User Manual -$Id: user-manual.sgml,v 1.86 2002/04/21 01:46:32 hal9 Exp $ +$Id: user-manual.sgml,v 1.92 2002/04/25 18:55:13 hal9 Exp $ @@ -189,13 +189,25 @@ Red Hat and SuSE RPMs - RPMs can be installed with rpm -Uvh <name-of-rpm.rpm>, + RPMs can be installed with rpm -Uvh privoxy-&p-version;-1.rpm, and will use /etc/privoxy for the location of configuration files. - Note that if you have a Junkbuster RPM installed + Note that on Red Hat, Privoxy will not be + automatically started on system boot. You will need to enable that using + chkconfig, ntsysv, or similar method. + + + + If you have problems with failed dependencies, try rebuilding the SRC RPM: + rpm --rebuild privoxy-&p-version;-1.src.rpm;. This + will use your locally installed libraries and RPM version. + + + + Also note that if you have a Junkbuster RPM installed on your system, you need to remove it first, because the packages conflict. Otherwise, RPM will try to remove Junkbuster automatically, before installing Privoxy. @@ -235,8 +247,7 @@ First, make sure that no previous installations of Junkbuster and / or Privoxy are left on your - system. - You can do this by + system. You can do this by @@ -262,7 +273,7 @@ Privoxy will be installed in the subdirectory /Applications/Privoxy.app. Privoxy will set itself up to start - automatically on system bringup via + automatically on system bring-up via /System/Library/StartupItems/Privoxy. @@ -270,7 +281,19 @@ AmigaOS - Unpack the .lha archive, then FIXME. + Copy and then unpack the lha archive to a suitable location. + All necessary files will be installed into Privoxy + directory, including all configuration and log files. To uninstall, just + remove this directory. + + + Start Privoxy (with RUN <>NIL:) in your + startnet script (AmiTCP), in + s:user-startup (RoadShow), as startup program in your + startup script (Genesis), or as startup action (Miami and MiamiDx). + Privoxy will automatically quit when you quit your + TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that + Privoxy is still running). @@ -279,7 +302,7 @@ Building from Source -&buildsource; + &buildsource; @@ -304,8 +327,9 @@ configuration files will not migrate. The functionality of the old blockfile, cookiefile and imagelist, are now combined into the - actions file (default.action - for most installations). + actions files. default.action, + is the main actions file. Local exceptions should best be put into + user.action. A filter file (typically default.filter) @@ -317,7 +341,7 @@ 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 file, please note that even the pattern syntax has + 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. @@ -354,9 +378,10 @@ The primary configuration file for cookie management, ad and banner blocking, and many other aspects of Privoxy - configuration is default.action. It is strongly + configuration is in the actions files. It is strongly recommended to become familiar with the new actions concept below, - before modifying this file. + before modifying these files. Locally defined rules + should go into user.action. @@ -429,7 +454,7 @@ - For Red Hat: /etc/rc.d/init.d/privoxy start + For Red Hat and Debian: /etc/rc.d/init.d/privoxy start @@ -453,22 +478,22 @@ - You will probably want to keep an eye out for sites that require persistent - cookies, and add these to default.action as needed. By + You will probably want to keep an eye out for sites for which you may prefer + persistent cookies, and add these to your actions configuration as needed. By default, most of these will be accepted only during the current browser - session (aka session cookies), until you add them to the + session (aka session cookies), unless you add them to the configuration. If you want the browser to handle this instead, you will need - to edit default.action and disable this feature. If you - use more than one browser, it would make more sense to let - Privoxy handle this. In which case, the - browser(s) should be set to accept all cookies. + to edit user.action (or through the web based interface) + and disable this feature. If you use more than one browser, it would make + more sense to let Privoxy handle this. In which + case, the browser(s) should be set to accept all cookies. Another feature where you will probably want to define exceptions for trusted sites is the popup-killing (through the +popup and +filter{popups} actions), because your favorite shopping, - banking, or leisure site may need popups. + banking, or leisure site may need popups (explained below). @@ -478,7 +503,7 @@ (like Mozilla or recent versions of I.E.), you might try to force HTTP/1.0 compatibility. For Mozilla, look under Edit -> Preferences -> Debug -> Networking. - Alternatively, set the +downgrade config option in + Alternatively, set the +downgrade-http-version config option in default.action which will downgrade your browser's HTTP requests from HTTP/1.1 to HTTP/1.0 before processing them. @@ -487,11 +512,11 @@ After running Privoxy for a while, you can start to fine tune the configuration to suit your personal, or site, preferences and requirements. There are many, many aspects that can - be customized. Actions (as specified in default.action) + be customized. Actions can be adjusted by pointing your browser to http://config.privoxy.org/ (shortcut: http://p.p/), - and then follow the link to edit the actions list. + and then follow the link to View & Change the Current Configuration. (This is an internal page and does not require Internet access.) @@ -500,7 +525,7 @@ configuration can be viewed from this page, including current configuration parameters, source code version numbers, the browser's request headers, and actions that apply - to a given URL. In addition to the default.action file + to a given URL. In addition to the actions file editor mentioned above, Privoxy can also be turned on and off (toggled) from this page. @@ -525,7 +550,8 @@ If you can't get rid of the problem at all, think you've found a bug in Privoxy, want to propose a new feature or smarter rules, please see the - chapter "Contacting the Developers, .." below. + section Contacting the + Developers below. @@ -621,7 +647,6 @@ in text files. These files can be edited with a text editor. Many important aspects of Privoxy can also be controlled easily with a web browser. - @@ -638,25 +663,35 @@ - - - -Please choose from the following options: + + + + Privoxy Menu - * Privoxy main page - * Show information about the current configuration - * Show the source code version numbers - * Show the request headers. - * Show which actions apply to a URL and why - * Toggle Privoxy on or off - * Edit the actions list + + +         ▪  View & change the current configuration + + +         ▪  View the source code version numbers + + +         ▪  View the request headers. + + +         ▪  Look up which actions apply to a URL and why + + +         ▪  Toggle Privoxy on or off + + + + - - - This should be self-explanatory. Note the last item is an editor for the - actions list, which is where much of the ad, banner, cookie, + This should be self-explanatory. Note the first item leads to an editor for the + actions list, which is where the ad, banner, cookie, and URL blocking magic is configured as well as other advanced features of Privoxy. This is an easy way to adjust various aspects of Privoxy configuration. The actions @@ -683,7 +718,7 @@ Please choose from the following options: - + Configuration Files Overview For Unix, *BSD and Linux, all configuration files are located in @@ -695,9 +730,9 @@ Please choose from the following options: - The installed defaults provide a reasonable starting point, though possibly - aggressive by some standards. For the time being, there are only three - default configuration files (this may change in time): + The installed defaults provide a reasonable starting point, though + some settings may be aggressive by some standards. For the time being, the + principle configuration files are: @@ -705,31 +740,44 @@ Please choose from the following options: - The main configuration file is named config + The main configuration file is named config on Linux, Unix, BSD, OS/2, and AmigaOS and config.txt - on Windows. + on Windows. This is a required file. - default.action (the actions file) is used to define - which of a set of various actions relating to images, banners, - pop-ups, access restrictions, banners and cookies are to be applied, and where. - There is a web based editor for this file that can be accessed at http://config.privoxy.org/edit-actions/ - (Shortcut: http://p.p/edit-actions/). - (Other actions files are included as well with differing levels of filtering - and blocking, e.g. basic.action.) + default.action (the main actions file) is used to define + the default settings for various actions relating to images, banners, + pop-ups, access restrictions, banners and cookies. + + + Multiple actions files may be defined in config. These + are processed in the order they are defined. Local customizations and locally + preferred exceptions to the default policies as defined in + default.action are probably best applied in + user.action, which should be preserved across + upgrades. standard.action is also included. This is mostly + for Privoxy's internal use. + + + There is also a web based editor that can be accessed from + http://config.privoxy.org/show-status/ + (Shortcut: http://p.p/show-status/) for the + various actions files. - default.filter (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 file. + default.filter (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. @@ -747,7 +795,7 @@ Please choose from the following options: - default.action and default.filter + The actions files and default.filter can use Perl style regular expressions for maximum flexibility. @@ -775,7 +823,7 @@ Please choose from the following options: - + The Main Configuration File Again, the main configuration file is named config on @@ -816,7 +864,7 @@ Please choose from the following options: - + Configuration and Log File Locations @@ -827,7 +875,7 @@ Please choose from the following options: -confdir +confdir @@ -873,7 +921,7 @@ Please choose from the following options: -logdir +logdir @@ -914,14 +962,19 @@ Please choose from the following options: -actionsfile + +<anchor id="default.action"> +<anchor id="standard.action"> +<anchor id="user.action"> +actionsfile + Specifies: - The actions file to use + The actions file(s) to use @@ -934,14 +987,24 @@ Please choose from the following options: Default value: - default.action (Unix) or default.action.txt (Windows) + + + standard # Internal purposes, recommended not editing + + + default # Main actions file + + + user # User customizations + + Effect if unset: - No action is taken at all. Simple neutral proxying. + No actions are taken at all. Simple neutral proxying. @@ -949,25 +1012,29 @@ Please choose from the following options: Notes: - There is no point in using Privoxy without - an actions file. There are three different actions files included in the - distribution, with varying degrees of aggressiveness: - default.action, intermediate.action and - advanced.action. + Multiple actionsfile lines are OK and are in fact recommended! + + + The default values include standard.action, which is used for internal + purposes and should be loaded, default.action, which is the + main actions file maintained by the developers, and + user.action, where you can make your personal additions. + + + There is no point in using Privoxy without an actions file. -filterfile - +<anchor id="default.filter">filterfile Specifies: - The filter file to use + The filter file to use @@ -989,7 +1056,7 @@ Please choose from the following options: No textual content filtering takes place, i.e. all +filter{name} - actions in the actions file are turned off + actions in the actions files are turned off @@ -1009,7 +1076,7 @@ Please choose from the following options: -logfile +logfile @@ -1070,7 +1137,7 @@ Please choose from the following options: -jarfile +jarfile @@ -1112,7 +1179,7 @@ Please choose from the following options: -trustfile +trustfile @@ -1175,7 +1242,7 @@ Please choose from the following options: - + Local Set-up Documentation @@ -1184,7 +1251,7 @@ Please choose from the following options: you, what you block and why you do that, your policies etc. -trust-info-url +trust-info-url @@ -1236,7 +1303,7 @@ Please choose from the following options: -admin-address +admin-address @@ -1280,7 +1347,7 @@ Please choose from the following options: -proxy-info-url +proxy-info-url @@ -1333,7 +1400,7 @@ Please choose from the following options: - + Debugging @@ -1343,7 +1410,7 @@ Please choose from the following options: command line option when debugging. -debug +debug @@ -1422,7 +1489,7 @@ Please choose from the following options: -single-threaded +single-threaded @@ -1470,7 +1537,7 @@ Please choose from the following options: - + Access Control and Security @@ -1478,7 +1545,7 @@ Please choose from the following options: of Privoxy's configuration. -listen-address +listen-address @@ -1526,7 +1593,7 @@ Please choose from the following options: If you leave out the IP address, Privoxy will bind to all interfaces (addresses) on your machine and may become reachable - from the Internet. In that case, consider using access control lists (acl's) + from the Internet. In that case, consider using access control lists (ACL's) (see ACLs below), or a firewall. @@ -1550,7 +1617,7 @@ Please choose from the following options: -toggle +toggle @@ -1602,7 +1669,7 @@ Please choose from the following options: -enable-remote-toggle +enable-remote-toggle Specifies: @@ -1659,13 +1726,13 @@ Please choose from the following options: -enable-edit-actions +enable-edit-actions Specifies: - Whether or not the web-based actions + Whether or not the web-based actions file editor may be used @@ -1710,7 +1777,11 @@ Please choose from the following options: -ACLs: permit-access and deny-access + +<anchor id="permit-acces"> +<anchor id="deny-acces"> +ACLs: permit-access and deny-access + Specifies: @@ -1831,7 +1902,7 @@ Please choose from the following options: -buffer-limit +buffer-limit @@ -1913,7 +1984,7 @@ Please choose from the following options: supports the SOCKS 4 and SOCKS 4A protocols. -forward +forward Specifies: @@ -1932,7 +2003,7 @@ Please choose from the following options: Where target_domain is a domain name pattern (see the - chapter on domain matching in the actions file), + chapter on domain matching in the default.action file), http_parent is the address of the parent HTTP proxy as an IP addresses in dotted decimal notation or as a valid DNS name (or . to denote no forwarding, and the optional @@ -1994,7 +2065,11 @@ Please choose from the following options: -forward-socks4 and forward-socks4a + +<anchor id="forward-socks4"> +<anchor id="forward-socks4a"> +forward-socks4 and forward-socks4a + Specifies: @@ -2014,7 +2089,7 @@ Please choose from the following options: Where target_domain is a domain name pattern (see the - chapter on domain matching in the actions file), + chapter on domain matching in the default.action file), http_parent and socks_proxy are IP addresses in dotted decimal notation or valid DNS names (http_parent may be . to denote no HTTP forwarding), and the optional @@ -2082,7 +2157,7 @@ Please choose from the following options: -Advanced Forwarding Examples +Advanced Forwarding Examples If you have links to multiple ISPs that provide various special content @@ -2166,13 +2241,14 @@ Please choose from the following options: - + Windows GUI Options Privoxy has a number of options specific to the Windows GUI interface: + If activity-animation is set to 1, the Privoxy icon will animate when @@ -2189,6 +2265,7 @@ Please choose from the following options: + If log-messages is set to 1, Privoxy will log messages to the console @@ -2205,6 +2282,7 @@ Please choose from the following options: + If log-buffer-size is set to 1, the size of the log buffer, i.e. the amount of memory used for the log messages displayed in the @@ -2226,6 +2304,7 @@ Please choose from the following options: + log-max-lines is the maximum number of lines held in the log buffer. See above. @@ -2241,6 +2320,7 @@ Please choose from the following options: + If log-highlight-messages is set to 1, Privoxy will highlight portions of the log @@ -2257,6 +2337,7 @@ Please choose from the following options: + The font used in the console window: @@ -2271,6 +2352,7 @@ Please choose from the following options: + Font size used in the console window: @@ -2285,6 +2367,7 @@ Please choose from the following options: + show-on-task-bar controls whether or not Privoxy will appear as a button on the Task bar @@ -2301,6 +2384,7 @@ Please choose from the following options: + If close-button-minimizes is set to 1, the Windows close button will minimize Privoxy instead of closing @@ -2317,6 +2401,7 @@ Please choose from the following options: + The hide-console option is specific to the MS-Win console version of Privoxy. If this option is used, @@ -2341,54 +2426,61 @@ Please choose from the following options: - -The Actions File - - - The actions file (default.action, formerly: - actionsfile or ijb.action) is used - to define what actions Privoxy takes for which - URLs, and thus determines how ad images, cookies and various other aspects - of HTTP content and transactions are handled on which sites (or even parts - thereof). - + +Actions Files + + + The actions files are used to define what actions + Privoxy takes for which URLs, and thus determines + 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, + with slightly different purposes. default.action sets + the default policies. standard.action is used by + Privoxy and the web based editor to set + pre-defined values (and normally should not be edited). Local exceptions + are best done in user.action. The content of these + can all be viewed and edited from http://config.privoxy.org/show-status. + Anything you want can blocked, including ads, banners, or just some obnoxious - URL that you would rather not see. Cookies can be accepted or rejected, or + URL that you would rather not see is done here. Cookies can be accepted or rejected, or accepted only during the current browser session (i.e. not written to disk), content can be modified, JavaScripts tamed, user-tracking fooled, and much more. See below for a complete list of available actions. - An actions file typically has sections. At the top, aliases are - defined (discussed below), then the default set of rules which will apply - universally to all sites and pages. And then below that is generally a lengthy - set of exceptions to the defined universal policies. + An actions file typically has sections. Near the top, aliases are + optionally defined (discussed below), then the default set of rules + which will apply universally to all sites and pages. And then below that, + exceptions to the defined universal policies. Finding the Right Mix - Note that some actions like cookie suppression or script disabling may - render some sites unusable, which rely on these techniques to work properly. - Finding the right mix of actions is not easy and 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 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. + Note that some actions like cookie suppression + or script disabling may render some sites unusable, which rely on these + techniques to work properly. Finding the right mix of actions is not easy and + 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 + 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. We have tried to provide you with reasonable rules to start from in the - distribution actions file. But there is no general rule of thumb on these + distribution actions files. But there is no general rule of thumb on these things. There just are too many variables, and sites are constantly changing. - Sooner or later you will want to change the rules (and read this chapter). + Sooner or later you will want to change the rules (and read this chapter again :). @@ -2396,14 +2488,14 @@ Please choose from the following options: How to Edit - The easiest way to edit the actions file is with a browser by - using our browser-based editor, which is available at http://config.privoxy.org/edit-actions. + The easiest way to edit the actions files is with a browser by + using our browser-based editor, which can be reached from http://config.privoxy.org/show-status. If you prefer plain text editing to GUIs, you can of course also directly edit the - default.action file. + the actions files. @@ -2411,9 +2503,9 @@ Please choose from the following options: How Actions are Applied to URLs - The actions file is divided into sections. There are special sections, - like the alias sections which will be discussed later. For now let's - concentrate on regular sections: They have a heading line (often split + Actions files are divided into sections. There are special sections, + like the alias sections which will be discussed later. For now + let's concentrate on regular sections: They have a heading line (often split up to multiple lines for readability) which consist of a list of actions, separated by whitespace and enclosed in curly braces. Below that, there is a list of URL patterns, each on a separate line. @@ -2424,7 +2516,11 @@ Please choose from the following options: compared to all patterns in this 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. + the same URL set the same action differently, the last match wins. If not, + the effects are aggregated (e.g. a URL might match both the + +handle-as-image + and +block actions). + @@ -2602,7 +2698,8 @@ Please choose from the following options: Note that the path pattern is automatically left-anchored at the /, - i.e. it matches as if it would start with a ^. + i.e. it matches as if it would start with a ^ (regular expression speak + for the beginning of a line). @@ -2626,11 +2723,18 @@ Please choose from the following options: Actions - Actions are enabled if preceded with a +, and disabled if - preceded with a -. Actions are invoked by enclosing the - action name in curly braces (e.g. {+some_action}), followed by a list of - URLs (or patterns that match URLs) to which the action applies. There are - three classes of actions: + All actions are disabled by default, until they are explicitly enabled + somewhere in an actions file. Actions are turned on if preceded with a + +, and turned off if preceded with a -. So a + +action means do that action, e.g. + +block means please block the following URL + patterns. + + + + Actions are invoked by enclosing the action name in curly braces (e.g. + {+some_action}), followed by a list of URLs (or patterns that match URLs) to + which the action applies. There are three classes of actions: @@ -2675,9 +2779,9 @@ Please choose from the following options: - Multi-value, e.g. {+/-add-header{Name: value}} ot - {+/-wafer{name=value}}), where some value needs to be defined - in addition to simply enabling the actino. Examples: + Multi-value, e.g. {+/-add-header{Name: value}} or + {+/-send-wafer{name=value}}), where some value needs to be defined + in addition to simply enabling the action. Examples: @@ -2696,19 +2800,21 @@ Please choose from the following options: - If nothing is specified in this file, no actions are taken. - So in this case Privoxy would just be a - normal, non-blocking, non-anonymizing proxy. You must specifically - enable the privacy and blocking features you need (although the - provided default default.action file will - give a good starting point). + If nothing is specified in any actions file, no actions are + taken. So in this case Privoxy would just be a + normal, non-blocking, non-anonymizing proxy. You must specifically enable the + privacy and blocking features you need (although the provided default actions + files will give a good starting point). Later defined actions always over-ride earlier ones. So exceptions to any rules you make, should come in the latter part of the file. For multi-valued actions, the actions are applied in the order they are - specified. + specified. Actions files are processed in the order they are defined + in config (the default installation has three + actions files). It also quite possible for any given URL pattern to + match more than one action! @@ -2817,7 +2923,7 @@ Please choose from the following options: {+block} - .example.com + .banners.example.com .ads.r.us @@ -2827,15 +2933,33 @@ Please choose from the following options: Notes: - Privoxy will display its - special BLOCKED page if a URL matches one of the - blocked patterns. If there is sufficient space, a large red - banner will appear with a friendly message about why the page - was blocked, and a way to go there anyway. If there is insufficient - space a smaller blocked page will appear without the red banner. - One exception is if the URL matches both +block - and +image, then it can be handled by - +image-blocker (see below). + If a URL matches one of the blocked patterns, Privoxy + will intercept the URL and display its special BLOCKED page + instead. If there is sufficient space, a large red banner will appear with + a friendly message about why the page was blocked, and a way to go there + anyway. If there is insufficient space a smaller blocked page will appear + without the red banner. + Click here + to view the default blocked HTML page (Privoxy must be running + for this to work as intended!). + + + + A very important exception is if the URL matches both + +block and +handle-as-image, + then it will be handled by + +set-image-blocker + (see below). It is important to understand this process, in order + to understand how Privoxy is able to deal with + ads and other objectionable content. + + + The +filter + action can also perform some of the + same functionality as +block, but by virtue of very + different programming techniques, and is most often used for different + reasons. @@ -2904,8 +3028,8 @@ Please choose from the following options: - -<emphasis>+downgrade</emphasis> + +<emphasis>+downgrade-http-version</emphasis> @@ -2920,7 +3044,7 @@ Please choose from the following options: Typical uses: - +downgrade will downgrade HTTP/1.1 client requests to + +downgrade-http-version will downgrade HTTP/1.1 client requests to HTTP/1.0 and downgrade the responses as well. @@ -2939,7 +3063,7 @@ Please choose from the following options: Example usage: - {+downgrade} + {+downgrade-http-version} .example.com @@ -2952,7 +3076,7 @@ Please choose from the following options: Use this action for servers that use HTTP/1.1 protocol features that Privoxy doesn't handle well yet. HTTP/1.1 is only partially implemented. Default is not to downgrade requests. This is - an infrequently needed action, and is used to help with problem sites only. + an infrequently needed action, and is used to help with rare problem sites only. @@ -2980,7 +3104,7 @@ Please choose from the following options: The +fast-redirects action enables interception of redirect requests from one server to another, which are used to track users.Privoxy can cut off - all but the last valid URL in redirect request and send a local redirect + all but the last valid URL in a redirect request and send a local redirect back to your browser without contacting the intermediate site(s). @@ -3024,8 +3148,8 @@ Please choose from the following options: the advertisers. - This is a normally on feature, and often requires exceptions for sites that - are sensitive to defeating this mechanism. + This is a normally on feature, and often requires exceptions + for sites that are sensitive to defeating this mechanism. @@ -3054,7 +3178,7 @@ Please choose from the following options: Apply page filtering as defined by named sections of the default.filter file to the specified site(s). Filtering can be any modification of the raw - page content, including re-writing or deletion. + page content, including re-writing or deletion of content. @@ -3142,6 +3266,7 @@ Please choose from the following options: This is potentially a very powerful feature! And requires a knowledge of regular expressions if you want to roll your own. + Filtering operates on a line by line basis throughout the entire page. Filtering requires buffering the page content, which may appear to @@ -3150,6 +3275,14 @@ Please choose from the following options: since the page is not incrementally displayed.) This effect will be more noticeable on slower connections. + + Filtering can achieve some of the effects as the + +block + action, i.e. it can be used to block ads and banners. In the overall + scheme of things, filtering is one of the first things Privoxy + does with a web page. So other most other actions are applied to the + already filtered page. + @@ -3158,8 +3291,8 @@ Please choose from the following options: - -<emphasis>+hide-forwarded</emphasis> + +<emphasis>+hide-forwarded-for-headers</emphasis> @@ -3192,7 +3325,7 @@ Please choose from the following options: Example usage: - {+hide-forwarded} + {+hide-forwarded-for-headers} .example.com @@ -3212,8 +3345,8 @@ Please choose from the following options: - -<emphasis>+hide-from</emphasis> + +<emphasis>+hide-from-header</emphasis> @@ -3247,7 +3380,7 @@ Please choose from the following options: Example usage: - {+hide-from{block}} + {+hide-from-header{block}} .example.com @@ -3257,7 +3390,9 @@ Please choose from the following options: Notes: - The keyword block will completely remove the header. + The keyword block will completely remove the header + (not to be confused with the +block action). Alternately, you can specify any value you prefer to send to the web server. @@ -3270,8 +3405,8 @@ Please choose from the following options: -<emphasis>+hide-referer</emphasis> - +<emphasis><anchor id="hide-referrer">+hide-referer</emphasis> + @@ -3391,8 +3526,8 @@ Please choose from the following options: - -<emphasis>+image</emphasis> + +<emphasis>+handle-as-image</emphasis> @@ -3408,7 +3543,8 @@ Please choose from the following options: To define what Privoxy should treat - automatically as an image. + automatically as an image, and is an important ingredient of how + ads are handled. @@ -3426,7 +3562,7 @@ Please choose from the following options: Example usage: - {+image} + {+handle-as-image} /.*\.(gif|jpg|jpeg|png|bmp|ico) @@ -3437,12 +3573,17 @@ Please choose from the following options: This only has meaning if the URL (or pattern) also is - +blocked, in which case a blocked image can - be sent rather than a HTML page. (See +image-blocker{} below - for the control over what is actually sent.) + +blocked, in which case a user definable image can + be sent rather than a HTML page. This is integral to the whole concept of + ad blocking: the URL must match both a +block rule, + and +handle-as-image. + (See +set-image-blocker + below for control over what will actually be displayed by the browser.) - There is little reason to change the default definition for this. + There is little reason to change the default definition for this action. @@ -3452,8 +3593,8 @@ Please choose from the following options: - -<emphasis>+image-blocker</emphasis> + +<emphasis>+set-image-blocker</emphasis> @@ -3468,8 +3609,11 @@ Please choose from the following options: Typical uses: - Decide what to do with URLs that end up tagged with both {+block} - and {+image}, e.g an advertisement. + Decide what to do with URLs that end up tagged with both + +block + and +handle-as-image, + e.g an advertisement. @@ -3478,14 +3622,17 @@ Please choose from the following options: Possible values: - There are four available options: -image-blocker will send a HTML + There are four available options: -set-image-blocker will send a HTML blocked page, usually resulting in a broken - image icon. +image-blocker{blank} will send a 1x1 - transparent GIF image. +image-blocker{pattern} will send a + image icon. + +set-image-blocker{blank} will send a + 1x1 transparent GIF image. + +set-image-blocker{pattern} will send a checkerboard type pattern (the default). And finally, - +image-blocker{http://xyz.com} will send a HTTP temporary - redirect to the specified image. This has the advantage of the icon being - being cached by the browser, which will speed up the display. + +set-image-blocker{http://xyz.com} will + send a HTTP temporary redirect to the specified image. This has the + advantage of the icon being being cached by the browser, which will speed + up the display. @@ -3494,7 +3641,7 @@ Please choose from the following options: Example usage: - {+image-blocker{blank}} + {+set-image-blocker{blank}} .example.com @@ -3504,13 +3651,14 @@ Please choose from the following options: Notes: - If you want invisible ads, they need to be both - defined as images and blocked. - And then, image-blocker should be set to + If you want invisible ads, they need to meet + criteria as matching both images and blocked + actions. And then, image-blocker should be set to blank for invisibility. Note you cannot treat HTML pages as - images in most cases. For instance, frames require an HTML page to display. - So a frame that is an ad, cannot be treated as an image. Forcing an - image in this situation just will not work. + images in most cases. For instance, frames require an HTML page to + display. So a frame that is an ad, typically cannot be treated as an image. + Forcing an image in this situation just will not work + reliably. @@ -3557,10 +3705,11 @@ Please choose from the following options: + - +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-} # Port less than 3, 7, 20 to 100 and above 500 are OK. + +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-} # Port less than 3, 7, 20 to 100 and above 500 are OK. @@ -3593,8 +3742,8 @@ Please choose from the following options: - -<emphasis>+no-compression</emphasis> + +<emphasis>+prevent-compression</emphasis> @@ -3627,7 +3776,7 @@ Please choose from the following options: Example usage: - {+no-compression} + {+prevent-compression} .example.com @@ -3638,10 +3787,14 @@ Please choose from the following options: Some websites do this, which can be a problem for - Privoxy, since +filter, - +no-popup and +gif-deanimate will not work - on compressed data. This will slow down connections to those websites, - though. Default typically is to turn no-compression on. + Privoxy, since + +filter, + +kill-popups + and +gif-deanimate + will not work on compressed data. This will slow down connections to those + websites, though. Default typically is to turn + prevent-compression on. @@ -3650,8 +3803,8 @@ Please choose from the following options: - -<emphasis>+no-cookies-keep</emphasis> + +<emphasis>+session-cookies-only</emphasis> @@ -3666,7 +3819,7 @@ Please choose from the following options: Typical uses: - Allow cookies for the current browser session only. + Allow cookies for the current browser session only. @@ -3681,10 +3834,10 @@ Please choose from the following options: - Example usage: + Example usage (disabling): - {+no-cookies-keep} + {-session-cookies-only} .example.com @@ -3694,11 +3847,17 @@ Please choose from the following options: Notes: - If websites set cookies, no-cookies-keep will make sure + If websites set cookies, +session-cookies-only will make sure they are erased when you exit and restart your web browser. This makes profiling cookies useless, but won't break sites which require cookies so that you can log in for transactions. This is generally turned on for all - sites. Sometimes referred to as session cookies. + sites, and is the recommended setting. + + + +prevent-*-cookies actions should be turned off as well (see + below), for +session-cookies-only to work. Or, else no cookies + will get through at all. For, persistent cookies that survive + across browser sessions, see below as well. @@ -3708,8 +3867,8 @@ Please choose from the following options: - -<emphasis>+no-cookies-read</emphasis> + +<emphasis>+prevent-reading-cookies</emphasis> @@ -3743,7 +3902,7 @@ Please choose from the following options: Example usage: - {+no-cookies-read} + {+prevent-reading-cookies} .example.com @@ -3753,8 +3912,15 @@ Please choose from the following options: Notes: - Often used in conjunction with +no-cookies-set to - disable persistant cookies completely. + Often used in conjunction with +prevent-setting-cookies to + disable cookies completely. Note that + +session-cookies-only + requires these to both be disabled (or else it never gets any cookies to cache). + + + For persistent cookies to work (i.e. they survive across browser + sessions and reboots), all three cookie settings should be off + for the specified sites. @@ -3764,8 +3930,8 @@ Please choose from the following options: - -<emphasis>+no-cookies-set</emphasis> + +<emphasis>+prevent-setting-cookies</emphasis> @@ -3780,7 +3946,7 @@ Please choose from the following options: Typical uses: - Explicitly block the web server from sending cookies to your + Explicitly block the web server from storing cookies on your system. @@ -3799,7 +3965,7 @@ Please choose from the following options: Example usage: - {+no-cookies-set} + {+prevent-setting-cookies} .example.com @@ -3809,8 +3975,8 @@ Please choose from the following options: Notes: - Often used in conjunction with +no-cookies-read to - disable persistant cookies completely. + Often used in conjunction with +prevent-reading-cookies to + disable cookies completely (see above). @@ -3819,11 +3985,9 @@ Please choose from the following options: - - -<emphasis>+no-popup</emphasis> - - + + +<emphasis>+kill-popups<anchor id="kill-popups"></emphasis> Type: @@ -3855,7 +4019,7 @@ Please choose from the following options: Example usage: - {+no-popup} + {+kill-popups} .example.com @@ -3865,13 +4029,18 @@ Please choose from the following options: Notes: - +no-popup uses a built in filter to disable pop-ups - that use the window.open() function, etc. - + +kill-popups uses a built in filter to disable pop-ups + that use the window.open() function, etc. This is + one of the first actions processed by Privoxy + as it contacts the remote web server. This action is not always 100% reliable, + and is supplemented by +filter{popups}. + + @@ -3880,8 +4049,8 @@ Please choose from the following options: - -<emphasis>+vanilla-wafer</emphasis> + +<emphasis>+send-vanilla-wafer</emphasis> @@ -3915,7 +4084,7 @@ Please choose from the following options: Example usage: - {+vanilla-wafer} + {+send-vanilla-wafer} .example.com @@ -3927,7 +4096,7 @@ Please choose from the following options: This action only applies if you are using a jarfile for saving cookies. Of course, this is a (relatively) unique header and - could be used to track you. + could conceivably be used to track you. @@ -3937,8 +4106,8 @@ Please choose from the following options: - -<emphasis>+wafer</emphasis> + +<emphasis>+send-wafer</emphasis> @@ -3971,7 +4140,7 @@ Please choose from the following options: Example usage: - {+wafer{name=value}} + {+send-wafer{name=value}} .example.com @@ -3999,8 +4168,11 @@ Please choose from the following options: the action with a -, in place of the +. Also, that some actions are turned on in the default section of the actions file, and require little to no additional configuration. These are just on. - Some actions that are turned on the default section do typically require - exceptions to be listed in the lower sections of actions file. + But, other actions that are turned on the default section do + typically require exceptions to be listed in the lower sections of + actions file. E.g. by default no URLs are blocked (i.e. in + the default definitions of default.action). We need + exceptions to this in order to enable ad blocking. @@ -4008,35 +4180,35 @@ Please choose from the following options: - Turn off cookies by default, then allow a few through for specified sites: + Turn off cookies by default, then allow a few through for specified sites + (showing an excerpt from the default section of an actions + file ONLY): - # Turn off all persistent cookies - { +no-cookies-read } - { +no-cookies-set } - - # Allow cookies for this browser session ONLY - { +no-cookies-keep } + # Excerpt only: + # Allow cookies to and from the server, but + # for this browser session ONLY + { + # other actions normally listed here... + -prevent-setting-cookies \ + -prevent-reading-cookies \ + +session-cookies-only \ + } + / # match all URLs # Exceptions to the above, sites that benefit from persistent cookies - # that saved from one browser session to the next. - { -no-cookies-read } - { -no-cookies-set } - { -no-cookies-keep } - .javasoft.com - .sun.com - .yahoo.com - .msdn.microsoft.com - .redhat.com - - # Alternative way of saying the same thing - {-no-cookies-set -no-cookies-read -no-cookies-keep} - .sourceforge.net - .sf.net + # that are saved from one browser session to the next. + { -session-cookies-only } + .javasoft.com + .sun.com + .yahoo.com + .msdn.microsoft.com + .redhat.com + @@ -4050,13 +4222,17 @@ Please choose from the following options: - # Turn them off! - {+fast-redirects} + # Turn them off (excerpt only)! + { + # other actions normally listed here... + +fast-redirects + } + / # match all URLs # Reverse it for these two sites, which don't work right without it. {-fast-redirects} - www.ukc.ac.uk/cgi-bin/wac\.cgi\? - login.yahoo.com + www.ukc.ac.uk/cgi-bin/wac\.cgi\? + login.yahoo.com @@ -4072,14 +4248,18 @@ Please choose from the following options: - # Run everything through the filter file, using only the + # Run everything through the filter file, using only certain # specified sections: - +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups}\ - +filter{webbugs} +filter{nimda} +filter{banners-by-size} + { + # other actions normally listed here... + +filter{html-annoyances} +filter{js-annoyances} +filter{kill-popups}\ + +filter{webbugs} +filter{nimda} +filter{banners-by-size} + } + / #match all URLs - # Then disable filtering of code from sourceforge! + # Then disable filtering of code from all sourceforge domains! {-filter} - .cvs.sourceforge.net + .sourceforge.net @@ -4087,9 +4267,11 @@ Please choose from the following options: Now some URLs that we want blocked (normally generates - the blocked banner). Many of these use - regular expressions that will expand to match - multiple URLs: + the blocked banner). Typically, the block + action is off by default in the upper section of an actions file, then enabled + against certain URLs and patterns in the lower part of the file. Many of these use regular expressions that will expand to match multiple + URLs: @@ -4097,48 +4279,16 @@ Please choose from the following options: # Blocklist: {+block} - /.*/(.*[-_.])?ads?[0-9]?(/|[-_.].*|\.(gif|jpe?g)) - /.*/(.*[-_.])?count(er)?(\.cgi|\.dll|\.exe|[?/]) + ad*. + .*ads. + banner?. + count*. + /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?) + /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/ + .hitbox.com /.*/(ng)?adclient\.cgi /.*/(plain|live|rotate)[-_.]?ads?/ - /.*/(sponsor)s?[0-9]?/ - /.*/_?(plain|live)?ads?(-banners)?/ /.*/abanners/ - /.*/ad(sdna_image|gifs?)/ - /.*/ad(server|stream|juggler)\.(cgi|pl|dll|exe) - /.*/adbanners/ - /.*/adserver - /.*/adstream\.cgi - /.*/adv((er)?ts?|ertis(ing|ements?))?/ - /.*/banner_?ads/ - /.*/banners?/ - /.*/banners?\.cgi/ - /.*/cgi-bin/centralad/getimage - /.*/images/addver\.gif - /.*/images/marketing/.*\.(gif|jpe?g) - /.*/popupads/ - /.*/siteads/ - /.*/sponsor.*\.gif - /.*/sponsors?[0-9]?/ - /.*/advert[0-9]+\.jpg - /Media/Images/Adds/ - /ad_images/ - /adimages/ - /.*/ads/ - /bannerfarm/ - /grafikk/annonse/ - /graphics/defaultAd/ - /image\.ng/AdType - /image\.ng/transactionID - /images/.*/.*_anim\.gif # alvin brattli - /ip_img/.*\.(gif|jpe?g) - /rotateads/ - /rotations/ - /worldnet/ad\.cgi - /cgi-bin/nph-adclick.exe/ - /.*/Image/BannerAdvertising/ - /.*/ad-bin/ - /.*/adlib/server\.cgi /autoads/ @@ -4149,9 +4299,10 @@ Please choose from the following options: Note that many of these actions have the potential to cause a page to misbehave, possibly even not to display at all. There are many ways a site designer may choose to design his site, and what HTTP header - content he may depend on. There is no way to have hard and fast rules - for all sites. See the Appendix - for a brief example on troubleshooting actions. + content, and other criteria, he may depend on. There is no way to have hard + and fast rules for all sites. See the Appendix for a brief example on troubleshooting + actions. @@ -4161,7 +4312,7 @@ Please choose from the following options: - + Aliases Custom actions, known to Privoxy @@ -4171,9 +4322,10 @@ Please choose from the following options: { or }. But please use only a- z, 0-9, +, and -. Alias names are not case sensitive, and - must be defined before anything else in the - default.actionfile! And there can only be one set of - aliases defined. + must be defined before other actions in the + actions file! And there can only be one set of aliases + defined per file. Each actions file may have its own aliases, but they are + only visible within that file. @@ -4186,17 +4338,16 @@ Please choose from the following options: # Useful custom aliases we can use later. These must come first! {{alias}} - +no-cookies = +no-cookies-set +no-cookies-read - -no-cookies = -no-cookies-set -no-cookies-read - fragile = -block -no-cookies -filter -fast-redirects -hide-referer -no-popups - shop = -no-cookies -filter -fast-redirects - +imageblock = +block +image - - #For people who don't like to type too much: ;-) - c0 = +no-cookies - c1 = -no-cookies - c2 = -no-cookies-set +no-cookies-read - c3 = +no-cookies-set -no-cookies-read + +prevent-cookies = +prevent-setting-cookies +prevent-reading-cookies + -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies + fragile = -block -prevent-cookies -filter -fast-redirects -hide-referer -kill-popups + shop = -prevent-cookies -filter -fast-redirects + +imageblock = +block +handle-as-image + + # Aliases defined from other aliases, for people who don't like to type + # too much: ;-) + c0 = +prevent-cookies + c1 = -prevent-cookies #... etc. Customize to your heart's content. @@ -4205,7 +4356,9 @@ Please choose from the following options: Some examples using our shop and fragile - aliases from above: + aliases from above. These would appear in the lower sections of an + actions file as exceptions to the default actions (as defined in the + upper section): @@ -4215,21 +4368,20 @@ Please choose from the following options: # These sites are very complex and require # minimal interference. {fragile} - .office.microsoft.com - .windowsupdate.microsoft.com - .nytimes.com + .office.microsoft.com + .windowsupdate.microsoft.com + .nytimes.com # Shopping sites - but we still want to block ads. {shop} - .quietpc.com - .worldpay.com # for quietpc.com - .jungle.com - .scan.co.uk + .quietpc.com + .worldpay.com # for quietpc.com + .scan.co.uk # These shops require pop-ups also - {shop -no-popups} - .dabs.com - .overclockers.co.uk + {shop -kill-popups} + .dabs.com + .overclockers.co.uk @@ -4249,7 +4401,7 @@ Please choose from the following options: - + The Filter File Any web page can be dynamically modified with the filter file. This @@ -4411,10 +4563,8 @@ Requests - New default.actions files will occasionally be made - available based on your feedback. These - will be announced on the - default.action files will occasionally be made + available based on your feedback. These will be announced on the ijbswa-announce list. @@ -4540,7 +4690,7 @@ Requests special characters (e.g. .) needs to be taken literally and not as a special meta-character. Example: example\.com, makes sure the period is recognized only as a period (and not expanded to its - metacharacter meaning of any single character). + meta-character meaning of any single character). @@ -4742,7 +4892,8 @@ Requests - Show information about the current configuration: + Show information about the current configuration, including viewing and + editing of actions files:
@@ -4764,7 +4915,7 @@ Requests - Show the client's request headers: + Show the browser's request headers:
@@ -4808,17 +4959,6 @@ Requests
- - - - Edit the actions list file: - -
- - http://config.privoxy.org/edit-actions - -
- @@ -4897,13 +5037,138 @@ Requests + + +Chain of Events + + Let's take a quick look at the basic sequence of events when a web page is + requested by your browser and Privoxy is on duty: + + + + + + + First, your web browser requests a web page. The browser knows to send + the request to Privoxy, which will in turn, + relay the request to the remote web server after passing the following + tests: + + + + + Privoxy traps any request for its own internal CGI + pages (e.g http://p.p/) and sends the CGI page back to the browser. + + + + + Next, Privoxy checks to see if the URL + matches any +block patterns. If + so, the URL is then blocked, and the remote web server will not be contacted. + +handle-as-image + is then checked and if it does not match, an + HTML BLOCKED page is sent back. Otherwise, if it does match, + an image is returned. The type of image depends on the setting of +set-image-blocker + (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere). + + + + + Untrusted URLs are blocked. If URLs are being added to the + trust file, then that is done. + + + + + If the URL pattern matches the +fast-redirects action, + it is then processed. Unwanted parts of the requested URL are stripped. + + + + + Now the rest of the client browser's request headers are processed. If any + of these match any of the relevant actions (e.g. +hide-user-agent, + etc.), headers are suppressed or forged as determined by these actions and + their parameters. + + + + + Now the web server starts sending its response back (i.e. typically a web page and related + data). + + + + + 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 deterimed by the + +prevent-setting-cookies, + +session-cookies-only, + and +downgrade-http-version + actions. + + + + + If the +kill-popups + action applies, and it is an HTML or JavaScript document, the popup-code in the + response is filtered on-the-fly as it is received. + + + + + If a +filter + or +deanimate-gifs + 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 + 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. + + + If neither +filter + or +deanimate-gifs + matches, then Privoxy passes the raw data through + to the client browser as it becomes available. + + + + + As the browser receives the now (probably filtered) page content, it + reads and then requests any URLs that may be embedded within the page + source, e.g. ad images, stylesheets, JavaScript, other HTML documents (e.g. + frames), sounds, etc. For each of these objects, the browser issues a new + request. And each such request is in turn processed as above. Note that a + complex web page may have many such embedded URLs. + + + + + + + + + Anatomy of an Action - The way Privoxy applies actions - and filters to any given URL can be complex, and not always so + The way Privoxy applies + actions + and filters + to any given URL can be complex, and not always so easy to understand what is happening. And sometimes we need to be able to see just what Privoxy is doing. Especially, if something Privoxy is doing @@ -4917,7 +5182,7 @@ 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. + and easy way to do this (be sure to flush caches afterward!). @@ -4931,92 +5196,95 @@ Requests First, enter one URL (or partial URL) at the prompt, and then Privoxy will tell us how the current configuration will handle it. This will not - help with filtering effects from the default.filter file! It - also will not tell you about any other URLs that may be embedded within the - URL you are testing (i.e. a web page). For instance, images such as ads are expressed as URLs - within the raw page source of HTML pages. So you will only get info for the - actual URL that is pasted into the prompt area -- not any sub-URLs. If you - want to know about embedded URLs like ads, you will have to dig those out of - the HTML source. Use your browser's View Page Source option - for this. Or right click on the ad, and grab the URL. + help with filtering effects (i.e. the +filter action) from + the default.filter file 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 + you will only get info for the actual URL that is pasted into the prompt area + -- not any sub-URLs. If you want to know about embedded URLs like ads, you + will have to dig those out of the HTML source. Use your browser's View + Page Source option for this. Or right click on the ad, and grab the + URL. - Let's look at an example, google.com, - one section at a time: + Let's try an example, google.com, + and look at it one section at a time: - System default actions: - - { -add-header -block -deanimate-gifs -downgrade -fast-redirects -filter - -hide-forwarded -hide-from -hide-referer -hide-user-agent -image - -image-blocker -limit-connect -no-compression -no-cookies-keep - -no-cookies-read -no-cookies-set -no-popups -vanilla-wafer -wafer } - - - - - - This is the top section, and only tells us of the compiled in defaults. This - is basically what Privoxy would do if there - were not any actions defined, i.e. it does nothing. Every action - is disabled. This is not particularly informative for our purposes here. OK, - next section: - + Matches for http://google.com: - - +--- File standard --- +(no matches in this file) - Matches for http://google.com: +--- File default --- - { -add-header -block +deanimate-gifs -downgrade +fast-redirects - +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups} - +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal} - +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge} - -hide-user-agent -image +image-blocker{blank} +no-compression - +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups - -vanilla-wafer -wafer } - / +{ -add-header -block +deanimate-gifs{last} -downgrade-http-version +fast-redirects + -filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental} + +filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies} + +filter{webbugs} +filter{refresh-tags} +filter{nimda} +filter{banners-by-size} + +hide-forwarded-for-headers +hide-from-header{block} +hide-referer{forge} + -hide-user-agent -handle-as-image +set-image-blocker{pattern} -limit-connect + +prevent-compression +session-cookies-only -prevent-reading-cookies + -prevent-setting-cookies -kill-popups -send-vanilla-wafer -send-wafer } +/ - { -no-cookies-keep -no-cookies-read -no-cookies-set } - .google.com + { -session-cookies-only } + .google.com { -fast-redirects } - .google.com + .google.com - +--- File user --- +(no matches in this file) + + - This is much more informative, and tells us how we have defined our - actions, and which ones match for our example, - google.com. The first grouping shows our default - settings, which would apply to all URLs. If you look at your actions - file, this would be the section just below the aliases section - near the top. This applies to all URLs as signified by the single forward - slash -- /. - + This tells us how we have defined our + actions, and + which ones match for our example, google.com. The first listing + is any matches for the standard.action file. No hits at + all here on standard. Then next is default, or + our default.action file. The large, multi-line listing, + is how the actions are set to match for all URLs, i.e. our default settings. + If you look at your actions file, this would be the section + just below the aliases section near the top. This will apply to + all URLs as signified by the single forward slash at the end of the listing + -- /. - These are the default actions we have enabled. But we can define additional - actions that would be exceptions to these general rules, and then list - specific URLs that these exceptions would apply to. Last match wins. - Just below this then are two explicit matches for .google.com. - The first is negating our various cookie blocking actions (i.e. we will allow - cookies here). The second is allowing fast-redirects. Note - that there is a leading dot here -- .google.com. This will - match any hosts and sub-domains, in the google.com domain also, such as - www.google.com. So, apparently, we have these actions defined - somewhere in the lower part of our actions file, and - google.com is referenced in these sections. + But we can define additional actions that would be exceptions to these general + rules, and then list specific URLs (or patterns) that these exceptions would + apply to. Last match wins. Just below this then are two explicit matches for + .google.com. The first is negating our previous cookie setting, + which was for +session-cookies-only + (i.e. not persistent). So we will allow persistent cookies for google. The + second turns off any + +fast-redirects + action, allowing this to take place unmolested. Note that there is a leading + dot here -- .google.com. This will match any hosts and + sub-domains, in the google.com domain also, such as + www.google.com. So, apparently, we have these two actions + defined somewhere in the lower part of our default.action + file, and google.com is referenced somewhere in these latter + sections. + + + Then, for our user.action file, we again have no hits. - And now we pull it altogether in the bottom section and summarize how + And finally we pull it all together in the bottom section and summarize how Privoxy is applying all its actions to google.com: @@ -5026,18 +5294,23 @@ Requests Final results: - - -add-header -block -deanimate-gifs -downgrade -fast-redirects - +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups} - +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal} - +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge} - -hide-user-agent -image +image-blocker{blank} -limit-connect +no-compression - -no-cookies-keep -no-cookies-read -no-cookies-set +no-popups -vanilla-wafer - -wafer - + -add-header -block +deanimate-gifs{last} -downgrade-http-version -fast-redirects + -filter{popups} -filter{fun} -filter{shockwave-flash} -filter{crude-parental} + +filter{html-annoyances} +filter{js-annoyances} +filter{content-cookies} + +filter{webbugs} +filter{refresh-tags} +filter{nimda} +filter{banners-by-size} + +hide-forwarded-for-headers +hide-from-header{block} +hide-referer{forge} + -hide-user-agent -handle-as-image +set-image-blocker{pattern} -limit-connect + +prevent-compression -session-cookies-only -prevent-reading-cookies + -prevent-setting-cookies -kill-popups -send-vanilla-wafer -send-wafer + + + Notice the only difference here to the previous listing, is to + fast-redirects and session-cookies-only. + + Now another example, ad.doubleclick.net: @@ -5045,13 +5318,13 @@ Requests - { +block +image } + { +block +handle-as-image } .ad.doubleclick.net - { +block +image } + { +block +handle-as-image } ad*. - { +block +image } + { +block +handle-as-image } .doubleclick.net @@ -5059,10 +5332,11 @@ Requests We'll just show the interesting part here, the explicit matches. It is - matched three different times. Each as an +block +image, + matched three different times. Each as an +block +handle-as-image, which is the expanded form of one of our aliases that had been defined as: - +imageblock. (Aliases are defined in the - first section of the actions file and typically used to combine more + +imageblock. (Aliases are defined in + the first section of the actions file and typically used to combine more than one action.) @@ -5072,9 +5346,13 @@ Requests would also cover the first. No point in taking chances with these guys though ;-) Note that if you want an ad or obnoxious URL to be invisible, it should be defined as ad.doubleclick.net - is done here -- as both a +block and an - +image. The custom alias +imageblock does this - for us. + is done here -- as both a +block + and an + +handle-as-image. + The custom alias +imageblock just simplifies the process and make + it more readable. @@ -5087,16 +5365,16 @@ Requests Matches for http://www.rhapsodyk.net/adsl/HOWTO/: - { -add-header -block +deanimate-gifs -downgrade +fast-redirects - +filter{html-annoyances} +filter{js-annoyances} +filter{no-popups} + { -add-header -block +deanimate-gifs -downgrade-http-version +fast-redirects + +filter{html-annoyances} +filter{js-annoyances} +filter{kill-popups} +filter{webbugs} +filter{nimda} +filter{banners-by-size} +filter{hal} - +filter{fun} +hide-forwarded +hide-from{block} +hide-referer{forge} - -hide-user-agent -image +image-blocker{blank} +no-compression - +no-cookies-keep -no-cookies-read -no-cookies-set +no-popups - -vanilla-wafer -wafer } + +filter{fun} +hide-forwarded-for-headers +hide-from-header{block} + +hide-referer{forge} -hide-user-agent -handle-as-image +set-image-blocker{blank} + +prevent-compression +session-cookies-only -prevent-setting-cookies + -prevent-reading-cookies +kill-popups -send-vanilla-wafer -send-wafer } / - { +block +image } + { +block +handle-as-image } /ads @@ -5106,8 +5384,8 @@ Requests Ooops, the /adsl/ is matching /ads! But we did not want this at all! Now we see why we get the blank page. We could now add a new action below this that explicitly does not - block (-block) pages with adsl. There are various ways to - handle such exceptions. Example: + block ({-block}) paths with adsl. There are + various ways to handle such exceptions. Example: @@ -5132,9 +5410,9 @@ Requests - { -block } - /adsl - + { +block +handle-as-image } + /ads + @@ -5162,8 +5440,8 @@ Requests {shop} is an alias that expands to - { -filter -no-cookies -no-cookies-keep }. Or you could do - your own exception to negate filtering: + { -filter -session-cookies-only }. + Or you could do your own exception to negate filtering: @@ -5176,6 +5454,11 @@ Requests + + This would probably be most appropriately put in user.action, + for local site exceptions. + + {fragile} is an alias that disables most actions. This can be used as a last resort for problem sites. Remember to flush caches! If this @@ -5208,6 +5491,26 @@ Requests Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.92 2002/04/25 18:55:13 hal9 + More catchups on new actions files, and new actions names. + Other assorted cleanups, and minor modifications. + + Revision 1.91 2002/04/24 02:39:31 hal9 + Add 'Chain of Events' section. + + Revision 1.90 2002/04/23 21:41:25 hal9 + Linuxconf is deprecated on RH, substitute chkconfig. + + Revision 1.89 2002/04/23 21:05:28 oes + Added hint for startup on Red Hat + + Revision 1.88 2002/04/23 05:37:54 hal9 + Add AmigaOS install stuff. + + Revision 1.87 2002/04/23 02:53:15 david__schmidt + Updated OSX installation section + Added a few English tweaks here an there + Revision 1.86 2002/04/21 01:46:32 hal9 Re-write actions section.