X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=b777ac07aecf365bd6c8c18a5d37024622f54fe7;hp=15ac7f60602025b5e1635b9bd62ac3f64662825a;hb=84a1e001c40726ad4a1fdc577f7baac89c873899;hpb=ed70e742f22c7a2eff07f2509e74080190271796 diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 15ac7f60..b777ac07 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -25,7 +25,7 @@ This file belongs into ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/ - $Id: user-manual.sgml,v 1.95 2002/04/26 17:23:29 swa Exp $ + $Id: user-manual.sgml,v 1.102 2002/05/03 17:46:00 oes 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.95 2002/04/26 17:23:29 swa Exp $ +$Id: user-manual.sgml,v 1.102 2002/05/03 17:46:00 oes Exp $ @@ -91,13 +91,6 @@ - - - - - - - Introduction @@ -147,39 +140,28 @@ packages for a wide range of operating systems, and as raw source code. For most users, we recommend using the packages, which can be downloaded from our Privoxy Project - Page. For installing and compiling the source code, please look - into our Developer Manual. + Page. - - 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 - tarball. Again, we refer you to the Developer Manual. - - - - &supported; - - Note: If you have a previous Junkbuster or Privoxy installation on your system, you will need to remove it. Some platforms do this for you as part of their installation procedure. (See below for your platform). - - - In any case be sure to backup your old configuration if it is valuable to you. See the note to upgraders section below. + +Binary Packages + +How to install the binary packages depends on your operating system: + + -Red Hat and SuSE RPMs +Red Hat and SuSE RPMs RPMs can be installed with rpm -Uvh privoxy-&p-version;-1.rpm, @@ -207,17 +189,17 @@ automatically start Privoxy in the boot process. Otherwise, RPM will try to remove Junkbuster automatically, before installing Privoxy. - + -Debian +Debian FIXME. - + -Windows +Windows Just double-click the installer, which will guide you through @@ -225,20 +207,20 @@ automatically start Privoxy in the boot process. in the same directory as you installed Privoxy in. We do not use the registry of Windows. - + -Solaris, NetBSD, FreeBSD, HP-UX +Solaris, NetBSD, FreeBSD, HP-UX Create a new directory, cd to it, then unzip and untar the archive. For the most part, you'll have to figure out where things go. FIXME. - + -OS/2 +OS/2 First, make sure that no previous installations of @@ -258,10 +240,10 @@ automatically start Privoxy in the boot process. The directory you choose to install Privoxy into will contain all of the configuration files. - + -Max OSX +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, @@ -273,10 +255,10 @@ automatically start Privoxy in the boot process. automatically on system bring-up via /System/Library/StartupItems/Privoxy. - + -AmigaOS +AmigaOS Copy and then unpack the lha archive to a suitable location. All necessary files will be installed into Privoxy @@ -292,7 +274,35 @@ automatically start Privoxy in the boot process. TCP/IP stack (just ignore the harmless warning your TCP/IP stack may display that Privoxy is still running). + + + +Building from Source + + + The most convenient way to obtain the Privoxy sources + is to download the source tarball from our project + page. + + + + 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 + tarball. + + + +&buildsource; + + + + + + @@ -301,22 +311,25 @@ automatically start Privoxy in the boot process. Note to Upgraders - There are very significant changes from older versions of - Junkbuster to the current - Privoxy. Configuration is substantially - changed. Junkbuster 2.0.x and earlier - configuration files will not migrate. The functionality 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. + 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. - 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. + 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. If upgrading from a 2.0.x version, you will have to use the new config @@ -359,9 +372,9 @@ automatically start Privoxy in the boot process. The primary configuration file for cookie management, ad and banner blocking, and many other aspects of Privoxy - configuration is in the actions files. It is strongly - recommended to become familiar with the new actions concept below, - before modifying these files. Locally defined rules + configuration is in 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. @@ -385,32 +398,68 @@ automatically start Privoxy in the boot process. - Install Privoxy. See the section Installing. + If upgrading, please back up any configuration files. See + the Note to Upgraders Section. + + + + Install Privoxy. See the Installation Section for platform specific + information. + - Start Privoxy. See the section Starting Privoxy. + Start Privoxy, if the installation program has + not done this already. See the section Starting + Privoxy. - Change your browser's configuration to use the proxy localhost on port - 8118. See the section Starting Privoxy. + Set your browser to use Privoxy as HTTP and HTTPS + proxy by setting the proxy configuration for address of + localhost and port 8118. + (Junkbuster and earlier versions of + Privoxy used port 8000.) See the section Starting Privoxy. - Enjoy surfing with enhanced comfort and privacy. Please see the section - Contacting the Developers on how to report - bugs or problems with websites or to get help. You may want to change the - file user.action to further tweak your new browsing - experience. + Flush your browser's caches, to remove any cached ad images. - + + + + + Enjoy surfing with enhanced comfort and privacy. You may want to customize the + user.action file to + personalize your new browsing experience. See the Configuration section for more configuration + options, and how to further customize your installation. + + + + + + If you experience problems with sites that misbehave, see + the Anatomy of an Action section in the + Appendix. + + + + + + Please see the section Contacting the + Developers on how to report bugs or problems with websites or to get + help. + + @@ -421,11 +470,11 @@ automatically start Privoxy in the boot process. Starting <application>Privoxy</application> - Before launching Privoxy for the first time, you - will want to configure your browser(s) to use Privoxy - as a HTTP and HTTPS proxy. The default is localhost for the proxy address, - and port 8118 (earlier versions used port 8000). This is the one - configuration step that must be done! + Before launching Privoxy for the first time, you + will want to configure your browser(s) to use + Privoxy as a HTTP and HTTPS proxy. The default is + localhost for the proxy address, and port 8118 (earlier versions used port + 8000). This is the one configuration step that must be done! @@ -445,53 +494,102 @@ automatically start Privoxy in the boot process. Privoxy! - Privoxy is typically started by specifying the - main configuration file to be used on the command line. Example Unix startup - command: + 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 + directory. Except on Win32 where it will try config.txt. + +RedHat and Debian + +We use a script. Note that RedHat does not start Privoxy upon booting per +default. It will use the file /etc/privoxy/config as its +main configuration file. FIXME: Debian?? + - # /usr/sbin/privoxy /etc/privoxy/config + # /etc/rc.d/init.d/privoxy start + + + +SuSE + +We use a script. It will use the file /etc/privoxy/config +as its main configuration file. Note that SuSE starts Privoxy upon booting +your PC. + + + + # rcprivoxy start + + + + + +Windows + +Click on the Privoxy Icon to start Privoxy. If no configuration file is + specified on the command line, Privoxy will look + for a file named config.txt. Note that Windows will + automatically start Privoxy upon booting you PC. + + + +Solaris, NetBSD, FreeBSD, HP-UX and others + +Example Unix startup command: + - See below for other command line options. + + # /usr/sbin/privoxy /etc/privoxy/config + + + +OS/2 - An init script is provided for SuSE and Red Hat. +FIXME. + + +MAX OSX - For for SuSE: rcprivoxy start +FIXME. + + + +AmigaOS - For Red Hat and Debian: /etc/rc.d/init.d/privoxy start +FIXME. + + + Command Line Options @@ -705,8 +808,8 @@ automatically start Privoxy in the boot process. 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 + actions files, 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 file, and other configuration files, are explained in detail below. @@ -717,7 +820,8 @@ automatically start Privoxy in the boot process. have problems with your current actions and filters. You can in fact use it as a test to see whether it is Privoxy causing the problem or not. Privoxy continues - to run as a proxy in this case, but all filtering is disabled. There + to run as a proxy in this case, but all manipulation is disabled, i.e. + Privoxy acts like a normal forwarding proxy. There is even a toggle Bookmarklet offered, so that you can toggle Privoxy with one click from your browser. @@ -754,7 +858,7 @@ automatically start Privoxy in the boot process. - 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. This is a required file. @@ -762,25 +866,29 @@ automatically start Privoxy in the boot process. - 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. + default.action (the main actions file) + is used to define which actions relating to banner-blocking, images, pop-ups, + content modification, cookie handling etc should be applied by default. It also defines many + exceptions (both positive and negative) from this default set of actions that enable + Privoxy to selectively eliminate the junk, and only the junk, on + as many websites as possible. 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. + preferred exceptions to the default policies as defined in + default.action (which you will most propably want + to define sooner or later) are probably best applied in + user.action, where you can preserve them across + upgrades. standard.action is for + Privoxy's internal use. There is also a web based editor that can be accessed from http://config.privoxy.org/show-status/ + url="http://config.privoxy.org/show-status">http://config.privoxy.org/show-status (Shortcut: http://p.p/show-status/) for the + url="http://p.p/show-status">http://p.p/show-status) for the various actions files. @@ -800,7 +908,7 @@ automatically start Privoxy in the boot process. All files use the # character to denote a - comment (the rest of the line will be ignored) angd understand line continuation + comment (the rest of the line will be ignored) and understand line continuation through placing a backslash ("\") as the very last character in a line. If the # is preceded by a backslash, it looses its special function. Placing a # in front of an otherwise @@ -832,13 +940,17 @@ automatically start Privoxy in the boot process. please check all your configuration files on important issues. ]]> + + + - + - + The Main Configuration File + Again, the main configuration file is named config on Linux/Unix/BSD and OS/2, and config.txt on Windows. @@ -851,8 +963,7 @@ automatically start Privoxy in the boot process. - confdir /etc/privoxy - + confdir /etc/privoxy @@ -878,18 +989,23 @@ automatically start Privoxy in the boot process. - + Configuration and Log File Locations Privoxy can (and normally does) use a number of - other files for additional configuration and logging. + other files for additional configuration, help and logging. This section of the configuration file tells Privoxy where to find those other files. + + The user running Privoxy, must have read permission for all + configuration files, and write permission to any files that would + be modified, such as log files. + -confdir +confdir @@ -932,10 +1048,10 @@ automatically start Privoxy in the boot process. - + -logdir +logdir @@ -974,28 +1090,28 @@ automatically start Privoxy in the boot process. - + - +<sect3 renderas="sect4" id="actionsfile"><title> actionsfile - + Specifies: - The actions file(s) to use + The actions file(s) to use Type of value: - File name, relative to confdir + File name, relative to confdir, without the .action suffix @@ -1003,7 +1119,7 @@ actionsfile - standard # Internal purposes, recommended not editing + standard # Internal purposes, no editing recommended default # Main actions file @@ -1026,7 +1142,7 @@ actionsfile Notes: - Multiple actionsfile lines are OK and are in fact recommended! + Multiple actionsfile lines are permitted, and are in fact recommended! The default values include standard.action, which is used for internal @@ -1035,14 +1151,17 @@ actionsfile user.action, where you can make your personal additions. - There is no point in using Privoxy without an actions file. + Actions files are where all the per site and per URL configuration is done for + ad blocking, cookie management, privacy considerations, etc. + There is no point in using Privoxy without at + least one actions file. - + -filterfile +filterfile @@ -1071,7 +1190,7 @@ actionsfile No textual content filtering takes place, i.e. all +filter{name} - actions in the actions files are turned off + actions in the actions files are turned neutral. @@ -1089,9 +1208,9 @@ actionsfile - + -logfile +logfile @@ -1147,12 +1266,16 @@ actionsfile the effect that cron.daily will automatically archive, gzip, and empty the log, when it exceeds 1M size. + + Any log files must be writable by whatever user Privoxy + is being run as (default on UNIX, user id is privoxy). + - + -jarfile +jarfile @@ -1192,10 +1315,9 @@ actionsfile - - -trustfile + +trustfile Specifies: @@ -1247,9 +1369,8 @@ actionsfile - - + @@ -1257,7 +1378,7 @@ actionsfile - + Local Set-up Documentation @@ -1266,7 +1387,73 @@ actionsfile you, what you block and why you do that, your policies etc. -trust-info-url +user-manual + + + Specifies: + + + Location of the Privoxy User Manual. + + + + + Type of value: + + A fully qualified URI + + + + Default value: + + Unset + + + + Effect if unset: + + + http://www.privoxy.org/version/user-manual/ + will be used, where version is the Privoxy version. + + + + + Notes: + + + The User Manual URI is used for help links from some of the internal CGI pages. + The manual itself is normally packaged with the binary distributions, so you propably want + to set this to a locally installed copy. For multi-user setups, you could provide a copy on + a local webserver for all your users and use the corresponding URL here. + + + Examples: + + + Unix, in local filesystem: + + + user-manual  file:///usr/share/doc/privoxy-&p-version;/user-manual/ + + + Any platform, on local webserver (called local-webserver): + + + user-manual  http://local-webserver/privoxy-user-manual/ + + + + If set, this option should be the first option in the config file, because + it is used while the config file is being read. + + + + + + + +trust-info-url @@ -1316,9 +1503,9 @@ actionsfile - + -admin-address +admin-address @@ -1360,9 +1547,9 @@ actionsfile - + -proxy-info-url +proxy-info-url @@ -1408,14 +1595,14 @@ actionsfile - - + + - + Debugging @@ -1425,7 +1612,7 @@ actionsfile command line option when debugging. -debug +debug @@ -1502,9 +1689,9 @@ actionsfile - + -single-threaded +single-threaded @@ -1546,13 +1733,13 @@ actionsfile - - + + - + Access Control and Security @@ -1560,7 +1747,7 @@ actionsfile of Privoxy's configuration. -listen-address +listen-address @@ -1578,6 +1765,7 @@ actionsfile [IP-Address]:Port + Default value: @@ -1630,9 +1818,9 @@ actionsfile - + -toggle +toggle @@ -1672,7 +1860,7 @@ actionsfile proxy. See enable-remote-toggle below. This is not really useful anymore, since toggling is much easier via the web - interface then via editing the conf file. + interface than via editing the conf file. The windows version will only display the toggle icon in the system tray @@ -1681,10 +1869,10 @@ actionsfile - + -enable-remote-toggle +enable-remote-toggle Specifies: @@ -1738,10 +1926,10 @@ actionsfile - + -enable-edit-actions +enable-edit-actions Specifies: @@ -1790,9 +1978,9 @@ actionsfile - + - +<sect3 renderas="sect4" id="acls"><title> ACLs: permit-access and deny-access @@ -1915,9 +2103,9 @@ ACLs: permit-access and deny-access - + -buffer-limit +buffer-limit @@ -1970,16 +2158,16 @@ ACLs: permit-access and deny-access - - + + - + Forwarding @@ -1999,7 +2187,7 @@ ACLs: permit-access and deny-access supports the SOCKS 4 and SOCKS 4A protocols. -forward +forward Specifies: @@ -2078,9 +2266,9 @@ ACLs: permit-access and deny-access - + - +<sect3 renderas="sect4" id="socks"><title> forward-socks4 and forward-socks4a @@ -2170,9 +2358,9 @@ forward-socks4 and forward-socks4a - + -Advanced Forwarding Examples +Advanced Forwarding Examples If you have links to multiple ISPs that provide various special content @@ -2246,16 +2434,16 @@ forward-socks4 and forward-socks4a Squid normally uses port 3128. If unsure consult http_port in squid.conf. - - + + - + Windows GUI Options Privoxy has a number of options specific to the @@ -2427,59 +2615,104 @@ forward-socks4 and forward-socks4a - #hide-console + #hide-console - + - -Actions Files + + + +Actions Files The actions files are used to define what actions - Privoxy takes for which URLs, and thus determines + 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, - 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. + are three such files included with Privoxy (as of + version 2.9.15), with differing purposes: + + + + + + standard.action - is used by the web based editor, + to set various pre-defined sets of rules for the default actions section + in default.action. These have increasing levels of + aggressiveness and have no influence on your browsing unless + you select them explicitly in the editor. It is not recommend + to edit this file. + + + + + default.action - is the primary action file + that sets the initial values for all actions. It is intended to + 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. + + + + + user.action - is intended to be for local site + preferences and exceptions. As an example, if your ISP or your bank + has specific requirements, and need special handling, this kind of + thing should go here. This file will not be upgraded. + + + + - - Anything you want can be blocked, including ads, banners, or just some obnoxious - 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. + + 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 http://config.privoxy.org/show-status. - 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. + An actions file typically has multiple sections. If you want to use + aliases in an actions file, you have to place the (optional) + alias section at the top of that file. + Then comes the default set of rules which will apply universally to all + sites and pages (be very careful with using such a + universal set in user.action or any other actions file after + default.action, because it will override the result + from consulting any previous file). And then below that, + exceptions to the defined universal policies. You can regard + user.action as an appendix to default.action, + with the advantage that is a separate file, which makes preserving your + personal settings across Privoxy upgrades easier. + + + + Actions can be used to block anything you want, including ads, banners, or + just some obnoxious URL that you would rather not see. 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 actions. - + 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 + Note that some actions, like cookie suppression + or script disabling, may render some sites unusable that rely on these + techniques to work properly. Finding the right mix of actions is not always 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 @@ -2495,25 +2728,29 @@ forward-socks4 and forward-socks4a 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 again :). - + - + How to Edit - The easiest way to edit the actions files is with a browser by + 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. + 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. If you prefer plain text editing to GUIs, you can of course also directly edit the - the actions files. + the actions files. Look at default.action which is richly + commented. - + - + How Actions are Applied to URLs Actions files are divided into sections. There are special sections, @@ -2526,18 +2763,18 @@ forward-socks4 and forward-socks4a To determine which actions apply to a request, the URL of the request is - compared to all patterns in this 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 both the - +handle-as-image - and +block actions). + +handle-as-image + and +block actions). - You can trace this process by visiting http://config.privoxy.org/show-url-info. @@ -2545,10 +2782,10 @@ forward-socks4 and forward-socks4a More detail on this is provided in the Appendix, Anatomy of an Action. - + - + Patterns Generally, a pattern has the form <domain>/<path>, @@ -2604,7 +2841,9 @@ forward-socks4 and forward-socks4a -The Domain Pattern + + +The Domain Pattern The matching of the domain part offers some flexible options: if the @@ -2690,9 +2929,13 @@ forward-socks4 and forward-socks4a - + + + -The Path Pattern + + +The Path Pattern Privoxy uses Perl compatible regular expressions @@ -2724,88 +2967,99 @@ forward-socks4 and forward-socks4a documents whose path starts with PaTtErN in exactly this capitalization. - - + + - + 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. + +action means do that action, e.g. + +block means please block URLs that match the + following patterns, and -block means don't + block URLs that match the following patterns, even if +block + previously applied. + - 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: + Again, actions are invoked by placing them on a line, enclosed in curly braces and + separated by whitespace, like in + {+some-action -some-other-action{some-parameter}}, + followed by a list of URL patterns, one per line, to which they apply. + Together, the actions line and the following pattern lines make up a section + of the actions file. + + + + There are three classes of actions: - - Boolean, i.e the action can only be on or - off. Examples: - + Boolean, i.e the action can only be enabled or + disabled. Syntax: + - - - - {+name} # enable this action - {-name} # disable this action - - - + + +name # enable action name + -name # disable action name + + + Example: +block - Parameterized, e.g. +/-hide-user-agent{ Mozilla 1.0 }, - where some value is required in order to enable this type of action. - Examples: + Parameterized, where some value is required in order to enable this type of action. + Syntax: + + + + +name{param} # enable action and set parameter to param, + # overwriting parameter from previous match if necessary + -name # disable action. The parameter can be omitted - - - - {+name{param}} # enable action and set parameter to param - {-name} # disable action (parameter) can be omitted - - - + Note that if the URL matches multiple positive forms of a parameterized action, + the last match wins, i.e. the params from earlier matches are simply ignored. + + + Example: +hide-user-agent{ Mozilla 1.0 } - - 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: + Multi-value. These look exactly like parameterized actions, + but they behave differently: If the action applies multiple times to the + same URL, but with different parameters, all the parameters + from all matches are remembered. This is used for actions + that can be executed for the same request repeatedly, like adding multiple + headers, or filtering through multiple filters. Syntax: - - - - {+name{param=value}} # enable action and set param to value - {-name{param=value}} # remove the parameter param completely - {-name} # disable this action totally and remove param too - - - + + +name{param} # enable action and add param to the list of parameters + -name{param} # remove the parameter param from the list of parameters + # If it was the last one left, disable the action. + -name # disable this action completely and remove all parameters from the list + + + Examples: +add-header{X-Fun-Header: Some text} and + +filter{html-annoyances} @@ -2828,12 +3082,12 @@ forward-socks4 and forward-socks4a 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! + one pattern and thus more than one set of actions! - The list of valid Privoxy actions are: + The list of valid Privoxy actions are: @@ -2846,7 +3100,7 @@ forward-socks4 and forward-socks4a - + <emphasis>+add-header</emphasis> @@ -2859,10 +3113,10 @@ forward-socks4 and forward-socks4a - Typical uses: + Purpose and typical uses: - Send a user defined HTTP header to the web server. + Send a user defined HTTP header to the web server. Can be used to confuse log analysis. @@ -2872,6 +3126,8 @@ forward-socks4 and forward-socks4a Any value is possible. Validity of the defined HTTP headers is not checked. + It is recommended that you use the X- prefix + for custom headers. @@ -2881,8 +3137,7 @@ forward-socks4 and forward-socks4a {+add-header{X-User-Tracking: sucks}} - .example.com - + .example.com @@ -2898,11 +3153,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+block</emphasis> @@ -2915,12 +3170,14 @@ forward-socks4 and forward-socks4a - Typical uses: + Purpose and typical uses: - Used to block a URL from reaching your browser. The URL may be - anything, but is typically used to block ads or other obnoxious - content. + Requests for URLs to which this action applies are blocked, i.e. the requests are not + forwarded to the remote server, but answered locally with a substitute page or image, + as determined by the handle-as-image and + set-image-blocker actions. + It is typically used to block ads or other obnoxious content. @@ -2961,15 +3218,15 @@ forward-socks4 and forward-socks4a A very important exception is if the URL matches both +block and +handle-as-image, + url="actions-file.html#HANDLE-AS-IMAGE">+handle-as-image, then it will be handled by - +set-image-blocker + +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 + 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 @@ -2979,11 +3236,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+deanimate-gifs</emphasis> @@ -3039,10 +3296,10 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+downgrade-http-version</emphasis> @@ -3096,10 +3353,10 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+fast-redirects</emphasis> @@ -3169,11 +3426,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+filter</emphasis> @@ -3213,61 +3470,73 @@ forward-socks4 and forward-socks4a + +filter{html-annoyances}: Get rid of particularly annoying HTML abuse. + +filter{js-annoyances}: Get rid of particularly annoying JavaScript abuse + +filter{content-cookies}: Kill cookies that come in the HTML or JS content + +filter{popups}: Kill all popups in JS and HTML + +filter{frameset-borders}: Give frames a border and make them resizable + +filter{webbugs}: Squish WebBugs (1x1 invisible GIFs used for user tracking) + +filter{refresh-tags}: Kill automatic refresh tags (for dial-on-demand setups) + +filter{fun}: Text replacements for subversive browsing fun! + +filter{nimda}: Remove Nimda (virus) code. + +filter{banners-by-size}: Kill banners by size (very efficient!) + +filter{shockwave-flash}: Kill embedded Shockwave Flash objects + +filter{crude-parental}: Kill all web pages that contain the words "sex" or "warez" @@ -3291,7 +3560,7 @@ forward-socks4 and forward-socks4a Filtering can achieve some of the effects as the - +block + +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 @@ -3301,11 +3570,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+hide-forwarded-for-headers</emphasis> @@ -3355,11 +3624,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+hide-from-header</emphasis> @@ -3406,7 +3675,7 @@ forward-socks4 and forward-socks4a The keyword block will completely remove the header (not to be confused with the +block action). + url="actions-file.html#BLOCK">+block action). Alternately, you can specify any value you prefer to send to the web server. @@ -3414,11 +3683,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+hide-referer</emphasis> @@ -3479,11 +3748,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+hide-user-agent</emphasis> @@ -3536,10 +3805,10 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+handle-as-image</emphasis> @@ -3589,10 +3858,10 @@ forward-socks4 and forward-socks4a +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, + url="actions-file.html#BLOCK">+block rule, and +handle-as-image. (See +set-image-blocker + url="actions-file.html#SET-IMAGE-BLOCKER">+set-image-blocker below for control over what will actually be displayed by the browser.) @@ -3602,11 +3871,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+set-image-blocker</emphasis> @@ -3623,9 +3892,9 @@ forward-socks4 and forward-socks4a Decide what to do with URLs that end up tagged with both - +block + +block and +handle-as-image, + url="actions-file.html#HANDLE-AS-IMAGE">+handle-as-image, e.g an advertisement. @@ -3677,10 +3946,10 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+limit-connect</emphasis> @@ -3752,10 +4021,10 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+prevent-compression</emphasis> @@ -3801,10 +4070,10 @@ forward-socks4 and forward-socks4a Some websites do this, which can be a problem for Privoxy, since - +filter, - +kill-popups + +filter, + +kill-popups and +gif-deanimate + url="actions-file.html#GIF-DEANIMATE">+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. @@ -3813,10 +4082,10 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+session-cookies-only</emphasis> @@ -3876,11 +4145,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+prevent-reading-cookies</emphasis> @@ -3927,7 +4196,7 @@ forward-socks4 and forward-socks4a Often used in conjunction with +prevent-setting-cookies to disable cookies completely. Note that - +session-cookies-only + +session-cookies-only requires these to both be disabled (or else it never gets any cookies to cache). @@ -3939,11 +4208,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+prevent-setting-cookies</emphasis> @@ -3995,11 +4264,11 @@ forward-socks4 and forward-socks4a - + - - + + <emphasis>+kill-popups<anchor id="kill-popups"></emphasis> @@ -4058,11 +4327,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+send-vanilla-wafer</emphasis> @@ -4115,11 +4384,11 @@ forward-socks4 and forward-socks4a - + - + <emphasis>+send-wafer</emphasis> @@ -4170,30 +4439,49 @@ forward-socks4 and forward-socks4a - + + + + + +Summary + + 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, 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. + + - -Actions Examples + +Sample Actions Files - Note that the meaning of any of the above examples is reversed by preceding + Remember that the meaning of any of the above references is reversed by preceding 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. - But, other actions that are turned on the default section do + + + + But, other actions that are turned on in the default section do typically require exceptions to be listed in the latter sections of one of our actions file. For instance, 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 in the lower sections. But we need to be very selective - about what we do block. + enable ad blocking in the lower sections. But we need to + be very selective about what we do block. Thus, the default is off + for blocking. - Below is a liberally commented default.action file to - demonstrate how all the pieces come together. And to show how exceptions to - the default policies can be handled. This is followed by a + Below is a liberally commented sample default.action file + to demonstrate how all the pieces come together. And to show how exceptions + to the default policies can be handled. This is followed by a brief user.action with similar examples. @@ -4201,6 +4489,7 @@ forward-socks4 and forward-socks4a +# Sample default.action file <developers@privoxy.org> # Settings -- Don't change! For internal Privoxy use ONLY. {{settings}} @@ -4208,13 +4497,19 @@ for-privoxy-version=3.0 ########################################################################## -# Aliases must be defined *before* they are used. These are -# easier to remember, and combine several actions into one. Once defined -# they can be used just like any built-in action. +# Aliases must be defined *before* they are used. These are +# easier to remember, and can combine several actions into one. Once +# defined they can be used just like any built-in action -- but within +# this file only! Aliases do not require a + or - sign. ########################################################################## # Some useful aliases. - -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies +# Alias to turn off cookie handling, ie allow all cookies unmolested. + -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies \ + -session-cookies-only + +# Alias to both block and treat as if an image for ad blocking +# purposes. +imageblock = +block +handle-as-image # Fragile sites should have the minimum changes: @@ -4227,62 +4522,63 @@ for-privoxy-version=3.0 ########################################################################## # Begin default action settings. Anything in this section will match -# all URLs -- UNLESS we have exceptions that match defined below this +# all URLs -- UNLESS we have exceptions that also match, defined below this # section. We will show all potential actions here whether they are on # or off. We could omit any disabled action if we wanted, since all # actions are 'off' by default anyway. Shown for completeness only. -# Actions are enabled if preceded by a '+', otherwise they are disabled. +# Actions are enabled if preceded by a '+', otherwise they are disabled +# (unless an alias has been defined without this). ########################################################################## { \ - -add-header \ - -block \ - -deanimate-gifs \ - -downgrade-http-version \ - +fast-redirects \ - +filter{html-annoyances} \ - +filter{js-annoyances} \ - -filter{content-cookies} \ - -filter{popups} \ - +filter{webbugs} \ - -filter{refresh-tags} \ - -filter{fun} \ - +filter{nimda} \ - +filter{banners-by-size} \ - -filter{shockwave-flash} \ - -filter{crude-prental} \ - +hide-forwarded-for-headers \ - +hide-from-header{block} \ - -hide-referrer \ - -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 \ + -add-header \ + -block \ + -deanimate-gifs \ + -downgrade-http-version \ + +fast-redirects \ + +filter{html-annoyances} \ + +filter{js-annoyances} \ + -filter{content-cookies} \ + -filter{popups} \ + +filter{webbugs} \ + -filter{refresh-tags} \ + -filter{fun} \ + +filter{nimda} \ + +filter{banners-by-size} \ + -filter{shockwave-flash} \ + -filter{crude-prental} \ + +hide-forwarded-for-headers \ + +hide-from-header{block} \ + -hide-referrer \ + -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 \ } / # forward slash will match *all* potential URL patterns. ########################################################################## -# Default behavior is now set. Time for some exceptions to our -# default actions. +# Default behavior is now set. Now we will define some exceptions to our +# default action policies. ########################################################################## # These sites are very complex and require very minimal interference. -# We'll disable most actions with our 'fragile' alias. - {fragile} +# We'll disable most actions with our 'fragile' alias: + { fragile } .office.microsoft.com # surprise, surprise! .windowsupdate.microsoft.com # Shopping sites - not as fragile but require some special # handling. We still want to block ads, and we will allow -# persistant cookies via the 'shop' alias. - {shop} +# persistant cookies via the 'shop' alias: + { shop } .quietpc.com .worldpay.com # for quietpc.com .jungle.com @@ -4291,15 +4587,14 @@ for-privoxy-version=3.0 # These sites require pop-ups too :( We'll combine our 'shop' # alias with two other actions into one rule to allow all popups. - {shop -no-popups -filter{popups}} + { shop -kill-popups -filter{popups} } .dabs.com .overclockers.co.uk # The 'Fast-redirects' action breaks some sites. Disable this action -# for these known sensitive sites. - {-fast-redirects} - www.ukc.ac.uk/cgi-bin/wac\.cgi\? +# for these known sensitive sites: + { -fast-redirects } login.yahoo.com edit.europe.yahoo.com .google.com @@ -4310,16 +4605,16 @@ for-privoxy-version=3.0 # Define which file types will be treated as images. Important # for ad blocking. - {+handle-as-image} + { +handle-as-image } /.*\.(gif|jpe?g|png|bmp|ico) # Now lets list some domains that are known ad generators. And -# our alias here will block these as well as force them to be -# treated as images. This combination of actions is important -# for ad blocking. What the browser will show instead is -# determined by the setting of +set-image-blocker - {+imageblock} +# our alias that we use here will block these as well as force +# them to be treated as images. This combination of actions is +# important for ad blocking. What the browser will show instead is +# determined by the setting of +set-image-blocker + { +imageblock } ar.atwola.com .ad.doubleclick.net .a.yimg.com/(?:(?!/i/).)*$ @@ -4332,8 +4627,8 @@ for-privoxy-version=3.0 # These will just simply be blocked. They will generate the BLOCKED # banner page, if matched. Heavy use of wildcards and regular -# expressions in this example. - {+block} +# expressions in this example. Enable block action: + { +block } ad*. .*ads. banner?. @@ -4343,10 +4638,11 @@ for-privoxy-version=3.0 .hitbox.com -# The above block section will catch some sites we DO NOT want -# blocked via the wildcards and regular expressions. Now let's set -# exceptions to the exceptions so the good guys get better treatment. - {-block} +# The above block section will probably inadvertantly catch some +# sites we DO NOT want blocked via the wildcards and regular expressions. +# Now let's set exceptions to the exceptions so the good guys get better +# treatment. Disable block action: + { -block } advogato.org adsl. ad[ud]*. @@ -4364,9 +4660,9 @@ for-privoxy-version=3.0 # Don't filter *anything* from our friends at sourceforge. # Notice we don't have to name the individual filter # identifiers -- we just turn them all off in one fell swoop. - {-filter} +# Disable all filters for this one site: + { -filter } .sourceforge.net - @@ -4376,159 +4672,81 @@ for-privoxy-version=3.0 So far we are painting with a broad brush by setting general policies. The above would be a reasonable starting point for many situations. Now, we want to be more specific and have customized rules that are more suitable - to our personal habits and preferences. These should be placed in + to our personal habits and preferences. These would be for narrowly defined + situations like your ISP or your bank, and should be placed in user.action, which is parsed after all other - actions files. So any settings here, will have the last word. + actions files and should not be clobbered by upgrades. So any settings here, + will have the last word and over-ride any previously defined actions. - Now an example of a few things that one might do with a user.action - file. This is where user preferences are defined. + Now a few examples of some things that one might do with a + user.action file. - - - - - Some examples: - - - - 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): - - - # 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 are saved from one browser session to the next. - { -session-cookies-only } - .javasoft.com - .sun.com - .yahoo.com - .msdn.microsoft.com - .redhat.com - - - - - - - - Now turn off fast redirects, and then we allow two exceptions: - +# Sample user.action file. - - - - - # 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 - - - - - - - Turn on page filtering according to rules in the defined sections - of default.filter, and make one exception for - Sourceforge: - - - - - - - # Run everything through the filter file, using only certain - # specified sections: - { - # 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 all sourceforge domains! - {-filter} - .sourceforge.net - - - - +# Any aliases you want to use need to be re-defined here. +# Alias to turn off cookie handling, ie allow all cookies unmolested. + -prevent-cookies = -prevent-setting-cookies -prevent-reading-cookies \ + -session-cookies-only - - Now some URLs that we want blocked (normally generates - 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: +# Fragile sites should have the minimum changes: + fragile = -block -deanimate-gifs -fast-redirects -filter -hide-referer \ + -prevent-cookies -kill-popups - - - - - # Blocklist: - {+block} - 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?/ - /.*/abanners/ - /autoads/ +# Allow persistent cookies for a few regular sites that we +# trust via our above alias. These will be saved from one browser session +# to the next. We are explicity turning off any and all cookie handling, +# even though the prevent-*-cookie settings were disabled in our above +# default.action anyway. So cookies from these domains will come through +# unmolested. + { -prevent-cookies } + .sun.com + .yahoo.com + .msdn.microsoft.com + .redhat.com + + +# My ISP uses obnoxious self promoting images on many pages. +# Nuke them :) Note that +handle-as-image need not be specified, +# since all URLs ending in .gif will be tagged as images by the +# general rules in default.action anyway. + { +block } + www.my-isp-example.com/logo[0-9].gif + + +# Say the site where you do your homebanking needs to open +# popup windows, but you have chosen to kill popups by +# default. This will allow it for your-example-bank.com: +# + { -filter{popups} -kill-popups } + .my-example-bank.com + + +# This site is delicate, and requires kid-glove +# treatment. + { fragile } + .forbes.com - - 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, 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. - - - + - + Aliases Custom actions, known to Privoxy @@ -4541,7 +4759,8 @@ for-privoxy-version=3.0 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. + only visible within that file. Aliases do not requir a + or + - sign in front, since they are merely expanded. @@ -4610,20 +4829,23 @@ for-privoxy-version=3.0 - + - - + + + + The Filter File Any web page can be dynamically modified with the filter file. This modification can be removal, or re-writing, of any web page content, including tags and non-visible content. The default filter file is - default.filter, located in the config directory. + oddly enough default.filter, located in the config + directory. @@ -4718,56 +4940,56 @@ for-privoxy-version=3.0 - -The +filter Action + +The <emphasis>+filter</emphasis> Action Filters are enabled with the +filter action from within + url="actions-file.html#FILTER">+filter action from within one of the actions files. +filter requires one parameter, which should match one of the section identifiers in the filter file itself. Example: - - + +filter{html-annoyances} - - + This would activate that particular filter. Similarly, +filter can be turned off for selected sites as: - -filter{html-annoyances}. Remember, all actions are off by + -filter{html-annoyances}. Remember too, all actions are off by default, unless they are explicity enabled in one of the actions files. - - + + - + Templates When Privoxy displays one of its internal - pages, such as a 404 Not Found error page, it uses the appropriate template. - On Linux, BSD, and Unix, these are located in - /etc/privoxy/templates by default. These may be - customized, if desired. cgi-style.css is - used to control the HTML attributes (fonts, etc). - - - The default Blocked banner page with the bright red top + pages, such as a 404 Not Found error page + (Privoxy must be running for link to work as + intended), it uses the appropriate template. On Linux, BSD, and Unix, these + are located in /etc/privoxy/templates by default. These + may be customized, if desired. cgi-style.css is used to + control the HTML attributes (fonts, etc). + + + The default +Blocked +(Privoxy needs to be running for page to display) + banner page with the bright red top banner, is called just blocked. This may be customized or replaced with something else if desired. - - @@ -5282,13 +5504,13 @@ Requests Next, Privoxy checks to see if the URL matches any +block patterns. If + url="actions-file.html#BLOCK">+block patterns. If so, the URL is then blocked, and the remote web server will not be contacted. - +handle-as-image + +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 + url="actions-file.html#SET-IMAGE-BLOCKER">+set-image-blocker (blank, checkerboard pattern, or an HTTP redirect to an image elsewhere). @@ -5301,7 +5523,7 @@ Requests If the URL pattern matches the +fast-redirects action, + url="actions-file.html#FAST-REDIRECTS">+fast-redirects action, it is then processed. Unwanted parts of the requested URL are stripped. @@ -5309,7 +5531,7 @@ Requests 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, + url="actions-file.html#HIDE-USER-AGENT">+hide-user-agent, etc.), headers are suppressed or forged as determined by these actions and their parameters. @@ -5325,24 +5547,24 @@ 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 deterimed by the - +prevent-setting-cookies, - +session-cookies-only, - and +downgrade-http-version + +prevent-setting-cookies, + +session-cookies-only, + and +downgrade-http-version actions. - If the +kill-popups + 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 + If a +filter or +deanimate-gifs + url="actions-file.html#DEANIMATE-GIFS">+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 @@ -5353,9 +5575,9 @@ Requests Privoxy back to your browser. - If neither +filter + If neither +filter or +deanimate-gifs + url="actions-file.html#DEANIMATE-GIFS">+deanimate-gifs matches, then Privoxy passes the raw data through to the client browser as it becomes available. @@ -5383,8 +5605,8 @@ Requests The way Privoxy applies - actions - and filters + 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 @@ -5414,7 +5636,7 @@ Requests Privoxy will tell us how the current configuration will handle it. This will not help with filtering effects (i.e. the +filter action) from + url="actions-file.html#FILTER">+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 @@ -5463,7 +5685,7 @@ Requests This tells us how we have defined our - actions, and + 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 @@ -5481,11 +5703,11 @@ Requests 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 + url="actions-file.html#SESSION-COOKIES-ONLY">+session-cookies-only (i.e. not persistent). So we will allow persistent cookies for google. The second turns off any +fast-redirects + url="actions-file.html#FAST-REDIRECTS">+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 @@ -5549,7 +5771,7 @@ Requests 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 + url="actions-file.html#ALIASES">Aliases are defined in the first section of the actions file and typically used to combine more than one action.) @@ -5561,10 +5783,10 @@ Requests 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 + url="actions-file.html#BLOCK">+block and an +handle-as-image. + url="actions-file.html#HANDLE-AS-IMAGE">+handle-as-image. The custom alias +imageblock just simplifies the process and make it more readable. @@ -5700,6 +5922,31 @@ Requests Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: user-manual.sgml,v $ + Revision 1.102 2002/05/03 17:46:00 oes + Further proofread & reactivated short build instructions + + Revision 1.101 2002/05/03 03:58:30 hal9 + Move the user-manual config directive to top of section. Add note about + Privoxy needing read permissions for configs, and write for logs. + + Revision 1.100 2002/04/29 03:05:55 hal9 + Add clarification on differences of new actions files. + + Revision 1.99 2002/04/28 16:59:05 swa + more structure in starting section + + Revision 1.98 2002/04/28 05:43:59 hal9 + This is the break up of configuration.html into multiple files. This + will probably break links elsewhere :( + + Revision 1.97 2002/04/27 21:04:42 hal9 + -Rewrite of Actions File example. + -Add section for user-manual directive in config. + + Revision 1.96 2002/04/27 05:32:00 hal9 + -Add short section to Filter Files to tie in with +filter action. + -Start rewrite of examples in Actions Examples (not finished). + Revision 1.95 2002/04/26 17:23:29 swa bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot