doc/webserver/user-manual/actions-file.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
   2 "http://www.w3.org/TR/html4/loose.dtd">
   3 <html>
   4 <head>
   5   <title>Actions Files</title>
   6   <meta name="GENERATOR" content="Modular DocBook HTML Stylesheet Version 1.79">
   7   <link rel="HOME" title="Privoxy 3.0.27 User Manual" href="index.html">
   8   <link rel="PREVIOUS" title="The Main Configuration File" href="config.html">
   9   <link rel="NEXT" title="Filter Files" href="filter-file.html">
  10   <link rel="STYLESHEET" type="text/css" href="../p_doc.css">
  11   <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  12   <link rel="STYLESHEET" type="text/css" href="p_doc.css">
  13 </head>
  14 <body class="SECT1" bgcolor="#EEEEEE" text="#000000" link="#0000FF" vlink="#840084" alink="#0000FF">
  15   <div class="NAVHEADER">
  16     <table summary="Header navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
  17       <tr>
  18         <th colspan="3" align="center">Privoxy 3.0.27 User Manual</th>
  19       </tr>
  20       <tr>
  21         <td width="10%" align="left" valign="bottom"><a href="config.html" accesskey="P">Prev</a></td>
  22         <td width="80%" align="center" valign="bottom"></td>
  23         <td width="10%" align="right" valign="bottom"><a href="filter-file.html" accesskey="N">Next</a></td>
  24       </tr>
  25     </table>
  26     <hr align="left" width="100%">
  27   </div>
  28   <div class="SECT1">
  29     <h1 class="SECT1"><a name="ACTIONS-FILE" id="ACTIONS-FILE">8. Actions Files</a></h1>
  30     <p>The actions files are used to define what <span class="emphasis"><i class="EMPHASIS">actions</i></span>
  31     <span class="APPLICATION">Privoxy</span> takes for which URLs, and thus determines how ad images, cookies and
  32     various other aspects of HTTP content and transactions are handled, and on which sites (or even parts thereof).
  33     There are a number of such actions, with a wide range of functionality. Each action does something a little
  34     different. These actions give us a veritable arsenal of tools with which to exert our control, preferences and
  35     independence. Actions can be combined so that their effects are aggregated when applied against a given set of
  36     URLs.</p>
  37     <p>There are three action files included with <span class="APPLICATION">Privoxy</span> with differing purposes:</p>
  38     <ul>
  39       <li>
  40         <p><tt class="FILENAME">match-all.action</tt> - is used to define which <span class="QUOTE">"actions"</span>
  41         relating to banner-blocking, images, pop-ups, content modification, cookie handling etc should be applied by
  42         default. It should be the first actions file loaded</p>
  43       </li>
  44       <li>
  45         <p><tt class="FILENAME">default.action</tt> - defines many exceptions (both positive and negative) from the
  46         default set of actions that's configured in <tt class="FILENAME">match-all.action</tt>. It is a set of rules
  47         that should work reasonably well as-is for most users. This file is only supposed to be edited by the
  48         developers. It should be the second actions file loaded.</p>
  49       </li>
  50       <li>
  51         <p><tt class="FILENAME">user.action</tt> - is intended to be for local site preferences and exceptions. As an
  52         example, if your ISP or your bank has specific requirements, and need special handling, this kind of thing
  53         should go here. This file will not be upgraded.</p>
  54       </li>
  55       <li>
  56         <p><span class="GUIBUTTON">Edit</span> <span class="GUIBUTTON">Set to Cautious</span> <span class=
  57         "GUIBUTTON">Set to Medium</span> <span class="GUIBUTTON">Set to Advanced</span></p>
  58         <p>These have increasing levels of aggressiveness <span class="emphasis"><i class="EMPHASIS">and have no
  59         influence on your browsing unless you select them explicitly in the editor</i></span>. A default installation
  60         should be pre-set to <tt class="LITERAL">Cautious</tt>. New users should try this for a while before adjusting
  61         the settings to more aggressive levels. The more aggressive the settings, then the more likelihood there is of
  62         problems such as sites not working as they should.</p>
  63         <p>The <span class="GUIBUTTON">Edit</span> button allows you to turn each action on/off individually for
  64         fine-tuning. The <span class="GUIBUTTON">Cautious</span> button changes the actions list to low/safe settings
  65         which will activate ad blocking and a minimal set of <span class="APPLICATION">Privoxy</span>'s features, and
  66         subsequently there will be less of a chance for accidental problems. The <span class="GUIBUTTON">Medium</span>
  67         button sets the list to a medium level of other features and a low level set of privacy features. The
  68         <span class="GUIBUTTON">Advanced</span> button sets the list to a high level of ad blocking and medium level of
  69         privacy. See the chart below. The latter three buttons over-ride any changes via with the <span class=
  70         "GUIBUTTON">Edit</span> button. More fine-tuning can be done in the lower sections of this internal page.</p>
  71         <p>While the actions file editor allows to enable these settings in all actions files, they are only supposed
  72         to be enabled in the first one to make sure you don't unintentionally overrule earlier rules.</p>
  73         <p>The default profiles, and their associated actions, as pre-defined in <tt class=
  74         "FILENAME">default.action</tt> are:</p>
  75         <div class="TABLE">
  76           <a name="AEN2871" id="AEN2871"></a>
  77           <p><b>Table 1. Default Configurations</b></p>
  78           <table border="1" frame="border" rules="all" class="CALSTABLE">
  79             <col width="1*" title="C1">
  80             <col width="1*" title="C2">
  81             <col width="1*" title="C3">
  82             <col width="1*" title="C4">
  83             <thead>
  84               <tr>
  85                 <th>Feature</th>
  86                 <th>Cautious</th>
  87                 <th>Medium</th>
  88                 <th>Advanced</th>
  89               </tr>
  90             </thead>
  91             <tbody>
  92               <tr>
  93                 <td>Ad-blocking Aggressiveness</td>
  94                 <td>medium</td>
  95                 <td>high</td>
  96                 <td>high</td>
  97               </tr>
  98               <tr>
  99                 <td>Ad-filtering by size</td>
 100                 <td>no</td>
 101                 <td>yes</td>
 102                 <td>yes</td>
 103               </tr>
 104               <tr>
 105                 <td>Ad-filtering by link</td>
 106                 <td>no</td>
 107                 <td>no</td>
 108                 <td>yes</td>
 109               </tr>
 110               <tr>
 111                 <td>Pop-up killing</td>
 112                 <td>blocks only</td>
 113                 <td>blocks only</td>
 114                 <td>blocks only</td>
 115               </tr>
 116               <tr>
 117                 <td>Privacy Features</td>
 118                 <td>low</td>
 119                 <td>medium</td>
 120                 <td>medium/high</td>
 121               </tr>
 122               <tr>
 123                 <td>Cookie handling</td>
 124                 <td>none</td>
 125                 <td>session-only</td>
 126                 <td>kill</td>
 127               </tr>
 128               <tr>
 129                 <td>Referer forging</td>
 130                 <td>no</td>
 131                 <td>yes</td>
 132                 <td>yes</td>
 133               </tr>
 134               <tr>
 135                 <td>GIF de-animation</td>
 136                 <td>no</td>
 137                 <td>yes</td>
 138                 <td>yes</td>
 139               </tr>
 140               <tr>
 141                 <td>Fast redirects</td>
 142                 <td>no</td>
 143                 <td>no</td>
 144                 <td>yes</td>
 145               </tr>
 146               <tr>
 147                 <td>HTML taming</td>
 148                 <td>no</td>
 149                 <td>no</td>
 150                 <td>yes</td>
 151               </tr>
 152               <tr>
 153                 <td>JavaScript taming</td>
 154                 <td>no</td>
 155                 <td>no</td>
 156                 <td>yes</td>
 157               </tr>
 158               <tr>
 159                 <td>Web-bug killing</td>
 160                 <td>no</td>
 161                 <td>yes</td>
 162                 <td>yes</td>
 163               </tr>
 164               <tr>
 165                 <td>Image tag reordering</td>
 166                 <td>no</td>
 167                 <td>yes</td>
 168                 <td>yes</td>
 169               </tr>
 170             </tbody>
 171           </table>
 172         </div>
 173       </li>
 174     </ul>
 175     <p>The list of actions files to be used are defined in the main configuration file, and are processed in the order
 176     they are defined (e.g. <tt class="FILENAME">default.action</tt> is typically processed before <tt class=
 177     "FILENAME">user.action</tt>). The content of these can all be viewed and edited from <a href=
 178     "http://config.privoxy.org/show-status" target="_top">http://config.privoxy.org/show-status</a>. The over-riding
 179     principle when applying actions, is that the last action that matches a given URL wins. The broadest, most general
 180     rules go first (defined in <tt class="FILENAME">default.action</tt>), followed by any exceptions (typically also in
 181     <tt class="FILENAME">default.action</tt>), which are then followed lastly by any local preferences (typically in
 182     <span class="emphasis"><i class="EMPHASIS">user</i></span><tt class="FILENAME">.action</tt>). Generally, <tt class=
 183     "FILENAME">user.action</tt> has the last word.</p>
 184     <p>An actions file typically has multiple sections. If you want to use <span class="QUOTE">"aliases"</span> in an
 185     actions file, you have to place the (optional) <a href="actions-file.html#ALIASES">alias section</a> at the top of
 186     that file. Then comes the default set of rules which will apply universally to all sites and pages (be <span class=
 187     "emphasis"><i class="EMPHASIS">very careful</i></span> with using such a universal set in <tt class=
 188     "FILENAME">user.action</tt> or any other actions file after <tt class="FILENAME">default.action</tt>, because it
 189     will override the result from consulting any previous file). And then below that, exceptions to the defined
 190     universal policies. You can regard <tt class="FILENAME">user.action</tt> as an appendix to <tt class=
 191     "FILENAME">default.action</tt>, with the advantage that it is a separate file, which makes preserving your personal
 192     settings across <span class="APPLICATION">Privoxy</span> upgrades easier.</p>
 193     <p>Actions can be used to block anything you want, including ads, banners, or just some obnoxious URL whose content
 194     you would rather not see. Cookies can be accepted or rejected, or accepted only during the current browser session
 195     (i.e. not written to disk), content can be modified, some JavaScripts tamed, user-tracking fooled, and much more.
 196     See below for a <a href="actions-file.html#ACTIONS">complete list of actions</a>.</p>
 197     <div class="SECT2">
 198       <h2 class="SECT2"><a name="RIGHT-MIX" id="RIGHT-MIX">8.1. Finding the Right Mix</a></h2>
 199       <p>Note that some <a href="actions-file.html#ACTIONS">actions</a>, like cookie suppression or script disabling,
 200       may render some sites unusable that rely on these techniques to work properly. Finding the right mix of actions
 201       is not always easy and certainly a matter of personal taste. And, things can always change, requiring refinements
 202       in the configuration. In general, it can be said that the more <span class="QUOTE">"aggressive"</span> your
 203       default settings (in the top section of the actions file) are, the more exceptions for <span class=
 204       "QUOTE">"trusted"</span> sites you will have to make later. If, for example, you want to crunch all cookies per
 205       default, you'll have to make exceptions from that rule for sites that you regularly use and that require cookies
 206       for actually useful purposes, like maybe your bank, favorite shop, or newspaper.</p>
 207       <p>We have tried to provide you with reasonable rules to start from in the distribution actions files. But there
 208       is no general rule of thumb on these things. There just are too many variables, and sites are constantly
 209       changing. Sooner or later you will want to change the rules (and read this chapter again :).</p>
 210     </div>
 211     <div class="SECT2">
 212       <h2 class="SECT2"><a name="HOW-TO-EDIT" id="HOW-TO-EDIT">8.2. How to Edit</a></h2>
 213       <p>The easiest way to edit the actions files is with a browser by using our browser-based editor, which can be
 214       reached from <a href="http://config.privoxy.org/show-status" target=
 215       "_top">http://config.privoxy.org/show-status</a>. Note: the config file option <a href=
 216       "config.html#ENABLE-EDIT-ACTIONS">enable-edit-actions</a> must be enabled for this to work. The editor allows
 217       both fine-grained control over every single feature on a per-URL basis, and easy choosing from wholesale sets of
 218       defaults like <span class="QUOTE">"Cautious"</span>, <span class="QUOTE">"Medium"</span> or <span class=
 219       "QUOTE">"Advanced"</span>. Warning: the <span class="QUOTE">"Advanced"</span> setting is more aggressive, and
 220       will be more likely to cause problems for some sites. Experienced users only!</p>
 221       <p>If you prefer plain text editing to GUIs, you can of course also directly edit the the actions files with your
 222       favorite text editor. Look at <tt class="FILENAME">default.action</tt> which is richly commented with many good
 223       examples.</p>
 224     </div>
 225     <div class="SECT2">
 226       <h2 class="SECT2"><a name="ACTIONS-APPLY" id="ACTIONS-APPLY">8.3. How Actions are Applied to Requests</a></h2>
 227       <p>Actions files are divided into sections. There are special sections, like the <span class="QUOTE">"<a href=
 228       "actions-file.html#ALIASES">alias</a>"</span> sections which will be discussed later. For now let's concentrate
 229       on regular sections: They have a heading line (often split up to multiple lines for readability) which consist of
 230       a list of actions, separated by whitespace and enclosed in curly braces. Below that, there is a list of URL and
 231       tag patterns, each on a separate line.</p>
 232       <p>To determine which actions apply to a request, the URL of the request is compared to all URL patterns in each
 233       <span class="QUOTE">"action file"</span>. Every time it matches, the list of applicable actions for the request
 234       is incrementally updated, using the heading of the section in which the pattern is located. The same is done
 235       again for tags and tag patterns later on.</p>
 236       <p>If multiple applying sections set the same action differently, the last match wins. If not, the effects are
 237       aggregated. E.g. a URL might match a regular section with a heading line of <tt class="LITERAL">{ +<a href=
 238       "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a> }</tt>, then later another one with just <tt class=
 239       "LITERAL">{ +<a href="actions-file.html#BLOCK">block</a> }</tt>, resulting in <span class="emphasis"><i class=
 240       "EMPHASIS">both</i></span> actions to apply. And there may well be cases where you will want to combine actions
 241       together. Such a section then might look like:</p>
 242       <table border="0" bgcolor="#E0E0E0" width="100%">
 243         <tr>
 244           <td>
 245             <pre class="SCREEN">  { +<tt class="LITERAL">handle-as-image</tt>  +<tt class=
 246             "LITERAL">block{Banner ads.}</tt> }
 247   # Block these as if they were images. Send no block page.
 248    banners.example.com
 249    media.example.com/.*banners
 250    .example.com/images/ads/</pre>
 251           </td>
 252         </tr>
 253       </table>
 254       <p>You can trace this process for URL patterns and any given URL by visiting <a href=
 255       "http://config.privoxy.org/show-url-info" target="_top">http://config.privoxy.org/show-url-info</a>.</p>
 256       <p>Examples and more detail on this is provided in the Appendix, <a href=
 257       "appendix.html#ACTIONSANAT">Troubleshooting: Anatomy of an Action</a> section.</p>
 258     </div>
 259     <div class="SECT2">
 260       <h2 class="SECT2"><a name="AF-PATTERNS" id="AF-PATTERNS">8.4. Patterns</a></h2>
 261       <p>As mentioned, <span class="APPLICATION">Privoxy</span> uses <span class="QUOTE">"patterns"</span> to determine
 262       what <span class="emphasis"><i class="EMPHASIS">actions</i></span> might apply to which sites and pages your
 263       browser attempts to access. These <span class="QUOTE">"patterns"</span> use wild card type <span class=
 264       "emphasis"><i class="EMPHASIS">pattern</i></span> matching to achieve a high degree of flexibility. This allows
 265       one expression to be expanded and potentially match against many similar patterns.</p>
 266       <p>Generally, an URL pattern has the form <tt class="LITERAL">&lt;host&gt;&lt;port&gt;/&lt;path&gt;</tt>, where
 267       the <tt class="LITERAL">&lt;host&gt;</tt>, the <tt class="LITERAL">&lt;port&gt;</tt> and the <tt class=
 268       "LITERAL">&lt;path&gt;</tt> are optional. (This is why the special <tt class="LITERAL">/</tt> pattern matches all
 269       URLs). Note that the protocol portion of the URL pattern (e.g. <tt class="LITERAL">http://</tt>) should
 270       <span class="emphasis"><i class="EMPHASIS">not</i></span> be included in the pattern. This is assumed
 271       already!</p>
 272       <p>The pattern matching syntax is different for the host and path parts of the URL. The host part uses a simple
 273       globbing type matching technique, while the path part uses more flexible <a href=
 274       "http://en.wikipedia.org/wiki/Regular_expressions" target="_top"><span class="QUOTE">"Regular
 275       Expressions"</span></a> (POSIX 1003.2).</p>
 276       <p>The port part of a pattern is a decimal port number preceded by a colon (<tt class="LITERAL">:</tt>). If the
 277       host part contains a numerical IPv6 address, it has to be put into angle brackets (<tt class="LITERAL">&lt;</tt>,
 278       <tt class="LITERAL">&gt;</tt>).</p>
 279       <div class="VARIABLELIST">
 280         <dl>
 281           <dt><tt class="LITERAL">www.example.com/</tt></dt>
 282           <dd>
 283             <p>is a host-only pattern and will match any request to <tt class="LITERAL">www.example.com</tt>,
 284             regardless of which document on that server is requested. So ALL pages in this domain would be covered by
 285             the scope of this action. Note that a simple <tt class="LITERAL">example.com</tt> is different and would
 286             NOT match.</p>
 287           </dd>
 288           <dt><tt class="LITERAL">www.example.com</tt></dt>
 289           <dd>
 290             <p>means exactly the same. For host-only patterns, the trailing <tt class="LITERAL">/</tt> may be
 291             omitted.</p>
 292           </dd>
 293           <dt><tt class="LITERAL">www.example.com/index.html</tt></dt>
 294           <dd>
 295             <p>matches all the documents on <tt class="LITERAL">www.example.com</tt> whose name starts with <tt class=
 296             "LITERAL">/index.html</tt>.</p>
 297           </dd>
 298           <dt><tt class="LITERAL">www.example.com/index.html$</tt></dt>
 299           <dd>
 300             <p>matches only the single document <tt class="LITERAL">/index.html</tt> on <tt class=
 301             "LITERAL">www.example.com</tt>.</p>
 302           </dd>
 303           <dt><tt class="LITERAL">/index.html$</tt></dt>
 304           <dd>
 305             <p>matches the document <tt class="LITERAL">/index.html</tt>, regardless of the domain, i.e. on
 306             <span class="emphasis"><i class="EMPHASIS">any</i></span> web server anywhere.</p>
 307           </dd>
 308           <dt><tt class="LITERAL">/</tt></dt>
 309           <dd>
 310             <p>Matches any URL because there's no requirement for either the domain or the path to match anything.</p>
 311           </dd>
 312           <dt><tt class="LITERAL">:8000/</tt></dt>
 313           <dd>
 314             <p>Matches any URL pointing to TCP port 8000.</p>
 315           </dd>
 316           <dt><tt class="LITERAL">10.0.0.1/</tt></dt>
 317           <dd>
 318             <p>Matches any URL with the host address <tt class="LITERAL">10.0.0.1</tt>. (Note that the real URL uses
 319             plain brackets, not angle brackets.)</p>
 320           </dd>
 321           <dt><tt class="LITERAL">&lt;2001:db8::1&gt;/</tt></dt>
 322           <dd>
 323             <p>Matches any URL with the host address <tt class="LITERAL">2001:db8::1</tt>. (Note that the real URL uses
 324             plain brackets, not angle brackets.)</p>
 325           </dd>
 326           <dt><tt class="LITERAL">index.html</tt></dt>
 327           <dd>
 328             <p>matches nothing, since it would be interpreted as a domain name and there is no top-level domain called
 329             <tt class="LITERAL">.html</tt>. So its a mistake.</p>
 330           </dd>
 331         </dl>
 332       </div>
 333       <div class="SECT3">
 334         <h3 class="SECT3"><a name="HOST-PATTERN" id="HOST-PATTERN">8.4.1. The Host Pattern</a></h3>
 335         <p>The matching of the host part offers some flexible options: if the host pattern starts or ends with a dot,
 336         it becomes unanchored at that end. The host pattern is often referred to as domain pattern as it is usually
 337         used to match domain names and not IP addresses. For example:</p>
 338         <div class="VARIABLELIST">
 339           <dl>
 340             <dt><tt class="LITERAL">.example.com</tt></dt>
 341             <dd>
 342               <p>matches any domain with first-level domain <tt class="LITERAL">com</tt> and second-level domain
 343               <tt class="LITERAL">example</tt>. For example <tt class="LITERAL">www.example.com</tt>, <tt class=
 344               "LITERAL">example.com</tt> and <tt class="LITERAL">foo.bar.baz.example.com</tt>. Note that it wouldn't
 345               match if the second-level domain was <tt class="LITERAL">another-example</tt>.</p>
 346             </dd>
 347             <dt><tt class="LITERAL">www.</tt></dt>
 348             <dd>
 349               <p>matches any domain that <span class="emphasis"><i class="EMPHASIS">STARTS</i></span> with <tt class=
 350               "LITERAL">www.</tt> (It also matches the domain <tt class="LITERAL">www</tt> but most of the time that
 351               doesn't matter.)</p>
 352             </dd>
 353             <dt><tt class="LITERAL">.example.</tt></dt>
 354             <dd>
 355               <p>matches any domain that <span class="emphasis"><i class="EMPHASIS">CONTAINS</i></span> <tt class=
 356               "LITERAL">.example.</tt>. And, by the way, also included would be any files or documents that exist
 357               within that domain since no path limitations are specified. (Correctly speaking: It matches any FQDN that
 358               contains <tt class="LITERAL">example</tt> as a domain.) This might be <tt class=
 359               "LITERAL">www.example.com</tt>, <tt class="LITERAL">news.example.de</tt>, or <tt class=
 360               "LITERAL">www.example.net/cgi/testing.pl</tt> for instance. All these cases are matched.</p>
 361             </dd>
 362           </dl>
 363         </div>
 364         <p>Additionally, there are wild-cards that you can use in the domain names themselves. These work similarly to
 365         shell globbing type wild-cards: <span class="QUOTE">"*"</span> represents zero or more arbitrary characters
 366         (this is equivalent to the <a href="http://en.wikipedia.org/wiki/Regular_expressions" target=
 367         "_top"><span class="QUOTE">"Regular Expression"</span></a> based syntax of <span class="QUOTE">".*"</span>),
 368         <span class="QUOTE">"?"</span> represents any single character (this is equivalent to the regular expression
 369         syntax of a simple <span class="QUOTE">"."</span>), and you can define <span class="QUOTE">"character
 370         classes"</span> in square brackets which is similar to the same regular expression technique. All of this can
 371         be freely mixed:</p>
 372         <div class="VARIABLELIST">
 373           <dl>
 374             <dt><tt class="LITERAL">ad*.example.com</tt></dt>
 375             <dd>
 376               <p>matches <span class="QUOTE">"adserver.example.com"</span>, <span class=
 377               "QUOTE">"ads.example.com"</span>, etc but not <span class="QUOTE">"sfads.example.com"</span></p>
 378             </dd>
 379             <dt><tt class="LITERAL">*ad*.example.com</tt></dt>
 380             <dd>
 381               <p>matches all of the above, and then some.</p>
 382             </dd>
 383             <dt><tt class="LITERAL">.?pix.com</tt></dt>
 384             <dd>
 385               <p>matches <tt class="LITERAL">www.ipix.com</tt>, <tt class="LITERAL">pictures.epix.com</tt>, <tt class=
 386               "LITERAL">a.b.c.d.e.upix.com</tt> etc.</p>
 387             </dd>
 388             <dt><tt class="LITERAL">www[1-9a-ez].example.c*</tt></dt>
 389             <dd>
 390               <p>matches <tt class="LITERAL">www1.example.com</tt>, <tt class="LITERAL">www4.example.cc</tt>,
 391               <tt class="LITERAL">wwwd.example.cy</tt>, <tt class="LITERAL">wwwz.example.com</tt> etc., but
 392               <span class="emphasis"><i class="EMPHASIS">not</i></span> <tt class="LITERAL">wwww.example.com</tt>.</p>
 393             </dd>
 394           </dl>
 395         </div>
 396         <p>While flexible, this is not the sophistication of full regular expression based syntax.</p>
 397       </div>
 398       <div class="SECT3">
 399         <h3 class="SECT3"><a name="PATH-PATTERN" id="PATH-PATTERN">8.4.2. The Path Pattern</a></h3>
 400         <p><span class="APPLICATION">Privoxy</span> uses <span class="QUOTE">"modern"</span> POSIX 1003.2 <a href=
 401         "http://en.wikipedia.org/wiki/Regular_expressions" target="_top"><span class="QUOTE">"Regular
 402         Expressions"</span></a> for matching the path portion (after the slash), and is thus more flexible.</p>
 403         <p>There is an <a href="appendix.html#REGEX">Appendix</a> with a brief quick-start into regular expressions,
 404         you also might want to have a look at your operating system's documentation on regular expressions (try
 405         <tt class="LITERAL">man re_format</tt>).</p>
 406         <p>Note that the path pattern is automatically left-anchored at the <span class="QUOTE">"/"</span>, i.e. it
 407         matches as if it would start with a <span class="QUOTE">"^"</span> (regular expression speak for the beginning
 408         of a line).</p>
 409         <p>Please also note that matching in the path is <span class="emphasis"><i class="EMPHASIS">CASE
 410         INSENSITIVE</i></span> by default, but you can switch to case sensitive at any point in the pattern by using
 411         the <span class="QUOTE">"(?-i)"</span> switch: <tt class="LITERAL">www.example.com/(?-i)PaTtErN.*</tt> will
 412         match only documents whose path starts with <tt class="LITERAL">PaTtErN</tt> in <span class=
 413         "emphasis"><i class="EMPHASIS">exactly</i></span> this capitalization.</p>
 414         <div class="VARIABLELIST">
 415           <dl>
 416             <dt><tt class="LITERAL">.example.com/.*</tt></dt>
 417             <dd>
 418               <p>Is equivalent to just <span class="QUOTE">".example.com"</span>, since any documents within that
 419               domain are matched with or without the <span class="QUOTE">".*"</span> regular expression. This is
 420               redundant</p>
 421             </dd>
 422             <dt><tt class="LITERAL">.example.com/.*/index.html$</tt></dt>
 423             <dd>
 424               <p>Will match any page in the domain of <span class="QUOTE">"example.com"</span> that is named
 425               <span class="QUOTE">"index.html"</span>, and that is part of some path. For example, it matches
 426               <span class="QUOTE">"www.example.com/testing/index.html"</span> but NOT <span class=
 427               "QUOTE">"www.example.com/index.html"</span> because the regular expression called for at least two
 428               <span class="QUOTE">"/'s"</span>, thus the path requirement. It also would match <span class=
 429               "QUOTE">"www.example.com/testing/index_html"</span>, because of the special meta-character <span class=
 430               "QUOTE">"."</span>.</p>
 431             </dd>
 432             <dt><tt class="LITERAL">.example.com/(.*/)?index\.html$</tt></dt>
 433             <dd>
 434               <p>This regular expression is conditional so it will match any page named <span class=
 435               "QUOTE">"index.html"</span> regardless of path which in this case can have one or more <span class=
 436               "QUOTE">"/'s"</span>. And this one must contain exactly <span class="QUOTE">".html"</span> (and end with
 437               that!).</p>
 438             </dd>
 439             <dt><tt class="LITERAL">.example.com/(.*/)(ads|banners?|junk)</tt></dt>
 440             <dd>
 441               <p>This regular expression will match any path of <span class="QUOTE">"example.com"</span> that contains
 442               any of the words <span class="QUOTE">"ads"</span>, <span class="QUOTE">"banner"</span>, <span class=
 443               "QUOTE">"banners"</span> (because of the <span class="QUOTE">"?"</span>) or <span class=
 444               "QUOTE">"junk"</span>. The path does not have to end in these words, just contain them. The path has to
 445               contain at least two slashes (including the one at the beginning).</p>
 446             </dd>
 447             <dt><tt class="LITERAL">.example.com/(.*/)(ads|banners?|junk)/.*\.(jpe?g|gif|png)$</tt></dt>
 448             <dd>
 449               <p>This is very much the same as above, except now it must end in either <span class=
 450               "QUOTE">".jpg"</span>, <span class="QUOTE">".jpeg"</span>, <span class="QUOTE">".gif"</span> or
 451               <span class="QUOTE">".png"</span>. So this one is limited to common image formats.</p>
 452             </dd>
 453           </dl>
 454         </div>
 455         <p>There are many, many good examples to be found in <tt class="FILENAME">default.action</tt>, and more
 456         tutorials below in <a href="appendix.html#REGEX">Appendix on regular expressions</a>.</p>
 457       </div>
 458       <div class="SECT3">
 459         <h3 class="SECT3"><a name="TAG-PATTERN" id="TAG-PATTERN">8.4.3. The Request Tag Pattern</a></h3>
 460         <p>Request tag patterns are used to change the applying actions based on the request's tags. Tags can be
 461         created based on HTTP headers with either the <a href=
 462         "actions-file.html#CLIENT-HEADER-TAGGER">client-header-tagger</a> or the <a href=
 463         "actions-file.html#SERVER-HEADER-TAGGER">server-header-tagger</a> action.</p>
 464         <p>Request tag patterns have to start with <span class="QUOTE">"TAG:"</span>, so <span class=
 465         "APPLICATION">Privoxy</span> can tell them apart from other patterns. Everything after the colon including
 466         white space, is interpreted as a regular expression with path pattern syntax, except that tag patterns aren't
 467         left-anchored automatically (<span class="APPLICATION">Privoxy</span> doesn't silently add a <span class=
 468         "QUOTE">"^"</span>, you have to do it yourself if you need it).</p>
 469         <p>To match all requests that are tagged with <span class="QUOTE">"foo"</span> your pattern line should be
 470         <span class="QUOTE">"TAG:^foo$"</span>, <span class="QUOTE">"TAG:foo"</span> would work as well, but it would
 471         also match requests whose tags contain <span class="QUOTE">"foo"</span> somewhere. <span class="QUOTE">"TAG:
 472         foo"</span> wouldn't work as it requires white space.</p>
 473         <p>Sections can contain URL and request tag patterns at the same time, but request tag patterns are checked
 474         after the URL patterns and thus always overrule them, even if they are located before the URL patterns.</p>
 475         <p>Once a new request tag is added, Privoxy checks right away if it's matched by one of the request tag
 476         patterns and updates the action settings accordingly. As a result request tags can be used to activate other
 477         tagger actions, as long as these other taggers look for headers that haven't already be parsed.</p>
 478         <p>For example you could tag client requests which use the <tt class="LITERAL">POST</tt> method, then use this
 479         tag to activate another tagger that adds a tag if cookies are sent, and then use a block action based on the
 480         cookie tag. This allows the outcome of one action, to be input into a subsequent action. However if you'd
 481         reverse the position of the described taggers, and activated the method tagger based on the cookie tagger, no
 482         method tags would be created. The method tagger would look for the request line, but at the time the cookie tag
 483         is created, the request line has already been parsed.</p>
 484         <p>While this is a limitation you should be aware of, this kind of indirection is seldom needed anyway and even
 485         the example doesn't make too much sense.</p>
 486       </div>
 487       <div class="SECT3">
 488         <h3 class="SECT3"><a name="NEGATIVE-TAG-PATTERNS" id="NEGATIVE-TAG-PATTERNS">8.4.4. The Negative Request Tag
 489         Patterns</a></h3>
 490         <p>To match requests that do not have a certain request tag, specify a negative tag pattern by prefixing the
 491         tag pattern line with either <span class="QUOTE">"NO-REQUEST-TAG:"</span> or <span class=
 492         "QUOTE">"NO-RESPONSE-TAG:"</span> instead of <span class="QUOTE">"TAG:"</span>.</p>
 493         <p>Negative request tag patterns created with <span class="QUOTE">"NO-REQUEST-TAG:"</span> are checked after
 494         all client headers are scanned, the ones created with <span class="QUOTE">"NO-RESPONSE-TAG:"</span> are checked
 495         after all server headers are scanned. In both cases all the created tags are considered.</p>
 496       </div>
 497       <div class="SECT3">
 498         <h3 class="SECT3"><a name="CLIENT-TAG-PATTERN" id="CLIENT-TAG-PATTERN">8.4.5. The Client Tag Pattern</a></h3>
 499         <div class="WARNING">
 500           <table class="WARNING" border="1" width="100%">
 501             <tr>
 502               <td align="center"><b>Warning</b></td>
 503             </tr>
 504             <tr>
 505               <td align="left">
 506                 <p>This is an experimental feature. The syntax is likely to change in future versions.</p>
 507               </td>
 508             </tr>
 509           </table>
 510         </div>
 511         <p>Client tag patterns are not set based on HTTP headers but based on the client's IP address. Users can enable
 512         them themselves, but the Privoxy admin controls which tags are available and what their effect is.</p>
 513         <p>After a client-specific tag has been defined with the <a href=
 514         "config.html#CLIENT-SPECIFIC-TAG">client-specific-tag</a>, directive, action sections can be activated based on
 515         the tag by using a CLIENT-TAG pattern. The CLIENT-TAG pattern is evaluated at the same priority as URL
 516         patterns, as a result the last matching pattern wins. Tags that are created based on client or server headers
 517         are evaluated later on and can overrule CLIENT-TAG and URL patterns!</p>
 518         <p>The tag is set for all requests that come from clients that requested it to be set. Note that "clients" are
 519         differentiated by IP address, if the IP address changes the tag has to be requested again.</p>
 520         <p>Clients can request tags to be set by using the CGI interface <a href=
 521         "http://config.privoxy.org/client-tags" target="_top">http://config.privoxy.org/client-tags</a>.</p>
 522         <p>Example:</p>
 523         <table border="0" bgcolor="#E0E0E0" width="100%">
 524           <tr>
 525             <td>
 526               <pre class="SCREEN"># If the admin defined the client-specific-tag circumvent-blocks,
 527 # and the request comes from a client that previously requested
 528 # the tag to be set, overrule all previous +block actions that
 529 # are enabled based on URL to CLIENT-TAG patterns.
 530 {-block}
 531 CLIENT-TAG:^circumvent-blocks$
 532
 533 # This section is not overruled because it's located after
 534 # the previous one.
 535 {+block{Nobody is supposed to request this.}}
 536 example.org/blocked-example-page</pre>
 537             </td>
 538           </tr>
 539         </table>
 540       </div>
 541     </div>
 542     <div class="SECT2">
 543       <h2 class="SECT2"><a name="ACTIONS" id="ACTIONS">8.5. Actions</a></h2>
 544       <p>All actions are disabled by default, until they are explicitly enabled somewhere in an actions file. Actions
 545       are turned on if preceded with a <span class="QUOTE">"+"</span>, and turned off if preceded with a <span class=
 546       "QUOTE">"-"</span>. So a <tt class="LITERAL">+action</tt> means <span class="QUOTE">"do that action"</span>, e.g.
 547       <tt class="LITERAL">+block</tt> means <span class="QUOTE">"please block URLs that match the following
 548       patterns"</span>, and <tt class="LITERAL">-block</tt> means <span class="QUOTE">"don't block URLs that match the
 549       following patterns, even if <tt class="LITERAL">+block</tt> previously applied."</span></p>
 550       <p>Again, actions are invoked by placing them on a line, enclosed in curly braces and separated by whitespace,
 551       like in <tt class="LITERAL">{+some-action -some-other-action{some-parameter}}</tt>, followed by a list of URL
 552       patterns, one per line, to which they apply. Together, the actions line and the following pattern lines make up a
 553       section of the actions file.</p>
 554       <p>Actions fall into three categories:</p>
 555       <ul>
 556         <li>
 557           <p>Boolean, i.e the action can only be <span class="QUOTE">"enabled"</span> or <span class=
 558           "QUOTE">"disabled"</span>. Syntax:</p>
 559           <table border="0" bgcolor="#E0E0E0" width="90%">
 560             <tr>
 561               <td>
 562                 <pre class="SCREEN">  +<tt class="REPLACEABLE"><i>name</i></tt>        # enable action <tt class=
 563                 "REPLACEABLE"><i>name</i></tt>
 564   -<tt class="REPLACEABLE"><i>name</i></tt>        # disable action <tt class="REPLACEABLE"><i>name</i></tt></pre>
 565               </td>
 566             </tr>
 567           </table>
 568           <p>Example: <tt class="LITERAL">+handle-as-image</tt></p>
 569         </li>
 570         <li>
 571           <p>Parameterized, where some value is required in order to enable this type of action. Syntax:</p>
 572           <table border="0" bgcolor="#E0E0E0" width="90%">
 573             <tr>
 574               <td>
 575                 <pre class="SCREEN">  +<tt class="REPLACEABLE"><i>name</i></tt>{<tt class=
 576                 "REPLACEABLE"><i>param</i></tt>}  # enable action and set parameter to <tt class=
 577                 "REPLACEABLE"><i>param</i></tt>,
 578                # overwriting parameter from previous match if necessary
 579   -<tt class="REPLACEABLE"><i>name</i></tt>         # disable action. The parameter can be omitted</pre>
 580               </td>
 581             </tr>
 582           </table>
 583           <p>Note that if the URL matches multiple positive forms of a parameterized action, the last match wins, i.e.
 584           the params from earlier matches are simply ignored.</p>
 585           <p>Example: <tt class="LITERAL">+hide-user-agent{Mozilla/5.0 (X11; U; FreeBSD i386; en-US; rv:1.8.1.4)
 586           Gecko/20070602 Firefox/2.0.0.4}</tt></p>
 587         </li>
 588         <li>
 589           <p>Multi-value. These look exactly like parameterized actions, but they behave differently: If the action
 590           applies multiple times to the same URL, but with different parameters, <span class="emphasis"><i class=
 591           "EMPHASIS">all</i></span> the parameters from <span class="emphasis"><i class="EMPHASIS">all</i></span>
 592           matches are remembered. This is used for actions that can be executed for the same request repeatedly, like
 593           adding multiple headers, or filtering through multiple filters. Syntax:</p>
 594           <table border="0" bgcolor="#E0E0E0" width="90%">
 595             <tr>
 596               <td>
 597                 <pre class="SCREEN">  +<tt class="REPLACEABLE"><i>name</i></tt>{<tt class=
 598                 "REPLACEABLE"><i>param</i></tt>}   # enable action and add <tt class=
 599                 "REPLACEABLE"><i>param</i></tt> to the list of parameters
 600   -<tt class="REPLACEABLE"><i>name</i></tt>{<tt class=
 601 "REPLACEABLE"><i>param</i></tt>}   # remove the parameter <tt class=
 602 "REPLACEABLE"><i>param</i></tt> from the list of parameters
 603                 # If it was the last one left, disable the action.
 604   <tt class=
 605 "REPLACEABLE"><i>-name</i></tt>          # disable this action completely and remove all parameters from the list</pre>
 606               </td>
 607             </tr>
 608           </table>
 609           <p>Examples: <tt class="LITERAL">+add-header{X-Fun-Header: Some text}</tt> and <tt class=
 610           "LITERAL">+filter{html-annoyances}</tt></p>
 611         </li>
 612       </ul>
 613       <p>If nothing is specified in any actions file, no <span class="QUOTE">"actions"</span> are taken. So in this
 614       case <span class="APPLICATION">Privoxy</span> would just be a normal, non-blocking, non-filtering proxy. You must
 615       specifically enable the privacy and blocking features you need (although the provided default actions files will
 616       give a good starting point).</p>
 617       <p>Later defined action sections always over-ride earlier ones of the same type. So exceptions to any rules you
 618       make, should come in the latter part of the file (or in a file that is processed later when using multiple
 619       actions files such as <tt class="FILENAME">user.action</tt>). For multi-valued actions, the actions are applied
 620       in the order they are specified. Actions files are processed in the order they are defined in <tt class=
 621       "FILENAME">config</tt> (the default installation has three actions files). It also quite possible for any given
 622       URL to match more than one <span class="QUOTE">"pattern"</span> (because of wildcards and regular expressions),
 623       and thus to trigger more than one set of actions! Last match wins.</p>
 624       <p>The list of valid <span class="APPLICATION">Privoxy</span> actions are:</p>
 625       <div class="SECT3">
 626         <h4 class="SECT3"><a name="ADD-HEADER" id="ADD-HEADER">8.5.1. add-header</a></h4>
 627         <div class="VARIABLELIST">
 628           <dl>
 629             <dt>Typical use:</dt>
 630             <dd>
 631               <p>Confuse log analysis, custom applications</p>
 632             </dd>
 633             <dt>Effect:</dt>
 634             <dd>
 635               <p>Sends a user defined HTTP header to the web server.</p>
 636             </dd>
 637             <dt>Type:</dt>
 638             <dd>
 639               <p>Multi-value.</p>
 640             </dd>
 641             <dt>Parameter:</dt>
 642             <dd>
 643               <p>Any string value is possible. Validity of the defined HTTP headers is not checked. It is recommended
 644               that you use the <span class="QUOTE">"<tt class="LITERAL">X-</tt>"</span> prefix for custom headers.</p>
 645             </dd>
 646             <dt>Notes:</dt>
 647             <dd>
 648               <p>This action may be specified multiple times, in order to define multiple headers. This is rarely
 649               needed for the typical user. If you don't know what <span class="QUOTE">"HTTP headers"</span> are, you
 650               definitely don't need to worry about this one.</p>
 651               <p>Headers added by this action are not modified by other actions.</p>
 652             </dd>
 653             <dt>Example usage:</dt>
 654             <dd>
 655               <table border="0" bgcolor="#E0E0E0" width="90%">
 656                 <tr>
 657                   <td>
 658                     <pre class="SCREEN"># Add a DNT ("Do not track") header to all requests,
 659 # event to those that already have one.
 660 #
 661 # This is just an example, not a recommendation.
 662 #
 663 # There is no reason to believe that user-tracking websites care
 664 # about the DNT header and depending on the User-Agent, adding the
 665 # header may make user-tracking easier.
 666 {+add-header{DNT: 1}}
 667 /</pre>
 668                   </td>
 669                 </tr>
 670               </table>
 671             </dd>
 672           </dl>
 673         </div>
 674       </div>
 675       <div class="SECT3">
 676         <h4 class="SECT3"><a name="BLOCK" id="BLOCK">8.5.2. block</a></h4>
 677         <div class="VARIABLELIST">
 678           <dl>
 679             <dt>Typical use:</dt>
 680             <dd>
 681               <p>Block ads or other unwanted content</p>
 682             </dd>
 683             <dt>Effect:</dt>
 684             <dd>
 685               <p>Requests for URLs to which this action applies are blocked, i.e. the requests are trapped by
 686               <span class="APPLICATION">Privoxy</span> and the requested URL is never retrieved, but is answered
 687               locally with a substitute page or image, as determined by the <tt class="LITERAL"><a href=
 688               "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></tt>, <tt class="LITERAL"><a href=
 689               "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></tt>, and <tt class="LITERAL"><a href=
 690               "actions-file.html#HANDLE-AS-EMPTY-DOCUMENT">handle-as-empty-document</a></tt> actions.</p>
 691             </dd>
 692             <dt>Type:</dt>
 693             <dd>
 694               <p>Parameterized.</p>
 695             </dd>
 696             <dt>Parameter:</dt>
 697             <dd>
 698               <p>A block reason that should be given to the user.</p>
 699             </dd>
 700             <dt>Notes:</dt>
 701             <dd>
 702               <p><span class="APPLICATION">Privoxy</span> sends a special <span class="QUOTE">"BLOCKED"</span> page for
 703               requests to blocked pages. This page contains the block reason given as parameter, a link to find out why
 704               the block action applies, and a click-through to the blocked content (the latter only if the force
 705               feature is available and enabled).</p>
 706               <p>A very important exception occurs if <span class="emphasis"><i class="EMPHASIS">both</i></span>
 707               <tt class="LITERAL">block</tt> and <tt class="LITERAL"><a href=
 708               "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></tt>, apply to the same request: it will then be
 709               replaced by an image. If <tt class="LITERAL"><a href=
 710               "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></tt> (see below) also applies, the type of
 711               image will be determined by its parameter, if not, the standard checkerboard pattern is sent.</p>
 712               <p>It is important to understand this process, in order to understand how <span class=
 713               "APPLICATION">Privoxy</span> deals with ads and other unwanted content. Blocking is a core feature, and
 714               one upon which various other features depend.</p>
 715               <p>The <tt class="LITERAL"><a href="actions-file.html#FILTER">filter</a></tt> action can perform a very
 716               similar task, by <span class="QUOTE">"blocking"</span> banner images and other content through rewriting
 717               the relevant URLs in the document's HTML source, so they don't get requested in the first place. Note
 718               that this is a totally different technique, and it's easy to confuse the two.</p>
 719             </dd>
 720             <dt>Example usage (section):</dt>
 721             <dd>
 722               <table border="0" bgcolor="#E0E0E0" width="90%">
 723                 <tr>
 724                   <td>
 725                     <pre class="SCREEN">{+block{No nasty stuff for you.}}
 726 # Block and replace with "blocked" page
 727  .nasty-stuff.example.com
 728
 729 {+block{Doubleclick banners.} +handle-as-image}
 730 # Block and replace with image
 731  .ad.doubleclick.net
 732  .ads.r.us/banners/
 733
 734 {+block{Layered ads.} +handle-as-empty-document}
 735 # Block and then ignore
 736  adserver.example.net/.*\.js$</pre>
 737                   </td>
 738                 </tr>
 739               </table>
 740             </dd>
 741           </dl>
 742         </div>
 743       </div>
 744       <div class="SECT3">
 745         <h4 class="SECT3"><a name="CHANGE-X-FORWARDED-FOR" id="CHANGE-X-FORWARDED-FOR">8.5.3.
 746         change-x-forwarded-for</a></h4>
 747         <div class="VARIABLELIST">
 748           <dl>
 749             <dt>Typical use:</dt>
 750             <dd>
 751               <p>Improve privacy by not forwarding the source of the request in the HTTP headers.</p>
 752             </dd>
 753             <dt>Effect:</dt>
 754             <dd>
 755               <p>Deletes the <span class="QUOTE">"X-Forwarded-For:"</span> HTTP header from the client request, or adds
 756               a new one.</p>
 757             </dd>
 758             <dt>Type:</dt>
 759             <dd>
 760               <p>Parameterized.</p>
 761             </dd>
 762             <dt>Parameter:</dt>
 763             <dd>
 764               <ul>
 765                 <li>
 766                   <p><span class="QUOTE">"block"</span> to delete the header.</p>
 767                 </li>
 768                 <li>
 769                   <p><span class="QUOTE">"add"</span> to create the header (or append the client's IP address to an
 770                   already existing one).</p>
 771                 </li>
 772               </ul>
 773             </dd>
 774             <dt>Notes:</dt>
 775             <dd>
 776               <p>It is safe and recommended to use <tt class="LITERAL">block</tt>.</p>
 777               <p>Forwarding the source address of the request may make sense in some multi-user setups but is also a
 778               privacy risk.</p>
 779             </dd>
 780             <dt>Example usage:</dt>
 781             <dd>
 782               <table border="0" bgcolor="#E0E0E0" width="90%">
 783                 <tr>
 784                   <td>
 785                     <pre class="SCREEN">+change-x-forwarded-for{block}</pre>
 786                   </td>
 787                 </tr>
 788               </table>
 789             </dd>
 790           </dl>
 791         </div>
 792       </div>
 793       <div class="SECT3">
 794         <h4 class="SECT3"><a name="CLIENT-HEADER-FILTER" id="CLIENT-HEADER-FILTER">8.5.4. client-header-filter</a></h4>
 795         <div class="VARIABLELIST">
 796           <dl>
 797             <dt>Typical use:</dt>
 798             <dd>
 799               <p>Rewrite or remove single client headers.</p>
 800             </dd>
 801             <dt>Effect:</dt>
 802             <dd>
 803               <p>All client headers to which this action applies are filtered on-the-fly through the specified regular
 804               expression based substitutions.</p>
 805             </dd>
 806             <dt>Type:</dt>
 807             <dd>
 808               <p>Multi-value.</p>
 809             </dd>
 810             <dt>Parameter:</dt>
 811             <dd>
 812               <p>The name of a client-header filter, as defined in one of the <a href="filter-file.html">filter
 813               files</a>.</p>
 814             </dd>
 815             <dt>Notes:</dt>
 816             <dd>
 817               <p>Client-header filters are applied to each header on its own, not to all at once. This makes it easier
 818               to diagnose problems, but on the downside you can't write filters that only change header x if header y's
 819               value is z. You can do that by using tags though.</p>
 820               <p>Client-header filters are executed after the other header actions have finished and use their output
 821               as input.</p>
 822               <p>If the request URI gets changed, <span class="APPLICATION">Privoxy</span> will detect that and use the
 823               new one. This can be used to rewrite the request destination behind the client's back, for example to
 824               specify a Tor exit relay for certain requests.</p>
 825               <p>Please refer to the <a href="filter-file.html">filter file chapter</a> to learn which client-header
 826               filters are available by default, and how to create your own.</p>
 827             </dd>
 828             <dt>Example usage (section):</dt>
 829             <dd>
 830               <table border="0" bgcolor="#E0E0E0" width="90%">
 831                 <tr>
 832                   <td>
 833                     <pre class="SCREEN"># Hide Tor exit notation in Host and Referer Headers
 834 {+client-header-filter{hide-tor-exit-notation}}
 835 /</pre>
 836                   </td>
 837                 </tr>
 838               </table>
 839             </dd>
 840           </dl>
 841         </div>
 842       </div>
 843       <div class="SECT3">
 844         <h4 class="SECT3"><a name="CLIENT-HEADER-TAGGER" id="CLIENT-HEADER-TAGGER">8.5.5. client-header-tagger</a></h4>
 845         <div class="VARIABLELIST">
 846           <dl>
 847             <dt>Typical use:</dt>
 848             <dd>
 849               <p>Block requests based on their headers.</p>
 850             </dd>
 851             <dt>Effect:</dt>
 852             <dd>
 853               <p>Client headers to which this action applies are filtered on-the-fly through the specified regular
 854               expression based substitutions, the result is used as tag.</p>
 855             </dd>
 856             <dt>Type:</dt>
 857             <dd>
 858               <p>Multi-value.</p>
 859             </dd>
 860             <dt>Parameter:</dt>
 861             <dd>
 862               <p>The name of a client-header tagger, as defined in one of the <a href="filter-file.html">filter
 863               files</a>.</p>
 864             </dd>
 865             <dt>Notes:</dt>
 866             <dd>
 867               <p>Client-header taggers are applied to each header on its own, and as the header isn't modified, each
 868               tagger <span class="QUOTE">"sees"</span> the original.</p>
 869               <p>Client-header taggers are the first actions that are executed and their tags can be used to control
 870               every other action.</p>
 871             </dd>
 872             <dt>Example usage (section):</dt>
 873             <dd>
 874               <table border="0" bgcolor="#E0E0E0" width="90%">
 875                 <tr>
 876                   <td>
 877                     <pre class="SCREEN"># Tag every request with the User-Agent header
 878 {+client-header-tagger{user-agent}}
 879 /
 880
 881 # Tagging itself doesn't change the action
 882 # settings, sections with TAG patterns do:
 883 #
 884 # If it's a download agent, use a different forwarding proxy,
 885 # show the real User-Agent and make sure resume works.
 886 {+forward-override{forward-socks5 10.0.0.2:2222 .} \
 887  -hide-if-modified-since      \
 888  -overwrite-last-modified     \
 889  -hide-user-agent             \
 890  -filter                      \
 891  -deanimate-gifs              \
 892 }
 893 TAG:^User-Agent: NetBSD-ftp/
 894 TAG:^User-Agent: Novell ZYPP Installer
 895 TAG:^User-Agent: RPM APT-HTTP/
 896 TAG:^User-Agent: fetch libfetch/
 897 TAG:^User-Agent: Ubuntu APT-HTTP/
 898 TAG:^User-Agent: MPlayer/</pre>
 899                   </td>
 900                 </tr>
 901               </table>
 902               <table border="0" bgcolor="#E0E0E0" width="90%">
 903                 <tr>
 904                   <td>
 905                     <pre class="SCREEN"># Tag all requests with the Range header set
 906 {+client-header-tagger{range-requests}}
 907 /
 908
 909 # Disable filtering for the tagged requests.
 910 #
 911 # With filtering enabled Privoxy would remove the Range headers
 912 # to be able to filter the whole response. The downside is that
 913 # it prevents clients from resuming downloads or skipping over
 914 # parts of multimedia files.
 915 {-filter -deanimate-gifs}
 916 TAG:^RANGE-REQUEST$</pre>
 917                   </td>
 918                 </tr>
 919               </table>
 920               <table border="0" bgcolor="#E0E0E0" width="90%">
 921                 <tr>
 922                   <td>
 923                     <pre class="SCREEN"># Tag all requests with the client IP address
 924 #
 925 # (Technically the client IP address isn't included in the
 926 # client headers but client-header taggers can set it anyway.
 927 # For details see the tagger in default.filter)
 928 {+client-header-tagger{client-ip-address}}
 929 /
 930
 931 # Change forwarding settings for requests coming from address 10.0.0.1
 932 {+forward-override{forward-socks5 127.0.1.2:2222 .}}
 933 TAG:^IP-ADDRESS: 10\.0\.0\.1$</pre>
 934                   </td>
 935                 </tr>
 936               </table>
 937             </dd>
 938           </dl>
 939         </div>
 940       </div>
 941       <div class="SECT3">
 942         <h4 class="SECT3"><a name="CONTENT-TYPE-OVERWRITE" id="CONTENT-TYPE-OVERWRITE">8.5.6.
 943         content-type-overwrite</a></h4>
 944         <div class="VARIABLELIST">
 945           <dl>
 946             <dt>Typical use:</dt>
 947             <dd>
 948               <p>Stop useless download menus from popping up, or change the browser's rendering mode</p>
 949             </dd>
 950             <dt>Effect:</dt>
 951             <dd>
 952               <p>Replaces the <span class="QUOTE">"Content-Type:"</span> HTTP server header.</p>
 953             </dd>
 954             <dt>Type:</dt>
 955             <dd>
 956               <p>Parameterized.</p>
 957             </dd>
 958             <dt>Parameter:</dt>
 959             <dd>
 960               <p>Any string.</p>
 961             </dd>
 962             <dt>Notes:</dt>
 963             <dd>
 964               <p>The <span class="QUOTE">"Content-Type:"</span> HTTP server header is used by the browser to decide
 965               what to do with the document. The value of this header can cause the browser to open a download menu
 966               instead of displaying the document by itself, even if the document's format is supported by the
 967               browser.</p>
 968               <p>The declared content type can also affect which rendering mode the browser chooses. If XHTML is
 969               delivered as <span class="QUOTE">"text/html"</span>, many browsers treat it as yet another broken HTML
 970               document. If it is send as <span class="QUOTE">"application/xml"</span>, browsers with XHTML support will
 971               only display it, if the syntax is correct.</p>
 972               <p>If you see a web site that proudly uses XHTML buttons, but sets <span class="QUOTE">"Content-Type:
 973               text/html"</span>, you can use <span class="APPLICATION">Privoxy</span> to overwrite it with <span class=
 974               "QUOTE">"application/xml"</span> and validate the web master's claim inside your XHTML-supporting
 975               browser. If the syntax is incorrect, the browser will complain loudly.</p>
 976               <p>You can also go the opposite direction: if your browser prints error messages instead of rendering a
 977               document falsely declared as XHTML, you can overwrite the content type with <span class=
 978               "QUOTE">"text/html"</span> and have it rendered as broken HTML document.</p>
 979               <p>By default <tt class="LITERAL">content-type-overwrite</tt> only replaces <span class=
 980               "QUOTE">"Content-Type:"</span> headers that look like some kind of text. If you want to overwrite it
 981               unconditionally, you have to combine it with <tt class="LITERAL"><a href=
 982               "actions-file.html#FORCE-TEXT-MODE">force-text-mode</a></tt>. This limitation exists for a reason, think
 983               twice before circumventing it.</p>
 984               <p>Most of the time it's easier to replace this action with a custom <tt class="LITERAL"><a href=
 985               "actions-file.html#SERVER-HEADER-FILTER">server-header filter</a></tt>. It allows you to activate it for
 986               every document of a certain site and it will still only replace the content types you aimed at.</p>
 987               <p>Of course you can apply <tt class="LITERAL">content-type-overwrite</tt> to a whole site and then make
 988               URL based exceptions, but it's a lot more work to get the same precision.</p>
 989             </dd>
 990             <dt>Example usage (sections):</dt>
 991             <dd>
 992               <table border="0" bgcolor="#E0E0E0" width="90%">
 993                 <tr>
 994                   <td>
 995                     <pre class="SCREEN"># Check if www.example.net/ really uses valid XHTML
 996 { +content-type-overwrite{application/xml} }
 997 www.example.net/
 998
 999 # but leave the content type unmodified if the URL looks like a style sheet
1000 {-content-type-overwrite}
1001 www.example.net/.*\.css$
1002 www.example.net/.*style</pre>
1003                   </td>
1004                 </tr>
1005               </table>
1006             </dd>
1007           </dl>
1008         </div>
1009       </div>
1010       <div class="SECT3">
1011         <h4 class="SECT3"><a name="CRUNCH-CLIENT-HEADER" id="CRUNCH-CLIENT-HEADER">8.5.7. crunch-client-header</a></h4>
1012         <div class="VARIABLELIST">
1013           <dl>
1014             <dt>Typical use:</dt>
1015             <dd>
1016               <p>Remove a client header <span class="APPLICATION">Privoxy</span> has no dedicated action for.</p>
1017             </dd>
1018             <dt>Effect:</dt>
1019             <dd>
1020               <p>Deletes every header sent by the client that contains the string the user supplied as parameter.</p>
1021             </dd>
1022             <dt>Type:</dt>
1023             <dd>
1024               <p>Parameterized.</p>
1025             </dd>
1026             <dt>Parameter:</dt>
1027             <dd>
1028               <p>Any string.</p>
1029             </dd>
1030             <dt>Notes:</dt>
1031             <dd>
1032               <p>This action allows you to block client headers for which no dedicated <span class=
1033               "APPLICATION">Privoxy</span> action exists. <span class="APPLICATION">Privoxy</span> will remove every
1034               client header that contains the string you supplied as parameter.</p>
1035               <p>Regular expressions are <span class="emphasis"><i class="EMPHASIS">not supported</i></span> and you
1036               can't use this action to block different headers in the same request, unless they contain the same
1037               string.</p>
1038               <p><tt class="LITERAL">crunch-client-header</tt> is only meant for quick tests. If you have to block
1039               several different headers, or only want to modify parts of them, you should use a <tt class=
1040               "LITERAL"><a href="actions-file.html#CLIENT-HEADER-FILTER">client-header filter</a></tt>.</p>
1041               <div class="WARNING">
1042                 <table class="WARNING" border="1" width="90%">
1043                   <tr>
1044                     <td align="center"><b>Warning</b></td>
1045                   </tr>
1046                   <tr>
1047                     <td align="left">
1048                       <p>Don't block any header without understanding the consequences.</p>
1049                     </td>
1050                   </tr>
1051                 </table>
1052               </div>
1053             </dd>
1054             <dt>Example usage (section):</dt>
1055             <dd>
1056               <table border="0" bgcolor="#E0E0E0" width="90%">
1057                 <tr>
1058                   <td>
1059                     <pre class="SCREEN"># Block the non-existent "Privacy-Violation:" client header
1060 { +crunch-client-header{Privacy-Violation:} }
1061 /</pre>
1062                   </td>
1063                 </tr>
1064               </table>
1065             </dd>
1066           </dl>
1067         </div>
1068       </div>
1069       <div class="SECT3">
1070         <h4 class="SECT3"><a name="CRUNCH-IF-NONE-MATCH" id="CRUNCH-IF-NONE-MATCH">8.5.8. crunch-if-none-match</a></h4>
1071         <div class="VARIABLELIST">
1072           <dl>
1073             <dt>Typical use:</dt>
1074             <dd>
1075               <p>Prevent yet another way to track the user's steps between sessions.</p>
1076             </dd>
1077             <dt>Effect:</dt>
1078             <dd>
1079               <p>Deletes the <span class="QUOTE">"If-None-Match:"</span> HTTP client header.</p>
1080             </dd>
1081             <dt>Type:</dt>
1082             <dd>
1083               <p>Boolean.</p>
1084             </dd>
1085             <dt>Parameter:</dt>
1086             <dd>
1087               <p>N/A</p>
1088             </dd>
1089             <dt>Notes:</dt>
1090             <dd>
1091               <p>Removing the <span class="QUOTE">"If-None-Match:"</span> HTTP client header is useful for filter
1092               testing, where you want to force a real reload instead of getting status code <span class=
1093               "QUOTE">"304"</span> which would cause the browser to use a cached copy of the page.</p>
1094               <p>It is also useful to make sure the header isn't used as a cookie replacement (unlikely but
1095               possible).</p>
1096               <p>Blocking the <span class="QUOTE">"If-None-Match:"</span> header shouldn't cause any caching problems,
1097               as long as the <span class="QUOTE">"If-Modified-Since:"</span> header isn't blocked or missing as
1098               well.</p>
1099               <p>It is recommended to use this action together with <tt class="LITERAL"><a href=
1100               "actions-file.html#HIDE-IF-MODIFIED-SINCE">hide-if-modified-since</a></tt> and <tt class=
1101               "LITERAL"><a href="actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></tt>.</p>
1102             </dd>
1103             <dt>Example usage (section):</dt>
1104             <dd>
1105               <table border="0" bgcolor="#E0E0E0" width="90%">
1106                 <tr>
1107                   <td>
1108                     <pre class="SCREEN"># Let the browser revalidate cached documents but don't
1109 # allow the server to use the revalidation headers for user tracking.
1110 {+hide-if-modified-since{-60} \
1111  +overwrite-last-modified{randomize} \
1112  +crunch-if-none-match}
1113 /</pre>
1114                   </td>
1115                 </tr>
1116               </table>
1117             </dd>
1118           </dl>
1119         </div>
1120       </div>
1121       <div class="SECT3">
1122         <h4 class="SECT3"><a name="CRUNCH-INCOMING-COOKIES" id="CRUNCH-INCOMING-COOKIES">8.5.9.
1123         crunch-incoming-cookies</a></h4>
1124         <div class="VARIABLELIST">
1125           <dl>
1126             <dt>Typical use:</dt>
1127             <dd>
1128               <p>Prevent the web server from setting HTTP cookies on your system</p>
1129             </dd>
1130             <dt>Effect:</dt>
1131             <dd>
1132               <p>Deletes any <span class="QUOTE">"Set-Cookie:"</span> HTTP headers from server replies.</p>
1133             </dd>
1134             <dt>Type:</dt>
1135             <dd>
1136               <p>Boolean.</p>
1137             </dd>
1138             <dt>Parameter:</dt>
1139             <dd>
1140               <p>N/A</p>
1141             </dd>
1142             <dt>Notes:</dt>
1143             <dd>
1144               <p>This action is only concerned with <span class="emphasis"><i class="EMPHASIS">incoming</i></span> HTTP
1145               cookies. For <span class="emphasis"><i class="EMPHASIS">outgoing</i></span> HTTP cookies, use <tt class=
1146               "LITERAL"><a href="actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a></tt>. Use
1147               <span class="emphasis"><i class="EMPHASIS">both</i></span> to disable HTTP cookies completely.</p>
1148               <p>It makes <span class="emphasis"><i class="EMPHASIS">no sense at all</i></span> to use this action in
1149               conjunction with the <tt class="LITERAL"><a href=
1150               "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></tt> action, since it would prevent the
1151               session cookies from being set. See also <tt class="LITERAL"><a href=
1152               "actions-file.html#FILTER-CONTENT-COOKIES">filter-content-cookies</a></tt>.</p>
1153             </dd>
1154             <dt>Example usage:</dt>
1155             <dd>
1156               <table border="0" bgcolor="#E0E0E0" width="90%">
1157                 <tr>
1158                   <td>
1159                     <pre class="SCREEN">+crunch-incoming-cookies</pre>
1160                   </td>
1161                 </tr>
1162               </table>
1163             </dd>
1164           </dl>
1165         </div>
1166       </div>
1167       <div class="SECT3">
1168         <h4 class="SECT3"><a name="CRUNCH-SERVER-HEADER" id="CRUNCH-SERVER-HEADER">8.5.10.
1169         crunch-server-header</a></h4>
1170         <div class="VARIABLELIST">
1171           <dl>
1172             <dt>Typical use:</dt>
1173             <dd>
1174               <p>Remove a server header <span class="APPLICATION">Privoxy</span> has no dedicated action for.</p>
1175             </dd>
1176             <dt>Effect:</dt>
1177             <dd>
1178               <p>Deletes every header sent by the server that contains the string the user supplied as parameter.</p>
1179             </dd>
1180             <dt>Type:</dt>
1181             <dd>
1182               <p>Parameterized.</p>
1183             </dd>
1184             <dt>Parameter:</dt>
1185             <dd>
1186               <p>Any string.</p>
1187             </dd>
1188             <dt>Notes:</dt>
1189             <dd>
1190               <p>This action allows you to block server headers for which no dedicated <span class=
1191               "APPLICATION">Privoxy</span> action exists. <span class="APPLICATION">Privoxy</span> will remove every
1192               server header that contains the string you supplied as parameter.</p>
1193               <p>Regular expressions are <span class="emphasis"><i class="EMPHASIS">not supported</i></span> and you
1194               can't use this action to block different headers in the same request, unless they contain the same
1195               string.</p>
1196               <p><tt class="LITERAL">crunch-server-header</tt> is only meant for quick tests. If you have to block
1197               several different headers, or only want to modify parts of them, you should use a custom <tt class=
1198               "LITERAL"><a href="actions-file.html#SERVER-HEADER-FILTER">server-header filter</a></tt>.</p>
1199               <div class="WARNING">
1200                 <table class="WARNING" border="1" width="90%">
1201                   <tr>
1202                     <td align="center"><b>Warning</b></td>
1203                   </tr>
1204                   <tr>
1205                     <td align="left">
1206                       <p>Don't block any header without understanding the consequences.</p>
1207                     </td>
1208                   </tr>
1209                 </table>
1210               </div>
1211             </dd>
1212             <dt>Example usage (section):</dt>
1213             <dd>
1214               <table border="0" bgcolor="#E0E0E0" width="90%">
1215                 <tr>
1216                   <td>
1217                     <pre class="SCREEN"># Crunch server headers that try to prevent caching
1218 { +crunch-server-header{no-cache} }
1219 /</pre>
1220                   </td>
1221                 </tr>
1222               </table>
1223             </dd>
1224           </dl>
1225         </div>
1226       </div>
1227       <div class="SECT3">
1228         <h4 class="SECT3"><a name="CRUNCH-OUTGOING-COOKIES" id="CRUNCH-OUTGOING-COOKIES">8.5.11.
1229         crunch-outgoing-cookies</a></h4>
1230         <div class="VARIABLELIST">
1231           <dl>
1232             <dt>Typical use:</dt>
1233             <dd>
1234               <p>Prevent the web server from reading any HTTP cookies from your system</p>
1235             </dd>
1236             <dt>Effect:</dt>
1237             <dd>
1238               <p>Deletes any <span class="QUOTE">"Cookie:"</span> HTTP headers from client requests.</p>
1239             </dd>
1240             <dt>Type:</dt>
1241             <dd>
1242               <p>Boolean.</p>
1243             </dd>
1244             <dt>Parameter:</dt>
1245             <dd>
1246               <p>N/A</p>
1247             </dd>
1248             <dt>Notes:</dt>
1249             <dd>
1250               <p>This action is only concerned with <span class="emphasis"><i class="EMPHASIS">outgoing</i></span> HTTP
1251               cookies. For <span class="emphasis"><i class="EMPHASIS">incoming</i></span> HTTP cookies, use <tt class=
1252               "LITERAL"><a href="actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a></tt>. Use
1253               <span class="emphasis"><i class="EMPHASIS">both</i></span> to disable HTTP cookies completely.</p>
1254               <p>It makes <span class="emphasis"><i class="EMPHASIS">no sense at all</i></span> to use this action in
1255               conjunction with the <tt class="LITERAL"><a href=
1256               "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></tt> action, since it would prevent the
1257               session cookies from being read.</p>
1258             </dd>
1259             <dt>Example usage:</dt>
1260             <dd>
1261               <table border="0" bgcolor="#E0E0E0" width="90%">
1262                 <tr>
1263                   <td>
1264                     <pre class="SCREEN">+crunch-outgoing-cookies</pre>
1265                   </td>
1266                 </tr>
1267               </table>
1268             </dd>
1269           </dl>
1270         </div>
1271       </div>
1272       <div class="SECT3">
1273         <h4 class="SECT3"><a name="DEANIMATE-GIFS" id="DEANIMATE-GIFS">8.5.12. deanimate-gifs</a></h4>
1274         <div class="VARIABLELIST">
1275           <dl>
1276             <dt>Typical use:</dt>
1277             <dd>
1278               <p>Stop those annoying, distracting animated GIF images.</p>
1279             </dd>
1280             <dt>Effect:</dt>
1281             <dd>
1282               <p>De-animate GIF animations, i.e. reduce them to their first or last image.</p>
1283             </dd>
1284             <dt>Type:</dt>
1285             <dd>
1286               <p>Parameterized.</p>
1287             </dd>
1288             <dt>Parameter:</dt>
1289             <dd>
1290               <p><span class="QUOTE">"last"</span> or <span class="QUOTE">"first"</span></p>
1291             </dd>
1292             <dt>Notes:</dt>
1293             <dd>
1294               <p>This will also shrink the images considerably (in bytes, not pixels!). If the option <span class=
1295               "QUOTE">"first"</span> is given, the first frame of the animation is used as the replacement. If
1296               <span class="QUOTE">"last"</span> is given, the last frame of the animation is used instead, which
1297               probably makes more sense for most banner animations, but also has the risk of not showing the entire
1298               last frame (if it is only a delta to an earlier frame).</p>
1299               <p>You can safely use this action with patterns that will also match non-GIF objects, because no attempt
1300               will be made at anything that doesn't look like a GIF.</p>
1301             </dd>
1302             <dt>Example usage:</dt>
1303             <dd>
1304               <table border="0" bgcolor="#E0E0E0" width="90%">
1305                 <tr>
1306                   <td>
1307                     <pre class="SCREEN">+deanimate-gifs{last}</pre>
1308                   </td>
1309                 </tr>
1310               </table>
1311             </dd>
1312           </dl>
1313         </div>
1314       </div>
1315       <div class="SECT3">
1316         <h4 class="SECT3"><a name="DOWNGRADE-HTTP-VERSION" id="DOWNGRADE-HTTP-VERSION">8.5.13.
1317         downgrade-http-version</a></h4>
1318         <div class="VARIABLELIST">
1319           <dl>
1320             <dt>Typical use:</dt>
1321             <dd>
1322               <p>Work around (very rare) problems with HTTP/1.1</p>
1323             </dd>
1324             <dt>Effect:</dt>
1325             <dd>
1326               <p>Downgrades HTTP/1.1 client requests and server replies to HTTP/1.0.</p>
1327             </dd>
1328             <dt>Type:</dt>
1329             <dd>
1330               <p>Boolean.</p>
1331             </dd>
1332             <dt>Parameter:</dt>
1333             <dd>
1334               <p>N/A</p>
1335             </dd>
1336             <dt>Notes:</dt>
1337             <dd>
1338               <p>This is a left-over from the time when <span class="APPLICATION">Privoxy</span> didn't support
1339               important HTTP/1.1 features well. It is left here for the unlikely case that you experience
1340               HTTP/1.1-related problems with some server out there.</p>
1341               <p>Note that enabling this action is only a workaround. It should not be enabled for sites that work
1342               without it. While it shouldn't break any pages, it has an (usually negative) performance impact.</p>
1343               <p>If you come across a site where enabling this action helps, please report it, so the cause of the
1344               problem can be analyzed. If the problem turns out to be caused by a bug in <span class=
1345               "APPLICATION">Privoxy</span> it should be fixed so the following release works without the work
1346               around.</p>
1347             </dd>
1348             <dt>Example usage (section):</dt>
1349             <dd>
1350               <table border="0" bgcolor="#E0E0E0" width="90%">
1351                 <tr>
1352                   <td>
1353                     <pre class="SCREEN">{+downgrade-http-version}
1354 problem-host.example.com</pre>
1355                   </td>
1356                 </tr>
1357               </table>
1358             </dd>
1359           </dl>
1360         </div>
1361       </div>
1362       <div class="SECT3">
1363         <h4 class="SECT3"><a name="EXTERNAL-FILTER" id="EXTERNAL-FILTER">8.5.14. external-filter</a></h4>
1364         <div class="VARIABLELIST">
1365           <dl>
1366             <dt>Typical use:</dt>
1367             <dd>
1368               <p>Modify content using a programming language of your choice.</p>
1369             </dd>
1370             <dt>Effect:</dt>
1371             <dd>
1372               <p>All instances of text-based type, most notably HTML and JavaScript, to which this action applies, can
1373               be filtered on-the-fly through the specified external filter. By default plain text documents are
1374               exempted from filtering, because web servers often use the <tt class="LITERAL">text/plain</tt> MIME type
1375               for all files whose type they don't know.)</p>
1376             </dd>
1377             <dt>Type:</dt>
1378             <dd>
1379               <p>Multi-value.</p>
1380             </dd>
1381             <dt>Parameter:</dt>
1382             <dd>
1383               <p>The name of an external content filter, as defined in the <a href="filter-file.html">filter file</a>.
1384               External filters can be defined in one or more files as defined by the <tt class="LITERAL"><a href=
1385               "config.html#FILTERFILE">filterfile</a></tt> option in the <a href="config.html">config file</a>.</p>
1386               <p>When used in its negative form, and without parameters, <span class="emphasis"><i class=
1387               "EMPHASIS">all</i></span> filtering with external filters is completely disabled.</p>
1388             </dd>
1389             <dt>Notes:</dt>
1390             <dd>
1391               <p>External filters are scripts or programs that can modify the content in case common <tt class=
1392               "LITERAL"><a href="actions-file.html#FILTER">filters</a></tt> aren't powerful enough. With the exception
1393               that this action doesn't use pcrs-based filters, the notes in the <tt class="LITERAL"><a href=
1394               "actions-file.html#FILTER">filter</a></tt> section apply.</p>
1395               <div class="WARNING">
1396                 <table class="WARNING" border="1" width="90%">
1397                   <tr>
1398                     <td align="center"><b>Warning</b></td>
1399                   </tr>
1400                   <tr>
1401                     <td align="left">
1402                       <p>Currently external filters are executed with <span class="APPLICATION">Privoxy</span>'s
1403                       privileges. Only use external filters you understand and trust.</p>
1404                     </td>
1405                   </tr>
1406                 </table>
1407               </div>
1408               <p>This feature is experimental, the <tt class="LITERAL"><a href=
1409               "filter-file.html#EXTERNAL-FILTER-SYNTAX">syntax</a></tt> may change in the future.</p>
1410             </dd>
1411             <dt>Example usage:</dt>
1412             <dd>
1413               <table border="0" bgcolor="#E0E0E0" width="90%">
1414                 <tr>
1415                   <td>
1416                     <pre class="SCREEN">+external-filter{fancy-filter}</pre>
1417                   </td>
1418                 </tr>
1419               </table>
1420             </dd>
1421           </dl>
1422         </div>
1423       </div>
1424       <div class="SECT3">
1425         <h4 class="SECT3"><a name="FAST-REDIRECTS" id="FAST-REDIRECTS">8.5.15. fast-redirects</a></h4>
1426         <div class="VARIABLELIST">
1427           <dl>
1428             <dt>Typical use:</dt>
1429             <dd>
1430               <p>Fool some click-tracking scripts and speed up indirect links.</p>
1431             </dd>
1432             <dt>Effect:</dt>
1433             <dd>
1434               <p>Detects redirection URLs and redirects the browser without contacting the redirection server
1435               first.</p>
1436             </dd>
1437             <dt>Type:</dt>
1438             <dd>
1439               <p>Parameterized.</p>
1440             </dd>
1441             <dt>Parameter:</dt>
1442             <dd>
1443               <ul>
1444                 <li>
1445                   <p><span class="QUOTE">"simple-check"</span> to just search for the string <span class=
1446                   "QUOTE">"http://"</span> to detect redirection URLs.</p>
1447                 </li>
1448                 <li>
1449                   <p><span class="QUOTE">"check-decoded-url"</span> to decode URLs (if necessary) before searching for
1450                   redirection URLs.</p>
1451                 </li>
1452               </ul>
1453             </dd>
1454             <dt>Notes:</dt>
1455             <dd>
1456               <p>Many sites, like yahoo.com, don't just link to other sites. Instead, they will link to some script on
1457               their own servers, giving the destination as a parameter, which will then redirect you to the final
1458               target. URLs resulting from this scheme typically look like: <span class=
1459               "QUOTE">"http://www.example.org/click-tracker.cgi?target=http%3a//www.example.net/"</span>.</p>
1460               <p>Sometimes, there are even multiple consecutive redirects encoded in the URL. These redirections via
1461               scripts make your web browsing more traceable, since the server from which you follow such a link can see
1462               where you go to. Apart from that, valuable bandwidth and time is wasted, while your browser asks the
1463               server for one redirect after the other. Plus, it feeds the advertisers.</p>
1464               <p>This feature is currently not very smart and is scheduled for improvement. If it is enabled by
1465               default, you will have to create some exceptions to this action. It can lead to failures in several
1466               ways:</p>
1467               <p>Not every URLs with other URLs as parameters is evil. Some sites offer a real service that requires
1468               this information to work. For example a validation service needs to know, which document to validate.
1469               <tt class="LITERAL">fast-redirects</tt> assumes that every URL parameter that looks like another URL is a
1470               redirection target, and will always redirect to the last one. Most of the time the assumption is correct,
1471               but if it isn't, the user gets redirected anyway.</p>
1472               <p>Another failure occurs if the URL contains other parameters after the URL parameter. The URL:
1473               <span class="QUOTE">"http://www.example.org/?redirect=http%3a//www.example.net/&amp;foo=bar"</span>.
1474               contains the redirection URL <span class="QUOTE">"http://www.example.net/"</span>, followed by another
1475               parameter. <tt class="LITERAL">fast-redirects</tt> doesn't know that and will cause a redirect to
1476               <span class="QUOTE">"http://www.example.net/&amp;foo=bar"</span>. Depending on the target server
1477               configuration, the parameter will be silently ignored or lead to a <span class="QUOTE">"page not
1478               found"</span> error. You can prevent this problem by first using the <tt class="LITERAL"><a href=
1479               "actions-file.html#REDIRECT">redirect</a></tt> action to remove the last part of the URL, but it requires
1480               a little effort.</p>
1481               <p>To detect a redirection URL, <tt class="LITERAL">fast-redirects</tt> only looks for the string
1482               <span class="QUOTE">"http://"</span>, either in plain text (invalid but often used) or encoded as
1483               <span class="QUOTE">"http%3a//"</span>. Some sites use their own URL encoding scheme, encrypt the address
1484               of the target server or replace it with a database id. In theses cases <tt class=
1485               "LITERAL">fast-redirects</tt> is fooled and the request reaches the redirection server where it probably
1486               gets logged.</p>
1487             </dd>
1488             <dt>Example usage:</dt>
1489             <dd>
1490               <table border="0" bgcolor="#E0E0E0" width="90%">
1491                 <tr>
1492                   <td>
1493                     <pre class="SCREEN"> { +fast-redirects{simple-check} }
1494    one.example.com
1495
1496  { +fast-redirects{check-decoded-url} }
1497    another.example.com/testing</pre>
1498                   </td>
1499                 </tr>
1500               </table>
1501             </dd>
1502           </dl>
1503         </div>
1504       </div>
1505       <div class="SECT3">
1506         <h4 class="SECT3"><a name="FILTER" id="FILTER">8.5.16. filter</a></h4>
1507         <div class="VARIABLELIST">
1508           <dl>
1509             <dt>Typical use:</dt>
1510             <dd>
1511               <p>Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements,
1512               add personalized effects, etc.</p>
1513             </dd>
1514             <dt>Effect:</dt>
1515             <dd>
1516               <p>All instances of text-based type, most notably HTML and JavaScript, to which this action applies, can
1517               be filtered on-the-fly through the specified regular expression based substitutions. (Note: as of version
1518               3.0.3 plain text documents are exempted from filtering, because web servers often use the <tt class=
1519               "LITERAL">text/plain</tt> MIME type for all files whose type they don't know.)</p>
1520             </dd>
1521             <dt>Type:</dt>
1522             <dd>
1523               <p>Multi-value.</p>
1524             </dd>
1525             <dt>Parameter:</dt>
1526             <dd>
1527               <p>The name of a content filter, as defined in the <a href="filter-file.html">filter file</a>. Filters
1528               can be defined in one or more files as defined by the <tt class="LITERAL"><a href=
1529               "config.html#FILTERFILE">filterfile</a></tt> option in the <a href="config.html">config file</a>.
1530               <tt class="FILENAME">default.filter</tt> is the collection of filters supplied by the developers. Locally
1531               defined filters should go in their own file, such as <tt class="FILENAME">user.filter</tt>.</p>
1532               <p>When used in its negative form, and without parameters, <span class="emphasis"><i class=
1533               "EMPHASIS">all</i></span> filtering is completely disabled.</p>
1534             </dd>
1535             <dt>Notes:</dt>
1536             <dd>
1537               <p>For your convenience, there are a number of pre-defined filters available in the distribution filter
1538               file that you can use. See the examples below for a list.</p>
1539               <p>Filtering requires buffering the page content, which may appear to slow down page rendering since
1540               nothing is displayed until all content has passed the filters. (The total time until the page is
1541               completely rendered doesn't change much, but it may be perceived as slower since the page is not
1542               incrementally displayed.) This effect will be more noticeable on slower connections.</p>
1543               <p><span class="QUOTE">"Rolling your own"</span> filters requires a knowledge of <a href=
1544               "http://en.wikipedia.org/wiki/Regular_expressions" target="_top"><span class="QUOTE">"Regular
1545               Expressions"</span></a> and <a href="http://en.wikipedia.org/wiki/Html" target="_top"><span class=
1546               "QUOTE">"HTML"</span></a>. This is very powerful feature, and potentially very intrusive. Filters should
1547               be used with caution, and where an equivalent <span class="QUOTE">"action"</span> is not available.</p>
1548               <p>The amount of data that can be filtered is limited to the <tt class="LITERAL"><a href=
1549               "config.html#BUFFER-LIMIT">buffer-limit</a></tt> option in the main <a href="config.html">config
1550               file</a>. The default is 4096 KB (4 Megs). Once this limit is exceeded, the buffered data, and all
1551               pending data, is passed through unfiltered.</p>
1552               <p>Inappropriate MIME types, such as zipped files, are not filtered at all. (Again, only text-based types
1553               except plain text). Encrypted SSL data (from HTTPS servers) cannot be filtered either, since this would
1554               violate the integrity of the secure transaction. In some situations it might be necessary to protect
1555               certain text, like source code, from filtering by defining appropriate <tt class="LITERAL">-filter</tt>
1556               exceptions.</p>
1557               <p>Compressed content can't be filtered either, but if <span class="APPLICATION">Privoxy</span> is
1558               compiled with zlib support and a supported compression algorithm is used (gzip or deflate), <span class=
1559               "APPLICATION">Privoxy</span> can first decompress the content and then filter it.</p>
1560               <p>If you use a <span class="APPLICATION">Privoxy</span> version without zlib support, but want filtering
1561               to work on as much documents as possible, even those that would normally be sent compressed, you must use
1562               the <tt class="LITERAL"><a href="actions-file.html#PREVENT-COMPRESSION">prevent-compression</a></tt>
1563               action in conjunction with <tt class="LITERAL">filter</tt>.</p>
1564               <p>Content filtering can achieve some of the same effects as the <tt class="LITERAL"><a href=
1565               "actions-file.html#BLOCK">block</a></tt> action, i.e. it can be used to block ads and banners. But the
1566               mechanism works quite differently. One effective use, is to block ad banners based on their size (see
1567               below), since many of these seem to be somewhat standardized.</p>
1568               <p><a href="contact.html">Feedback</a> with suggestions for new or improved filters is particularly
1569               welcome!</p>
1570               <p>The below list has only the names and a one-line description of each predefined filter. There are
1571               <a href="filter-file.html#PREDEFINED-FILTERS">more verbose explanations</a> of what these filters do in
1572               the <a href="filter-file.html">filter file chapter</a>.</p>
1573             </dd>
1574             <dt>Example usage (with filters from the distribution <tt class="FILENAME">default.filter</tt> file). See
1575             <a href="filter-file.html#PREDEFINED-FILTERS">the Predefined Filters section</a> for more explanation on
1576             each:</dt>
1577             <dd>
1578               <p><a name="FILTER-JS-ANNOYANCES" id="FILTER-JS-ANNOYANCES"></a></p>
1579               <table border="0" bgcolor="#E0E0E0" width="90%">
1580                 <tr>
1581                   <td>
1582                     <pre class=
1583                     "SCREEN">+filter{js-annoyances}       # Get rid of particularly annoying JavaScript abuse.</pre>
1584                   </td>
1585                 </tr>
1586               </table>
1587               <p><a name="FILTER-JS-EVENTS" id="FILTER-JS-EVENTS"></a></p>
1588               <table border="0" bgcolor="#E0E0E0" width="90%">
1589                 <tr>
1590                   <td>
1591                     <pre class=
1592                     "SCREEN">+filter{js-events}           # Kill JavaScript event bindings and timers (Radically destructive! Only for extra nasty sites).</pre>
1593                   </td>
1594                 </tr>
1595               </table>
1596               <p><a name="FILTER-HTML-ANNOYANCES" id="FILTER-HTML-ANNOYANCES"></a></p>
1597               <table border="0" bgcolor="#E0E0E0" width="90%">
1598                 <tr>
1599                   <td>
1600                     <pre class=
1601                     "SCREEN">+filter{html-annoyances}     # Get rid of particularly annoying HTML abuse.</pre>
1602                   </td>
1603                 </tr>
1604               </table>
1605               <p><a name="FILTER-CONTENT-COOKIES" id="FILTER-CONTENT-COOKIES"></a></p>
1606               <table border="0" bgcolor="#E0E0E0" width="90%">
1607                 <tr>
1608                   <td>
1609                     <pre class=
1610                     "SCREEN">+filter{content-cookies}     # Kill cookies that come in the HTML or JS content.</pre>
1611                   </td>
1612                 </tr>
1613               </table>
1614               <p><a name="FILTER-REFRESH-TAGS" id="FILTER-REFRESH-TAGS"></a></p>
1615               <table border="0" bgcolor="#E0E0E0" width="90%">
1616                 <tr>
1617                   <td>
1618                     <pre class=
1619                     "SCREEN">+filter{refresh-tags}        # Kill automatic refresh tags if refresh time is larger than 9 seconds.</pre>
1620                   </td>
1621                 </tr>
1622               </table>
1623               <p><a name="FILTER-UNSOLICITED-POPUPS" id="FILTER-UNSOLICITED-POPUPS"></a></p>
1624               <table border="0" bgcolor="#E0E0E0" width="90%">
1625                 <tr>
1626                   <td>
1627                     <pre class="SCREEN">+filter{unsolicited-popups}  # Disable only unsolicited pop-up windows.</pre>
1628                   </td>
1629                 </tr>
1630               </table>
1631               <p><a name="FILTER-ALL-POPUPS" id="FILTER-ALL-POPUPS"></a></p>
1632               <table border="0" bgcolor="#E0E0E0" width="90%">
1633                 <tr>
1634                   <td>
1635                     <pre class="SCREEN">+filter{all-popups}          # Kill all popups in JavaScript and HTML.</pre>
1636                   </td>
1637                 </tr>
1638               </table>
1639               <p><a name="FILTER-IMG-REORDER" id="FILTER-IMG-REORDER"></a></p>
1640               <table border="0" bgcolor="#E0E0E0" width="90%">
1641                 <tr>
1642                   <td>
1643                     <pre class=
1644                     "SCREEN">+filter{img-reorder}         # Reorder attributes in &lt;img&gt; tags to make the banners-by-* filters more effective.</pre>
1645                   </td>
1646                 </tr>
1647               </table>
1648               <p><a name="FILTER-BANNERS-BY-SIZE" id="FILTER-BANNERS-BY-SIZE"></a></p>
1649               <table border="0" bgcolor="#E0E0E0" width="90%">
1650                 <tr>
1651                   <td>
1652                     <pre class="SCREEN">+filter{banners-by-size}     # Kill banners by size.</pre>
1653                   </td>
1654                 </tr>
1655               </table>
1656               <p><a name="FILTER-BANNERS-BY-LINK" id="FILTER-BANNERS-BY-LINK"></a></p>
1657               <table border="0" bgcolor="#E0E0E0" width="90%">
1658                 <tr>
1659                   <td>
1660                     <pre class=
1661                     "SCREEN">+filter{banners-by-link}     # Kill banners by their links to known clicktrackers.</pre>
1662                   </td>
1663                 </tr>
1664               </table>
1665               <p><a name="FILTER-WEBBUGS" id="FILTER-WEBBUGS"></a></p>
1666               <table border="0" bgcolor="#E0E0E0" width="90%">
1667                 <tr>
1668                   <td>
1669                     <pre class=
1670                     "SCREEN">+filter{webbugs}             # Squish WebBugs (1x1 invisible GIFs used for user tracking).</pre>
1671                   </td>
1672                 </tr>
1673               </table>
1674               <p><a name="FILTER-TINY-TEXTFORMS" id="FILTER-TINY-TEXTFORMS"></a></p>
1675               <table border="0" bgcolor="#E0E0E0" width="90%">
1676                 <tr>
1677                   <td>
1678                     <pre class=
1679                     "SCREEN">+filter{tiny-textforms}      # Extend those tiny textareas up to 40x80 and kill the hard wrap.</pre>
1680                   </td>
1681                 </tr>
1682               </table>
1683               <p><a name="FILTER-JUMPING-WINDOWS" id="FILTER-JUMPING-WINDOWS"></a></p>
1684               <table border="0" bgcolor="#E0E0E0" width="90%">
1685                 <tr>
1686                   <td>
1687                     <pre class=
1688                     "SCREEN">+filter{jumping-windows}     # Prevent windows from resizing and moving themselves.</pre>
1689                   </td>
1690                 </tr>
1691               </table>
1692               <p><a name="FILTER-FRAMESET-BORDERS" id="FILTER-FRAMESET-BORDERS"></a></p>
1693               <table border="0" bgcolor="#E0E0E0" width="90%">
1694                 <tr>
1695                   <td>
1696                     <pre class=
1697                     "SCREEN">+filter{frameset-borders}    # Give frames a border and make them resizable.</pre>
1698                   </td>
1699                 </tr>
1700               </table>
1701               <p><a name="FILTER-IFRAMES" id="FILTER-IFRAMES"></a></p>
1702               <table border="0" bgcolor="#E0E0E0" width="90%">
1703                 <tr>
1704                   <td>
1705                     <pre class=
1706                     "SCREEN">+filter{iframes}             # Removes all detected iframes. Should only be enabled for individual sites.</pre>
1707                   </td>
1708                 </tr>
1709               </table>
1710               <p><a name="FILTER-DEMORONIZER" id="FILTER-DEMORONIZER"></a></p>
1711               <table border="0" bgcolor="#E0E0E0" width="90%">
1712                 <tr>
1713                   <td>
1714                     <pre class=
1715                     "SCREEN">+filter{demoronizer}         # Fix MS's non-standard use of standard charsets.</pre>
1716                   </td>
1717                 </tr>
1718               </table>
1719               <p><a name="FILTER-SHOCKWAVE-FLASH" id="FILTER-SHOCKWAVE-FLASH"></a></p>
1720               <table border="0" bgcolor="#E0E0E0" width="90%">
1721                 <tr>
1722                   <td>
1723                     <pre class="SCREEN">+filter{shockwave-flash}     # Kill embedded Shockwave Flash objects.</pre>
1724                   </td>
1725                 </tr>
1726               </table>
1727               <p><a name="FILTER-QUICKTIME-KIOSKMODE" id="FILTER-QUICKTIME-KIOSKMODE"></a></p>
1728               <table border="0" bgcolor="#E0E0E0" width="90%">
1729                 <tr>
1730                   <td>
1731                     <pre class="SCREEN">+filter{quicktime-kioskmode} # Make Quicktime movies saveable.</pre>
1732                   </td>
1733                 </tr>
1734               </table>
1735               <p><a name="FILTER-FUN" id="FILTER-FUN"></a></p>
1736               <table border="0" bgcolor="#E0E0E0" width="90%">
1737                 <tr>
1738                   <td>
1739                     <pre class=
1740                     "SCREEN">+filter{fun}                 # Text replacements for subversive browsing fun!</pre>
1741                   </td>
1742                 </tr>
1743               </table>
1744               <p><a name="FILTER-CRUDE-PARENTAL" id="FILTER-CRUDE-PARENTAL"></a></p>
1745               <table border="0" bgcolor="#E0E0E0" width="90%">
1746                 <tr>
1747                   <td>
1748                     <pre class=
1749                     "SCREEN">+filter{crude-parental}      # Crude parental filtering. Note that this filter doesn't work reliably.</pre>
1750                   </td>
1751                 </tr>
1752               </table>
1753               <p><a name="FILTER-IE-EXPLOITS" id="FILTER-IE-EXPLOITS"></a></p>
1754               <table border="0" bgcolor="#E0E0E0" width="90%">
1755                 <tr>
1756                   <td>
1757                     <pre class=
1758                     "SCREEN">+filter{ie-exploits}         # Disable some known Internet Explorer bug exploits.</pre>
1759                   </td>
1760                 </tr>
1761               </table>
1762               <p><a name="FILTER-SITE-SPECIFICS" id="FILTER-SITE-SPECIFICS"></a></p>
1763               <table border="0" bgcolor="#E0E0E0" width="90%">
1764                 <tr>
1765                   <td>
1766                     <pre class=
1767                     "SCREEN">+filter{site-specifics}      # Cure for site-specific problems. Don't apply generally!</pre>
1768                   </td>
1769                 </tr>
1770               </table>
1771               <p><a name="FILTER-NO-PING" id="FILTER-NO-PING"></a></p>
1772               <table border="0" bgcolor="#E0E0E0" width="90%">
1773                 <tr>
1774                   <td>
1775                     <pre class=
1776                     "SCREEN">+filter{no-ping}             # Removes non-standard ping attributes in &lt;a&gt; and &lt;area&gt; tags.</pre>
1777                   </td>
1778                 </tr>
1779               </table>
1780               <p><a name="FILTER-GOOGLE" id="FILTER-GOOGLE"></a></p>
1781               <table border="0" bgcolor="#E0E0E0" width="90%">
1782                 <tr>
1783                   <td>
1784                     <pre class=
1785                     "SCREEN">+filter{google}              # CSS-based block for Google text ads. Also removes a width limitation and the toolbar advertisement.</pre>
1786                   </td>
1787                 </tr>
1788               </table>
1789               <p><a name="FILTER-YAHOO" id="FILTER-YAHOO"></a></p>
1790               <table border="0" bgcolor="#E0E0E0" width="90%">
1791                 <tr>
1792                   <td>
1793                     <pre class=
1794                     "SCREEN">+filter{yahoo}               # CSS-based block for Yahoo text ads. Also removes a width limitation.</pre>
1795                   </td>
1796                 </tr>
1797               </table>
1798               <p><a name="FILTER-MSN" id="FILTER-MSN"></a></p>
1799               <table border="0" bgcolor="#E0E0E0" width="90%">
1800                 <tr>
1801                   <td>
1802                     <pre class=
1803                     "SCREEN">+filter{msn}                 # CSS-based block for MSN text ads. Also removes tracking URLs and a width limitation.</pre>
1804                   </td>
1805                 </tr>
1806               </table>
1807               <p><a name="FILTER-BLOGSPOT" id="FILTER-BLOGSPOT"></a></p>
1808               <table border="0" bgcolor="#E0E0E0" width="90%">
1809                 <tr>
1810                   <td>
1811                     <pre class=
1812                     "SCREEN">+filter{blogspot}            # Cleans up some Blogspot blogs. Read the fine print before using this.</pre>
1813                   </td>
1814                 </tr>
1815               </table>
1816             </dd>
1817           </dl>
1818         </div>
1819       </div>
1820       <div class="SECT3">
1821         <h4 class="SECT3"><a name="FORCE-TEXT-MODE" id="FORCE-TEXT-MODE">8.5.17. force-text-mode</a></h4>
1822         <div class="VARIABLELIST">
1823           <dl>
1824             <dt>Typical use:</dt>
1825             <dd>
1826               <p>Force <span class="APPLICATION">Privoxy</span> to treat a document as if it was in some kind of
1827               <span class="emphasis"><i class="EMPHASIS">text</i></span> format.</p>
1828             </dd>
1829             <dt>Effect:</dt>
1830             <dd>
1831               <p>Declares a document as text, even if the <span class="QUOTE">"Content-Type:"</span> isn't detected as
1832               such.</p>
1833             </dd>
1834             <dt>Type:</dt>
1835             <dd>
1836               <p>Boolean.</p>
1837             </dd>
1838             <dt>Parameter:</dt>
1839             <dd>
1840               <p>N/A</p>
1841             </dd>
1842             <dt>Notes:</dt>
1843             <dd>
1844               <p>As explained <tt class="LITERAL"><a href="actions-file.html#FILTER">above</a></tt>, <span class=
1845               "APPLICATION">Privoxy</span> tries to only filter files that are in some kind of text format. The same
1846               restrictions apply to <tt class="LITERAL"><a href=
1847               "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite</a></tt>. <tt class=
1848               "LITERAL">force-text-mode</tt> declares a document as text, without looking at the <span class=
1849               "QUOTE">"Content-Type:"</span> first.</p>
1850               <div class="WARNING">
1851                 <table class="WARNING" border="1" width="90%">
1852                   <tr>
1853                     <td align="center"><b>Warning</b></td>
1854                   </tr>
1855                   <tr>
1856                     <td align="left">
1857                       <p>Think twice before activating this action. Filtering binary data with regular expressions can
1858                       cause file damage.</p>
1859                     </td>
1860                   </tr>
1861                 </table>
1862               </div>
1863             </dd>
1864             <dt>Example usage:</dt>
1865             <dd>
1866               <table border="0" bgcolor="#E0E0E0" width="90%">
1867                 <tr>
1868                   <td>
1869                     <pre class="SCREEN">+force-text-mode</pre>
1870                   </td>
1871                 </tr>
1872               </table>
1873             </dd>
1874           </dl>
1875         </div>
1876       </div>
1877       <div class="SECT3">
1878         <h4 class="SECT3"><a name="FORWARD-OVERRIDE" id="FORWARD-OVERRIDE">8.5.18. forward-override</a></h4>
1879         <div class="VARIABLELIST">
1880           <dl>
1881             <dt>Typical use:</dt>
1882             <dd>
1883               <p>Change the forwarding settings based on User-Agent or request origin</p>
1884             </dd>
1885             <dt>Effect:</dt>
1886             <dd>
1887               <p>Overrules the forward directives in the configuration file.</p>
1888             </dd>
1889             <dt>Type:</dt>
1890             <dd>
1891               <p>Parameterized.</p>
1892             </dd>
1893             <dt>Parameter:</dt>
1894             <dd>
1895               <ul>
1896                 <li>
1897                   <p><span class="QUOTE">"forward ."</span> to use a direct connection without any additional
1898                   proxies.</p>
1899                 </li>
1900                 <li>
1901                   <p><span class="QUOTE">"forward 127.0.0.1:8123"</span> to use the HTTP proxy listening at 127.0.0.1
1902                   port 8123.</p>
1903                 </li>
1904                 <li>
1905                   <p><span class="QUOTE">"forward-socks4a 127.0.0.1:9050 ."</span> to use the socks4a proxy listening
1906                   at 127.0.0.1 port 9050. Replace <span class="QUOTE">"forward-socks4a"</span> with <span class=
1907                   "QUOTE">"forward-socks4"</span> to use a socks4 connection (with local DNS resolution) instead, use
1908                   <span class="QUOTE">"forward-socks5"</span> for socks5 connections (with remote DNS resolution).</p>
1909                 </li>
1910                 <li>
1911                   <p><span class="QUOTE">"forward-socks4a 127.0.0.1:9050 proxy.example.org:8000"</span> to use the
1912                   socks4a proxy listening at 127.0.0.1 port 9050 to reach the HTTP proxy listening at proxy.example.org
1913                   port 8000. Replace <span class="QUOTE">"forward-socks4a"</span> with <span class=
1914                   "QUOTE">"forward-socks4"</span> to use a socks4 connection (with local DNS resolution) instead, use
1915                   <span class="QUOTE">"forward-socks5"</span> for socks5 connections (with remote DNS resolution).</p>
1916                 </li>
1917                 <li>
1918                   <p><span class="QUOTE">"forward-webserver 127.0.0.1:80"</span> to use the HTTP server listening at
1919                   127.0.0.1 port 80 without adjusting the request headers.</p>
1920                   <p>This makes it more convenient to use Privoxy to make existing websites available as onion services
1921                   as well.</p>
1922                   <p>Many websites serve content with hardcoded URLs and can't be easily adjusted to change the domain
1923                   based on the one used by the client.</p>
1924                   <p>Putting Privoxy between Tor and the webserver (or an stunnel that forwards to the webserver)
1925                   allows to rewrite headers and content to make client and server happy at the same time.</p>
1926                   <p>Using Privoxy for webservers that are only reachable through onion addresses and whose location is
1927                   supposed to be secret is not recommended and should not be necessary anyway.</p>
1928                 </li>
1929               </ul>
1930             </dd>
1931             <dt>Notes:</dt>
1932             <dd>
1933               <p>This action takes parameters similar to the <a href="config.html#FORWARDING">forward</a> directives in
1934               the configuration file, but without the URL pattern. It can be used as replacement, but normally it's
1935               only used in cases where matching based on the request URL isn't sufficient.</p>
1936               <div class="WARNING">
1937                 <table class="WARNING" border="1" width="90%">
1938                   <tr>
1939                     <td align="center"><b>Warning</b></td>
1940                   </tr>
1941                   <tr>
1942                     <td align="left">
1943                       <p>Please read the description for the <a href="config.html#FORWARDING">forward</a> directives
1944                       before using this action. Forwarding to the wrong people will reduce your privacy and increase
1945                       the chances of man-in-the-middle attacks.</p>
1946                       <p>If the ports are missing or invalid, default values will be used. This might change in the
1947                       future and you shouldn't rely on it. Otherwise incorrect syntax causes Privoxy to exit. Due to
1948                       design limitations, invalid parameter syntax isn't detected until the action is used the first
1949                       time.</p>
1950                       <p>Use the <a href="http://config.privoxy.org/show-url-info" target="_top">show-url-info CGI
1951                       page</a> to verify that your forward settings do what you thought the do.</p>
1952                     </td>
1953                   </tr>
1954                 </table>
1955               </div>
1956             </dd>
1957             <dt>Example usage:</dt>
1958             <dd>
1959               <table border="0" bgcolor="#E0E0E0" width="90%">
1960                 <tr>
1961                   <td>
1962                     <pre class="SCREEN"># Use an ssh tunnel for requests previously tagged as
1963 # <span class="QUOTE">"User-Agent: fetch libfetch/2.0"</span> and make sure
1964 # resuming downloads continues to work.
1965 #
1966 # This way you can continue to use Tor for your normal browsing,
1967 # without overloading the Tor network with your FreeBSD ports updates
1968 # or downloads of bigger files like ISOs.
1969 #
1970 # Note that HTTP headers are easy to fake and therefore their
1971 # values are as (un)trustworthy as your clients and users.
1972 {+forward-override{forward-socks5 10.0.0.2:2222 .} \
1973  -hide-if-modified-since      \
1974  -overwrite-last-modified     \
1975 }
1976 TAG:^User-Agent: fetch libfetch/2\.0$</pre>
1977                   </td>
1978                 </tr>
1979               </table>
1980             </dd>
1981           </dl>
1982         </div>
1983       </div>
1984       <div class="SECT3">
1985         <h4 class="SECT3"><a name="HANDLE-AS-EMPTY-DOCUMENT" id="HANDLE-AS-EMPTY-DOCUMENT">8.5.19.
1986         handle-as-empty-document</a></h4>
1987         <div class="VARIABLELIST">
1988           <dl>
1989             <dt>Typical use:</dt>
1990             <dd>
1991               <p>Mark URLs that should be replaced by empty documents <span class="emphasis"><i class="EMPHASIS">if
1992               they get blocked</i></span></p>
1993             </dd>
1994             <dt>Effect:</dt>
1995             <dd>
1996               <p>This action alone doesn't do anything noticeable. It just marks URLs. If the <tt class=
1997               "LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> action <span class="emphasis"><i class=
1998               "EMPHASIS">also applies</i></span>, the presence or absence of this mark decides whether an HTML
1999               <span class="QUOTE">"BLOCKED"</span> page, or an empty document will be sent to the client as a
2000               substitute for the blocked content. The <span class="emphasis"><i class="EMPHASIS">empty</i></span>
2001               document isn't literally empty, but actually contains a single space.</p>
2002             </dd>
2003             <dt>Type:</dt>
2004             <dd>
2005               <p>Boolean.</p>
2006             </dd>
2007             <dt>Parameter:</dt>
2008             <dd>
2009               <p>N/A</p>
2010             </dd>
2011             <dt>Notes:</dt>
2012             <dd>
2013               <p>Some browsers complain about syntax errors if JavaScript documents are blocked with <span class=
2014               "APPLICATION">Privoxy's</span> default HTML page; this option can be used to silence them. And of course
2015               this action can also be used to eliminate the <span class="APPLICATION">Privoxy</span> BLOCKED message in
2016               frames.</p>
2017               <p>The content type for the empty document can be specified with <tt class="LITERAL"><a href=
2018               "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite{}</a></tt>, but usually this isn't
2019               necessary.</p>
2020             </dd>
2021             <dt>Example usage:</dt>
2022             <dd>
2023               <table border="0" bgcolor="#E0E0E0" width="90%">
2024                 <tr>
2025                   <td>
2026                     <pre class="SCREEN"># Block all documents on example.org that end with ".js",
2027 # but send an empty document instead of the usual HTML message.
2028 {+block{Blocked JavaScript} +handle-as-empty-document}
2029 example.org/.*\.js$</pre>
2030                   </td>
2031                 </tr>
2032               </table>
2033             </dd>
2034           </dl>
2035         </div>
2036       </div>
2037       <div class="SECT3">
2038         <h4 class="SECT3"><a name="HANDLE-AS-IMAGE" id="HANDLE-AS-IMAGE">8.5.20. handle-as-image</a></h4>
2039         <div class="VARIABLELIST">
2040           <dl>
2041             <dt>Typical use:</dt>
2042             <dd>
2043               <p>Mark URLs as belonging to images (so they'll be replaced by images <span class="emphasis"><i class=
2044               "EMPHASIS">if they do get blocked</i></span>, rather than HTML pages)</p>
2045             </dd>
2046             <dt>Effect:</dt>
2047             <dd>
2048               <p>This action alone doesn't do anything noticeable. It just marks URLs as images. If the <tt class=
2049               "LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> action <span class="emphasis"><i class=
2050               "EMPHASIS">also applies</i></span>, the presence or absence of this mark decides whether an HTML
2051               <span class="QUOTE">"blocked"</span> page, or a replacement image (as determined by the <tt class=
2052               "LITERAL"><a href="actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></tt> action) will be sent
2053               to the client as a substitute for the blocked content.</p>
2054             </dd>
2055             <dt>Type:</dt>
2056             <dd>
2057               <p>Boolean.</p>
2058             </dd>
2059             <dt>Parameter:</dt>
2060             <dd>
2061               <p>N/A</p>
2062             </dd>
2063             <dt>Notes:</dt>
2064             <dd>
2065               <p>The below generic example section is actually part of <tt class="FILENAME">default.action</tt>. It
2066               marks all URLs with well-known image file name extensions as images and should be left intact.</p>
2067               <p>Users will probably only want to use the handle-as-image action in conjunction with <tt class=
2068               "LITERAL"><a href="actions-file.html#BLOCK">block</a></tt>, to block sources of banners, whose URLs don't
2069               reflect the file type, like in the second example section.</p>
2070               <p>Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad frames
2071               require an HTML page to be sent, or they won't display properly. Forcing <tt class=
2072               "LITERAL">handle-as-image</tt> in this situation will not replace the ad frame with an image, but lead to
2073               error messages.</p>
2074             </dd>
2075             <dt>Example usage (sections):</dt>
2076             <dd>
2077               <table border="0" bgcolor="#E0E0E0" width="90%">
2078                 <tr>
2079                   <td>
2080                     <pre class="SCREEN"># Generic image extensions:
2081 #
2082 {+handle-as-image}
2083 /.*\.(gif|jpg|jpeg|png|bmp|ico)$
2084
2085 # These don't look like images, but they're banners and should be
2086 # blocked as images:
2087 #
2088 {+block{Nasty banners.} +handle-as-image}
2089 nasty-banner-server.example.com/junk.cgi\?output=trash</pre>
2090                   </td>
2091                 </tr>
2092               </table>
2093             </dd>
2094           </dl>
2095         </div>
2096       </div>
2097       <div class="SECT3">
2098         <h4 class="SECT3"><a name="HIDE-ACCEPT-LANGUAGE" id="HIDE-ACCEPT-LANGUAGE">8.5.21.
2099         hide-accept-language</a></h4>
2100         <div class="VARIABLELIST">
2101           <dl>
2102             <dt>Typical use:</dt>
2103             <dd>
2104               <p>Pretend to use different language settings.</p>
2105             </dd>
2106             <dt>Effect:</dt>
2107             <dd>
2108               <p>Deletes or replaces the <span class="QUOTE">"Accept-Language:"</span> HTTP header in client
2109               requests.</p>
2110             </dd>
2111             <dt>Type:</dt>
2112             <dd>
2113               <p>Parameterized.</p>
2114             </dd>
2115             <dt>Parameter:</dt>
2116             <dd>
2117               <p>Keyword: <span class="QUOTE">"block"</span>, or any user defined value.</p>
2118             </dd>
2119             <dt>Notes:</dt>
2120             <dd>
2121               <p>Faking the browser's language settings can be useful to make a foreign User-Agent set with <tt class=
2122               "LITERAL"><a href="actions-file.html#HIDE-USER-AGENT">hide-user-agent</a></tt> more believable.</p>
2123               <p>However some sites with content in different languages check the <span class=
2124               "QUOTE">"Accept-Language:"</span> to decide which one to take by default. Sometimes it isn't possible to
2125               later switch to another language without changing the <span class="QUOTE">"Accept-Language:"</span>
2126               header first.</p>
2127               <p>Therefore it's a good idea to either only change the <span class="QUOTE">"Accept-Language:"</span>
2128               header to languages you understand, or to languages that aren't wide spread.</p>
2129               <p>Before setting the <span class="QUOTE">"Accept-Language:"</span> header to a rare language, you should
2130               consider that it helps to make your requests unique and thus easier to trace. If you don't plan to change
2131               this header frequently, you should stick to a common language.</p>
2132             </dd>
2133             <dt>Example usage (section):</dt>
2134             <dd>
2135               <table border="0" bgcolor="#E0E0E0" width="90%">
2136                 <tr>
2137                   <td>
2138                     <pre class="SCREEN"># Pretend to use Canadian language settings.
2139 {+hide-accept-language{en-ca} \
2140 +hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv:1.8.0.4) Gecko/20060628 Firefox/1.5.0.4} \
2141 }
2142 /</pre>
2143                   </td>
2144                 </tr>
2145               </table>
2146             </dd>
2147           </dl>
2148         </div>
2149       </div>
2150       <div class="SECT3">
2151         <h4 class="SECT3"><a name="HIDE-CONTENT-DISPOSITION" id="HIDE-CONTENT-DISPOSITION">8.5.22.
2152         hide-content-disposition</a></h4>
2153         <div class="VARIABLELIST">
2154           <dl>
2155             <dt>Typical use:</dt>
2156             <dd>
2157               <p>Prevent download menus for content you prefer to view inside the browser.</p>
2158             </dd>
2159             <dt>Effect:</dt>
2160             <dd>
2161               <p>Deletes or replaces the <span class="QUOTE">"Content-Disposition:"</span> HTTP header set by some
2162               servers.</p>
2163             </dd>
2164             <dt>Type:</dt>
2165             <dd>
2166               <p>Parameterized.</p>
2167             </dd>
2168             <dt>Parameter:</dt>
2169             <dd>
2170               <p>Keyword: <span class="QUOTE">"block"</span>, or any user defined value.</p>
2171             </dd>
2172             <dt>Notes:</dt>
2173             <dd>
2174               <p>Some servers set the <span class="QUOTE">"Content-Disposition:"</span> HTTP header for documents they
2175               assume you want to save locally before viewing them. The <span class=
2176               "QUOTE">"Content-Disposition:"</span> header contains the file name the browser is supposed to use by
2177               default.</p>
2178               <p>In most browsers that understand this header, it makes it impossible to <span class=
2179               "emphasis"><i class="EMPHASIS">just view</i></span> the document, without downloading it first, even if
2180               it's just a simple text file or an image.</p>
2181               <p>Removing the <span class="QUOTE">"Content-Disposition:"</span> header helps to prevent this annoyance,
2182               but some browsers additionally check the <span class="QUOTE">"Content-Type:"</span> header, before they
2183               decide if they can display a document without saving it first. In these cases, you have to change this
2184               header as well, before the browser stops displaying download menus.</p>
2185               <p>It is also possible to change the server's file name suggestion to another one, but in most cases it
2186               isn't worth the time to set it up.</p>
2187               <p>This action will probably be removed in the future, use server-header filters instead.</p>
2188             </dd>
2189             <dt>Example usage:</dt>
2190             <dd>
2191               <table border="0" bgcolor="#E0E0E0" width="90%">
2192                 <tr>
2193                   <td>
2194                     <pre class="SCREEN"># Disarm the download link in Sourceforge's patch tracker
2195 { -filter \
2196  +content-type-overwrite{text/plain}\
2197  +hide-content-disposition{block} }
2198  .sourceforge.net/tracker/download\.php</pre>
2199                   </td>
2200                 </tr>
2201               </table>
2202             </dd>
2203           </dl>
2204         </div>
2205       </div>
2206       <div class="SECT3">
2207         <h4 class="SECT3"><a name="HIDE-IF-MODIFIED-SINCE" id="HIDE-IF-MODIFIED-SINCE">8.5.23.
2208         hide-if-modified-since</a></h4>
2209         <div class="VARIABLELIST">
2210           <dl>
2211             <dt>Typical use:</dt>
2212             <dd>
2213               <p>Prevent yet another way to track the user's steps between sessions.</p>
2214             </dd>
2215             <dt>Effect:</dt>
2216             <dd>
2217               <p>Deletes the <span class="QUOTE">"If-Modified-Since:"</span> HTTP client header or modifies its
2218               value.</p>
2219             </dd>
2220             <dt>Type:</dt>
2221             <dd>
2222               <p>Parameterized.</p>
2223             </dd>
2224             <dt>Parameter:</dt>
2225             <dd>
2226               <p>Keyword: <span class="QUOTE">"block"</span>, or a user defined value that specifies a range of
2227               hours.</p>
2228             </dd>
2229             <dt>Notes:</dt>
2230             <dd>
2231               <p>Removing this header is useful for filter testing, where you want to force a real reload instead of
2232               getting status code <span class="QUOTE">"304"</span>, which would cause the browser to use a cached copy
2233               of the page.</p>
2234               <p>Instead of removing the header, <tt class="LITERAL">hide-if-modified-since</tt> can also add or
2235               subtract a random amount of time to/from the header's value. You specify a range of minutes where the
2236               random factor should be chosen from and <span class="APPLICATION">Privoxy</span> does the rest. A
2237               negative value means subtracting, a positive value adding.</p>
2238               <p>Randomizing the value of the <span class="QUOTE">"If-Modified-Since:"</span> makes it less likely that
2239               the server can use the time as a cookie replacement, but you will run into caching problems if the random
2240               range is too high.</p>
2241               <p>It is a good idea to only use a small negative value and let <tt class="LITERAL"><a href=
2242               "actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></tt> handle the greater
2243               changes.</p>
2244               <p>It is also recommended to use this action together with <tt class="LITERAL"><a href=
2245               "actions-file.html#CRUNCH-IF-NONE-MATCH">crunch-if-none-match</a></tt>, otherwise it's more or less
2246               pointless.</p>
2247             </dd>
2248             <dt>Example usage (section):</dt>
2249             <dd>
2250               <table border="0" bgcolor="#E0E0E0" width="90%">
2251                 <tr>
2252                   <td>
2253                     <pre class="SCREEN"># Let the browser revalidate but make tracking based on the time less likely.
2254 {+hide-if-modified-since{-60} \
2255  +overwrite-last-modified{randomize} \
2256  +crunch-if-none-match}
2257 /</pre>
2258                   </td>
2259                 </tr>
2260               </table>
2261             </dd>
2262           </dl>
2263         </div>
2264       </div>
2265       <div class="SECT3">
2266         <h4 class="SECT3"><a name="HIDE-FROM-HEADER" id="HIDE-FROM-HEADER">8.5.24. hide-from-header</a></h4>
2267         <div class="VARIABLELIST">
2268           <dl>
2269             <dt>Typical use:</dt>
2270             <dd>
2271               <p>Keep your (old and ill) browser from telling web servers your email address</p>
2272             </dd>
2273             <dt>Effect:</dt>
2274             <dd>
2275               <p>Deletes any existing <span class="QUOTE">"From:"</span> HTTP header, or replaces it with the specified
2276               string.</p>
2277             </dd>
2278             <dt>Type:</dt>
2279             <dd>
2280               <p>Parameterized.</p>
2281             </dd>
2282             <dt>Parameter:</dt>
2283             <dd>
2284               <p>Keyword: <span class="QUOTE">"block"</span>, or any user defined value.</p>
2285             </dd>
2286             <dt>Notes:</dt>
2287             <dd>
2288               <p>The keyword <span class="QUOTE">"block"</span> will completely remove the header (not to be confused
2289               with the <tt class="LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> action).</p>
2290               <p>Alternately, you can specify any value you prefer to be sent to the web server. If you do, it is a
2291               matter of fairness not to use any address that is actually used by a real person.</p>
2292               <p>This action is rarely needed, as modern web browsers don't send <span class="QUOTE">"From:"</span>
2293               headers anymore.</p>
2294             </dd>
2295             <dt>Example usage:</dt>
2296             <dd>
2297               <table border="0" bgcolor="#E0E0E0" width="90%">
2298                 <tr>
2299                   <td>
2300                     <pre class="SCREEN">+hide-from-header{block}</pre>
2301                   </td>
2302                 </tr>
2303               </table>
2304               <p>or</p>
2305               <table border="0" bgcolor="#E0E0E0" width="90%">
2306                 <tr>
2307                   <td>
2308                     <pre class="SCREEN">+hide-from-header{spam-me-senseless@sittingduck.example.com}</pre>
2309                   </td>
2310                 </tr>
2311               </table>
2312             </dd>
2313           </dl>
2314         </div>
2315       </div>
2316       <div class="SECT3">
2317         <h4 class="SECT3"><a name="HIDE-REFERRER" id="HIDE-REFERRER">8.5.25. hide-referrer</a></h4><a name=
2318         "HIDE-REFERER" id="HIDE-REFERER"></a>
2319         <div class="VARIABLELIST">
2320           <dl>
2321             <dt>Typical use:</dt>
2322             <dd>
2323               <p>Conceal which link you followed to get to a particular site</p>
2324             </dd>
2325             <dt>Effect:</dt>
2326             <dd>
2327               <p>Deletes the <span class="QUOTE">"Referer:"</span> (sic) HTTP header from the client request, or
2328               replaces it with a forged one.</p>
2329             </dd>
2330             <dt>Type:</dt>
2331             <dd>
2332               <p>Parameterized.</p>
2333             </dd>
2334             <dt>Parameter:</dt>
2335             <dd>
2336               <ul>
2337                 <li>
2338                   <p><span class="QUOTE">"conditional-block"</span> to delete the header completely if the host has
2339                   changed.</p>
2340                 </li>
2341                 <li>
2342                   <p><span class="QUOTE">"conditional-forge"</span> to forge the header if the host has changed.</p>
2343                 </li>
2344                 <li>
2345                   <p><span class="QUOTE">"block"</span> to delete the header unconditionally.</p>
2346                 </li>
2347                 <li>
2348                   <p><span class="QUOTE">"forge"</span> to pretend to be coming from the homepage of the server we are
2349                   talking to.</p>
2350                 </li>
2351                 <li>
2352                   <p>Any other string to set a user defined referrer.</p>
2353                 </li>
2354               </ul>
2355             </dd>
2356             <dt>Notes:</dt>
2357             <dd>
2358               <p><tt class="LITERAL">conditional-block</tt> is the only parameter, that isn't easily detected in the
2359               server's log file. If it blocks the referrer, the request will look like the visitor used a bookmark or
2360               typed in the address directly.</p>
2361               <p>Leaving the referrer unmodified for requests on the same host allows the server owner to see the
2362               visitor's <span class="QUOTE">"click path"</span>, but in most cases she could also get that information
2363               by comparing other parts of the log file: for example the User-Agent if it isn't a very common one, or
2364               the user's IP address if it doesn't change between different requests.</p>
2365               <p>Always blocking the referrer, or using a custom one, can lead to failures on servers that check the
2366               referrer before they answer any requests, in an attempt to prevent their content from being embedded or
2367               linked to elsewhere.</p>
2368               <p>Both <tt class="LITERAL">conditional-block</tt> and <tt class="LITERAL">forge</tt> will work with
2369               referrer checks, as long as content and valid referring page are on the same host. Most of the time
2370               that's the case.</p>
2371               <p><tt class="LITERAL">hide-referer</tt> is an alternate spelling of <tt class=
2372               "LITERAL">hide-referrer</tt> and the two can be can be freely substituted with each other. (<span class=
2373               "QUOTE">"referrer"</span> is the correct English spelling, however the HTTP specification has a bug - it
2374               requires it to be spelled as <span class="QUOTE">"referer"</span>.)</p>
2375             </dd>
2376             <dt>Example usage:</dt>
2377             <dd>
2378               <table border="0" bgcolor="#E0E0E0" width="90%">
2379                 <tr>
2380                   <td>
2381                     <pre class="SCREEN">+hide-referrer{forge}</pre>
2382                   </td>
2383                 </tr>
2384               </table>
2385               <p>or</p>
2386               <table border="0" bgcolor="#E0E0E0" width="90%">
2387                 <tr>
2388                   <td>
2389                     <pre class="SCREEN">+hide-referrer{http://www.yahoo.com/}</pre>
2390                   </td>
2391                 </tr>
2392               </table>
2393             </dd>
2394           </dl>
2395         </div>
2396       </div>
2397       <div class="SECT3">
2398         <h4 class="SECT3"><a name="HIDE-USER-AGENT" id="HIDE-USER-AGENT">8.5.26. hide-user-agent</a></h4>
2399         <div class="VARIABLELIST">
2400           <dl>
2401             <dt>Typical use:</dt>
2402             <dd>
2403               <p>Try to conceal your type of browser and client operating system</p>
2404             </dd>
2405             <dt>Effect:</dt>
2406             <dd>
2407               <p>Replaces the value of the <span class="QUOTE">"User-Agent:"</span> HTTP header in client requests with
2408               the specified value.</p>
2409             </dd>
2410             <dt>Type:</dt>
2411             <dd>
2412               <p>Parameterized.</p>
2413             </dd>
2414             <dt>Parameter:</dt>
2415             <dd>
2416               <p>Any user-defined string.</p>
2417             </dd>
2418             <dt>Notes:</dt>
2419             <dd>
2420               <div class="WARNING">
2421                 <table class="WARNING" border="1" width="90%">
2422                   <tr>
2423                     <td align="center"><b>Warning</b></td>
2424                   </tr>
2425                   <tr>
2426                     <td align="left">
2427                       <p>This can lead to problems on web sites that depend on looking at this header in order to
2428                       customize their content for different browsers (which, by the way, is <span class=
2429                       "emphasis"><i class="EMPHASIS">NOT</i></span> the right thing to do: good web sites work
2430                       browser-independently).</p>
2431                     </td>
2432                   </tr>
2433                 </table>
2434               </div>
2435               <p>Using this action in multi-user setups or wherever different types of browsers will access the same
2436               <span class="APPLICATION">Privoxy</span> is <span class="emphasis"><i class="EMPHASIS">not
2437               recommended</i></span>. In single-user, single-browser setups, you might use it to delete your OS version
2438               information from the headers, because it is an invitation to exploit known bugs for your OS. It is also
2439               occasionally useful to forge this in order to access sites that won't let you in otherwise (though there
2440               may be a good reason in some cases).</p>
2441               <p>More information on known user-agent strings can be found at <a href="http://www.user-agents.org/"
2442               target="_top">http://www.user-agents.org/</a> and <a href="http://en.wikipedia.org/wiki/User_agent"
2443               target="_top">http://en.wikipedia.org/wiki/User_agent</a>.</p>
2444             </dd>
2445             <dt>Example usage:</dt>
2446             <dd>
2447               <table border="0" bgcolor="#E0E0E0" width="90%">
2448                 <tr>
2449                   <td>
2450                     <pre class="SCREEN">+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}</pre>
2451                   </td>
2452                 </tr>
2453               </table>
2454             </dd>
2455           </dl>
2456         </div>
2457       </div>
2458       <div class="SECT3">
2459         <h4 class="SECT3"><a name="LIMIT-CONNECT" id="LIMIT-CONNECT">8.5.27. limit-connect</a></h4>
2460         <div class="VARIABLELIST">
2461           <dl>
2462             <dt>Typical use:</dt>
2463             <dd>
2464               <p>Prevent abuse of <span class="APPLICATION">Privoxy</span> as a TCP proxy relay or disable SSL for
2465               untrusted sites</p>
2466             </dd>
2467             <dt>Effect:</dt>
2468             <dd>
2469               <p>Specifies to which ports HTTP CONNECT requests are allowable.</p>
2470             </dd>
2471             <dt>Type:</dt>
2472             <dd>
2473               <p>Parameterized.</p>
2474             </dd>
2475             <dt>Parameter:</dt>
2476             <dd>
2477               <p>A comma-separated list of ports or port ranges (the latter using dashes, with the minimum defaulting
2478               to 0 and the maximum to 65K).</p>
2479             </dd>
2480             <dt>Notes:</dt>
2481             <dd>
2482               <p>By default, i.e. if no <tt class="LITERAL">limit-connect</tt> action applies, <span class=
2483               "APPLICATION">Privoxy</span> allows HTTP CONNECT requests to all ports. Use <tt class=
2484               "LITERAL">limit-connect</tt> if fine-grained control is desired for some or all destinations.</p>
2485               <p>The CONNECT methods exists in HTTP to allow access to secure websites (<span class=
2486               "QUOTE">"https://"</span> URLs) through proxies. It works very simply: the proxy connects to the server
2487               on the specified port, and then short-circuits its connections to the client and to the remote server.
2488               This means CONNECT-enabled proxies can be used as TCP relays very easily.</p>
2489               <p><span class="APPLICATION">Privoxy</span> relays HTTPS traffic without seeing the decoded content.
2490               Websites can leverage this limitation to circumvent <span class="APPLICATION">Privoxy</span>'s filters.
2491               By specifying an invalid port range you can disable HTTPS entirely.</p>
2492             </dd>
2493             <dt>Example usages:</dt>
2494             <dd>
2495               <table border="0" bgcolor="#E0E0E0" width="90%">
2496                 <tr>
2497                   <td>
2498                     <pre class="SCREEN">+limit-connect{443}                   # Port 443 is OK.
2499 +limit-connect{80,443}                # Ports 80 and 443 are OK.
2500 +limit-connect{-3, 7, 20-100, 500-}   # Ports less than 3, 7, 20 to 100 and above 500 are OK.
2501 +limit-connect{-}                     # All ports are OK
2502 +limit-connect{,}                     # No HTTPS/SSL traffic is allowed</pre>
2503                   </td>
2504                 </tr>
2505               </table>
2506             </dd>
2507           </dl>
2508         </div>
2509       </div>
2510       <div class="SECT3">
2511         <h4 class="SECT3"><a name="LIMIT-COOKIE-LIFETIME" id="LIMIT-COOKIE-LIFETIME">8.5.28.
2512         limit-cookie-lifetime</a></h4>
2513         <div class="VARIABLELIST">
2514           <dl>
2515             <dt>Typical use:</dt>
2516             <dd>
2517               <p>Limit the lifetime of HTTP cookies to a couple of minutes or hours.</p>
2518             </dd>
2519             <dt>Effect:</dt>
2520             <dd>
2521               <p>Overwrites the expires field in Set-Cookie server headers if it's above the specified limit.</p>
2522             </dd>
2523             <dt>Type:</dt>
2524             <dd>
2525               <p>Parameterized.</p>
2526             </dd>
2527             <dt>Parameter:</dt>
2528             <dd>
2529               <p>The lifetime limit in minutes, or 0.</p>
2530             </dd>
2531             <dt>Notes:</dt>
2532             <dd>
2533               <p>This action reduces the lifetime of HTTP cookies coming from the server to the specified number of
2534               minutes, starting from the time the cookie passes Privoxy.</p>
2535               <p>Cookies with a lifetime below the limit are not modified. The lifetime of session cookies is set to
2536               the specified limit.</p>
2537               <p>The effect of this action depends on the server.</p>
2538               <p>In case of servers which refresh their cookies with each response (or at least frequently), the
2539               lifetime limit set by this action is updated as well. Thus, a session associated with the cookie
2540               continues to work with this action enabled, as long as a new request is made before the last limit set is
2541               reached.</p>
2542               <p>However, some servers send their cookies once, with a lifetime of several years (the year 2037 is a
2543               popular choice), and do not refresh them until a certain event in the future, for example the user
2544               logging out. In this case this action may limit the absolute lifetime of the session, even if requests
2545               are made frequently.</p>
2546               <p>If the parameter is <span class="QUOTE">"0"</span>, this action behaves like <tt class=
2547               "LITERAL"><a href="actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></tt>.</p>
2548             </dd>
2549             <dt>Example usages:</dt>
2550             <dd>
2551               <table border="0" bgcolor="#E0E0E0" width="90%">
2552                 <tr>
2553                   <td>
2554                     <pre class="SCREEN">+limit-cookie-lifetime{60}</pre>
2555                   </td>
2556                 </tr>
2557               </table>
2558             </dd>
2559           </dl>
2560         </div>
2561       </div>
2562       <div class="SECT3">
2563         <h4 class="SECT3"><a name="PREVENT-COMPRESSION" id="PREVENT-COMPRESSION">8.5.29. prevent-compression</a></h4>
2564         <div class="VARIABLELIST">
2565           <dl>
2566             <dt>Typical use:</dt>
2567             <dd>
2568               <p>Ensure that servers send the content uncompressed, so it can be passed through <tt class=
2569               "LITERAL"><a href="actions-file.html#FILTER">filter</a></tt>s.</p>
2570             </dd>
2571             <dt>Effect:</dt>
2572             <dd>
2573               <p>Removes the Accept-Encoding header which can be used to ask for compressed transfer.</p>
2574             </dd>
2575             <dt>Type:</dt>
2576             <dd>
2577               <p>Boolean.</p>
2578             </dd>
2579             <dt>Parameter:</dt>
2580             <dd>
2581               <p>N/A</p>
2582             </dd>
2583             <dt>Notes:</dt>
2584             <dd>
2585               <p>More and more websites send their content compressed by default, which is generally a good idea and
2586               saves bandwidth. But the <tt class="LITERAL"><a href="actions-file.html#FILTER">filter</a></tt> and
2587               <tt class="LITERAL"><a href="actions-file.html#DEANIMATE-GIFS">deanimate-gifs</a></tt> actions need
2588               access to the uncompressed data.</p>
2589               <p>When compiled with zlib support (available since <span class="APPLICATION">Privoxy</span> 3.0.7),
2590               content that should be filtered is decompressed on-the-fly and you don't have to worry about this action.
2591               If you are using an older <span class="APPLICATION">Privoxy</span> version, or one that hasn't been
2592               compiled with zlib support, this action can be used to convince the server to send the content
2593               uncompressed.</p>
2594               <p>Most text-based instances compress very well, the size is seldom decreased by less than 50%, for
2595               markup-heavy instances like news feeds saving more than 90% of the original size isn't unusual.</p>
2596               <p>Not using compression will therefore slow down the transfer, and you should only enable this action if
2597               you really need it. As of <span class="APPLICATION">Privoxy</span> 3.0.7 it's disabled in all predefined
2598               action settings.</p>
2599               <p>Note that some (rare) ill-configured sites don't handle requests for uncompressed documents correctly.
2600               Broken PHP applications tend to send an empty document body, some IIS versions only send the beginning of
2601               the content. If you enable <tt class="LITERAL">prevent-compression</tt> per default, you might want to
2602               add exceptions for those sites. See the example for how to do that.</p>
2603             </dd>
2604             <dt>Example usage (sections):</dt>
2605             <dd>
2606               <table border="0" bgcolor="#E0E0E0" width="90%">
2607                 <tr>
2608                   <td>
2609                     <pre class="SCREEN"># Selectively turn off compression, and enable a filter
2610 #
2611 { +filter{tiny-textforms} +prevent-compression }
2612 # Match only these sites
2613  .google.
2614  sourceforge.net
2615  sf.net
2616
2617 # Or instead, we could set a universal default:
2618 #
2619 { +prevent-compression }
2620  / # Match all sites
2621
2622 # Then maybe make exceptions for broken sites:
2623 #
2624 { -prevent-compression }
2625 .compusa.com/</pre>
2626                   </td>
2627                 </tr>
2628               </table>
2629             </dd>
2630           </dl>
2631         </div>
2632       </div>
2633       <div class="SECT3">
2634         <h4 class="SECT3"><a name="OVERWRITE-LAST-MODIFIED" id="OVERWRITE-LAST-MODIFIED">8.5.30.
2635         overwrite-last-modified</a></h4>
2636         <div class="VARIABLELIST">
2637           <dl>
2638             <dt>Typical use:</dt>
2639             <dd>
2640               <p>Prevent yet another way to track the user's steps between sessions.</p>
2641             </dd>
2642             <dt>Effect:</dt>
2643             <dd>
2644               <p>Deletes the <span class="QUOTE">"Last-Modified:"</span> HTTP server header or modifies its value.</p>
2645             </dd>
2646             <dt>Type:</dt>
2647             <dd>
2648               <p>Parameterized.</p>
2649             </dd>
2650             <dt>Parameter:</dt>
2651             <dd>
2652               <p>One of the keywords: <span class="QUOTE">"block"</span>, <span class=
2653               "QUOTE">"reset-to-request-time"</span> and <span class="QUOTE">"randomize"</span></p>
2654             </dd>
2655             <dt>Notes:</dt>
2656             <dd>
2657               <p>Removing the <span class="QUOTE">"Last-Modified:"</span> header is useful for filter testing, where
2658               you want to force a real reload instead of getting status code <span class="QUOTE">"304"</span>, which
2659               would cause the browser to reuse the old version of the page.</p>
2660               <p>The <span class="QUOTE">"randomize"</span> option overwrites the value of the <span class=
2661               "QUOTE">"Last-Modified:"</span> header with a randomly chosen time between the original value and the
2662               current time. In theory the server could send each document with a different <span class=
2663               "QUOTE">"Last-Modified:"</span> header to track visits without using cookies. <span class=
2664               "QUOTE">"Randomize"</span> makes it impossible and the browser can still revalidate cached documents.</p>
2665               <p><span class="QUOTE">"reset-to-request-time"</span> overwrites the value of the <span class=
2666               "QUOTE">"Last-Modified:"</span> header with the current time. You could use this option together with
2667               <tt class="LITERAL"><a href="actions-file.html#HIDE-IF-MODIFIED-SINCE">hide-if-modified-since</a></tt> to
2668               further customize your random range.</p>
2669               <p>The preferred parameter here is <span class="QUOTE">"randomize"</span>. It is safe to use, as long as
2670               the time settings are more or less correct. If the server sets the <span class=
2671               "QUOTE">"Last-Modified:"</span> header to the time of the request, the random range becomes zero and the
2672               value stays the same. Therefore you should later randomize it a second time with <tt class=
2673               "LITERAL"><a href="actions-file.html#HIDE-IF-MODIFIED-SINCE">hided-if-modified-since</a></tt>, just to be
2674               sure.</p>
2675               <p>It is also recommended to use this action together with <tt class="LITERAL"><a href=
2676               "actions-file.html#CRUNCH-IF-NONE-MATCH">crunch-if-none-match</a></tt>.</p>
2677             </dd>
2678             <dt>Example usage:</dt>
2679             <dd>
2680               <table border="0" bgcolor="#E0E0E0" width="90%">
2681                 <tr>
2682                   <td>
2683                     <pre class="SCREEN"># Let the browser revalidate without being tracked across sessions
2684 { +hide-if-modified-since{-60} \
2685  +overwrite-last-modified{randomize} \
2686  +crunch-if-none-match}
2687 /</pre>
2688                   </td>
2689                 </tr>
2690               </table>
2691             </dd>
2692           </dl>
2693         </div>
2694       </div>
2695       <div class="SECT3">
2696         <h4 class="SECT3"><a name="REDIRECT" id="REDIRECT">8.5.31. redirect</a></h4>
2697         <div class="VARIABLELIST">
2698           <dl>
2699             <dt>Typical use:</dt>
2700             <dd>
2701               <p>Redirect requests to other sites.</p>
2702             </dd>
2703             <dt>Effect:</dt>
2704             <dd>
2705               <p>Convinces the browser that the requested document has been moved to another location and the browser
2706               should get it from there.</p>
2707             </dd>
2708             <dt>Type:</dt>
2709             <dd>
2710               <p>Parameterized</p>
2711             </dd>
2712             <dt>Parameter:</dt>
2713             <dd>
2714               <p>An absolute URL or a single pcrs command.</p>
2715             </dd>
2716             <dt>Notes:</dt>
2717             <dd>
2718               <p>Requests to which this action applies are answered with a HTTP redirect to URLs of your choosing. The
2719               new URL is either provided as parameter, or derived by applying a single pcrs command to the original
2720               URL.</p>
2721               <p>The syntax for pcrs commands is documented in the <a href="filter-file.html">filter file</a>
2722               section.</p>
2723               <p>Requests can't be blocked and redirected at the same time, applying this action together with
2724               <tt class="LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> is a configuration error. Currently
2725               the request is blocked and an error message logged, the behavior may change in the future and result in
2726               Privoxy rejecting the action file.</p>
2727               <p>This action can be combined with <tt class="LITERAL"><a href=
2728               "actions-file.html#FAST-REDIRECTS">fast-redirects{check-decoded-url}</a></tt> to redirect to a decoded
2729               version of a rewritten URL.</p>
2730               <p>Use this action carefully, make sure not to create redirection loops and be aware that using your own
2731               redirects might make it possible to fingerprint your requests.</p>
2732               <p>In case of problems with your redirects, or simply to watch them working, enable <a href=
2733               "config.html#DEBUG">debug 128</a>.</p>
2734             </dd>
2735             <dt>Example usages:</dt>
2736             <dd>
2737               <table border="0" bgcolor="#E0E0E0" width="90%">
2738                 <tr>
2739                   <td>
2740                     <pre class="SCREEN"># Replace example.com's style sheet with another one
2741 { +redirect{http://localhost/css-replacements/example.com.css} }
2742  example.com/stylesheet\.css
2743
2744 # Create a short, easy to remember nickname for a favorite site
2745 # (relies on the browser to accept and forward invalid URLs to <span class="APPLICATION">Privoxy</span>)
2746 { +redirect{https://www.privoxy.org/user-manual/actions-file.html} }
2747  a
2748
2749 # Always use the expanded view for Undeadly.org articles
2750 # (Note the $ at the end of the URL pattern to make sure
2751 # the request for the rewritten URL isn't redirected as well)
2752 {+redirect{s@$@&amp;mode=expanded@}}
2753 undeadly.org/cgi\?action=article&amp;sid=\d*$
2754
2755 # Redirect Google search requests to MSN
2756 {+redirect{s@^http://[^/]*/search\?q=([^&amp;]*).*@http://search.msn.com/results.aspx?q=$1@}}
2757 .google.com/search
2758
2759 # Redirect MSN search requests to Yahoo
2760 {+redirect{s@^http://[^/]*/results\.aspx\?q=([^&amp;]*).*@http://search.yahoo.com/search?p=$1@}}
2761 search.msn.com//results\.aspx\?q=
2762
2763 # Redirect http://example.com/&amp;bla=fasel&amp;toChange=foo (and any other value but "bar")
2764 # to       http://example.com/&amp;bla=fasel&amp;toChange=bar
2765 #
2766 # The URL pattern makes sure that the following request isn't redirected again.
2767 {+redirect{s@toChange=[^&amp;]+@toChange=bar@}}
2768 example.com/.*toChange=(?!bar)
2769
2770 # Add a shortcut to look up illumos bugs
2771 {+redirect{s@^http://i([0-9]+)/.*@https://www.illumos.org/issues/$1@}}
2772 # Redirected URL = http://i4974/
2773 # Redirect Destination = https://www.illumos.org/issues/4974
2774 i[0-9][0-9][0-9][0-9]*/
2775
2776 # Redirect remote requests for this manual
2777 # to the local version delivered by Privoxy
2778 {+redirect{s@^http://www@http://config@}}
2779 www.privoxy.org/user-manual/</pre>
2780                   </td>
2781                 </tr>
2782               </table>
2783             </dd>
2784           </dl>
2785         </div>
2786       </div>
2787       <div class="SECT3">
2788         <h4 class="SECT3"><a name="SERVER-HEADER-FILTER" id="SERVER-HEADER-FILTER">8.5.32.
2789         server-header-filter</a></h4>
2790         <div class="VARIABLELIST">
2791           <dl>
2792             <dt>Typical use:</dt>
2793             <dd>
2794               <p>Rewrite or remove single server headers.</p>
2795             </dd>
2796             <dt>Effect:</dt>
2797             <dd>
2798               <p>All server headers to which this action applies are filtered on-the-fly through the specified regular
2799               expression based substitutions.</p>
2800             </dd>
2801             <dt>Type:</dt>
2802             <dd>
2803               <p>Multi-value.</p>
2804             </dd>
2805             <dt>Parameter:</dt>
2806             <dd>
2807               <p>The name of a server-header filter, as defined in one of the <a href="filter-file.html">filter
2808               files</a>.</p>
2809             </dd>
2810             <dt>Notes:</dt>
2811             <dd>
2812               <p>Server-header filters are applied to each header on its own, not to all at once. This makes it easier
2813               to diagnose problems, but on the downside you can't write filters that only change header x if header y's
2814               value is z. You can do that by using tags though.</p>
2815               <p>Server-header filters are executed after the other header actions have finished and use their output
2816               as input.</p>
2817               <p>Please refer to the <a href="filter-file.html">filter file chapter</a> to learn which server-header
2818               filters are available by default, and how to create your own.</p>
2819             </dd>
2820             <dt>Example usage (section):</dt>
2821             <dd>
2822               <table border="0" bgcolor="#E0E0E0" width="90%">
2823                 <tr>
2824                   <td>
2825                     <pre class="SCREEN">{+server-header-filter{html-to-xml}}
2826 example.org/xml-instance-that-is-delivered-as-html
2827
2828 {+server-header-filter{xml-to-html}}
2829 example.org/instance-that-is-delivered-as-xml-but-is-not</pre>
2830                   </td>
2831                 </tr>
2832               </table>
2833             </dd>
2834           </dl>
2835         </div>
2836       </div>
2837       <div class="SECT3">
2838         <h4 class="SECT3"><a name="SERVER-HEADER-TAGGER" id="SERVER-HEADER-TAGGER">8.5.33.
2839         server-header-tagger</a></h4>
2840         <div class="VARIABLELIST">
2841           <dl>
2842             <dt>Typical use:</dt>
2843             <dd>
2844               <p>Enable or disable filters based on the Content-Type header.</p>
2845             </dd>
2846             <dt>Effect:</dt>
2847             <dd>
2848               <p>Server headers to which this action applies are filtered on-the-fly through the specified regular
2849               expression based substitutions, the result is used as tag.</p>
2850             </dd>
2851             <dt>Type:</dt>
2852             <dd>
2853               <p>Multi-value.</p>
2854             </dd>
2855             <dt>Parameter:</dt>
2856             <dd>
2857               <p>The name of a server-header tagger, as defined in one of the <a href="filter-file.html">filter
2858               files</a>.</p>
2859             </dd>
2860             <dt>Notes:</dt>
2861             <dd>
2862               <p>Server-header taggers are applied to each header on its own, and as the header isn't modified, each
2863               tagger <span class="QUOTE">"sees"</span> the original.</p>
2864               <p>Server-header taggers are executed before all other header actions that modify server headers. Their
2865               tags can be used to control all of the other server-header actions, the content filters and the crunch
2866               actions (<a href="actions-file.html#REDIRECT">redirect</a> and <a href=
2867               "actions-file.html#BLOCK">block</a>).</p>
2868               <p>Obviously crunching based on tags created by server-header taggers doesn't prevent the request from
2869               showing up in the server's log file.</p>
2870             </dd>
2871             <dt>Example usage (section):</dt>
2872             <dd>
2873               <table border="0" bgcolor="#E0E0E0" width="90%">
2874                 <tr>
2875                   <td>
2876                     <pre class="SCREEN"># Tag every request with the content type declared by the server
2877 {+server-header-tagger{content-type}}
2878 /
2879
2880 # If the response has a tag starting with 'image/' enable an external
2881 # filter that only applies to images.
2882 #
2883 # Note that the filter is not available by default, it's just a
2884 # <tt class="LITERAL"><a href="filter-file.html#EXTERNAL-FILTER-SYNTAX">silly example</a></tt>.
2885 {+external-filter{rotate-image} +force-text-mode}
2886 TAG:^image/</pre>
2887                   </td>
2888                 </tr>
2889               </table>
2890             </dd>
2891           </dl>
2892         </div>
2893       </div>
2894       <div class="SECT3">
2895         <h4 class="SECT3"><a name="SESSION-COOKIES-ONLY" id="SESSION-COOKIES-ONLY">8.5.34.
2896         session-cookies-only</a></h4>
2897         <div class="VARIABLELIST">
2898           <dl>
2899             <dt>Typical use:</dt>
2900             <dd>
2901               <p>Allow only temporary <span class="QUOTE">"session"</span> cookies (for the current browser session
2902               <span class="emphasis"><i class="EMPHASIS">only</i></span>).</p>
2903             </dd>
2904             <dt>Effect:</dt>
2905             <dd>
2906               <p>Deletes the <span class="QUOTE">"expires"</span> field from <span class="QUOTE">"Set-Cookie:"</span>
2907               server headers. Most browsers will not store such cookies permanently and forget them in between
2908               sessions.</p>
2909             </dd>
2910             <dt>Type:</dt>
2911             <dd>
2912               <p>Boolean.</p>
2913             </dd>
2914             <dt>Parameter:</dt>
2915             <dd>
2916               <p>N/A</p>
2917             </dd>
2918             <dt>Notes:</dt>
2919             <dd>
2920               <p>This is less strict than <tt class="LITERAL"><a href=
2921               "actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a></tt> / <tt class=
2922               "LITERAL"><a href="actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a></tt> and allows
2923               you to browse websites that insist or rely on setting cookies, without compromising your privacy too
2924               badly.</p>
2925               <p>Most browsers will not permanently store cookies that have been processed by <tt class=
2926               "LITERAL">session-cookies-only</tt> and will forget about them between sessions. This makes profiling
2927               cookies useless, but won't break sites which require cookies so that you can log in for transactions.
2928               This is generally turned on for all sites, and is the recommended setting.</p>
2929               <p>It makes <span class="emphasis"><i class="EMPHASIS">no sense at all</i></span> to use <tt class=
2930               "LITERAL">session-cookies-only</tt> together with <tt class="LITERAL"><a href=
2931               "actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a></tt> or <tt class=
2932               "LITERAL"><a href="actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a></tt>. If you
2933               do, cookies will be plainly killed.</p>
2934               <p>Note that it is up to the browser how it handles such cookies without an <span class=
2935               "QUOTE">"expires"</span> field. If you use an exotic browser, you might want to try it out to be
2936               sure.</p>
2937               <p>This setting also has no effect on cookies that may have been stored previously by the browser before
2938               starting <span class="APPLICATION">Privoxy</span>. These would have to be removed manually.</p>
2939               <p><span class="APPLICATION">Privoxy</span> also uses the <a href=
2940               "actions-file.html#FILTER-CONTENT-COOKIES">content-cookies filter</a> to block some types of cookies.
2941               Content cookies are not effected by <tt class="LITERAL">session-cookies-only</tt>.</p>
2942             </dd>
2943             <dt>Example usage:</dt>
2944             <dd>
2945               <table border="0" bgcolor="#E0E0E0" width="90%">
2946                 <tr>
2947                   <td>
2948                     <pre class="SCREEN">+session-cookies-only</pre>
2949                   </td>
2950                 </tr>
2951               </table>
2952             </dd>
2953           </dl>
2954         </div>
2955       </div>
2956       <div class="SECT3">
2957         <h4 class="SECT3"><a name="SET-IMAGE-BLOCKER" id="SET-IMAGE-BLOCKER">8.5.35. set-image-blocker</a></h4>
2958         <div class="VARIABLELIST">
2959           <dl>
2960             <dt>Typical use:</dt>
2961             <dd>
2962               <p>Choose the replacement for blocked images</p>
2963             </dd>
2964             <dt>Effect:</dt>
2965             <dd>
2966               <p>This action alone doesn't do anything noticeable. If <span class="emphasis"><i class=
2967               "EMPHASIS">both</i></span> <tt class="LITERAL"><a href="actions-file.html#BLOCK">block</a></tt>
2968               <span class="emphasis"><i class="EMPHASIS">and</i></span> <tt class="LITERAL"><a href=
2969               "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></tt> <span class="emphasis"><i class=
2970               "EMPHASIS">also</i></span> apply, i.e. if the request is to be blocked as an image, <span class=
2971               "emphasis"><i class="EMPHASIS">then</i></span> the parameter of this action decides what will be sent as
2972               a replacement.</p>
2973             </dd>
2974             <dt>Type:</dt>
2975             <dd>
2976               <p>Parameterized.</p>
2977             </dd>
2978             <dt>Parameter:</dt>
2979             <dd>
2980               <ul>
2981                 <li>
2982                   <p><span class="QUOTE">"pattern"</span> to send a built-in checkerboard pattern image. The image is
2983                   visually decent, scales very well, and makes it obvious where banners were busted.</p>
2984                 </li>
2985                 <li>
2986                   <p><span class="QUOTE">"blank"</span> to send a built-in transparent image. This makes banners
2987                   disappear completely, but makes it hard to detect where <span class="APPLICATION">Privoxy</span> has
2988                   blocked images on a given page and complicates troubleshooting if <span class=
2989                   "APPLICATION">Privoxy</span> has blocked innocent images, like navigation icons.</p>
2990                 </li>
2991                 <li>
2992                   <p><span class="QUOTE">"<tt class="REPLACEABLE"><i>target-url</i></tt>"</span> to send a redirect to
2993                   <tt class="REPLACEABLE"><i>target-url</i></tt>. You can redirect to any image anywhere, even in your
2994                   local filesystem via <span class="QUOTE">"file:///"</span> URL. (But note that not all browsers
2995                   support redirecting to a local file system).</p>
2996                   <p>A good application of redirects is to use special <span class=
2997                   "APPLICATION">Privoxy</span>-built-in URLs, which send the built-in images, as <tt class=
2998                   "REPLACEABLE"><i>target-url</i></tt>. This has the same visual effect as specifying <span class=
2999                   "QUOTE">"blank"</span> or <span class="QUOTE">"pattern"</span> in the first place, but enables your
3000                   browser to cache the replacement image, instead of requesting it over and over again.</p>
3001                 </li>
3002               </ul>
3003             </dd>
3004             <dt>Notes:</dt>
3005             <dd>
3006               <p>The URLs for the built-in images are <span class=
3007               "QUOTE">"http://config.privoxy.org/send-banner?type=<tt class="REPLACEABLE"><i>type</i></tt>"</span>,
3008               where <tt class="REPLACEABLE"><i>type</i></tt> is either <span class="QUOTE">"blank"</span> or
3009               <span class="QUOTE">"pattern"</span>.</p>
3010               <p>There is a third (advanced) type, called <span class="QUOTE">"auto"</span>. It is <span class=
3011               "emphasis"><i class="EMPHASIS">NOT</i></span> to be used in <tt class="LITERAL">set-image-blocker</tt>,
3012               but meant for use from <a href="filter-file.html">filters</a>. Auto will select the type of image that
3013               would have applied to the referring page, had it been an image.</p>
3014             </dd>
3015             <dt>Example usage:</dt>
3016             <dd>
3017               <p>Built-in pattern:</p>
3018               <table border="0" bgcolor="#E0E0E0" width="90%">
3019                 <tr>
3020                   <td>
3021                     <pre class="SCREEN">+set-image-blocker{pattern}</pre>
3022                   </td>
3023                 </tr>
3024               </table>
3025               <p>Redirect to the BSD daemon:</p>
3026               <table border="0" bgcolor="#E0E0E0" width="90%">
3027                 <tr>
3028                   <td>
3029                     <pre class="SCREEN">+set-image-blocker{http://www.freebsd.org/gifs/dae_up3.gif}</pre>
3030                   </td>
3031                 </tr>
3032               </table>
3033               <p>Redirect to the built-in pattern for better caching:</p>
3034               <table border="0" bgcolor="#E0E0E0" width="90%">
3035                 <tr>
3036                   <td>
3037                     <pre class="SCREEN">+set-image-blocker{http://config.privoxy.org/send-banner?type=pattern}</pre>
3038                   </td>
3039                 </tr>
3040               </table>
3041             </dd>
3042           </dl>
3043         </div>
3044       </div>
3045       <div class="SECT3">
3046         <h3 class="SECT3"><a name="SUMMARY" id="SUMMARY">8.5.36. Summary</a></h3>
3047         <p>Note that many of these actions have the potential to cause a page to misbehave, possibly even not to
3048         display at all. There are many ways a site designer may choose to design his site, and what HTTP header
3049         content, and other criteria, he may depend on. There is no way to have hard and fast rules for all sites. See
3050         the <a href="appendix.html#ACTIONSANAT">Appendix</a> for a brief example on troubleshooting actions.</p>
3051       </div>
3052     </div>
3053     <div class="SECT2">
3054       <h2 class="SECT2"><a name="ALIASES" id="ALIASES">8.6. Aliases</a></h2>
3055       <p>Custom <span class="QUOTE">"actions"</span>, known to <span class="APPLICATION">Privoxy</span> as <span class=
3056       "QUOTE">"aliases"</span>, can be defined by combining other actions. These can in turn be invoked just like the
3057       built-in actions. Currently, an alias name can contain any character except space, tab, <span class=
3058       "QUOTE">"="</span>, <span class="QUOTE">"{"</span> and <span class="QUOTE">"}"</span>, but we <span class=
3059       "emphasis"><i class="EMPHASIS">strongly recommend</i></span> that you only use <span class="QUOTE">"a"</span> to
3060       <span class="QUOTE">"z"</span>, <span class="QUOTE">"0"</span> to <span class="QUOTE">"9"</span>, <span class=
3061       "QUOTE">"+"</span>, and <span class="QUOTE">"-"</span>. Alias names are not case sensitive, and are not required
3062       to start with a <span class="QUOTE">"+"</span> or <span class="QUOTE">"-"</span> sign, since they are merely
3063       textually expanded.</p>
3064       <p>Aliases can be used throughout the actions file, but they <span class="emphasis"><i class="EMPHASIS">must be
3065       defined in a special section at the top of the file!</i></span> And there can only be one such section per
3066       actions file. Each actions file may have its own alias section, and the aliases defined in it are only visible
3067       within that file.</p>
3068       <p>There are two main reasons to use aliases: One is to save typing for frequently used combinations of actions,
3069       the other one is a gain in flexibility: If you decide once how you want to handle shops by defining an alias
3070       called <span class="QUOTE">"shop"</span>, you can later change your policy on shops in <span class=
3071       "emphasis"><i class="EMPHASIS">one</i></span> place, and your changes will take effect everywhere in the actions
3072       file where the <span class="QUOTE">"shop"</span> alias is used. Calling aliases by their purpose also makes your
3073       actions files more readable.</p>
3074       <p>Currently, there is one big drawback to using aliases, though: <span class="APPLICATION">Privoxy</span>'s
3075       built-in web-based action file editor honors aliases when reading the actions files, but it expands them before
3076       writing. So the effects of your aliases are of course preserved, but the aliases themselves are lost when you
3077       edit sections that use aliases with it.</p>
3078       <p>Now let's define some aliases...</p>
3079       <table border="0" bgcolor="#E0E0E0" width="100%">
3080         <tr>
3081           <td>
3082             <pre class="SCREEN"> # Useful custom aliases we can use later.
3083  #
3084  # Note the (required!) section header line and that this section
3085  # must be at the top of the actions file!
3086  #
3087  {{alias}}
3088
3089  # These aliases just save typing later:
3090  # (Note that some already use other aliases!)
3091  #
3092  +crunch-all-cookies = +<a href="actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a> +<a href=
3093 "actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a>
3094  -crunch-all-cookies = -<a href="actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a> -<a href=
3095 "actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a>
3096  +block-as-image      = +block{Blocked image.} +handle-as-image
3097  allow-all-cookies   = -crunch-all-cookies -<a href=
3098 "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a> -<a href=
3099 "actions-file.html#FILTER-CONTENT-COOKIES">filter{content-cookies}</a>
3100
3101  # These aliases define combinations of actions
3102  # that are useful for certain types of sites:
3103  #
3104  fragile     = -<a href="actions-file.html#BLOCK">block</a> -<a href=
3105 "actions-file.html#FILTER">filter</a> -crunch-all-cookies -<a href=
3106 "actions-file.html#FAST-REDIRECTS">fast-redirects</a> -<a href=
3107 "actions-file.html#HIDE-REFERER">hide-referrer</a> -<a href=
3108 "actions-file.html#PREVENT-COMPRESSION">prevent-compression</a>
3109
3110  shop        = -crunch-all-cookies -<a href="actions-file.html#FILTER-ALL-POPUPS">filter{all-popups}</a>
3111
3112  # Short names for other aliases, for really lazy people ;-)
3113  #
3114  c0 = +crunch-all-cookies
3115  c1 = -crunch-all-cookies</pre>
3116           </td>
3117         </tr>
3118       </table>
3119       <p>...and put them to use. These sections would appear in the lower part of an actions file and define exceptions
3120       to the default actions (as specified further up for the <span class="QUOTE">"/"</span> pattern):</p>
3121       <table border="0" bgcolor="#E0E0E0" width="100%">
3122         <tr>
3123           <td>
3124             <pre class="SCREEN"> # These sites are either very complex or very keen on
3125  # user data and require minimal interference to work:
3126  #
3127  {fragile}
3128  .office.microsoft.com
3129  .windowsupdate.microsoft.com
3130  # Gmail is really mail.google.com, not gmail.com
3131  mail.google.com
3132
3133  # Shopping sites:
3134  # Allow cookies (for setting and retrieving your customer data)
3135  #
3136  {shop}
3137  .quietpc.com
3138  .worldpay.com   # for quietpc.com
3139  mybank.example.com
3140
3141  # These shops require pop-ups:
3142  #
3143  {-filter{all-popups} -filter{unsolicited-popups}}
3144   .dabs.com
3145   .overclockers.co.uk</pre>
3146           </td>
3147         </tr>
3148       </table>
3149       <p>Aliases like <span class="QUOTE">"shop"</span> and <span class="QUOTE">"fragile"</span> are typically used for
3150       <span class="QUOTE">"problem"</span> sites that require more than one action to be disabled in order to function
3151       properly.</p>
3152     </div>
3153     <div class="SECT2">
3154       <h2 class="SECT2"><a name="ACT-EXAMPLES" id="ACT-EXAMPLES">8.7. Actions Files Tutorial</a></h2>
3155       <p>The above chapters have shown <a href="actions-file.html">which actions files there are and how they are
3156       organized</a>, how actions are <a href="actions-file.html#ACTIONS">specified</a> and <a href=
3157       "actions-file.html#ACTIONS-APPLY">applied to URLs</a>, how <a href="actions-file.html#AF-PATTERNS">patterns</a>
3158       work, and how to define and use <a href="actions-file.html#ALIASES">aliases</a>. Now, let's look at an example
3159       <tt class="FILENAME">match-all.action</tt>, <tt class="FILENAME">default.action</tt> and <tt class=
3160       "FILENAME">user.action</tt> file and see how all these pieces come together:</p>
3161       <div class="SECT3">
3162         <h3 class="SECT3"><a name="MATCH-ALL" id="MATCH-ALL">8.7.1. match-all.action</a></h3>
3163         <p>Remember <span class="emphasis"><i class="EMPHASIS">all actions are disabled when matching
3164         starts</i></span>, so we have to explicitly enable the ones we want.</p>
3165         <p>While the <tt class="FILENAME">match-all.action</tt> file only contains a single section, it is probably the
3166         most important one. It has only one pattern, <span class="QUOTE">"<tt class="LITERAL">/</tt>"</span>, but this
3167         pattern <a href="actions-file.html#AF-PATTERNS">matches all URLs</a>. Therefore, the set of actions used in
3168         this <span class="QUOTE">"default"</span> section <span class="emphasis"><i class="EMPHASIS">will be applied to
3169         all requests as a start</i></span>. It can be partly or wholly overridden by other actions files like
3170         <tt class="FILENAME">default.action</tt> and <tt class="FILENAME">user.action</tt>, but it will still be
3171         largely responsible for your overall browsing experience.</p>
3172         <p>Again, at the start of matching, all actions are disabled, so there is no need to disable any actions here.
3173         (Remember: a <span class="QUOTE">"+"</span> preceding the action name enables the action, a <span class=
3174         "QUOTE">"-"</span> disables!). Also note how this long line has been made more readable by splitting it into
3175         multiple lines with line continuation.</p>
3176         <table border="0" bgcolor="#E0E0E0" width="100%">
3177           <tr>
3178             <td>
3179               <pre class="SCREEN">{ \
3180  +<a href="actions-file.html#CHANGE-X-FORWARDED-FOR">change-x-forwarded-for{block}</a> \
3181  +<a href="actions-file.html#HIDE-FROM-HEADER">hide-from-header{block}</a> \
3182  +<a href="actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker{pattern}</a> \
3183 }
3184 / # Match all URLs</pre>
3185             </td>
3186           </tr>
3187         </table>
3188         <p>The default behavior is now set.</p>
3189       </div>
3190       <div class="SECT3">
3191         <h3 class="SECT3"><a name="DEFAULT-ACTION" id="DEFAULT-ACTION">8.7.2. default.action</a></h3>
3192         <p>If you aren't a developer, there's no need for you to edit the <tt class="FILENAME">default.action</tt>
3193         file. It is maintained by the <span class="APPLICATION">Privoxy</span> developers and if you disagree with some
3194         of the sections, you should overrule them in your <tt class="FILENAME">user.action</tt>.</p>
3195         <p>Understanding the <tt class="FILENAME">default.action</tt> file can help you with your <tt class=
3196         "FILENAME">user.action</tt>, though.</p>
3197         <p>The first section in this file is a special section for internal use that prevents older <span class=
3198         "APPLICATION">Privoxy</span> versions from reading the file:</p>
3199         <table border="0" bgcolor="#E0E0E0" width="100%">
3200           <tr>
3201             <td>
3202               <pre class="SCREEN">##########################################################################
3203 # Settings -- Don't change! For internal Privoxy use ONLY.
3204 ##########################################################################
3205 {{settings}}
3206 for-privoxy-version=3.0.11</pre>
3207             </td>
3208           </tr>
3209         </table>
3210         <p>After that comes the (optional) alias section. We'll use the example section from the above <a href=
3211         "actions-file.html#ALIASES">chapter on aliases</a>, that also explains why and how aliases are used:</p>
3212         <table border="0" bgcolor="#E0E0E0" width="100%">
3213           <tr>
3214             <td>
3215               <pre class="SCREEN">##########################################################################
3216 # Aliases
3217 ##########################################################################
3218 {{alias}}
3219
3220  # These aliases just save typing later:
3221  # (Note that some already use other aliases!)
3222  #
3223  +crunch-all-cookies = +<a href="actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a> +<a href=
3224 "actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a>
3225  -crunch-all-cookies = -<a href="actions-file.html#CRUNCH-INCOMING-COOKIES">crunch-incoming-cookies</a> -<a href=
3226 "actions-file.html#CRUNCH-OUTGOING-COOKIES">crunch-outgoing-cookies</a>
3227  +block-as-image      = +block{Blocked image.} +handle-as-image
3228  mercy-for-cookies   = -crunch-all-cookies -<a href=
3229 "actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a> -<a href=
3230 "actions-file.html#FILTER-CONTENT-COOKIES">filter{content-cookies}</a>
3231
3232  # These aliases define combinations of actions
3233  # that are useful for certain types of sites:
3234  #
3235  fragile     = -<a href="actions-file.html#BLOCK">block</a> -<a href=
3236 "actions-file.html#FILTER">filter</a> -crunch-all-cookies -<a href=
3237 "actions-file.html#FAST-REDIRECTS">fast-redirects</a> -<a href="actions-file.html#HIDE-REFERER">hide-referrer</a>
3238  shop        = -crunch-all-cookies -<a href="actions-file.html#FILTER-ALL-POPUPS">filter{all-popups}</a></pre>
3239             </td>
3240           </tr>
3241         </table>
3242         <p>The first of our specialized sections is concerned with <span class="QUOTE">"fragile"</span> sites, i.e.
3243         sites that require minimum interference, because they are either very complex or very keen on tracking you (and
3244         have mechanisms in place that make them unusable for people who avoid being tracked). We will use our
3245         pre-defined <tt class="LITERAL">fragile</tt> alias instead of stating the list of actions explicitly:</p>
3246         <table border="0" bgcolor="#E0E0E0" width="100%">
3247           <tr>
3248             <td>
3249               <pre class="SCREEN">##########################################################################
3250 # Exceptions for sites that'll break under the default action set:
3251 ##########################################################################
3252
3253 # "Fragile" Use a minimum set of actions for these sites (see alias above):
3254 #
3255 { fragile }
3256 .office.microsoft.com           # surprise, surprise!
3257 .windowsupdate.microsoft.com
3258 mail.google.com</pre>
3259             </td>
3260           </tr>
3261         </table>
3262         <p>Shopping sites are not as fragile, but they typically require cookies to log in, and pop-up windows for
3263         shopping carts or item details. Again, we'll use a pre-defined alias:</p>
3264         <table border="0" bgcolor="#E0E0E0" width="100%">
3265           <tr>
3266             <td>
3267               <pre class="SCREEN"># Shopping sites:
3268 #
3269 { shop }
3270 .quietpc.com
3271 .worldpay.com   # for quietpc.com
3272 .jungle.com
3273 .scan.co.uk</pre>
3274             </td>
3275           </tr>
3276         </table>
3277         <p>The <tt class="LITERAL"><a href="actions-file.html#FAST-REDIRECTS">fast-redirects</a></tt> action, which may
3278         have been enabled in <tt class="FILENAME">match-all.action</tt>, breaks some sites. So disable it for popular
3279         sites where we know it misbehaves:</p>
3280         <table border="0" bgcolor="#E0E0E0" width="100%">
3281           <tr>
3282             <td>
3283               <pre class="SCREEN">{ -<a href="actions-file.html#FAST-REDIRECTS">fast-redirects</a> }
3284 login.yahoo.com
3285 edit.*.yahoo.com
3286 .google.com
3287 .altavista.com/.*(like|url|link):http
3288 .altavista.com/trans.*urltext=http
3289 .nytimes.com</pre>
3290             </td>
3291           </tr>
3292         </table>
3293         <p>It is important that <span class="APPLICATION">Privoxy</span> knows which URLs belong to images, so that
3294         <span class="emphasis"><i class="EMPHASIS">if</i></span> they are to be blocked, a substitute image can be
3295         sent, rather than an HTML page. Contacting the remote site to find out is not an option, since it would destroy
3296         the loading time advantage of banner blocking, and it would feed the advertisers information about you. We can
3297         mark any URL as an image with the <tt class="LITERAL"><a href=
3298         "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></tt> action, and marking all URLs that end in a known
3299         image file extension is a good start:</p>
3300         <table border="0" bgcolor="#E0E0E0" width="100%">
3301           <tr>
3302             <td>
3303               <pre class="SCREEN">##########################################################################
3304 # Images:
3305 ##########################################################################
3306
3307 # Define which file types will be treated as images, in case they get
3308 # blocked further down this file:
3309 #
3310 { +<a href="actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a> }
3311 /.*\.(gif|jpe?g|png|bmp|ico)$</pre>
3312             </td>
3313           </tr>
3314         </table>
3315         <p>And then there are known banner sources. They often use scripts to generate the banners, so it won't be
3316         visible from the URL that the request is for an image. Hence we block them <span class="emphasis"><i class=
3317         "EMPHASIS">and</i></span> mark them as images in one go, with the help of our <tt class=
3318         "LITERAL">+block-as-image</tt> alias defined above. (We could of course just as well use <tt class=
3319         "LITERAL">+<a href="actions-file.html#BLOCK">block</a> +<a href=
3320         "actions-file.html#HANDLE-AS-IMAGE">handle-as-image</a></tt> here.) Remember that the type of the replacement
3321         image is chosen by the <tt class="LITERAL"><a href=
3322         "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></tt> action. Since all URLs have matched the
3323         default section with its <tt class="LITERAL">+<a href=
3324         "actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a>{pattern}</tt> action before, it still applies and
3325         needn't be repeated:</p>
3326         <table border="0" bgcolor="#E0E0E0" width="100%">
3327           <tr>
3328             <td>
3329               <pre class="SCREEN"># Known ad generators:
3330 #
3331 { +block-as-image }
3332 ar.atwola.com
3333 .ad.doubleclick.net
3334 .ad.*.doubleclick.net
3335 .a.yimg.com/(?:(?!/i/).)*$
3336 .a[0-9].yimg.com/(?:(?!/i/).)*$
3337 bs*.gsanet.com
3338 .qkimg.net</pre>
3339             </td>
3340           </tr>
3341         </table>
3342         <p>One of the most important jobs of <span class="APPLICATION">Privoxy</span> is to block banners. Many of
3343         these can be <span class="QUOTE">"blocked"</span> by the <tt class="LITERAL"><a href=
3344         "actions-file.html#FILTER">filter</a>{banners-by-size}</tt> action, which we enabled above, and which deletes
3345         the references to banner images from the pages while they are loaded, so the browser doesn't request them
3346         anymore, and hence they don't need to be blocked here. But this naturally doesn't catch all banners, and some
3347         people choose not to use filters, so we need a comprehensive list of patterns for banner URLs here, and apply
3348         the <tt class="LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> action to them.</p>
3349         <p>First comes many generic patterns, which do most of the work, by matching typical domain and path name
3350         components of banners. Then comes a list of individual patterns for specific sites, which is omitted here to
3351         keep the example short:</p>
3352         <table border="0" bgcolor="#E0E0E0" width="100%">
3353           <tr>
3354             <td>
3355               <pre class="SCREEN">##########################################################################
3356 # Block these fine banners:
3357 ##########################################################################
3358 { <a href="actions-file.html#BLOCK">+block{Banner ads.}</a> }
3359
3360 # Generic patterns:
3361 #
3362 ad*.
3363 .*ads.
3364 banner?.
3365 count*.
3366 /.*count(er)?\.(pl|cgi|exe|dll|asp|php[34]?)
3367 /(?:.*/)?(publicite|werbung|rekla(ma|me|am)|annonse|maino(kset|nta|s)?)/
3368
3369 # Site-specific patterns (abbreviated):
3370 #
3371 .hitbox.com</pre>
3372             </td>
3373           </tr>
3374         </table>
3375         <p>It's quite remarkable how many advertisers actually call their banner servers ads.<tt class=
3376         "REPLACEABLE"><i>company</i></tt>.com, or call the directory in which the banners are stored literally
3377         <span class="QUOTE">"banners"</span>. So the above generic patterns are surprisingly effective.</p>
3378         <p>But being very generic, they necessarily also catch URLs that we don't want to block. The pattern <tt class=
3379         "LITERAL">.*ads.</tt> e.g. catches <span class="QUOTE">"nasty-<span class="emphasis"><i class=
3380         "EMPHASIS">ads</i></span>.nasty-corp.com"</span> as intended, but also <span class="QUOTE">"downlo<span class=
3381         "emphasis"><i class="EMPHASIS">ads</i></span>.sourcefroge.net"</span> or <span class="QUOTE">"<span class=
3382         "emphasis"><i class="EMPHASIS">ads</i></span>l.some-provider.net."</span> So here come some well-known
3383         exceptions to the <tt class="LITERAL">+<a href="actions-file.html#BLOCK">block</a></tt> section above.</p>
3384         <p>Note that these are exceptions to exceptions from the default! Consider the URL <span class=
3385         "QUOTE">"downloads.sourcefroge.net"</span>: Initially, all actions are deactivated, so it wouldn't get blocked.
3386         Then comes the defaults section, which matches the URL, but just deactivates the <tt class="LITERAL"><a href=
3387         "actions-file.html#BLOCK">block</a></tt> action once again. Then it matches <tt class="LITERAL">.*ads.</tt>, an
3388         exception to the general non-blocking policy, and suddenly <tt class="LITERAL"><a href=
3389         "actions-file.html#BLOCK">+block</a></tt> applies. And now, it'll match <tt class="LITERAL">.*loads.</tt>,
3390         where <tt class="LITERAL"><a href="actions-file.html#BLOCK">-block</a></tt> applies, so (unless it matches
3391         <span class="emphasis"><i class="EMPHASIS">again</i></span> further down) it ends up with no <tt class=
3392         "LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> action applying.</p>
3393         <table border="0" bgcolor="#E0E0E0" width="100%">
3394           <tr>
3395             <td>
3396               <pre class="SCREEN">##########################################################################
3397 # Save some innocent victims of the above generic block patterns:
3398 ##########################################################################
3399
3400 # By domain:
3401 #
3402 { -<a href="actions-file.html#BLOCK">block</a> }
3403 adv[io]*.  # (for advogato.org and advice.*)
3404 adsl.      # (has nothing to do with ads)
3405 adobe.     # (has nothing to do with ads either)
3406 ad[ud]*.   # (adult.* and add.*)
3407 .edu       # (universities don't host banners (yet!))
3408 .*loads.   # (downloads, uploads etc)
3409
3410 # By path:
3411 #
3412 /.*loads/
3413
3414 # Site-specific:
3415 #
3416 www.globalintersec.com/adv # (adv = advanced)
3417 www.ugu.com/sui/ugu/adv</pre>
3418             </td>
3419           </tr>
3420         </table>
3421         <p>Filtering source code can have nasty side effects, so make an exception for our friends at sourceforge.net,
3422         and all paths with <span class="QUOTE">"cvs"</span> in them. Note that <tt class="LITERAL">-<a href=
3423         "actions-file.html#FILTER">filter</a></tt> disables <span class="emphasis"><i class="EMPHASIS">all</i></span>
3424         filters in one fell swoop!</p>
3425         <table border="0" bgcolor="#E0E0E0" width="100%">
3426           <tr>
3427             <td>
3428               <pre class="SCREEN"># Don't filter code!
3429 #
3430 { -<a href="actions-file.html#FILTER">filter</a> }
3431 /(.*/)?cvs
3432 bugzilla.
3433 developer.
3434 wiki.
3435 .sourceforge.net</pre>
3436             </td>
3437           </tr>
3438         </table>
3439         <p>The actual <tt class="FILENAME">default.action</tt> is of course much more comprehensive, but we hope this
3440         example made clear how it works.</p>
3441       </div>
3442       <div class="SECT3">
3443         <h3 class="SECT3"><a name="USER-ACTION" id="USER-ACTION">8.7.3. user.action</a></h3>
3444         <p>So far we are painting with a broad brush by setting general policies, which would be a reasonable starting
3445         point for many people. Now, you might want to be more specific and have customized rules that are more suitable
3446         to your personal habits and preferences. These would be for narrowly defined situations like your ISP or your
3447         bank, and should be placed in <tt class="FILENAME">user.action</tt>, which is parsed after all other actions
3448         files and hence has the last word, over-riding any previously defined actions. <tt class=
3449         "FILENAME">user.action</tt> is also a <span class="emphasis"><i class="EMPHASIS">safe</i></span> place for your
3450         personal settings, since <tt class="FILENAME">default.action</tt> is actively maintained by the <span class=
3451         "APPLICATION">Privoxy</span> developers and you'll probably want to install updated versions from time to
3452         time.</p>
3453         <p>So let's look at a few examples of things that one might typically do in <tt class=
3454         "FILENAME">user.action</tt>:</p>
3455         <table border="0" bgcolor="#E0E0E0" width="100%">
3456           <tr>
3457             <td>
3458               <pre class="SCREEN"># My user.action file. &lt;fred@example.com&gt;</pre>
3459             </td>
3460           </tr>
3461         </table>
3462         <p>As <a href="actions-file.html#ALIASES">aliases</a> are local to the actions file that they are defined in,
3463         you can't use the ones from <tt class="FILENAME">default.action</tt>, unless you repeat them here:</p>
3464         <table border="0" bgcolor="#E0E0E0" width="100%">
3465           <tr>
3466             <td>
3467               <pre class="SCREEN"># Aliases are local to the file they are defined in.
3468 # (Re-)define aliases for this file:
3469 #
3470 {{alias}}
3471 #
3472 # These aliases just save typing later, and the alias names should
3473 # be self explanatory.
3474 #
3475 +crunch-all-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies
3476 -crunch-all-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies
3477  allow-all-cookies  = -crunch-all-cookies -session-cookies-only
3478  allow-popups       = -filter{all-popups}
3479 +block-as-image     = +block{Blocked as image.} +handle-as-image
3480 -block-as-image     = -block
3481
3482 # These aliases define combinations of actions that are useful for
3483 # certain types of sites:
3484 #
3485 fragile     = -block -crunch-all-cookies -filter -fast-redirects -hide-referrer
3486 shop        = -crunch-all-cookies allow-popups
3487
3488 # Allow ads for selected useful free sites:
3489 #
3490 allow-ads   = -block -filter{banners-by-size} -filter{banners-by-link}
3491
3492 # Alias for specific file types that are text, but might have conflicting
3493 # MIME types. We want the browser to force these to be text documents.
3494 handle-as-text = -<a href="actions-file.html#FILTER">filter</a> +-<a href=
3495 "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite{text/plain}</a> +-<a href=
3496 "actions-file.html#FORCE-TEXT-MODE">force-text-mode</a> -<a href=
3497 "actions-file.html#HIDE-CONTENT-DISPOSITION">hide-content-disposition</a></pre>
3498             </td>
3499           </tr>
3500         </table>
3501         <p>Say you have accounts on some sites that you visit regularly, and you don't want to have to log in manually
3502         each time. So you'd like to allow persistent cookies for these sites. The <tt class=
3503         "LITERAL">allow-all-cookies</tt> alias defined above does exactly that, i.e. it disables crunching of cookies
3504         in any direction, and the processing of cookies to make them only temporary.</p>
3505         <table border="0" bgcolor="#E0E0E0" width="100%">
3506           <tr>
3507             <td>
3508               <pre class="SCREEN">{ allow-all-cookies }
3509  sourceforge.net
3510  .yahoo.com
3511  .msdn.microsoft.com
3512  .redhat.com</pre>
3513             </td>
3514           </tr>
3515         </table>
3516         <p>Your bank is allergic to some filter, but you don't know which, so you disable them all:</p>
3517         <table border="0" bgcolor="#E0E0E0" width="100%">
3518           <tr>
3519             <td>
3520               <pre class="SCREEN">{ -<a href="actions-file.html#FILTER">filter</a> }
3521  .your-home-banking-site.com</pre>
3522             </td>
3523           </tr>
3524         </table>
3525         <p>Some file types you may not want to filter for various reasons:</p>
3526         <table border="0" bgcolor="#E0E0E0" width="100%">
3527           <tr>
3528             <td>
3529               <pre class="SCREEN"># Technical documentation is likely to contain strings that might
3530 # erroneously get altered by the JavaScript-oriented filters:
3531 #
3532 .tldp.org
3533 /(.*/)?selfhtml/
3534
3535 # And this stupid host sends streaming video with a wrong MIME type,
3536 # so that Privoxy thinks it is getting HTML and starts filtering:
3537 #
3538 stupid-server.example.com/</pre>
3539             </td>
3540           </tr>
3541         </table>
3542         <p>Example of a simple <a href="actions-file.html#BLOCK">block</a> action. Say you've seen an ad on your
3543         favourite page on example.com that you want to get rid of. You have right-clicked the image, selected
3544         <span class="QUOTE">"copy image location"</span> and pasted the URL below while removing the leading http://,
3545         into a <tt class="LITERAL">{ +block{} }</tt> section. Note that <tt class="LITERAL">{ +handle-as-image }</tt>
3546         need not be specified, since all URLs ending in <tt class="LITERAL">.gif</tt> will be tagged as images by the
3547         general rules as set in default.action anyway:</p>
3548         <table border="0" bgcolor="#E0E0E0" width="100%">
3549           <tr>
3550             <td>
3551               <pre class="SCREEN">{ +<a href="actions-file.html#BLOCK">block</a>{Nasty ads.} }
3552  www.example.com/nasty-ads/sponsor\.gif
3553  another.example.net/more/junk/here/</pre>
3554             </td>
3555           </tr>
3556         </table>
3557         <p>The URLs of dynamically generated banners, especially from large banner farms, often don't use the
3558         well-known image file name extensions, which makes it impossible for <span class="APPLICATION">Privoxy</span>
3559         to guess the file type just by looking at the URL. You can use the <tt class="LITERAL">+block-as-image</tt>
3560         alias defined above for these cases. Note that objects which match this rule but then turn out NOT to be an
3561         image are typically rendered as a <span class="QUOTE">"broken image"</span> icon by the browser. Use
3562         cautiously.</p>
3563         <table border="0" bgcolor="#E0E0E0" width="100%">
3564           <tr>
3565             <td>
3566               <pre class="SCREEN">{ +block-as-image }
3567  .doubleclick.net
3568  .fastclick.net
3569  /Realmedia/ads/
3570  ar.atwola.com/</pre>
3571             </td>
3572           </tr>
3573         </table>
3574         <p>Now you noticed that the default configuration breaks Forbes Magazine, but you were too lazy to find out
3575         which action is the culprit, and you were again too lazy to give <a href="contact.html">feedback</a>, so you
3576         just used the <tt class="LITERAL">fragile</tt> alias on the site, and -- <span class="emphasis"><i class=
3577         "EMPHASIS">whoa!</i></span> -- it worked. The <tt class="LITERAL">fragile</tt> aliases disables those actions
3578         that are most likely to break a site. Also, good for testing purposes to see if it is <span class=
3579         "APPLICATION">Privoxy</span> that is causing the problem or not. We later find other regular sites that
3580         misbehave, and add those to our personalized list of troublemakers:</p>
3581         <table border="0" bgcolor="#E0E0E0" width="100%">
3582           <tr>
3583             <td>
3584               <pre class="SCREEN">{ fragile }
3585  .forbes.com
3586  webmail.example.com
3587  .mybank.com</pre>
3588             </td>
3589           </tr>
3590         </table>
3591         <p>You like the <span class="QUOTE">"fun"</span> text replacements in <tt class="FILENAME">default.filter</tt>,
3592         but it is disabled in the distributed actions file. So you'd like to turn it on in your private, update-safe
3593         config, once and for all:</p>
3594         <table border="0" bgcolor="#E0E0E0" width="100%">
3595           <tr>
3596             <td>
3597               <pre class="SCREEN">{ +<a href="actions-file.html#FILTER-FUN">filter{fun}</a> }
3598  / # For ALL sites!</pre>
3599             </td>
3600           </tr>
3601         </table>
3602         <p>Note that the above is not really a good idea: There are exceptions to the filters in <tt class=
3603         "FILENAME">default.action</tt> for things that really shouldn't be filtered, like code on CVS-&#62;Web
3604         interfaces. Since <tt class="FILENAME">user.action</tt> has the last word, these exceptions won't be valid for
3605         the <span class="QUOTE">"fun"</span> filtering specified here.</p>
3606         <p>You might also worry about how your favourite free websites are funded, and find that they rely on
3607         displaying banner advertisements to survive. So you might want to specifically allow banners for those sites
3608         that you feel provide value to you:</p>
3609         <table border="0" bgcolor="#E0E0E0" width="100%">
3610           <tr>
3611             <td>
3612               <pre class="SCREEN">{ allow-ads }
3613  .sourceforge.net
3614  .slashdot.org
3615  .osdn.net</pre>
3616             </td>
3617           </tr>
3618         </table>
3619         <p>Note that <tt class="LITERAL">allow-ads</tt> has been aliased to <tt class="LITERAL">-<a href=
3620         "actions-file.html#BLOCK">block</a></tt>, <tt class="LITERAL">-<a href=
3621         "actions-file.html#FILTER-BANNERS-BY-SIZE">filter{banners-by-size}</a></tt>, and <tt class="LITERAL">-<a href=
3622         "actions-file.html#FILTER-BANNERS-BY-LINK">filter{banners-by-link}</a></tt> above.</p>
3623         <p>Invoke another alias here to force an over-ride of the MIME type <tt class="LITERAL">application/x-sh</tt>
3624         which typically would open a download type dialog. In my case, I want to look at the shell script, and then I
3625         can save it should I choose to.</p>
3626         <table border="0" bgcolor="#E0E0E0" width="100%">
3627           <tr>
3628             <td>
3629               <pre class="SCREEN">{ handle-as-text }
3630  /.*\.sh$</pre>
3631             </td>
3632           </tr>
3633         </table>
3634         <p><tt class="FILENAME">user.action</tt> is generally the best place to define exceptions and additions to the
3635         default policies of <tt class="FILENAME">default.action</tt>. Some actions are safe to have their default
3636         policies set here though. So let's set a default policy to have a <span class="QUOTE">"blank"</span> image as
3637         opposed to the checkerboard pattern for <span class="emphasis"><i class="EMPHASIS">ALL</i></span> sites.
3638         <span class="QUOTE">"/"</span> of course matches all URL paths and patterns:</p>
3639         <table border="0" bgcolor="#E0E0E0" width="100%">
3640           <tr>
3641             <td>
3642               <pre class="SCREEN">{ +<a href="actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker{blank}</a> }
3643 / # ALL sites</pre>
3644             </td>
3645           </tr>
3646         </table>
3647       </div>
3648     </div>
3649   </div>
3650   <div class="NAVFOOTER">
3651     <hr align="left" width="100%">
3652     <table summary="Footer navigation table" width="100%" border="0" cellpadding="0" cellspacing="0">
3653       <tr>
3654         <td width="33%" align="left" valign="top"><a href="config.html" accesskey="P">Prev</a></td>
3655         <td width="34%" align="center" valign="top"><a href="index.html" accesskey="H">Home</a></td>
3656         <td width="33%" align="right" valign="top"><a href="filter-file.html" accesskey="N">Next</a></td>
3657       </tr>
3658       <tr>
3659         <td width="33%" align="left" valign="top">The Main Configuration File</td>
3660         <td width="34%" align="center" valign="top">&nbsp;</td>
3661         <td width="33%" align="right" valign="top">Filter Files</td>
3662       </tr>
3663     </table>
3664   </div>
3665 </body>
3666 </html>