From: Fabian Keil Date: Sat, 14 Feb 2009 13:29:11 +0000 (+0000) Subject: Regenerate with recent match-all.action-related changes. X-Git-Tag: v_3_0_11~55 X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=commitdiff_plain;h=07710938efbece9c2c3f6d4b5ccf6f66d1396f1b Regenerate with recent match-all.action-related changes. --- diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index c561b689..bb00c669 100644 --- a/doc/webserver/user-manual/actions-file.html +++ b/doc/webserver/user-manual/actions-file.html @@ -106,58 +106,54 @@ CLASS="APPLICATION" CLASS="APPLICATION" >Privoxy with - differing purposes: -

-

The list of actions files to be used are defined in the main configuration file, and are processed in the order they are defined (e.g. @@ -505,7 +501,7 @@ CLASS="SECT2" >

8.1. Finding the Right Mix

8.2. How to Edit

8.4.1. The Domain Pattern

8.4.2. The Path Pattern

8.5.34. Summary

. Now, let's look at an example match-all.action, default.action and + and user.action - file and see how all these pieces come together:

file and see how all these pieces come together:

8.7.1. default.action8.7.1. match-all.action

Every config file should start with a short comment stating its purpose:

Remember all actions are disabled when matching starts, + so we have to explicitly enable the ones we want.

While the match-all.action file only contains a + single section, it is probably the most important one. It has only one + pattern, "/", but this pattern + matches all URLs. Therefore, the set of + actions used in this "default" section will + be applied to all requests as a start. It can be partly or + wholly overridden by other actions files like default.action + and user.action, but it will still be largely responsible + for your overall browsing experience.

Again, at the start of matching, all actions are disabled, so there is + no need to disable any actions here. (Remember: a "+" + preceding the action name enables the action, a "-" disables!). + Also note how this long line has been made more readable by splitting it into + multiple lines with line continuation.

# Sample default.action file <ijbswa-developers@lists.sourceforge.net>
{ \ + +change-x-forwarded-for{block} \ + +hide-from-header{block} \ + +set-image-blocker{pattern} \ +} +/ # Match all URLs +

Then, since this is the The default behavior is now set.

8.7.2. default.action

If you aren't a developer, there's no need for you to edit the + default.action file, the -first section is a special section for internal use that you needn't -change or worry about:

file. It is maintained by + the Privoxy developers and if you disagree with some of the + sections, you should overrule them in your user.action.

Understanding the default.action file can + help you with your user.action, though.

The first section in this file is a special section for internal use + that prevents older Privoxy versions from reading the file:

########################################################################## # Settings -- Don't change! For internal Privoxy use ONLY. ########################################################################## - {{settings}} -for-privoxy-version=3.0

After that comes the (optional) alias section. We'll use the example -section from the above After that comes the (optional) alias section. We'll use the example + section from the above chapter on aliases, -that also explains why and how aliases are used:

Now come the regular sections, i.e. sets of actions, accompanied - by URL patterns to which they apply. Remember all actions - are disabled when matching starts, so we have to explicitly - enable the ones we want.

The first regular section is probably the most important. It has only - one pattern, "/", but this pattern - matches all URLs. Therefore, the - set of actions used in this "default" section will - be applied to all requests as a start. It can be partly or - wholly overridden by later matches further down this file, or in user.action, - but it will still be largely responsible for your overall browsing - experience.

Again, at the start of matching, all actions are disabled, so there is - no need to disable any actions here. (Remember: a "+" - preceding the action name enables the action, a "-" disables!). - Also note how this long line has been made more readable by splitting it into - multiple lines with line continuation.

##########################################################################
-# "Defaults" section:
-##########################################################################
- { \
- +change-x-forwarded-for{block} \
- +deanimate-gifs \
- +filter{html-annoyances} \
- +filter{refresh-tags} \
- +filter{webbugs} \
- +filter{ie-exploits} \     
- +hide-from-header{block} \
- +hide-referrer{forge} \
- +prevent-compression \
- +session-cookies-only \
- +set-image-blocker{pattern} \
- }
- / # forward slash will match *all* potential URL patterns.

The default behavior is now set. -

The first of our specialized sections is concerned with "fragile"fast-redirects - action, which we enabled per default above, breaks some sites. So disable - it for popular sites where we know it misbehaves:

match-all.action, + breaks some sites. So disable it for popular sites where we know it misbehaves:

and - information). We can mark any URL as an image with the

8.7.2. user.action8.7.3. user.action

So far we are painting with a broad brush by setting general policies, diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html index c6896bc3..40b6c863 100644 --- a/doc/webserver/user-manual/appendix.html +++ b/doc/webserver/user-manual/appendix.html @@ -748,7 +748,7 @@ CLASS="SECT2" >

14.2. Privoxy's Internal Pages

Short cuts. Turn off, then on:

default.action (the main actions file) - is used to define which match-all.action 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. +> + relating to banner-blocking, images, pop-ups, content modification, cookie handling + etc should be applied by default. It should be the first actions file loaded. +

default.action defines many exceptions (both positive and negative) + from the default set of actions that's configured in match-all.action. + It should be the second actions file loaded and shouldn't be edited by the user.

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 + preferred exceptions to the default policies as defined in default.actionmatch-all.action (which you will most probably want - to define sooner or later) are probably best applied in - user.action, where you can preserve them across - upgrades. +>, + where you can preserve them across upgrades. The file isn't installed by all + installers, but you can easily create it yourself with a text editor.

diff --git a/doc/webserver/user-manual/copyright.html b/doc/webserver/user-manual/copyright.html index 569ef8dc..93a21ee6 100644 --- a/doc/webserver/user-manual/copyright.html +++ b/doc/webserver/user-manual/copyright.html @@ -102,7 +102,7 @@ CLASS="SECT2" >

12.1. License

9.1. Filter File Tutorial


$Id: user-manual.sgml,v 2.92 2009/02/12 16:08:26 fabiankeil Exp $

$Id: user-manual.sgml,v 2.96 2009/02/14 13:14:03 fabiankeil Exp $