7 CONTENT="Modular DocBook HTML Stylesheet Version 1.76b+
10 TITLE="Privoxy User Manual"
11 HREF="index.html"><LINK
13 TITLE="The Main Configuration File"
14 HREF="config.html"><LINK
16 TITLE="The Filter File"
17 HREF="filter-file.html"><LINK
20 HREF="../p_doc.css"></HEAD
31 SUMMARY="Header navigation table"
40 >Privoxy User Manual</TH
62 HREF="filter-file.html"
76 NAME="ACTIONS-FILE">8. Actions Files</H1
78 > The actions files are used to define what actions
82 > takes for which URLs, and thus determine
83 how ad images, cookies and various other aspects of HTTP content and
84 transactions are handled, and on which sites (or even parts thereof). There
85 are three such files included with <SPAN
89 version 2.9.15), with differing purposes:
100 > - is the primary action file
101 that sets the initial values for all actions. It is intended to
102 provide a base level of functionality for
106 > array of features. So it is
107 a set of broad rules that should work reasonably well for users everywhere.
108 This is the file that the developers are keeping updated, and making
117 > - is intended to be for local site
118 preferences and exceptions. As an example, if your ISP or your bank
119 has specific requirements, and need special handling, this kind of
120 thing should go here. This file will not be upgraded.
128 > - is used by the web based editor,
129 to set various pre-defined sets of rules for the default actions section
133 >. These have increasing levels of
138 >and have no influence on your browsing unless
139 you select them explicitly in the editor</I
141 >. It is not recommend
149 > The list of actions files to be used are defined in the main configuration
150 file, and are processed in the order they are defined. The content of these
151 can all be viewed and edited from <A
152 HREF="http://config.privoxy.org/show-status"
154 >http://config.privoxy.org/show-status</A
157 > An actions file typically has multiple sections. If you want to use
161 > in an actions file, you have to place the (optional)
163 HREF="actions-file.html#ALIASES"
165 > at the top of that file.
166 Then comes the default set of rules which will apply universally to all
167 sites and pages (be <SPAN
177 > or any other actions file after
181 >, because it will override the result
182 from consulting any previous file). And then below that,
183 exceptions to the defined universal policies. You can regard
187 > as an appendix to <TT
191 with the advantage that is a separate file, which makes preserving your
192 personal settings across <SPAN
195 > upgrades easier.</P
198 Actions can be used to block anything you want, including ads, banners, or
199 just some obnoxious URL that you would rather not see. Cookies can be accepted
200 or rejected, or accepted only during the current browser session (i.e. not
201 written to disk), content can be modified, JavaScripts tamed, user-tracking
202 fooled, and much more. See below for a <A
203 HREF="actions-file.html#ACTIONS"
212 NAME="AEN1584">8.1. Finding the Right Mix</H2
215 HREF="actions-file.html#ACTIONS"
217 >, like cookie suppression
218 or script disabling, may render some sites unusable that rely on these
219 techniques to work properly. Finding the right mix of actions is not always easy and
220 certainly a matter of personal taste. In general, it can be said that the more
224 > your default settings (in the top section of the
225 actions file) are, the more exceptions for <SPAN
229 will have to make later. If, for example, you want to kill popup windows per
230 default, you'll have to make exceptions from that rule for sites that you
231 regularly use and that require popups for actually useful content, like maybe
232 your bank, favorite shop, or newspaper.</P
234 > We have tried to provide you with reasonable rules to start from in the
235 distribution actions files. But there is no general rule of thumb on these
236 things. There just are too many variables, and sites are constantly changing.
237 Sooner or later you will want to change the rules (and read this chapter again :).</P
244 NAME="AEN1591">8.2. How to Edit</H2
246 > The easiest way to edit the actions files is with a browser by
247 using our browser-based editor, which can be reached from <A
248 HREF="http://config.privoxy.org/show-status"
250 >http://config.privoxy.org/show-status</A
252 The editor allows both fine-grained control over every single feature on a
253 per-URL basis, and easy choosing from wholesale sets of defaults like
265 > If you prefer plain text editing to GUIs, you can of course also directly edit the
266 the actions files. Look at <TT
277 NAME="ACTIONS-APPLY">8.3. How Actions are Applied to URLs</H2
279 > Actions files are divided into sections. There are special sections,
283 HREF="actions-file.html#ALIASES"
286 > sections which will
287 be discussed later. For now let's concentrate on regular sections: They have a
288 heading line (often split up to multiple lines for readability) which consist
289 of a list of actions, separated by whitespace and enclosed in curly braces.
290 Below that, there is a list of URL patterns, each on a separate line.</P
292 > To determine which actions apply to a request, the URL of the request is
293 compared to all patterns in each action file file. Every time it matches, the list of
294 applicable actions for the URL is incrementally updated, using the heading
295 of the section in which the pattern is located. If multiple matches for
296 the same URL set the same action differently, the last match wins. If not,
297 the effects are aggregated. E.g. a URL might match a regular section with
298 a heading line of <TT
302 HREF="actions-file.html#HANDLE-AS-IMAGE"
307 then later another one with just <TT
311 HREF="actions-file.html#BLOCK"
322 > actions to apply.</P
324 > You can trace this process for any given URL by visiting <A
325 HREF="http://config.privoxy.org/show-url-info"
327 >http://config.privoxy.org/show-url-info</A
330 > More detail on this is provided in the Appendix, <A
331 HREF="appendix.html#ACTIONSANAT"
332 > Anatomy of an Action</A
340 NAME="AF-PATTERNS">8.4. Patterns</H2
342 > Generally, a pattern has the form <TT
344 ><domain>/<path></TT
348 ><domain></TT
353 are optional. (This is why the pattern <TT
356 > matches all URLs).</P
365 >www.example.com/</TT
369 > is a domain-only pattern and will match any request to <TT
373 regardless of which document on that server is requested.
383 > means exactly the same. For domain-only patterns, the trailing <TT
393 >www.example.com/index.html</TT
397 > matches only the single document <TT
414 > matches the document <TT
417 >, regardless of the domain,
434 > matches nothing, since it would be interpreted as a domain name and
435 there is no top-level domain called <TT
448 NAME="AEN1655">8.4.1. The Domain Pattern</H3
450 > The matching of the domain part offers some flexible options: if the
451 domain starts or ends with a dot, it becomes unanchored at that end.
465 > matches any domain that <SPAN
485 > matches any domain that <SPAN
505 > matches any domain that <SPAN
515 (Correctly speaking: It matches any FQDN that contains <TT
524 > Additionally, there are wild-cards that you can use in the domain names
525 themselves. They work pretty similar to shell wild-cards: <SPAN
529 stands for zero or more arbitrary characters, <SPAN
533 any single character, you can define character classes in square
534 brackets and all of that can be freely mixed:</P
549 >"adserver.example.com"</SPAN
553 >"ads.example.com"</SPAN
556 >"sfads.example.com"</SPAN
563 >*ad*.example.com</TT
567 > matches all of the above, and then some.
583 >pictures.epix.com</TT
586 >a.b.c.d.e.upix.com</TT
593 >www[1-9a-ez].example.c*</TT
599 >www1.example.com</TT
610 >wwwz.example.com</TT
620 >wwww.example.com</TT
632 NAME="AEN1717">8.4.2. The Path Pattern</H3
637 > uses Perl compatible regular expressions
639 HREF="http://www.pcre.org/"
643 matching the path.</P
646 HREF="appendix.html#REGEX"
648 > with a brief quick-start into regular
649 expressions, and full (very technical) documentation on PCRE regex syntax is available on-line
651 HREF="http://www.pcre.org/man.txt"
653 >http://www.pcre.org/man.txt</A
655 You might also find the Perl man page on regular expressions (<TT
659 useful, which is available on-line at <A
660 HREF="http://www.perldoc.com/perl5.6/pod/perlre.html"
662 >http://www.perldoc.com/perl5.6/pod/perlre.html</A
665 > Note that the path pattern is automatically left-anchored at the <SPAN
669 i.e. it matches as if it would start with a <SPAN
672 > (regular expression speak
673 for the beginning of a line).</P
675 > Please also note that matching in the path is <SPAN
682 by default, but you can switch to case sensitive at any point in the pattern by using the
688 >www.example.com/(?-i)PaTtErN.*</TT
690 only documents whose path starts with <TT
700 > this capitalization.</P
708 NAME="ACTIONS">8.5. Actions</H2
710 > All actions are disabled by default, until they are explicitly enabled
711 somewhere in an actions file. Actions are turned on if preceded with a
715 >, and turned off if preceded with a <SPAN
724 >"do that action"</SPAN
731 >"please block URLs that match the
732 following patterns"</SPAN
739 block URLs that match the following patterns, even if <TT
743 previously applied."</SPAN
747 Again, actions are invoked by placing them on a line, enclosed in curly braces and
748 separated by whitespace, like in
751 >{+some-action -some-other-action{some-parameter}}</TT
753 followed by a list of URL patterns, one per line, to which they apply.
754 Together, the actions line and the following pattern lines make up a section
755 of the actions file. </P
758 There are three classes of actions:</P
766 Boolean, i.e the action can only be <SPAN
789 > # enable action <TT
800 > # disable action <TT
822 Parameterized, where some value is required in order to enable this type of action.
844 >} # enable action and set parameter to <TT
850 # overwriting parameter from previous match if necessary
856 > # disable action. The parameter can be omitted</PRE
863 > Note that if the URL matches multiple positive forms of a parameterized action,
864 the last match wins, i.e. the params from earlier matches are simply ignored.
870 >+hide-user-agent{ Mozilla 1.0 }</TT
877 Multi-value. These look exactly like parameterized actions,
878 but they behave differently: If the action applies multiple times to the
879 same URL, but with different parameters, <SPAN
892 > matches are remembered. This is used for actions
893 that can be executed for the same request repeatedly, like adding multiple
894 headers, or filtering through multiple filters. Syntax:
915 >} # enable action and add <TT
920 > to the list of parameters
931 >} # remove the parameter <TT
936 > from the list of parameters
937 # If it was the last one left, disable the action.
943 > # disable this action completely and remove all parameters from the list</PRE
953 >+add-header{X-Fun-Header: Some text}</TT
957 >+filter{html-annoyances}</TT
964 > If nothing is specified in any actions file, no <SPAN
968 taken. So in this case <SPAN
972 normal, non-blocking, non-anonymizing proxy. You must specifically enable the
973 privacy and blocking features you need (although the provided default actions
974 files will give a good starting point).</P
976 > Later defined actions always over-ride earlier ones. So exceptions
977 to any rules you make, should come in the latter part of the file (or
978 in a file that is processed later when using multiple actions files). For
979 multi-valued actions, the actions are applied in the order they are specified.
980 Actions files are processed in the order they are defined in
984 > (the default installation has three actions
985 files). It also quite possible for any given URL pattern to match more than
986 one pattern and thus more than one set of actions!</P
988 > The list of valid <SPAN
997 NAME="ADD-HEADER">8.5.1. add-header</H4
1001 CLASS="VARIABLELIST"
1007 >Confuse log analysis, custom applications</P
1013 > Sends a user defined HTTP header to the web server.
1026 > Any string value is possible. Validity of the defined HTTP headers is not checked.
1027 It is recommended that you use the <SPAN
1041 > This action may be specified multiple times, in order to define multiple
1042 headers. This is rarely needed for the typical user. If you don't know what
1045 >"HTTP headers"</SPAN
1046 > are, you definitely don't need to worry about this
1062 >+add-header{X-User-Tracking: sucks}</PRE
1077 NAME="BLOCK">8.5.2. block</H4
1081 CLASS="VARIABLELIST"
1087 >Block ads or other obnoxious content</P
1093 > Requests for URLs to which this action applies are blocked, i.e. the requests are not
1094 forwarded to the remote server, but answered locally with a substitute page or image,
1095 as determined by the <TT
1098 HREF="actions-file.html#HANDLE-AS-IMAGE"
1105 HREF="actions-file.html#SET-IMAGE-BLOCKER"
1106 >set-image-blocker</A
1130 > sends a special <SPAN
1134 for requests to blocked pages. This page contains links to find out why the request
1135 was blocked, and a click-through to the blocked content (the latter only if compiled with the
1136 force feature enabled). The <SPAN
1139 > page adapts to the available
1140 screen space -- it displays full-blown if space allows, or miniaturized and text-only
1141 if loaded into a small frame or window. If you are using <SPAN
1145 right now, you can take a look at the
1147 HREF="http://ads.bannerserver.example.com/nasty-ads/sponsor.html"
1158 A very important exception occurs if <SPAN
1171 HREF="actions-file.html#HANDLE-AS-IMAGE"
1175 apply to the same request: it will then be replaced by an image. If
1179 HREF="actions-file.html#SET-IMAGE-BLOCKER"
1180 >set-image-blocker</A
1183 (see below) also applies, the type of image will be determined by its parameter,
1184 if not, the standard checkerboard pattern is sent.
1187 > It is important to understand this process, in order
1188 to understand how <SPAN
1192 ads and other unwanted content.
1198 HREF="actions-file.html#FILTER"
1202 action can perform a very similar task, by <SPAN
1206 banner images and other content through rewriting the relevant URLs in the
1207 document's HTML source, so they don't get requested in the first place.
1208 Note that this is a totally different technique, and it's easy to confuse the two.
1212 >Example usage (section):</DT
1223 >{+block} # Block and replace with "blocked" page
1224 .nasty-stuff.example.com
1226 {+block +handle-as-image} # Block and replace with image
1243 NAME="CRUNCH-INCOMING-COOKIES">8.5.3. crunch-incoming-cookies</H4
1247 CLASS="VARIABLELIST"
1253 > Prevent the web server from setting any cookies on your system
1262 >"Set-Cookie:"</SPAN
1263 > HTTP headers from server replies.
1283 > This action is only concerned with <SPAN
1300 HREF="actions-file.html#CRUNCH-OUTGOING-COOKIES"
1301 >crunch-outgoing-cookies</A
1310 > to disable cookies completely.
1319 > to use this action in conjunction
1323 HREF="actions-file.html#SESSION-COOKIES-ONLY"
1324 >session-cookies-only</A
1327 since it would prevent the session cookies from being set.
1342 >+crunch-incoming-cookies</PRE
1357 NAME="CRUNCH-OUTGOING-COOKIES">8.5.4. crunch-outgoing-cookies</H4
1361 CLASS="VARIABLELIST"
1367 > Prevent the web server from reading any cookies from your system
1377 > HTTP headers from client requests.
1397 > This action is only concerned with <SPAN
1414 HREF="actions-file.html#CRUNCH-INCOMING-COOKIES"
1415 >crunch-incoming-cookies</A
1424 > to disable cookies completely.
1433 > to use this action in conjunction
1437 HREF="actions-file.html#SESSION-COOKIES-ONLY"
1438 >session-cookies-only</A
1441 since it would prevent the session cookies from being read.
1456 >+crunch-outgoing-cookies</PRE
1471 NAME="DEANIMATE-GIFS">8.5.5. deanimate-gifs</H4
1475 CLASS="VARIABLELIST"
1481 >Stop those annoying, distracting animated GIF images.</P
1487 > De-animate GIF animations, i.e. reduce them to their first or last image.
1513 > This will also shrink the images considerably (in bytes, not pixels!). If
1517 > is given, the first frame of the animation
1518 is used as the replacement. If <SPAN
1521 > is given, the last
1522 frame of the animation is used instead, which probably makes more sense for
1523 most banner animations, but also has the risk of not showing the entire
1524 last frame (if it is only a delta to an earlier frame).
1527 > You can safely use this action with patterns that will also match non-GIF
1528 objects, because no attempt will be made at anything that doesn't look like
1544 >+deanimate-gifs{last}</PRE
1559 NAME="DOWNGRADE-HTTP-VERSION">8.5.6. downgrade-http-version</H4
1563 CLASS="VARIABLELIST"
1569 >Work around (very rare) problems with HTTP/1.1</P
1575 > Downgrades HTTP/1.1 client requests and server replies to HTTP/1.0.
1595 > This is a left-over from the time when <SPAN
1599 didn't support important HTTP/1.1 features well. It is left here for the
1600 unlikely case that you experience HTTP/1.1 related problems with some server
1601 out there. Not all (optional) HTTP/1.1 features are supported yet, so there
1602 is a chance you might need this action.
1606 >Example usage (section):</DT
1617 >{+downgrade-http-version}
1618 problem-host.example.com</PRE
1633 NAME="FAST-REDIRECTS">8.5.7. fast-redirects</H4
1637 CLASS="VARIABLELIST"
1643 >Fool some click-tracking scripts and speed up indirect links</P
1649 > Cut off all but the last valid URL from requests.
1670 Many sites, like yahoo.com, don't just link to other sites. Instead, they
1671 will link to some script on their own servers, giving the destination as a
1672 parameter, which will then redirect you to the final target. URLs
1673 resulting from this scheme typically look like:
1678 >http://some.place/click-tracker.cgi?target=http://some.where.else</I
1683 > Sometimes, there are even multiple consecutive redirects encoded in the
1684 URL. These redirections via scripts make your web browsing more traceable,
1685 since the server from which you follow such a link can see where you go
1686 to. Apart from that, valuable bandwidth and time is wasted, while your
1687 browser ask the server for one redirect after the other. Plus, it feeds
1691 > This feature is currently not very smart and is scheduled for improvement.
1692 It is likely to break some sites. You should expect to need possibly
1693 many exceptions to this action, if it is enabled by default in
1697 >. Some sites just don't work without
1713 >{+fast-redirects}</PRE
1728 NAME="FILTER">8.5.8. filter</H4
1732 CLASS="VARIABLELIST"
1738 >Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements, etc.</P
1744 > Text documents, including HTML and JavaScript, to which this action applies, are filtered on-the-fly
1745 through the specified regular expression based substitutions.
1758 > The name of a filter, as defined in the <A
1759 HREF="filter-file.html"
1769 HREF="config.html#FILTERFILE"
1783 > For your convenience, there are a bunch of pre-defined filters available
1784 in the distribution filter file that you can use. See the example below for
1788 > This is potentially a very powerful feature! But <SPAN
1790 >"rolling your own"</SPAN
1792 filters requires a knowledge of regular expressions and HTML.
1795 > Filtering requires buffering the page content, which may appear to
1796 slow down page rendering since nothing is displayed until all content has
1797 passed the filters. (It does not really take longer, but seems that way
1798 since the page is not incrementally displayed.) This effect will be more
1799 noticeable on slower connections.
1802 > At this time, <SPAN
1805 > cannot (yet!) uncompress compressed
1806 documents. If you want filtering to work on all documents, even those that
1807 would normally be sent compressed, use the
1811 HREF="actions-file.html#PREVENT-COMPRESSION"
1812 >prevent-compression</A
1815 action in conjunction with <TT
1821 > Filtering can achieve some of the effects as the
1825 HREF="actions-file.html#BLOCK"
1829 action, i.e. it can be used to block ads and banners.
1835 > with suggestions for new or improved filters is particularly
1840 >Example usage (with filters from the distribution <TT
1847 NAME="FILTER-HTML-ANNOYANCES"
1858 >+filter{html-annoyances} # Get rid of particularly annoying HTML abuse.</PRE
1866 NAME="FILTER-JS-ANNOYANCES"
1877 >+filter{js-annoyances} # Get rid of particularly annoying JavaScript abuse</PRE
1885 NAME="FILTER-BANNERS-BY-SIZE"
1896 >+filter{banners-by-size} # Kill banners by size (<SPAN
1910 NAME="FILTER-CONTENT-COOKIES"
1921 >+filter{content-cookies} # Kill cookies that come sneaking in the HTML or JS content</PRE
1929 NAME="FILTER-POPUPS"
1940 >+filter{popups} # Kill all popups in JS and HTML</PRE
1948 NAME="FILTER-WEBBUGS"
1959 >+filter{webbugs} # Squish WebBugs (1x1 invisible GIFs used for user tracking)</PRE
1978 >+filter{fun} # Text replacements for subversive browsing fun!</PRE
1986 NAME="FILTER-FRAMESET-BORDERS"
1997 >+filter{frameset-borders} # Give frames a border and make them resizeable</PRE
2005 NAME="FILTER-REFRESH-TAGS"
2016 >+filter{refresh-tags} # Kill automatic refresh tags (for dial-on-demand setups)</PRE
2035 >+filter{nimda} # Remove Nimda (virus) code.</PRE
2043 NAME="FILTER-SHOCKWAVE-FLASH"
2054 >+filter{shockwave-flash} # Kill embedded Shockwave Flash objects</PRE
2062 NAME="FILTER-CRUDE-PARENTAL"
2073 >+filter{crude-parental} # Kill all web pages that contain the words "sex" or "warez"</PRE
2088 NAME="HANDLE-AS-IMAGE">8.5.9. handle-as-image</H4
2092 CLASS="VARIABLELIST"
2098 >Mark URLs as belonging to images (so they'll be replaced by images <SPAN
2102 >if they get blocked</I
2110 > This action alone doesn't do anything noticeable. It just marks URLs as images.
2114 HREF="actions-file.html#BLOCK"
2124 the presence or absence of this mark decides whether an HTML <SPAN
2128 page, or a replacement image (as determined by the <TT
2131 HREF="actions-file.html#SET-IMAGE-BLOCKER"
2132 >set-image-blocker</A
2134 > action) will be sent to the
2135 client as a substitute for the blocked content.
2155 > The below generic example section is actually part of <TT
2159 It marks all URLs with well-known image file name extensions as images and should
2163 > Users will probably only want to use the handle-as-image action in conjunction with
2167 HREF="actions-file.html#BLOCK"
2170 >, to block sources of banners, whose URLs don't
2171 reflect the file type, like in the second example section.
2174 > Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad
2175 frames require an HTML page to be sent, or they won't display properly.
2178 >handle-as-image</TT
2179 > in this situation will not replace the
2180 ad frame with an image, but lead to error messages.
2184 >Example usage (sections):</DT
2195 ># Generic image extensions:
2198 /.*\.(gif|jpg|jpeg|png|bmp|ico)$
2200 # These don't look like images, but they're banners and should be
2201 # blocked as images:
2203 {+block +handle-as-image}
2204 some.nasty-banner-server.com/junk.cgi?output=trash
2206 # Banner source! Who cares if they also have non-image content?
2207 ad.doubleclick.net </PRE
2222 NAME="HIDE-FORWARDED-FOR-HEADERS">8.5.10. hide-forwarded-for-headers</H4
2226 CLASS="VARIABLELIST"
2232 >Improve privacy by hiding the true source of the request</P
2238 > Deletes any existing <SPAN
2240 >"X-Forwarded-for:"</SPAN
2241 > HTTP header from client requests,
2242 and prevents adding a new one.
2262 > It is fairly safe to leave this on.
2265 > This action is scheduled for improvement: It should be able to generate forged
2268 >"X-Forwarded-for:"</SPAN
2269 > headers using random IP addresses from a specified network,
2270 to make successive requests from the same client look like requests from a pool of different
2271 users sharing the same proxy.
2286 >+hide-forwarded-for-headers</PRE
2301 NAME="HIDE-FROM-HEADER">8.5.11. hide-from-header</H4
2305 CLASS="VARIABLELIST"
2311 >Keep your (old and ill) browser from telling web servers your email address</P
2317 > Deletes any existing <SPAN
2320 > HTTP header, or replaces it with the
2337 >, or any user defined value.
2347 > will completely remove the header
2348 (not to be confused with the <TT
2351 HREF="actions-file.html#BLOCK"
2358 > Alternately, you can specify any value you prefer to be sent to the web
2359 server. If you do, it is a matter of fairness not to use any address that
2360 is actually used by a real person.
2363 > This action is rarely needed, as modern web browsers don't send
2382 >+hide-from-header{block}</PRE
2395 >+hide-from-header{spam-me-senseless@sittingduck.example.com}</PRE
2410 NAME="HIDE-REFERRER">8.5.12. hide-referrer</H4
2417 CLASS="VARIABLELIST"
2423 >Conceal which link you followed to get to a particular site</P
2432 > (sic) HTTP header from the client request,
2433 or replaces it with a forged one.
2453 > to delete the header completely.</P
2460 > to pretend to be coming from the homepage of the server we are talking to.</P
2464 >Any other string to set a user defined referrer.</P
2475 > is the preferred option here, since some servers will
2476 not send images back otherwise, in an attempt to prevent their valuable
2477 content from being embedded elsewhere (and hence, without being surrounded
2491 > is an alternate spelling of
2495 > and the two can be can be freely
2496 substituted with each other. (<SPAN
2500 correct English spelling, however the HTTP specification has a bug - it
2501 requires it to be spelled as <SPAN
2519 >+hide-referrer{forge}</PRE
2532 >+hide-referrer{http://www.yahoo.com/}</PRE
2547 NAME="HIDE-USER-AGENT">8.5.13. hide-user-agent</H4
2551 CLASS="VARIABLELIST"
2557 >Conceal your type of browser and client operating system</P
2563 > Replaces the value of the <SPAN
2565 >"User-Agent:"</SPAN
2567 in client requests with the specified value.
2580 > Any user-defined string.
2605 > This breaks many web sites that depend on looking at this header in order
2606 to customize their content for different browsers (which, by the
2614 HREF="http://www.javascriptkit.com/javaindex.shtml"
2625 > Using this action in multi-user setups or wherever different types of
2626 browsers will access the same <SPAN
2636 >. In single-user, single-browser
2637 setups, you might use it to delete your OS version information from
2638 the headers, because it is an invitation to exploit known bugs for your
2639 OS. It is also occasionally useful to forge this in order to access
2640 sites that won't let you in otherwise (though there may be a good
2641 reason in some cases). Example of this: some MSN sites will not
2645 > enter, yet forging to a
2649 > user-agent works just fine.
2650 (Must be just a silly MS goof, I'm sure :-).
2653 > This action is scheduled for improvement.
2668 >+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}</PRE
2683 NAME="KILL-POPUPS">8.5.14. kill-popups<A
2690 CLASS="VARIABLELIST"
2696 >Eliminate those annoying pop-up windows</P
2702 > While loading the document, replace JavaScript code that opens
2703 pop-up windows with (syntactically neutral) dummy code on the fly.
2723 > This action is easily confused with the built-in, hardwired <TT
2726 HREF="actions-file.html#FILTER"
2730 action, but there are important differences: For <TT
2734 the document need not be buffered, so it can be incrementally rendered while
2735 downloading. But <TT
2738 > doesn't catch as many pop-ups as
2742 HREF="actions-file.html#FILTER"
2754 > Think of it as a fast and efficient replacement for a filter that you
2755 can use if you don't want any filtering at all. Note that it doesn't make
2756 sense to combine it with any <TT
2759 HREF="actions-file.html#FILTER"
2763 since as soon as one <TT
2766 HREF="actions-file.html#FILTER"
2770 the whole document needs to be buffered anyway, which destroys the advantage of
2774 > action over its filter equivalent.
2777 > Killing all pop-ups is a dangerous business. Many shops and banks rely on
2778 pop-ups to display forms, shopping carts etc, and killing only the unwanted pop-ups
2779 would require artificial intelligence in <SPAN
2783 If the only kind of pop-ups that you want to kill are exit consoles (those
2790 > windows that appear when you close an other
2791 one), you might want to use
2795 HREF="actions-file.html#FILTER"
2833 NAME="LIMIT-CONNECT">8.5.15. limit-connect</H4
2837 CLASS="VARIABLELIST"
2843 >Prevent abuse of <SPAN
2846 > as a TCP proxy relay</P
2852 > Specifies to which ports HTTP CONNECT requests are allowable.
2865 > A comma-separated list of ports or port ranges (the latter using dashes, with the minimum
2866 defaulting to 0 and the maximum to 65K).
2873 > By default, i.e. if no <TT
2880 > only allows HTTP CONNECT
2881 requests to port 443 (the standard, secure HTTPS port). Use
2885 > if more fine-grained control is desired
2886 for some or all destinations.
2889 > The CONNECT methods exists in HTTP to allow access to secure websites
2893 > URLs) through proxies. It works very simply:
2894 the proxy connects to the server on the specified port, and then
2895 short-circuits its connections to the client and to the remote server.
2896 This can be a big security hole, since CONNECT-enabled proxies can be
2897 abused as TCP relays very easily.
2900 > If you don't know what any of this means, there probably is no reason to
2901 change this one, since the default is already very restrictive.
2905 >Example usages:</DT
2916 >+limit-connect{443} # This is the default and need not be specified.
2917 +limit-connect{80,443} # Ports 80 and 443 are OK.
2918 +limit-connect{-3, 7, 20-100, 500-} # Ports less than 3, 7, 20 to 100 and above 500 are OK.
2919 +limit-connect{-} # All ports are OK (gaping security hole!)</PRE
2934 NAME="PREVENT-COMPRESSION">8.5.16. prevent-compression</H4
2938 CLASS="VARIABLELIST"
2944 > Ensure that servers send the content uncompressed, so it can be
2948 HREF="actions-file.html#FILTER"
2958 > Adds a header to the request that asks for uncompressed transfer.
2978 > More and more websites send their content compressed by default, which
2979 is generally a good idea and saves bandwidth. But for the <TT
2982 HREF="actions-file.html#FILTER"
2988 HREF="actions-file.html#DEANIMATE-GIFS"
2995 HREF="actions-file.html#KILL-POPUPS"
3002 > needs access to the uncompressed data.
3003 Unfortunately, <SPAN
3006 > can't yet(!) uncompress, filter, and
3007 re-compress the content on the fly. So if you want to ensure that all websites, including
3008 those that normally compress, can be filtered, you need to use this action.
3011 > This will slow down transfers from those websites, though. If you use any of the above-mentioned
3012 actions, you will typically want to use <TT
3014 >prevent-compression</TT
3019 > Note that some (rare) ill-configured sites don't handle requests for uncompressed
3020 documents correctly (they send an empty document body). If you use <TT
3022 >prevent-compression</TT
3024 per default, you'll have to add exceptions for those sites. See the example for how to do that.
3028 >Example usage (sections):</DT
3041 {+prevent-compression}
3044 # Make exceptions for ill sites:
3046 {-prevent-compression}
3048 www.pclinuxonline.com</PRE
3063 NAME="SEND-VANILLA-WAFER">8.5.17. send-vanilla-wafer</H4
3067 CLASS="VARIABLELIST"
3073 > Feed log analysis scripts with useless data.
3080 > Sends a cookie with each request stating that you do not accept any copyright
3081 on cookies sent to you, and asking the site operator not to track you.
3101 > The vanilla wafer is a (relatively) unique header and could conceivably be used to track you.
3104 > This action is rarely used and not enabled in the default configuration.
3119 >+send-vanilla-wafer</PRE
3134 NAME="SEND-WAFER">8.5.18. send-wafer</H4
3138 CLASS="VARIABLELIST"
3144 > Send custom cookies or feed log analysis scripts with even more useless data.
3151 > Sends a custom, user-defined cookie with each request.
3164 > A string of the form <SPAN
3184 > Being multi-valued, multiple instances of this action can apply to the same request,
3185 resulting in multiple cookies being sent.
3188 > This action is rarely used and not enabled in the default configuration.
3192 >Example usage (section):</DT
3203 >{+send-wafer{UsingPrivoxy=true}}
3204 my-internal-testing-server.void</PRE
3219 NAME="SESSION-COOKIES-ONLY">8.5.19. session-cookies-only</H4
3223 CLASS="VARIABLELIST"
3229 > Allow only temporary <SPAN
3232 > cookies (for the current browser session <SPAN
3250 >"Set-Cookie:"</SPAN
3252 Most browsers will not store such cookies permanently and forget them in between sessions.
3272 > This is less strict than <TT
3275 HREF="actions-file.html#CRUNCH-INCOMING-COOKIES"
3276 >crunch-incoming-cookies</A
3282 HREF="actions-file.html#CRUNCH-OUTGOING-COOKIES"
3283 >crunch-outgoing-cookies</A
3285 > and allows you to browse
3286 websites that insist or rely on setting cookies, without compromising your privacy too badly.
3289 > Most browsers will not permanently store cookies that have been processed by
3292 >session-cookies-only</TT
3293 > and will forget about them between sessions.
3294 This makes profiling cookies useless, but won't break sites which require cookies so
3295 that you can log in for transactions. This is generally turned on for all
3296 sites, and is the recommended setting.
3307 >session-cookies-only</TT
3312 HREF="actions-file.html#CRUNCH-INCOMING-COOKIES"
3313 >crunch-incoming-cookies</A
3319 HREF="actions-file.html#CRUNCH-OUTGOING-COOKIES"
3320 >crunch-outgoing-cookies</A
3322 >. If you do, cookies
3323 will be plainly killed.
3326 > Note that it is up to the browser how it handles such cookies without an <SPAN
3330 field. If you use an exotic browser, you might want to try it out to be sure.
3345 >+session-cookies-only</PRE
3360 NAME="SET-IMAGE-BLOCKER">8.5.20. set-image-blocker</H4
3364 CLASS="VARIABLELIST"
3370 >Choose the replacement for blocked images</P
3376 > This action alone doesn't do anything noticeable. If <SPAN
3386 HREF="actions-file.html#BLOCK"
3398 HREF="actions-file.html#HANDLE-AS-IMAGE"
3408 apply, i.e. if the request is to be blocked as an image,
3415 > the parameter of this action decides what will be
3416 sent as a replacement.
3436 > to send a built-in checkerboard pattern image. The image is visually
3437 decent, scales very well, and makes it obvious where banners were busted.
3445 > to send a built-in transparent image. This makes banners disappear
3446 completely, but makes it hard to detect where <SPAN
3450 images on a given page and complicates troubleshooting if <SPAN
3454 has blocked innocent images, like navigation icons.
3468 send a redirect to <TT
3474 to any image anywhere, even in your local filesystem (via <SPAN
3480 > A good application of redirects is to use special <SPAN
3484 URLs, which send the built-in images, as <TT
3490 This has the same visual effect as specifying <SPAN
3497 the first place, but enables your browser to cache the replacement image, instead of requesting
3498 it over and over again.
3507 > The URLs for the built-in images are <SPAN
3509 >"http://config.privoxy.org/send-banner?type=<TT
3530 > There is a third (advanced) type, called <SPAN
3542 >set-image-blocker</TT
3543 >, but meant for use from <A
3544 HREF="filter-file.html"
3547 Auto will select the type of image that would have applied to the referring page, had it been an image.
3565 >+set-image-blocker{pattern}</PRE
3572 > Redirect to the BSD devil:
3583 >+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</PRE
3590 > Redirect to the built-in pattern for better caching:
3601 >+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</PRE
3616 NAME="AEN2631">8.5.21. Summary</H3
3618 > Note that many of these actions have the potential to cause a page to
3619 misbehave, possibly even not to display at all. There are many ways
3620 a site designer may choose to design his site, and what HTTP header
3621 content, and other criteria, he may depend on. There is no way to have hard
3622 and fast rules for all sites. See the <A
3623 HREF="appendix.html#ACTIONSANAT"
3625 > for a brief example on troubleshooting
3634 NAME="ALIASES">8.6. Aliases</H2
3646 >, can be defined by combining other actions.
3647 These can in turn be invoked just like the built-in actions.
3648 Currently, an alias name can contain any character except space, tab,
3666 > that you only use <SPAN
3686 Alias names are not case sensitive, and are not required to start with a
3693 > sign, since they are merely textually
3696 > Aliases can be used throughout the actions file, but they <SPAN
3701 defined in a special section at the top of the file!</I
3704 And there can only be one such section per actions file. Each actions file may
3705 have its own alias section, and the aliases defined in it are only visible
3706 within that file.</P
3708 > There are two main reasons to use aliases: One is to save typing for frequently
3709 used combinations of actions, the other one is a gain in flexibility: If you
3710 decide once how you want to handle shops by defining an alias called
3714 >, you can later change your policy on shops in
3721 > place, and your changes will take effect everywhere
3722 in the actions file where the <SPAN
3725 > alias is used. Calling aliases
3726 by their purpose also makes your actions files more readable.</P
3728 > Currently, there is one big drawback to using aliases, though:
3732 >'s built-in web-based action file
3733 editor honors aliases when reading the actions files, but it expands
3734 them before writing. So the effects of your aliases are of course preserved,
3735 but the aliases themselves are lost when you edit sections that use aliases
3737 This is likely to change in future versions of <SPAN
3742 > Now let's define some aliases...</P
3752 > # Useful custom aliases we can use later.
3754 # Note the (required!) section header line and that this section
3755 # must be at the top of the actions file!
3759 # These aliases just save typing later:
3760 # (Note that some already use other aliases!)
3762 +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
3763 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
3764 block-as-image = +block +handle-as-image
3765 mercy-for-cookies = -crunch-all-cookies -session-cookies-only
3767 # These aliases define combinations of actions
3768 # that are useful for certain types of sites:
3770 fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups
3771 shop = -crunch-all-cookies -filter{popups} -kill-popups
3773 # Short names for other aliases, for really lazy people ;-)
3775 c0 = +crunch-all-cookies
3776 c1 = -crunch-all-cookies</PRE
3782 > ...and put them to use. These sections would appear in the lower part of an
3783 actions file and define exceptions to the default actions (as specified further
3797 > # These sites are either very complex or very keen on
3798 # user data and require minimal interference to work:
3801 .office.microsoft.com
3802 .windowsupdate.microsoft.com
3806 # Allow cookies (for setting and retrieving your customer data)
3810 .worldpay.com # for quietpc.com
3813 # These shops require pop-ups:
3815 {shop -kill-popups -filter{popups}}
3817 .overclockers.co.uk</PRE
3823 > Aliases like <SPAN
3829 > are often used for
3833 > sites that require some actions to be disabled
3834 in order to function properly.</P
3841 NAME="ACT-EXAMPLES">8.7. Actions Files Tutorial</H2
3843 > The above chapters have shown <A
3844 HREF="actions-file.html"
3845 >which actions files
3846 there are and how they are organized</A
3847 >, how actions are <A
3848 HREF="actions-file.html#ACTIONS"
3851 HREF="actions-file.html#ACTIONS-APPLY"
3855 HREF="actions-file.html#AF-PATTERNS"
3859 HREF="actions-file.html#ALIASES"
3861 >. Now, let's look at an
3869 file and see how all these pieces come together:</P
3875 NAME="AEN2683">8.7.1. default.action</H3
3877 >Every config file should start with a short comment stating its purpose:</P
3887 ># Sample default.action file <developers@privoxy.org></PRE
3893 >Then, since this is the <TT
3897 first section is a special section for internal use that you needn't
3898 change or worry about:</P
3908 >##########################################################################
3909 # Settings -- Don't change! For internal Privoxy use ONLY.
3910 ##########################################################################
3913 for-privoxy-version=3.0</PRE
3919 >After that comes the (optional) alias section. We'll use the example
3920 section from the above <A
3921 HREF="actions-file.html#ALIASES"
3922 >chapter on aliases</A
3924 that also explains why and how aliases are used:</P
3934 >##########################################################################
3936 ##########################################################################
3939 # These aliases just save typing later:
3940 # (Note that some already use other aliases!)
3942 +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
3943 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
3944 block-as-image = +block +handle-as-image
3945 mercy-for-cookies = -crunch-all-cookies -session-cookies-only
3947 # These aliases define combinations of actions
3948 # that are useful for certain types of sites:
3950 fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups
3951 shop = mercy-for-cookies -filter{popups} -kill-popups</PRE
3957 > Now come the regular sections, i.e. sets of actions, accompanied
3958 by URL patterns to which they apply. Remember <SPAN
3963 are disabled when matching starts</I
3965 >, so we have to explicitly
3966 enable the ones we want.</P
3968 > The first regular section is probably the most important. It has only
3977 HREF="actions-file.html#AF-PATTERNS"
3978 >matches all URLs</A
3980 set of actions used in this <SPAN
3988 be applied to all requests as a start</I
3990 >. It can be partly or
3991 wholly overridden by later matches further down this file, or in user.action,
3992 but it will still be largely responsible for your overall browsing
3995 > Again, at the start of matching, all actions are disabled, so there is
3996 no real need to disable any actions here, but we will do that nonetheless,
3997 to have a complete listing for your reference. (Remember: a <SPAN
4001 preceding the action name enables the action, a <SPAN
4005 Also note how this long line has been made more readable by splitting it into
4006 multiple lines with line continuation.</P
4016 >##########################################################################
4017 # "Defaults" section:
4018 ##########################################################################
4021 HREF="actions-file.html#ADD-HEADER"
4025 HREF="actions-file.html#BLOCK"
4029 HREF="actions-file.html#CRUNCH-INCOMING-COOKIES"
4030 >crunch-incoming-cookies</A
4033 HREF="actions-file.html#CRUNCH-OUTGOING-COOKIES"
4034 >crunch-outgoing-cookies</A
4037 HREF="actions-file.html#DEANIMATE-GIFS"
4041 HREF="actions-file.html#DOWNGRADE-HTTP-VERSION"
4042 >downgrade-http-version</A
4045 HREF="actions-file.html#FAST-REDIRECTS"
4049 HREF="actions-file.html#FILTER-HTML-ANNOYANCES"
4050 >filter{html-annoyances}</A
4053 HREF="actions-file.html#FILTER-JS-ANNOYANCES"
4054 >filter{js-annoyances}</A
4057 HREF="actions-file.html#FILTER-CONTENT-COOKIES"
4058 >filter{content-cookies}</A
4061 HREF="actions-file.html#FILTER-POPUPS"
4065 HREF="actions-file.html#FILTER-WEBBUGS"
4069 HREF="actions-file.html#FILTER-REFRESH-TAGS"
4070 >filter{refresh-tags}</A
4073 HREF="actions-file.html#FILTER-FUN"
4077 HREF="actions-file.html#FILTER-NIMDA"
4081 HREF="actions-file.html#FILTER-BANNERS-BY-SIZE"
4082 >filter{banners-by-size}</A
4085 HREF="actions-file.html#FILTER-SHOCKWAVE-FLASH"
4086 >filter{shockwave-flash}</A
4089 HREF="actions-file.html#FILTER-CRUDE-PARENTAL"
4090 >filter{crude-parental}</A
4093 HREF="actions-file.html#HANDLE-AS-IMAGE"
4097 HREF="actions-file.html#HIDE-FORWARDED-FOR-HEADERS"
4098 >hide-forwarded-for-headers</A
4101 HREF="actions-file.html#HIDE-FROM-HEADER"
4102 >hide-from-header{block}</A
4105 HREF="actions-file.html#HIDE-REFERER"
4106 >hide-referrer{forge}</A
4109 HREF="actions-file.html#HIDE-USER-AGENT"
4113 HREF="actions-file.html#KILL-POPUPS"
4117 HREF="actions-file.html#LIMIT-CONNECT"
4121 HREF="actions-file.html#PREVENT-COMPRESSION"
4122 >prevent-compression</A
4125 HREF="actions-file.html#SEND-VANILLA-WAFER"
4126 >send-vanilla-wafer</A
4129 HREF="actions-file.html#SEND-WAFER"
4133 HREF="actions-file.html#SESSION-COOKIES-ONLY"
4134 >session-cookies-only</A
4137 HREF="actions-file.html#SET-IMAGE-BLOCKER"
4138 >set-image-blocker{pattern}</A
4141 / # forward slash will match *all* potential URL patterns.</PRE
4147 > The default behavior is now set. Note that some actions, like not hiding
4148 the user agent, are part of a <SPAN
4150 >"general policy"</SPAN
4152 universally and won't get any exceptions defined later. Other choices,
4153 like not blocking (which is <SPAN
4160 default!) need exceptions, i.e. we need to specify explicitly what we
4161 want to block in later sections.
4162 We will also want to make exceptions from our general pop-up-killing,
4163 and use our defined aliases for that.</P
4165 > The first of our specialized sections is concerned with <SPAN
4169 sites, i.e. sites that require minimum interference, because they are either
4170 very complex or very keen on tracking you (and have mechanisms in place that
4171 make them unusable for people who avoid being tracked). We will simply use
4175 > alias instead of stating the list
4176 of actions explicitly:</P
4186 >##########################################################################
4187 # Exceptions for sites that'll break under the default action set:
4188 ##########################################################################
4190 # "Fragile" Use a minimum set of actions for these sites (see alias above):
4193 .office.microsoft.com # surprise, surprise!
4194 .windowsupdate.microsoft.com</PRE
4200 > Shopping sites are not as fragile, but they typically
4201 require cookies to log in, and pop-up windows for shopping
4202 carts or item details. Again, we'll use a pre-defined alias:</P
4216 .worldpay.com # for quietpc.com
4224 > Then, there are sites which rely on pop-up windows (yuck!) to work.
4225 Since we made pop-up-killing our default above, we need to make exceptions
4227 HREF="http://www.mozilla.org/"
4231 can turn on smart handling of unwanted pop-ups in their browsers, can
4236 HREF="actions-file.html#FILTER-POPUPS"
4243 HREF="actions-file.html#KILL-POPUPS"
4247 and hence don't need this section. Anyway, disabling an already disabled
4248 action doesn't hurt, so we'll define our exceptions regardless of what was
4249 chosen in the defaults section:</P
4259 ># These sites require pop-ups too :(
4262 HREF="actions-file.html#KILL-POPUPS"
4265 HREF="actions-file.html#FILTER-POPUPS"
4270 .deutsche-bank-24.de</PRE
4279 HREF="actions-file.html#FAST-REDIRECTS"
4283 action, which we enabled per default above, breaks some sites. So disable
4284 it for popular sites where we know it misbehaves:</P
4295 HREF="actions-file.html#FAST-REDIRECTS"
4301 .altavista.com/.*(like|url|link):http
4302 .altavista.com/trans.*urltext=http
4309 > It is important that <SPAN
4313 URLs belong to images, so that <SPAN
4320 be blocked, a substitute image can be sent, rather than an HTML page.
4321 Contacting the remote site to find out is not an option, since it
4322 would destroy the loading time advantage of banner blocking, and it
4323 would feed the advertisers (in terms of money <SPAN
4330 information). We can mark any URL as an image with the <TT
4333 HREF="actions-file.html#HANDLE-AS-IMAGE"
4337 and marking all URLs that end in a known image file extension is a
4348 >##########################################################################
4350 ##########################################################################
4352 # Define which file types will be treated as images, in case they get
4353 # blocked further down this file:
4356 HREF="actions-file.html#HANDLE-AS-IMAGE"
4359 /.*\.(gif|jpe?g|png|bmp|ico)$</PRE
4365 > And then there are known banner sources. They often use scripts to
4366 generate the banners, so it won't be visible from the URL that the
4367 request is for an image. Hence we block them <SPAN
4374 mark them as images in one go, with the help of our
4378 > alias defined above. (We could of
4379 course just as well use <TT
4382 HREF="actions-file.html#BLOCK"
4386 HREF="actions-file.html#HANDLE-AS-IMAGE"
4390 Remember that the type of the replacement image is chosen by the
4394 HREF="actions-file.html#SET-IMAGE-BLOCKER"
4395 >set-image-blocker</A
4398 action. Since all URLs have matched the default section with its
4402 HREF="actions-file.html#SET-IMAGE-BLOCKER"
4403 >set-image-blocker</A
4406 action before, it still applies and needn't be repeated:</P
4416 ># Known ad generators:
4421 .ad.*.doubleclick.net
4422 .a.yimg.com/(?:(?!/i/).)*$
4423 .a[0-9].yimg.com/(?:(?!/i/).)*$
4432 > One of the most important jobs of <SPAN
4436 is to block banners. A huge bunch of them are already <SPAN
4443 HREF="actions-file.html#FILTER"
4445 >{banners-by-size}</TT
4447 action, which we enabled above, and which deletes the references to banner
4448 images from the pages while they are loaded, so the browser doesn't request
4449 them anymore, and hence they don't need to be blocked here. But this naturally
4450 doesn't catch all banners, and some people choose not to use filters, so we
4451 need a comprehensive list of patterns for banner URLs here, and apply the
4455 HREF="actions-file.html#BLOCK"
4458 > action to them.</P
4460 > First comes a bunch of generic patterns, which do most of the work, by
4461 matching typical domain and path name components of banners. Then comes
4462 a list of individual patterns for specific sites, which is omitted here
4463 to keep the example short:</P
4473 >##########################################################################
4474 # Block these fine banners:
4475 ##########################################################################
4477 HREF="actions-file.html#BLOCK"
4487 /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
4488 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/
4490 # Site-specific patterns (abbreviated):
4498 > You wouldn't believe how many advertisers actually call their banner
4504 >.com, or call the directory
4505 in which the banners are stored simply <SPAN
4509 generic patterns are surprisingly effective.</P
4511 > But being very generic, they necessarily also catch URLs that we don't want
4512 to block. The pattern <TT
4524 >.nasty-corp.com"</SPAN
4534 >.sourcefroge.net"</SPAN
4544 >l.some-provider.net."</SPAN
4546 well-known exceptions to the <TT
4549 HREF="actions-file.html#BLOCK"
4555 > Note that these are exceptions to exceptions from the default! Consider the URL
4558 >"downloads.sourcefroge.net"</SPAN
4559 >: Initially, all actions are deactivated,
4560 so it wouldn't get blocked. Then comes the defaults section, which matches the
4561 URL, but just deactivates the <TT
4564 HREF="actions-file.html#BLOCK"
4568 action once again. Then it matches <TT
4571 >, an exception to the
4572 general non-blocking policy, and suddenly
4576 HREF="actions-file.html#BLOCK"
4579 > applies. And now, it'll match
4586 HREF="actions-file.html#BLOCK"
4590 applies, so (unless it matches <SPAN
4596 > further down) it ends up
4600 HREF="actions-file.html#BLOCK"
4603 > action applying.</P
4613 >##########################################################################
4614 # Save some innocent victims of the above generic block patterns:
4615 ##########################################################################
4620 HREF="actions-file.html#BLOCK"
4623 adv[io]*. # (for advogato.org and advice.*)
4624 adsl. # (has nothing to do with ads)
4625 ad[ud]*. # (adult.* and add.*)
4626 .edu # (universities don't host banners (yet!))
4627 .*loads. # (downloads, uploads etc)
4635 www.globalintersec.com/adv # (adv = advanced)
4636 www.ugu.com/sui/ugu/adv</PRE
4642 > Filtering source code can have nasty side effects,
4643 so make an exception for our friends at sourceforge.net,
4644 and all paths with <SPAN
4647 > in them. Note that
4651 HREF="actions-file.html#FILTER"
4661 > filters in one fell swoop!</P
4671 ># Don't filter code!
4674 HREF="actions-file.html#FILTER"
4678 .sourceforge.net</PRE
4688 comprehensive, but we hope this example made clear how it works.</P
4695 NAME="AEN2837">8.7.2. user.action</H3
4697 > So far we are painting with a broad brush by setting general policies,
4698 which would be a reasonable starting point for many people. Now,
4699 you might want to be more specific and have customized rules that
4700 are more suitable to your personal habits and preferences. These would
4701 be for narrowly defined situations like your ISP or your bank, and should
4705 >, which is parsed after all other
4706 actions files and hence has the last word, over-riding any previously
4707 defined actions. <TT
4717 > place for your personal settings, since
4721 > is actively maintained by the
4725 > developers and you'll probably want
4726 to install updated versions from time to time.</P
4728 > So let's look at a few examples of things that one might typically do in
4742 ># My user.action file. <fred@foobar.com></PRE
4749 HREF="actions-file.html#ALIASES"
4751 > are local to the actions
4752 file that they are defined in, you can't use the ones from
4756 >, unless you repeat them here:</P
4766 ># (Re-)define aliases for this file:
4769 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
4770 mercy-for-cookies = -crunch-all-cookies -session-cookies-only
4771 fragile = -block -crunch-all-cookies -filter -fast-redirects -hide-referer -kill-popups
4772 shop = mercy-for-cookies -filter{popups} -kill-popups
4773 allow-ads = -block -filter{banners-by-size} # (see below)</PRE
4780 > Say you have accounts on some sites that you visit regularly, and
4781 you don't want to have to log in manually each time. So you'd like
4782 to allow persistent cookies for these sites. The
4785 >mercy-for-cookies</TT
4786 > alias defined above does exactly
4787 that, i.e. it disables crunching of cookies in any direction, and
4788 processing of cookies to make them temporary.</P
4798 >{ mercy-for-cookies }
4809 > Your bank needs popups and is allergic to some filter, but you don't
4810 know which, so you disable them all:</P
4821 HREF="actions-file.html#FILTER"
4824 HREF="actions-file.html#KILL-POPUPS"
4827 .your-home-banking-site.com</PRE
4833 > While browsing the web with <SPAN
4837 noticed some ads that sneaked through, but you were too lazy to
4838 report them through our fine and easy <A
4842 system, so you have added them here:</P
4853 HREF="actions-file.html#BLOCK"
4856 www.a-popular-site.com/some/unobvious/path
4857 another.popular.site.net/more/junk/here/</PRE
4863 > Note that, assuming the banners in the above example have regular image
4864 extensions (most do),
4868 HREF="actions-file.html#HANDLE-AS-IMAGE"
4872 need not be specified, since all URLs ending in these extensions will
4873 already have been tagged as images in the relevant section of
4879 > Then you noticed that the default configuration breaks Forbes Magazine,
4880 but you were too lazy to find out which action is the culprit, and you
4881 were again too lazy to give <A
4885 you just used the <TT
4888 > alias on the site, and
4889 -- whoa! -- it worked:</P
4906 > You like the <SPAN
4909 > text replacements in <TT
4913 but it is disabled in the distributed actions file. (My colleagues on the team just
4914 don't have a sense of humour, that's why! ;-). So you'd like to turn it on in your private,
4915 update-safe config, once and for all:</P
4926 HREF="actions-file.html#FILTER-FUN"
4929 / # For ALL sites!</PRE
4935 > Note that the above is not really a good idea: There are exceptions
4936 to the filters in <TT
4940 really shouldn't be filtered, like code on CVS->Web interfaces. Since
4944 > has the last word, these exceptions
4945 won't be valid for the <SPAN
4948 > filtering specified here.</P
4950 > Finally, you might think about how your favourite free websites are
4951 funded, and find that they rely on displaying banner advertisements
4952 to survive. So you might want to specifically allow banners for those
4953 sites that you feel provide value to you:</P
4975 > has been aliased to
4979 HREF="actions-file.html#BLOCK"
4986 HREF="actions-file.html#FILTER-BANNERS-BY-SIZE"
4987 >filter{banners-by-size}</A
4999 SUMMARY="Footer navigation table"
5028 HREF="filter-file.html"
5038 >The Main Configuration File</TD
5048 >The Filter File</TD