Rebuild docs
[privoxy.git] / doc / webserver / user-manual / actions-file.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
2 "">
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.29 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.29 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="AEN3088" id="AEN3088"></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     "" target="_top"></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="" target=
215       "_top"></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.
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       "" target="_top"></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       "" 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"></tt></dt>
282           <dd>
283             <p>is a host-only pattern and will match any request to <tt class="LITERAL"></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"></tt> is different and would
286             NOT match.</p>
287           </dd>
288           <dt><tt class="LITERAL"></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"></tt></dt>
294           <dd>
295             <p>matches all the documents on <tt class="LITERAL"></tt> whose name starts with <tt class=
296             "LITERAL">/index.html</tt>.</p>
297           </dd>
298           <dt><tt class="LITERAL">$</tt></dt>
299           <dd>
300             <p>matches only the single document <tt class="LITERAL">/index.html</tt> on <tt class=
301             "LITERAL"></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"></tt></dt>
317           <dd>
318             <p>Matches any URL with the host address <tt class="LITERAL"></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"></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"></tt>, <tt class=
344               "LITERAL"></tt> and <tt class="LITERAL"></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"></tt>, <tt class="LITERAL"></tt>, or <tt class=
360               "LITERAL"></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="" 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*</tt></dt>
375             <dd>
376               <p>matches <span class="QUOTE">""</span>, <span class=
377               "QUOTE">""</span>, etc but not <span class="QUOTE">""</span></p>
378             </dd>
379             <dt><tt class="LITERAL">*ad*</tt></dt>
380             <dd>
381               <p>matches all of the above, and then some.</p>
382             </dd>
383             <dt><tt class="LITERAL">.?</tt></dt>
384             <dd>
385               <p>matches <tt class="LITERAL"></tt>, <tt class="LITERAL"></tt>, <tt class=
386               "LITERAL"></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"></tt>, <tt class="LITERAL"></tt>,
391               <tt class="LITERAL"></tt>, <tt class="LITERAL"></tt> etc., but
392               <span class="emphasis"><i class="EMPHASIS">not</i></span> <tt class="LITERAL"></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         "" 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">*</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">*</tt></dt>
417             <dd>
418               <p>Is equivalent to just <span class="QUOTE">""</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">*/index.html$</tt></dt>
423             <dd>
424               <p>Will match any page in the domain of <span class="QUOTE">""</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">""</span> but NOT <span class=
427               "QUOTE">""</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">""</span>, because of the special meta-character <span class=
430               "QUOTE">"."</span>.</p>
431             </dd>
432             <dt><tt class="LITERAL">*/)?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">*/)(ads|banners?|junk)</tt></dt>
440             <dd>
441               <p>This regular expression will match any path of <span class="QUOTE">""</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">*/)(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         "" target="_top"></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$
533 # This section is not overruled because it's located after
534 # the previous one.
535 {+block{Nobody is supposed to request this.}}
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:
586           Gecko/20070602 Firefox/}</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
729 {+block{Doubleclick banners.} +handle-as-image}
730 # Block and replace with image
734 {+block{Layered ads.} +handle-as-empty-document}
735 # Block and then ignore
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 /
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 .} \
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 /
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}
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 /
931 # Change forwarding settings for requests coming from address
932 {+forward-override{forward-socks5 .}}
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 really uses valid XHTML
996 { +content-type-overwrite{application/xml} }
999 # but leave the content type unmodified if the URL looks like a style sheet
1000 {-content-type-overwrite}
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="DELAY-RESPONSE" id="DELAY-RESPONSE">8.5.13. delay-response</a></h4>
1317         <div class="VARIABLELIST">
1318           <dl>
1319             <dt>Typical use:</dt>
1320             <dd>
1321               <p>Delay responses to the client to reduce the load</p>
1322             </dd>
1323             <dt>Effect:</dt>
1324             <dd>
1325               <p>Delays responses to the client by sending the response in ca. 10 byte chunks.</p>
1326             </dd>
1327             <dt>Type:</dt>
1328             <dd>
1329               <p>Parameterized.</p>
1330             </dd>
1331             <dt>Parameter:</dt>
1332             <dd>
1333               <p><span class="QUOTE">"Number of milliseconds"</span></p>
1334             </dd>
1335             <dt>Notes:</dt>
1336             <dd>
1337               <p>Sometimes when JavaScript code is used to fetch advertisements it doesn't respect Privoxy's blocks and
1338               retries to fetch the same resource again causing unnecessary load on the client.</p>
1339               <p>This action delays responses to the client and can be combined with <tt class="LITERAL"><a href=
1340               "actions-file.html#BLOCK">blocks</a></tt> to slow down the JavaScript code, thus reducing the load on the
1341               client.</p>
1342               <p>When used without <tt class="LITERAL"><a href="actions-file.html#BLOCK">blocks</a></tt> the action can
1343               also be used to simulate a slow internet connection.</p>
1344             </dd>
1345             <dt>Example usage:</dt>
1346             <dd>
1347               <table border="0" bgcolor="#E0E0E0" width="90%">
1348                 <tr>
1349                   <td>
1350                     <pre class="SCREEN">+delay-response{100}</pre>
1351                   </td>
1352                 </tr>
1353               </table>
1354             </dd>
1355           </dl>
1356         </div>
1357       </div>
1358       <div class="SECT3">
1359         <h4 class="SECT3"><a name="DOWNGRADE-HTTP-VERSION" id="DOWNGRADE-HTTP-VERSION">8.5.14.
1360         downgrade-http-version</a></h4>
1361         <div class="VARIABLELIST">
1362           <dl>
1363             <dt>Typical use:</dt>
1364             <dd>
1365               <p>Work around (very rare) problems with HTTP/1.1</p>
1366             </dd>
1367             <dt>Effect:</dt>
1368             <dd>
1369               <p>Downgrades HTTP/1.1 client requests and server replies to HTTP/1.0.</p>
1370             </dd>
1371             <dt>Type:</dt>
1372             <dd>
1373               <p>Boolean.</p>
1374             </dd>
1375             <dt>Parameter:</dt>
1376             <dd>
1377               <p>N/A</p>
1378             </dd>
1379             <dt>Notes:</dt>
1380             <dd>
1381               <p>This is a left-over from the time when <span class="APPLICATION">Privoxy</span> didn't support
1382               important HTTP/1.1 features well. It is left here for the unlikely case that you experience
1383               HTTP/1.1-related problems with some server out there.</p>
1384               <p>Note that enabling this action is only a workaround. It should not be enabled for sites that work
1385               without it. While it shouldn't break any pages, it has an (usually negative) performance impact.</p>
1386               <p>If you come across a site where enabling this action helps, please report it, so the cause of the
1387               problem can be analyzed. If the problem turns out to be caused by a bug in <span class=
1388               "APPLICATION">Privoxy</span> it should be fixed so the following release works without the work
1389               around.</p>
1390             </dd>
1391             <dt>Example usage (section):</dt>
1392             <dd>
1393               <table border="0" bgcolor="#E0E0E0" width="90%">
1394                 <tr>
1395                   <td>
1396                     <pre class="SCREEN">{+downgrade-http-version}
1398                   </td>
1399                 </tr>
1400               </table>
1401             </dd>
1402           </dl>
1403         </div>
1404       </div>
1405       <div class="SECT3">
1406         <h4 class="SECT3"><a name="ENABLE-HTTPS-FILTERING" id="ENABLE-HTTPS-FILTERING">8.5.15.
1407         enable-https-filtering</a></h4>
1408         <div class="VARIABLELIST">
1409           <dl>
1410             <dt>Typical use:</dt>
1411             <dd>
1412               <p>Filter encrypted requests and responses</p>
1413             </dd>
1414             <dt>Effect:</dt>
1415             <dd>
1416               <p>Encrypted requests are decrypted, filtered and forwarded encrypted.</p>
1417             </dd>
1418             <dt>Type:</dt>
1419             <dd>
1420               <p>Boolean.</p>
1421             </dd>
1422             <dt>Parameter:</dt>
1423             <dd>
1424               <p>N/A</p>
1425             </dd>
1426             <dt>Notes:</dt>
1427             <dd>
1428               <p>This action allows <span class="APPLICATION">Privoxy</span> to filter encrypted requests and
1429               responses. For this to work <span class="APPLICATION">Privoxy</span> has to generate a certificate and
1430               send it to the client which has to accept it.</p>
1431               <p>Before this works the directives in the <a href="config.html">TLS section of the config</a> file have
1432               to be configured.</p>
1433             </dd>
1434             <dt>Example usage (section):</dt>
1435             <dd>
1436               <table border="0" bgcolor="#E0E0E0" width="90%">
1437                 <tr>
1438                   <td>
1439                     <pre class="SCREEN">{+enable-https-filtering}
1441                   </td>
1442                 </tr>
1443               </table>
1444             </dd>
1445           </dl>
1446         </div>
1447       </div>
1448       <div class="SECT3">
1449         <h4 class="SECT3"><a name="EXTERNAL-FILTER" id="EXTERNAL-FILTER">8.5.16. external-filter</a></h4>
1450         <div class="VARIABLELIST">
1451           <dl>
1452             <dt>Typical use:</dt>
1453             <dd>
1454               <p>Modify content using a programming language of your choice.</p>
1455             </dd>
1456             <dt>Effect:</dt>
1457             <dd>
1458               <p>All instances of text-based type, most notably HTML and JavaScript, to which this action applies, can
1459               be filtered on-the-fly through the specified external filter. By default plain text documents are
1460               exempted from filtering, because web servers often use the <tt class="LITERAL">text/plain</tt> MIME type
1461               for all files whose type they don't know.)</p>
1462             </dd>
1463             <dt>Type:</dt>
1464             <dd>
1465               <p>Multi-value.</p>
1466             </dd>
1467             <dt>Parameter:</dt>
1468             <dd>
1469               <p>The name of an external content filter, as defined in the <a href="filter-file.html">filter file</a>.
1470               External filters can be defined in one or more files as defined by the <tt class="LITERAL"><a href=
1471               "config.html#FILTERFILE">filterfile</a></tt> option in the <a href="config.html">config file</a>.</p>
1472               <p>When used in its negative form, and without parameters, <span class="emphasis"><i class=
1473               "EMPHASIS">all</i></span> filtering with external filters is completely disabled.</p>
1474             </dd>
1475             <dt>Notes:</dt>
1476             <dd>
1477               <p>External filters are scripts or programs that can modify the content in case common <tt class=
1478               "LITERAL"><a href="actions-file.html#FILTER">filters</a></tt> aren't powerful enough. With the exception
1479               that this action doesn't use pcrs-based filters, the notes in the <tt class="LITERAL"><a href=
1480               "actions-file.html#FILTER">filter</a></tt> section apply.</p>
1481               <div class="WARNING">
1482                 <table class="WARNING" border="1" width="90%">
1483                   <tr>
1484                     <td align="center"><b>Warning</b></td>
1485                   </tr>
1486                   <tr>
1487                     <td align="left">
1488                       <p>Currently external filters are executed with <span class="APPLICATION">Privoxy</span>'s
1489                       privileges. Only use external filters you understand and trust.</p>
1490                     </td>
1491                   </tr>
1492                 </table>
1493               </div>
1494               <p>This feature is experimental, the <tt class="LITERAL"><a href=
1495               "filter-file.html#EXTERNAL-FILTER-SYNTAX">syntax</a></tt> may change in the future.</p>
1496             </dd>
1497             <dt>Example usage:</dt>
1498             <dd>
1499               <table border="0" bgcolor="#E0E0E0" width="90%">
1500                 <tr>
1501                   <td>
1502                     <pre class="SCREEN">+external-filter{fancy-filter}</pre>
1503                   </td>
1504                 </tr>
1505               </table>
1506             </dd>
1507           </dl>
1508         </div>
1509       </div>
1510       <div class="SECT3">
1511         <h4 class="SECT3"><a name="FAST-REDIRECTS" id="FAST-REDIRECTS">8.5.17. fast-redirects</a></h4>
1512         <div class="VARIABLELIST">
1513           <dl>
1514             <dt>Typical use:</dt>
1515             <dd>
1516               <p>Fool some click-tracking scripts and speed up indirect links.</p>
1517             </dd>
1518             <dt>Effect:</dt>
1519             <dd>
1520               <p>Detects redirection URLs and redirects the browser without contacting the redirection server
1521               first.</p>
1522             </dd>
1523             <dt>Type:</dt>
1524             <dd>
1525               <p>Parameterized.</p>
1526             </dd>
1527             <dt>Parameter:</dt>
1528             <dd>
1529               <ul>
1530                 <li>
1531                   <p><span class="QUOTE">"simple-check"</span> to just search for the string <span class=
1532                   "QUOTE">"http://"</span> to detect redirection URLs.</p>
1533                 </li>
1534                 <li>
1535                   <p><span class="QUOTE">"check-decoded-url"</span> to decode URLs (if necessary) before searching for
1536                   redirection URLs.</p>
1537                 </li>
1538               </ul>
1539             </dd>
1540             <dt>Notes:</dt>
1541             <dd>
1542               <p>Many sites, like, don't just link to other sites. Instead, they will link to some script on
1543               their own servers, giving the destination as a parameter, which will then redirect you to the final
1544               target. URLs resulting from this scheme typically look like: <span class=
1545               "QUOTE">""</span>.</p>
1546               <p>Sometimes, there are even multiple consecutive redirects encoded in the URL. These redirections via
1547               scripts make your web browsing more traceable, since the server from which you follow such a link can see
1548               where you go to. Apart from that, valuable bandwidth and time is wasted, while your browser asks the
1549               server for one redirect after the other. Plus, it feeds the advertisers.</p>
1550               <p>This feature is currently not very smart and is scheduled for improvement. If it is enabled by
1551               default, you will have to create some exceptions to this action. It can lead to failures in several
1552               ways:</p>
1553               <p>Not every URLs with other URLs as parameters is evil. Some sites offer a real service that requires
1554               this information to work. For example a validation service needs to know, which document to validate.
1555               <tt class="LITERAL">fast-redirects</tt> assumes that every URL parameter that looks like another URL is a
1556               redirection target, and will always redirect to the last one. Most of the time the assumption is correct,
1557               but if it isn't, the user gets redirected anyway.</p>
1558               <p>Another failure occurs if the URL contains other parameters after the URL parameter. The URL:
1559               <span class="QUOTE">";foo=bar"</span>.
1560               contains the redirection URL <span class="QUOTE">""</span>, followed by another
1561               parameter. <tt class="LITERAL">fast-redirects</tt> doesn't know that and will cause a redirect to
1562               <span class="QUOTE">";foo=bar"</span>. Depending on the target server
1563               configuration, the parameter will be silently ignored or lead to a <span class="QUOTE">"page not
1564               found"</span> error. You can prevent this problem by first using the <tt class="LITERAL"><a href=
1565               "actions-file.html#REDIRECT">redirect</a></tt> action to remove the last part of the URL, but it requires
1566               a little effort.</p>
1567               <p>To detect a redirection URL, <tt class="LITERAL">fast-redirects</tt> only looks for the string
1568               <span class="QUOTE">"http://"</span>, either in plain text (invalid but often used) or encoded as
1569               <span class="QUOTE">"http%3a//"</span>. Some sites use their own URL encoding scheme, encrypt the address
1570               of the target server or replace it with a database id. In theses cases <tt class=
1571               "LITERAL">fast-redirects</tt> is fooled and the request reaches the redirection server where it probably
1572               gets logged.</p>
1573             </dd>
1574             <dt>Example usage:</dt>
1575             <dd>
1576               <table border="0" bgcolor="#E0E0E0" width="90%">
1577                 <tr>
1578                   <td>
1579                     <pre class="SCREEN"> { +fast-redirects{simple-check} }
1582  { +fast-redirects{check-decoded-url} }
1584                   </td>
1585                 </tr>
1586               </table>
1587             </dd>
1588           </dl>
1589         </div>
1590       </div>
1591       <div class="SECT3">
1592         <h4 class="SECT3"><a name="FILTER" id="FILTER">8.5.18. filter</a></h4>
1593         <div class="VARIABLELIST">
1594           <dl>
1595             <dt>Typical use:</dt>
1596             <dd>
1597               <p>Get rid of HTML and JavaScript annoyances, banner advertisements (by size), do fun text replacements,
1598               add personalized effects, etc.</p>
1599             </dd>
1600             <dt>Effect:</dt>
1601             <dd>
1602               <p>All instances of text-based type, most notably HTML and JavaScript, to which this action applies, can
1603               be filtered on-the-fly through the specified regular expression based substitutions. (Note: as of version
1604               3.0.3 plain text documents are exempted from filtering, because web servers often use the <tt class=
1605               "LITERAL">text/plain</tt> MIME type for all files whose type they don't know.)</p>
1606             </dd>
1607             <dt>Type:</dt>
1608             <dd>
1609               <p>Multi-value.</p>
1610             </dd>
1611             <dt>Parameter:</dt>
1612             <dd>
1613               <p>The name of a content filter, as defined in the <a href="filter-file.html">filter file</a>. Filters
1614               can be defined in one or more files as defined by the <tt class="LITERAL"><a href=
1615               "config.html#FILTERFILE">filterfile</a></tt> option in the <a href="config.html">config file</a>.
1616               <tt class="FILENAME">default.filter</tt> is the collection of filters supplied by the developers. Locally
1617               defined filters should go in their own file, such as <tt class="FILENAME">user.filter</tt>.</p>
1618               <p>When used in its negative form, and without parameters, <span class="emphasis"><i class=
1619               "EMPHASIS">all</i></span> filtering is completely disabled.</p>
1620             </dd>
1621             <dt>Notes:</dt>
1622             <dd>
1623               <p>For your convenience, there are a number of pre-defined filters available in the distribution filter
1624               file that you can use. See the examples below for a list.</p>
1625               <p>Filtering requires buffering the page content, which may appear to slow down page rendering since
1626               nothing is displayed until all content has passed the filters. (The total time until the page is
1627               completely rendered doesn't change much, but it may be perceived as slower since the page is not
1628               incrementally displayed.) This effect will be more noticeable on slower connections.</p>
1629               <p><span class="QUOTE">"Rolling your own"</span> filters requires a knowledge of <a href=
1630               "" target="_top"><span class="QUOTE">"Regular
1631               Expressions"</span></a> and <a href="" target="_top"><span class=
1632               "QUOTE">"HTML"</span></a>. This is very powerful feature, and potentially very intrusive. Filters should
1633               be used with caution, and where an equivalent <span class="QUOTE">"action"</span> is not available.</p>
1634               <p>The amount of data that can be filtered is limited to the <tt class="LITERAL"><a href=
1635               "config.html#BUFFER-LIMIT">buffer-limit</a></tt> option in the main <a href="config.html">config
1636               file</a>. The default is 4096 KB (4 Megs). Once this limit is exceeded, the buffered data, and all
1637               pending data, is passed through unfiltered.</p>
1638               <p>Inappropriate MIME types, such as zipped files, are not filtered at all. (Again, only text-based types
1639               except plain text). Encrypted SSL data (from HTTPS servers) cannot be filtered either, since this would
1640               violate the integrity of the secure transaction. In some situations it might be necessary to protect
1641               certain text, like source code, from filtering by defining appropriate <tt class="LITERAL">-filter</tt>
1642               exceptions.</p>
1643               <p>Compressed content can't be filtered either, but if <span class="APPLICATION">Privoxy</span> is
1644               compiled with zlib support and a supported compression algorithm is used (gzip or deflate), <span class=
1645               "APPLICATION">Privoxy</span> can first decompress the content and then filter it.</p>
1646               <p>If you use a <span class="APPLICATION">Privoxy</span> version without zlib support, but want filtering
1647               to work on as much documents as possible, even those that would normally be sent compressed, you must use
1648               the <tt class="LITERAL"><a href="actions-file.html#PREVENT-COMPRESSION">prevent-compression</a></tt>
1649               action in conjunction with <tt class="LITERAL">filter</tt>.</p>
1650               <p>Content filtering can achieve some of the same effects as the <tt class="LITERAL"><a href=
1651               "actions-file.html#BLOCK">block</a></tt> action, i.e. it can be used to block ads and banners. But the
1652               mechanism works quite differently. One effective use, is to block ad banners based on their size (see
1653               below), since many of these seem to be somewhat standardized.</p>
1654               <p><a href="contact.html">Feedback</a> with suggestions for new or improved filters is particularly
1655               welcome!</p>
1656               <p>The below list has only the names and a one-line description of each predefined filter. There are
1657               <a href="filter-file.html#PREDEFINED-FILTERS">more verbose explanations</a> of what these filters do in
1658               the <a href="filter-file.html">filter file chapter</a>.</p>
1659             </dd>
1660             <dt>Example usage (with filters from the distribution <tt class="FILENAME">default.filter</tt> file). See
1661             <a href="filter-file.html#PREDEFINED-FILTERS">the Predefined Filters section</a> for more explanation on
1662             each:</dt>
1663             <dd>
1664               <p><a name="FILTER-JS-ANNOYANCES" id="FILTER-JS-ANNOYANCES"></a></p>
1665               <table border="0" bgcolor="#E0E0E0" width="90%">
1666                 <tr>
1667                   <td>
1668                     <pre class="SCREEN">
1669                     +filter{js-annoyances}       # Get rid of particularly annoying JavaScript abuse.</pre>
1670                   </td>
1671                 </tr>
1672               </table>
1673               <p><a name="FILTER-JS-EVENTS" id="FILTER-JS-EVENTS"></a></p>
1674               <table border="0" bgcolor="#E0E0E0" width="90%">
1675                 <tr>
1676                   <td>
1677                     <pre class="SCREEN">
1678                     +filter{js-events}           # Kill JavaScript event bindings and timers (Radically destructive! Only for extra nasty sites).</pre>
1679                   </td>
1680                 </tr>
1681               </table>
1682               <p><a name="FILTER-HTML-ANNOYANCES" id="FILTER-HTML-ANNOYANCES"></a></p>
1683               <table border="0" bgcolor="#E0E0E0" width="90%">
1684                 <tr>
1685                   <td>
1686                     <pre class="SCREEN">
1687                     +filter{html-annoyances}     # Get rid of particularly annoying HTML abuse.</pre>
1688                   </td>
1689                 </tr>
1690               </table>
1691               <p><a name="FILTER-CONTENT-COOKIES" id="FILTER-CONTENT-COOKIES"></a></p>
1692               <table border="0" bgcolor="#E0E0E0" width="90%">
1693                 <tr>
1694                   <td>
1695                     <pre class="SCREEN">
1696                     +filter{content-cookies}     # Kill cookies that come in the HTML or JS content.</pre>
1697                   </td>
1698                 </tr>
1699               </table>
1700               <p><a name="FILTER-REFRESH-TAGS" id="FILTER-REFRESH-TAGS"></a></p>
1701               <table border="0" bgcolor="#E0E0E0" width="90%">
1702                 <tr>
1703                   <td>
1704                     <pre class="SCREEN">
1705                     +filter{refresh-tags}        # Kill automatic refresh tags if refresh time is larger than 9 seconds.</pre>
1706                   </td>
1707                 </tr>
1708               </table>
1709               <p><a name="FILTER-UNSOLICITED-POPUPS" id="FILTER-UNSOLICITED-POPUPS"></a></p>
1710               <table border="0" bgcolor="#E0E0E0" width="90%">
1711                 <tr>
1712                   <td>
1713                     <pre class="SCREEN">+filter{unsolicited-popups}  # Disable only unsolicited pop-up windows.</pre>
1714                   </td>
1715                 </tr>
1716               </table>
1717               <p><a name="FILTER-ALL-POPUPS" id="FILTER-ALL-POPUPS"></a></p>
1718               <table border="0" bgcolor="#E0E0E0" width="90%">
1719                 <tr>
1720                   <td>
1721                     <pre class="SCREEN">+filter{all-popups}          # Kill all popups in JavaScript and HTML.</pre>
1722                   </td>
1723                 </tr>
1724               </table>
1725               <p><a name="FILTER-IMG-REORDER" id="FILTER-IMG-REORDER"></a></p>
1726               <table border="0" bgcolor="#E0E0E0" width="90%">
1727                 <tr>
1728                   <td>
1729                     <pre class="SCREEN">
1730                     +filter{img-reorder}         # Reorder attributes in &lt;img&gt; tags to make the banners-by-* filters more effective.</pre>
1731                   </td>
1732                 </tr>
1733               </table>
1734               <p><a name="FILTER-BANNERS-BY-SIZE" id="FILTER-BANNERS-BY-SIZE"></a></p>
1735               <table border="0" bgcolor="#E0E0E0" width="90%">
1736                 <tr>
1737                   <td>
1738                     <pre class="SCREEN">+filter{banners-by-size}     # Kill banners by size.</pre>
1739                   </td>
1740                 </tr>
1741               </table>
1742               <p><a name="FILTER-BANNERS-BY-LINK" id="FILTER-BANNERS-BY-LINK"></a></p>
1743               <table border="0" bgcolor="#E0E0E0" width="90%">
1744                 <tr>
1745                   <td>
1746                     <pre class="SCREEN">
1747                     +filter{banners-by-link}     # Kill banners by their links to known clicktrackers.</pre>
1748                   </td>
1749                 </tr>
1750               </table>
1751               <p><a name="FILTER-WEBBUGS" id="FILTER-WEBBUGS"></a></p>
1752               <table border="0" bgcolor="#E0E0E0" width="90%">
1753                 <tr>
1754                   <td>
1755                     <pre class="SCREEN">
1756                     +filter{webbugs}             # Squish WebBugs (1x1 invisible GIFs used for user tracking).</pre>
1757                   </td>
1758                 </tr>
1759               </table>
1760               <p><a name="FILTER-TINY-TEXTFORMS" id="FILTER-TINY-TEXTFORMS"></a></p>
1761               <table border="0" bgcolor="#E0E0E0" width="90%">
1762                 <tr>
1763                   <td>
1764                     <pre class="SCREEN">
1765                     +filter{tiny-textforms}      # Extend those tiny textareas up to 40x80 and kill the hard wrap.</pre>
1766                   </td>
1767                 </tr>
1768               </table>
1769               <p><a name="FILTER-JUMPING-WINDOWS" id="FILTER-JUMPING-WINDOWS"></a></p>
1770               <table border="0" bgcolor="#E0E0E0" width="90%">
1771                 <tr>
1772                   <td>
1773                     <pre class="SCREEN">
1774                     +filter{jumping-windows}     # Prevent windows from resizing and moving themselves.</pre>
1775                   </td>
1776                 </tr>
1777               </table>
1778               <p><a name="FILTER-FRAMESET-BORDERS" id="FILTER-FRAMESET-BORDERS"></a></p>
1779               <table border="0" bgcolor="#E0E0E0" width="90%">
1780                 <tr>
1781                   <td>
1782                     <pre class="SCREEN">
1783                     +filter{frameset-borders}    # Give frames a border and make them resizable.</pre>
1784                   </td>
1785                 </tr>
1786               </table>
1787               <p><a name="FILTER-IFRAMES" id="FILTER-IFRAMES"></a></p>
1788               <table border="0" bgcolor="#E0E0E0" width="90%">
1789                 <tr>
1790                   <td>
1791                     <pre class="SCREEN">
1792                     +filter{iframes}             # Removes all detected iframes. Should only be enabled for individual sites.</pre>
1793                   </td>
1794                 </tr>
1795               </table>
1796               <p><a name="FILTER-DEMORONIZER" id="FILTER-DEMORONIZER"></a></p>
1797               <table border="0" bgcolor="#E0E0E0" width="90%">
1798                 <tr>
1799                   <td>
1800                     <pre class="SCREEN">
1801                     +filter{demoronizer}         # Fix MS's non-standard use of standard charsets.</pre>
1802                   </td>
1803                 </tr>
1804               </table>
1805               <p><a name="FILTER-SHOCKWAVE-FLASH" id="FILTER-SHOCKWAVE-FLASH"></a></p>
1806               <table border="0" bgcolor="#E0E0E0" width="90%">
1807                 <tr>
1808                   <td>
1809                     <pre class="SCREEN">+filter{shockwave-flash}     # Kill embedded Shockwave Flash objects.</pre>
1810                   </td>
1811                 </tr>
1812               </table>
1813               <p><a name="FILTER-QUICKTIME-KIOSKMODE" id="FILTER-QUICKTIME-KIOSKMODE"></a></p>
1814               <table border="0" bgcolor="#E0E0E0" width="90%">
1815                 <tr>
1816                   <td>
1817                     <pre class="SCREEN">+filter{quicktime-kioskmode} # Make Quicktime movies saveable.</pre>
1818                   </td>
1819                 </tr>
1820               </table>
1821               <p><a name="FILTER-FUN" id="FILTER-FUN"></a></p>
1822               <table border="0" bgcolor="#E0E0E0" width="90%">
1823                 <tr>
1824                   <td>
1825                     <pre class="SCREEN">
1826                     +filter{fun}                 # Text replacements for subversive browsing fun!</pre>
1827                   </td>
1828                 </tr>
1829               </table>
1830               <p><a name="FILTER-CRUDE-PARENTAL" id="FILTER-CRUDE-PARENTAL"></a></p>
1831               <table border="0" bgcolor="#E0E0E0" width="90%">
1832                 <tr>
1833                   <td>
1834                     <pre class="SCREEN">
1835                     +filter{crude-parental}      # Crude parental filtering. Note that this filter doesn't work reliably.</pre>
1836                   </td>
1837                 </tr>
1838               </table>
1839               <p><a name="FILTER-IE-EXPLOITS" id="FILTER-IE-EXPLOITS"></a></p>
1840               <table border="0" bgcolor="#E0E0E0" width="90%">
1841                 <tr>
1842                   <td>
1843                     <pre class="SCREEN">
1844                     +filter{ie-exploits}         # Disable some known Internet Explorer bug exploits.</pre>
1845                   </td>
1846                 </tr>
1847               </table>
1848               <p><a name="FILTER-SITE-SPECIFICS" id="FILTER-SITE-SPECIFICS"></a></p>
1849               <table border="0" bgcolor="#E0E0E0" width="90%">
1850                 <tr>
1851                   <td>
1852                     <pre class="SCREEN">
1853                     +filter{site-specifics}      # Cure for site-specific problems. Don't apply generally!</pre>
1854                   </td>
1855                 </tr>
1856               </table>
1857               <p><a name="FILTER-NO-PING" id="FILTER-NO-PING"></a></p>
1858               <table border="0" bgcolor="#E0E0E0" width="90%">
1859                 <tr>
1860                   <td>
1861                     <pre class="SCREEN">
1862                     +filter{no-ping}             # Removes non-standard ping attributes in &lt;a&gt; and &lt;area&gt; tags.</pre>
1863                   </td>
1864                 </tr>
1865               </table>
1866               <p><a name="FILTER-GOOGLE" id="FILTER-GOOGLE"></a></p>
1867               <table border="0" bgcolor="#E0E0E0" width="90%">
1868                 <tr>
1869                   <td>
1870                     <pre class="SCREEN">
1871                     +filter{google}              # CSS-based block for Google text ads. Also removes a width limitation and the toolbar advertisement.</pre>
1872                   </td>
1873                 </tr>
1874               </table>
1875               <p><a name="FILTER-YAHOO" id="FILTER-YAHOO"></a></p>
1876               <table border="0" bgcolor="#E0E0E0" width="90%">
1877                 <tr>
1878                   <td>
1879                     <pre class="SCREEN">
1880                     +filter{yahoo}               # CSS-based block for Yahoo text ads. Also removes a width limitation.</pre>
1881                   </td>
1882                 </tr>
1883               </table>
1884               <p><a name="FILTER-MSN" id="FILTER-MSN"></a></p>
1885               <table border="0" bgcolor="#E0E0E0" width="90%">
1886                 <tr>
1887                   <td>
1888                     <pre class="SCREEN">
1889                     +filter{msn}                 # CSS-based block for MSN text ads. Also removes tracking URLs and a width limitation.</pre>
1890                   </td>
1891                 </tr>
1892               </table>
1893               <p><a name="FILTER-BLOGSPOT" id="FILTER-BLOGSPOT"></a></p>
1894               <table border="0" bgcolor="#E0E0E0" width="90%">
1895                 <tr>
1896                   <td>
1897                     <pre class="SCREEN">
1898                     +filter{blogspot}            # Cleans up some Blogspot blogs. Read the fine print before using this.</pre>
1899                   </td>
1900                 </tr>
1901               </table>
1902             </dd>
1903           </dl>
1904         </div>
1905       </div>
1906       <div class="SECT3">
1907         <h4 class="SECT3"><a name="FORCE-TEXT-MODE" id="FORCE-TEXT-MODE">8.5.19. force-text-mode</a></h4>
1908         <div class="VARIABLELIST">
1909           <dl>
1910             <dt>Typical use:</dt>
1911             <dd>
1912               <p>Force <span class="APPLICATION">Privoxy</span> to treat a document as if it was in some kind of
1913               <span class="emphasis"><i class="EMPHASIS">text</i></span> format.</p>
1914             </dd>
1915             <dt>Effect:</dt>
1916             <dd>
1917               <p>Declares a document as text, even if the <span class="QUOTE">"Content-Type:"</span> isn't detected as
1918               such.</p>
1919             </dd>
1920             <dt>Type:</dt>
1921             <dd>
1922               <p>Boolean.</p>
1923             </dd>
1924             <dt>Parameter:</dt>
1925             <dd>
1926               <p>N/A</p>
1927             </dd>
1928             <dt>Notes:</dt>
1929             <dd>
1930               <p>As explained <tt class="LITERAL"><a href="actions-file.html#FILTER">above</a></tt>, <span class=
1931               "APPLICATION">Privoxy</span> tries to only filter files that are in some kind of text format. The same
1932               restrictions apply to <tt class="LITERAL"><a href=
1933               "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite</a></tt>. <tt class=
1934               "LITERAL">force-text-mode</tt> declares a document as text, without looking at the <span class=
1935               "QUOTE">"Content-Type:"</span> first.</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>Think twice before activating this action. Filtering binary data with regular expressions can
1944                       cause file damage.</p>
1945                     </td>
1946                   </tr>
1947                 </table>
1948               </div>
1949             </dd>
1950             <dt>Example usage:</dt>
1951             <dd>
1952               <table border="0" bgcolor="#E0E0E0" width="90%">
1953                 <tr>
1954                   <td>
1955                     <pre class="SCREEN">+force-text-mode</pre>
1956                   </td>
1957                 </tr>
1958               </table>
1959             </dd>
1960           </dl>
1961         </div>
1962       </div>
1963       <div class="SECT3">
1964         <h4 class="SECT3"><a name="FORWARD-OVERRIDE" id="FORWARD-OVERRIDE">8.5.20. forward-override</a></h4>
1965         <div class="VARIABLELIST">
1966           <dl>
1967             <dt>Typical use:</dt>
1968             <dd>
1969               <p>Change the forwarding settings based on User-Agent or request origin</p>
1970             </dd>
1971             <dt>Effect:</dt>
1972             <dd>
1973               <p>Overrules the forward directives in the configuration file.</p>
1974             </dd>
1975             <dt>Type:</dt>
1976             <dd>
1977               <p>Parameterized.</p>
1978             </dd>
1979             <dt>Parameter:</dt>
1980             <dd>
1981               <ul>
1982                 <li>
1983                   <p><span class="QUOTE">"forward ."</span> to use a direct connection without any additional
1984                   proxies.</p>
1985                 </li>
1986                 <li>
1987                   <p><span class="QUOTE">"forward"</span> to use the HTTP proxy listening at
1988                   port 8123.</p>
1989                 </li>
1990                 <li>
1991                   <p><span class="QUOTE">"forward-socks4a ."</span> to use the socks4a proxy listening
1992                   at port 9050. Replace <span class="QUOTE">"forward-socks4a"</span> with <span class=
1993                   "QUOTE">"forward-socks4"</span> to use a socks4 connection (with local DNS resolution) instead, use
1994                   <span class="QUOTE">"forward-socks5"</span> for socks5 connections (with remote DNS resolution).</p>
1995                 </li>
1996                 <li>
1997                   <p><span class="QUOTE">"forward-socks4a"</span> to use the
1998                   socks4a proxy listening at port 9050 to reach the HTTP proxy listening at
1999                   port 8000. Replace <span class="QUOTE">"forward-socks4a"</span> with <span class=
2000                   "QUOTE">"forward-socks4"</span> to use a socks4 connection (with local DNS resolution) instead, use
2001                   <span class="QUOTE">"forward-socks5"</span> for socks5 connections (with remote DNS resolution).</p>
2002                 </li>
2003                 <li>
2004                   <p><span class="QUOTE">"forward-webserver"</span> to use the HTTP server listening at
2005          port 80 without adjusting the request headers.</p>
2006                   <p>This makes it more convenient to use Privoxy to make existing websites available as onion services
2007                   as well.</p>
2008                   <p>Many websites serve content with hardcoded URLs and can't be easily adjusted to change the domain
2009                   based on the one used by the client.</p>
2010                   <p>Putting Privoxy between Tor and the webserver (or an stunnel that forwards to the webserver)
2011                   allows to rewrite headers and content to make client and server happy at the same time.</p>
2012                   <p>Using Privoxy for webservers that are only reachable through onion addresses and whose location is
2013                   supposed to be secret is not recommended and should not be necessary anyway.</p>
2014                 </li>
2015               </ul>
2016             </dd>
2017             <dt>Notes:</dt>
2018             <dd>
2019               <p>This action takes parameters similar to the <a href="config.html#FORWARDING">forward</a> directives in
2020               the configuration file, but without the URL pattern. It can be used as replacement, but normally it's
2021               only used in cases where matching based on the request URL isn't sufficient.</p>
2022               <div class="WARNING">
2023                 <table class="WARNING" border="1" width="90%">
2024                   <tr>
2025                     <td align="center"><b>Warning</b></td>
2026                   </tr>
2027                   <tr>
2028                     <td align="left">
2029                       <p>Please read the description for the <a href="config.html#FORWARDING">forward</a> directives
2030                       before using this action. Forwarding to the wrong people will reduce your privacy and increase
2031                       the chances of man-in-the-middle attacks.</p>
2032                       <p>If the ports are missing or invalid, default values will be used. This might change in the
2033                       future and you shouldn't rely on it. Otherwise incorrect syntax causes Privoxy to exit. Due to
2034                       design limitations, invalid parameter syntax isn't detected until the action is used the first
2035                       time.</p>
2036                       <p>Use the <a href="" target="_top">show-url-info CGI
2037                       page</a> to verify that your forward settings do what you thought the do.</p>
2038                     </td>
2039                   </tr>
2040                 </table>
2041               </div>
2042             </dd>
2043             <dt>Example usage:</dt>
2044             <dd>
2045               <table border="0" bgcolor="#E0E0E0" width="90%">
2046                 <tr>
2047                   <td>
2048                     <pre class="SCREEN"># Use an ssh tunnel for requests previously tagged as
2049 # <span class="QUOTE">"User-Agent: fetch libfetch/2.0"</span> and make sure
2050 # resuming downloads continues to work.
2051 #
2052 # This way you can continue to use Tor for your normal browsing,
2053 # without overloading the Tor network with your FreeBSD ports updates
2054 # or downloads of bigger files like ISOs.
2055 #
2056 # Note that HTTP headers are easy to fake and therefore their
2057 # values are as (un)trustworthy as your clients and users.
2058 {+forward-override{forward-socks5 .} \
2059  -hide-if-modified-since      \
2060  -overwrite-last-modified     \
2061 }
2062 TAG:^User-Agent: fetch libfetch/2\.0$</pre>
2063                   </td>
2064                 </tr>
2065               </table>
2066             </dd>
2067           </dl>
2068         </div>
2069       </div>
2070       <div class="SECT3">
2071         <h4 class="SECT3"><a name="HANDLE-AS-EMPTY-DOCUMENT" id="HANDLE-AS-EMPTY-DOCUMENT">8.5.21.
2072         handle-as-empty-document</a></h4>
2073         <div class="VARIABLELIST">
2074           <dl>
2075             <dt>Typical use:</dt>
2076             <dd>
2077               <p>Mark URLs that should be replaced by empty documents <span class="emphasis"><i class="EMPHASIS">if
2078               they get blocked</i></span></p>
2079             </dd>
2080             <dt>Effect:</dt>
2081             <dd>
2082               <p>This action alone doesn't do anything noticeable. It just marks URLs. If the <tt class=
2083               "LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> action <span class="emphasis"><i class=
2084               "EMPHASIS">also applies</i></span>, the presence or absence of this mark decides whether an HTML
2085               <span class="QUOTE">"BLOCKED"</span> page, or an empty document will be sent to the client as a
2086               substitute for the blocked content. The <span class="emphasis"><i class="EMPHASIS">empty</i></span>
2087               document isn't literally empty, but actually contains a single space.</p>
2088             </dd>
2089             <dt>Type:</dt>
2090             <dd>
2091               <p>Boolean.</p>
2092             </dd>
2093             <dt>Parameter:</dt>
2094             <dd>
2095               <p>N/A</p>
2096             </dd>
2097             <dt>Notes:</dt>
2098             <dd>
2099               <p>Some browsers complain about syntax errors if JavaScript documents are blocked with <span class=
2100               "APPLICATION">Privoxy's</span> default HTML page; this option can be used to silence them. And of course
2101               this action can also be used to eliminate the <span class="APPLICATION">Privoxy</span> BLOCKED message in
2102               frames.</p>
2103               <p>The content type for the empty document can be specified with <tt class="LITERAL"><a href=
2104               "actions-file.html#CONTENT-TYPE-OVERWRITE">content-type-overwrite{}</a></tt>, but usually this isn't
2105               necessary.</p>
2106             </dd>
2107             <dt>Example usage:</dt>
2108             <dd>
2109               <table border="0" bgcolor="#E0E0E0" width="90%">
2110                 <tr>
2111                   <td>
2112                     <pre class="SCREEN"># Block all documents on that end with ".js",
2113 # but send an empty document instead of the usual HTML message.
2114 {+block{Blocked JavaScript} +handle-as-empty-document}
2116                   </td>
2117                 </tr>
2118               </table>
2119             </dd>
2120           </dl>
2121         </div>
2122       </div>
2123       <div class="SECT3">
2124         <h4 class="SECT3"><a name="HANDLE-AS-IMAGE" id="HANDLE-AS-IMAGE">8.5.22. handle-as-image</a></h4>
2125         <div class="VARIABLELIST">
2126           <dl>
2127             <dt>Typical use:</dt>
2128             <dd>
2129               <p>Mark URLs as belonging to images (so they'll be replaced by images <span class="emphasis"><i class=
2130               "EMPHASIS">if they do get blocked</i></span>, rather than HTML pages)</p>
2131             </dd>
2132             <dt>Effect:</dt>
2133             <dd>
2134               <p>This action alone doesn't do anything noticeable. It just marks URLs as images. If the <tt class=
2135               "LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> action <span class="emphasis"><i class=
2136               "EMPHASIS">also applies</i></span>, the presence or absence of this mark decides whether an HTML
2137               <span class="QUOTE">"blocked"</span> page, or a replacement image (as determined by the <tt class=
2138               "LITERAL"><a href="actions-file.html#SET-IMAGE-BLOCKER">set-image-blocker</a></tt> action) will be sent
2139               to the client as a substitute for the blocked content.</p>
2140             </dd>
2141             <dt>Type:</dt>
2142             <dd>
2143               <p>Boolean.</p>
2144             </dd>
2145             <dt>Parameter:</dt>
2146             <dd>
2147               <p>N/A</p>
2148             </dd>
2149             <dt>Notes:</dt>
2150             <dd>
2151               <p>The below generic example section is actually part of <tt class="FILENAME">default.action</tt>. It
2152               marks all URLs with well-known image file name extensions as images and should be left intact.</p>
2153               <p>Users will probably only want to use the handle-as-image action in conjunction with <tt class=
2154               "LITERAL"><a href="actions-file.html#BLOCK">block</a></tt>, to block sources of banners, whose URLs don't
2155               reflect the file type, like in the second example section.</p>
2156               <p>Note that you cannot treat HTML pages as images in most cases. For instance, (in-line) ad frames
2157               require an HTML page to be sent, or they won't display properly. Forcing <tt class=
2158               "LITERAL">handle-as-image</tt> in this situation will not replace the ad frame with an image, but lead to
2159               error messages.</p>
2160             </dd>
2161             <dt>Example usage (sections):</dt>
2162             <dd>
2163               <table border="0" bgcolor="#E0E0E0" width="90%">
2164                 <tr>
2165                   <td>
2166                     <pre class="SCREEN"># Generic image extensions:
2167 #
2168 {+handle-as-image}
2169 /.*\.(gif|jpg|jpeg|png|bmp|ico)$
2171 # These don't look like images, but they're banners and should be
2172 # blocked as images:
2173 #
2174 {+block{Nasty banners.} +handle-as-image}
2176                   </td>
2177                 </tr>
2178               </table>
2179             </dd>
2180           </dl>
2181         </div>
2182       </div>
2183       <div class="SECT3">
2184         <h4 class="SECT3"><a name="HIDE-ACCEPT-LANGUAGE" id="HIDE-ACCEPT-LANGUAGE">8.5.23.
2185         hide-accept-language</a></h4>
2186         <div class="VARIABLELIST">
2187           <dl>
2188             <dt>Typical use:</dt>
2189             <dd>
2190               <p>Pretend to use different language settings.</p>
2191             </dd>
2192             <dt>Effect:</dt>
2193             <dd>
2194               <p>Deletes or replaces the <span class="QUOTE">"Accept-Language:"</span> HTTP header in client
2195               requests.</p>
2196             </dd>
2197             <dt>Type:</dt>
2198             <dd>
2199               <p>Parameterized.</p>
2200             </dd>
2201             <dt>Parameter:</dt>
2202             <dd>
2203               <p>Keyword: <span class="QUOTE">"block"</span>, or any user defined value.</p>
2204             </dd>
2205             <dt>Notes:</dt>
2206             <dd>
2207               <p>Faking the browser's language settings can be useful to make a foreign User-Agent set with <tt class=
2208               "LITERAL"><a href="actions-file.html#HIDE-USER-AGENT">hide-user-agent</a></tt> more believable.</p>
2209               <p>However some sites with content in different languages check the <span class=
2210               "QUOTE">"Accept-Language:"</span> to decide which one to take by default. Sometimes it isn't possible to
2211               later switch to another language without changing the <span class="QUOTE">"Accept-Language:"</span>
2212               header first.</p>
2213               <p>Therefore it's a good idea to either only change the <span class="QUOTE">"Accept-Language:"</span>
2214               header to languages you understand, or to languages that aren't wide spread.</p>
2215               <p>Before setting the <span class="QUOTE">"Accept-Language:"</span> header to a rare language, you should
2216               consider that it helps to make your requests unique and thus easier to trace. If you don't plan to change
2217               this header frequently, you should stick to a common language.</p>
2218             </dd>
2219             <dt>Example usage (section):</dt>
2220             <dd>
2221               <table border="0" bgcolor="#E0E0E0" width="90%">
2222                 <tr>
2223                   <td>
2224                     <pre class="SCREEN"># Pretend to use Canadian language settings.
2225 {+hide-accept-language{en-ca} \
2226 +hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv: Gecko/20060628 Firefox/} \
2227 }
2228 /</pre>
2229                   </td>
2230                 </tr>
2231               </table>
2232             </dd>
2233           </dl>
2234         </div>
2235       </div>
2236       <div class="SECT3">
2237         <h4 class="SECT3"><a name="HIDE-CONTENT-DISPOSITION" id="HIDE-CONTENT-DISPOSITION">8.5.24.
2238         hide-content-disposition</a></h4>
2239         <div class="VARIABLELIST">
2240           <dl>
2241             <dt>Typical use:</dt>
2242             <dd>
2243               <p>Prevent download menus for content you prefer to view inside the browser.</p>
2244             </dd>
2245             <dt>Effect:</dt>
2246             <dd>
2247               <p>Deletes or replaces the <span class="QUOTE">"Content-Disposition:"</span> HTTP header set by some
2248               servers.</p>
2249             </dd>
2250             <dt>Type:</dt>
2251             <dd>
2252               <p>Parameterized.</p>
2253             </dd>
2254             <dt>Parameter:</dt>
2255             <dd>
2256               <p>Keyword: <span class="QUOTE">"block"</span>, or any user defined value.</p>
2257             </dd>
2258             <dt>Notes:</dt>
2259             <dd>
2260               <p>Some servers set the <span class="QUOTE">"Content-Disposition:"</span> HTTP header for documents they
2261               assume you want to save locally before viewing them. The <span class=
2262               "QUOTE">"Content-Disposition:"</span> header contains the file name the browser is supposed to use by
2263               default.</p>
2264               <p>In most browsers that understand this header, it makes it impossible to <span class=
2265               "emphasis"><i class="EMPHASIS">just view</i></span> the document, without downloading it first, even if
2266               it's just a simple text file or an image.</p>
2267               <p>Removing the <span class="QUOTE">"Content-Disposition:"</span> header helps to prevent this annoyance,
2268               but some browsers additionally check the <span class="QUOTE">"Content-Type:"</span> header, before they
2269               decide if they can display a document without saving it first. In these cases, you have to change this
2270               header as well, before the browser stops displaying download menus.</p>
2271               <p>It is also possible to change the server's file name suggestion to another one, but in most cases it
2272               isn't worth the time to set it up.</p>
2273               <p>This action will probably be removed in the future, use server-header filters instead.</p>
2274             </dd>
2275             <dt>Example usage:</dt>
2276             <dd>
2277               <table border="0" bgcolor="#E0E0E0" width="90%">
2278                 <tr>
2279                   <td>
2280                     <pre class="SCREEN"># Disarm the download link in Sourceforge's patch tracker
2281 { -filter \
2282  +content-type-overwrite{text/plain}\
2283  +hide-content-disposition{block} }
2285                   </td>
2286                 </tr>
2287               </table>
2288             </dd>
2289           </dl>
2290         </div>
2291       </div>
2292       <div class="SECT3">
2293         <h4 class="SECT3"><a name="HIDE-IF-MODIFIED-SINCE" id="HIDE-IF-MODIFIED-SINCE">8.5.25.
2294         hide-if-modified-since</a></h4>
2295         <div class="VARIABLELIST">
2296           <dl>
2297             <dt>Typical use:</dt>
2298             <dd>
2299               <p>Prevent yet another way to track the user's steps between sessions.</p>
2300             </dd>
2301             <dt>Effect:</dt>
2302             <dd>
2303               <p>Deletes the <span class="QUOTE">"If-Modified-Since:"</span> HTTP client header or modifies its
2304               value.</p>
2305             </dd>
2306             <dt>Type:</dt>
2307             <dd>
2308               <p>Parameterized.</p>
2309             </dd>
2310             <dt>Parameter:</dt>
2311             <dd>
2312               <p>Keyword: <span class="QUOTE">"block"</span>, or a user defined value that specifies a range of
2313               hours.</p>
2314             </dd>
2315             <dt>Notes:</dt>
2316             <dd>
2317               <p>Removing this header is useful for filter testing, where you want to force a real reload instead of
2318               getting status code <span class="QUOTE">"304"</span>, which would cause the browser to use a cached copy
2319               of the page.</p>
2320               <p>Instead of removing the header, <tt class="LITERAL">hide-if-modified-since</tt> can also add or
2321               subtract a random amount of time to/from the header's value. You specify a range of minutes where the
2322               random factor should be chosen from and <span class="APPLICATION">Privoxy</span> does the rest. A
2323               negative value means subtracting, a positive value adding.</p>
2324               <p>Randomizing the value of the <span class="QUOTE">"If-Modified-Since:"</span> makes it less likely that
2325               the server can use the time as a cookie replacement, but you will run into caching problems if the random
2326               range is too high.</p>
2327               <p>It is a good idea to only use a small negative value and let <tt class="LITERAL"><a href=
2328               "actions-file.html#OVERWRITE-LAST-MODIFIED">overwrite-last-modified</a></tt> handle the greater
2329               changes.</p>
2330               <p>It is also recommended to use this action together with <tt class="LITERAL"><a href=
2331               "actions-file.html#CRUNCH-IF-NONE-MATCH">crunch-if-none-match</a></tt>, otherwise it's more or less
2332               pointless.</p>
2333             </dd>
2334             <dt>Example usage (section):</dt>
2335             <dd>
2336               <table border="0" bgcolor="#E0E0E0" width="90%">
2337                 <tr>
2338                   <td>
2339                     <pre class="SCREEN"># Let the browser revalidate but make tracking based on the time less likely.
2340 {+hide-if-modified-since{-60} \
2341  +overwrite-last-modified{randomize} \
2342  +crunch-if-none-match}
2343 /</pre>
2344                   </td>
2345                 </tr>
2346               </table>
2347             </dd>
2348           </dl>
2349         </div>
2350       </div>
2351       <div class="SECT3">
2352         <h4 class="SECT3"><a name="HIDE-FROM-HEADER" id="HIDE-FROM-HEADER">8.5.26. hide-from-header</a></h4>
2353         <div class="VARIABLELIST">
2354           <dl>
2355             <dt>Typical use:</dt>
2356             <dd>
2357               <p>Keep your (old and ill) browser from telling web servers your email address</p>
2358             </dd>
2359             <dt>Effect:</dt>
2360             <dd>
2361               <p>Deletes any existing <span class="QUOTE">"From:"</span> HTTP header, or replaces it with the specified
2362               string.</p>
2363             </dd>
2364             <dt>Type:</dt>
2365             <dd>
2366               <p>Parameterized.</p>
2367             </dd>
2368             <dt>Parameter:</dt>
2369             <dd>
2370               <p>Keyword: <span class="QUOTE">"block"</span>, or any user defined value.</p>
2371             </dd>
2372             <dt>Notes:</dt>
2373             <dd>
2374               <p>The keyword <span class="QUOTE">"block"</span> will completely remove the header (not to be confused
2375               with the <tt class="LITERAL"><a href="actions-file.html#BLOCK">block</a></tt> action).</p>
2376               <p>Alternately, you can specify any value you prefer to be sent to the web server. If you do, it is a
2377               matter of fairness not to use any address that is actually used by a real person.</p>
2378               <p>This action is rarely needed, as modern web browsers don't send <span class="QUOTE">"From:"</span>
2379               headers anymore.</p>
2380             </dd>
2381             <dt>Example usage:</dt>
2382             <dd>
2383               <table border="0" bgcolor="#E0E0E0" width="90%">
2384                 <tr>
2385                   <td>
2386                     <pre class="SCREEN">+hide-from-header{block}</pre>
2387                   </td>
2388                 </tr>
2389               </table>
2390               <p>or</p>
2391               <table border="0" bgcolor="#E0E0E0" width="90%">
2392                 <tr>
2393                   <td>
2394                     <pre class="SCREEN">+hide-from-header{}</pre>
2395                   </td>
2396                 </tr>
2397               </table>
2398             </dd>
2399           </dl>
2400         </div>
2401       </div>
2402       <div class="SECT3">
2403         <h4 class="SECT3"><a name="HIDE-REFERRER" id="HIDE-REFERRER">8.5.27. hide-referrer</a></h4><a name=
2404         "HIDE-REFERER" id="HIDE-REFERER"></a>
2405         <div class="VARIABLELIST">
2406           <dl>
2407             <dt>Typical use:</dt>
2408             <dd>
2409               <p>Conceal which link you followed to get to a particular site</p>
2410             </dd>
2411             <dt>Effect:</dt>
2412             <dd>
2413               <p>Deletes the <span class="QUOTE">"Referer:"</span> (sic) HTTP header from the client request, or
2414               replaces it with a forged one.</p>
2415             </dd>
2416             <dt>Type:</dt>
2417             <dd>
2418               <p>Parameterized.</p>
2419             </dd>
2420             <dt>Parameter:</dt>
2421             <dd>
2422               <ul>
2423                 <li>
2424                   <p><span class="QUOTE">"conditional-block"</span> to delete the header completely if the host has
2425                   changed.</p>
2426                 </li>
2427                 <li>
2428                   <p><span class="QUOTE">"conditional-forge"</span> to forge the header if the host has changed.</p>
2429                 </li>
2430                 <li>
2431                   <p><span class="QUOTE">"block"</span> to delete the header unconditionally.</p>
2432                 </li>
2433                 <li>
2434                   <p><span class="QUOTE">"forge"</span> to pretend to be coming from the homepage of the server we are
2435                   talking to.</p>
2436                 </li>
2437                 <li>
2438                   <p>Any other string to set a user defined referrer.</p>
2439                 </li>
2440               </ul>
2441             </dd>
2442             <dt>Notes:</dt>
2443             <dd>
2444               <p><tt class="LITERAL">conditional-block</tt> is the only parameter, that isn't easily detected in the
2445               server's log file. If it blocks the referrer, the request will look like the visitor used a bookmark or
2446               typed in the address directly.</p>
2447               <p>Leaving the referrer unmodified for requests on the same host allows the server owner to see the
2448               visitor's <span class="QUOTE">"click path"</span>, but in most cases she could also get that information
2449               by comparing other parts of the log file: for example the User-Agent if it isn't a very common one, or
2450               the user's IP address if it doesn't change between different requests.</p>
2451               <p>Always blocking the referrer, or using a custom one, can lead to failures on servers that check the
2452               referrer before they answer any requests, in an attempt to prevent their content from being embedded or
2453               linked to elsewhere.</p>
2454               <p>Both <tt class="LITERAL">conditional-block</tt> and <tt class="LITERAL">forge</tt> will work with
2455               referrer checks, as long as content and valid referring page are on the same host. Most of the time
2456               that's the case.</p>
2457               <p><tt class="LITERAL">hide-referer</tt> is an alternate spelling of <tt class=
2458               "LITERAL">hide-referrer</tt> and the two can be can be freely substituted with each other. (<span class=
2459               "QUOTE">"referrer"</span> is the correct English spelling, however the HTTP specification has a bug - it
2460               requires it to be spelled as <span class="QUOTE">"referer"</span>.)</p>
2461             </dd>
2462             <dt>Example usage:</dt>
2463             <dd>
2464               <table border="0" bgcolor="#E0E0E0" width="90%">
2465                 <tr>
2466                   <td>
2467                     <pre class="SCREEN">+hide-referrer{forge}</pre>
2468                   </td>
2469                 </tr>
2470               </table>
2471               <p>or</p>
2472               <table border="0" bgcolor="#E0E0E0" width="90%">
2473                 <tr>
2474                   <td>
2475                     <pre class="SCREEN">+hide-referrer{}</pre>
2476                   </td>
2477                 </tr>
2478               </table>
2479             </dd>
2480           </dl>
2481         </div>
2482       </div>
2483       <div class="SECT3">
2484         <h4 class="SECT3"><a name="HIDE-USER-AGENT" id="HIDE-USER-AGENT">8.5.28. hide-user-agent</a></h4>
2485         <div class="VARIABLELIST">
2486           <dl>
2487             <dt>Typical use:</dt>
2488             <dd>
2489               <p>Try to conceal your type of browser and client operating system</p>
2490             </dd>
2491             <dt>Effect:</dt>
2492             <dd>
2493               <p>Replaces the value of the <span class="QUOTE">"User-Agent:"</span> HTTP header in client requests with
2494               the specified value.</p>
2495             </dd>
2496             <dt>Type:</dt>
2497             <dd>
2498               <p>Parameterized.</p>
2499             </dd>
2500             <dt>Parameter:</dt>
2501             <dd>
2502               <p>Any user-defined string.</p>
2503             </dd>
2504             <dt>Notes:</dt>
2505             <dd>
2506               <div class="WARNING">
2507                 <table class="WARNING" border="1" width="90%">
2508                   <tr>
2509                     <td align="center"><b>Warning</b></td>
2510                   </tr>
2511                   <tr>
2512                     <td align="left">
2513                       <p>This can lead to problems on web sites that depend on looking at this header in order to
2514                       customize their content for different browsers (which, by the way, is <span class=
2515                       "emphasis"><i class="EMPHASIS">NOT</i></span> the right thing to do: good web sites work
2516                       browser-independently).</p>
2517                     </td>
2518                   </tr>
2519                 </table>
2520               </div>
2521               <p>Using this action in multi-user setups or wherever different types of browsers will access the same
2522               <span class="APPLICATION">Privoxy</span> is <span class="emphasis"><i class="EMPHASIS">not
2523               recommended</i></span>. In single-user, single-browser setups, you might use it to delete your OS version
2524               information from the headers, because it is an invitation to exploit known bugs for your OS. It is also
2525               occasionally useful to forge this in order to access sites that won't let you in otherwise (though there
2526               may be a good reason in some cases).</p>
2527               <p>More information on known user-agent strings can be found at <a href=""
2528               target="_top"></a> and <a href=""
2529               target="_top"></a>.</p>
2530             </dd>
2531             <dt>Example usage:</dt>
2532             <dd>
2533               <table border="0" bgcolor="#E0E0E0" width="90%">
2534                 <tr>
2535                   <td>
2536                     <pre class="SCREEN">+hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}</pre>
2537                   </td>
2538                 </tr>
2539               </table>
2540             </dd>
2541           </dl>
2542         </div>
2543       </div>
2544       <div class="SECT3">
2545         <h4 class="SECT3"><a name="IGNORE-CERTIFICATE-ERRORS" id="IGNORE-CERTIFICATE-ERRORS">8.5.29.
2546         ignore-certificate-errors</a></h4>
2547         <div class="VARIABLELIST">
2548           <dl>
2549             <dt>Typical use:</dt>
2550             <dd>
2551               <p>Filter encrypted requests and responses without verifying the certificate</p>
2552             </dd>
2553             <dt>Effect:</dt>
2554             <dd>
2555               <p>Encrypted requests are forwarded to sites without verifying the certificate.</p>
2556             </dd>
2557             <dt>Type:</dt>
2558             <dd>
2559               <p>Boolean.</p>
2560             </dd>
2561             <dt>Parameter:</dt>
2562             <dd>
2563               <p>N/A</p>
2564             </dd>
2565             <dt>Notes:</dt>
2566             <dd>
2567               <p>When the <a href="actions-file.html#ENABLE-HTTPS-FILTERING"><span class=
2568               "QUOTE">"+enable-https-filtering"</span></a> action is used <span class="APPLICATION">Privoxy</span> by
2569               default verifies that the remote site uses a valid certificate.</p>
2570               <p>If the certificate is invalid the connection is aborted.</p>
2571               <p>This action disabled the certificate check allowing requests to sites with invalid certificates.</p>
2572             </dd>
2573             <dt>Example usage:</dt>
2574             <dd>
2575               <table border="0" bgcolor="#E0E0E0" width="90%">
2576                 <tr>
2577                   <td>
2578                     <pre class="SCREEN">    {+ignore-certificate-errors}
2580    </pre>
2581                   </td>
2582                 </tr>
2583               </table>
2584             </dd>
2585           </dl>
2586         </div>
2587       </div>
2588       <div class="SECT3">
2589         <h4 class="SECT3"><a name="LIMIT-CONNECT" id="LIMIT-CONNECT">8.5.30. limit-connect</a></h4>
2590         <div class="VARIABLELIST">
2591           <dl>
2592             <dt>Typical use:</dt>
2593             <dd>
2594               <p>Prevent abuse of <span class="APPLICATION">Privoxy</span> as a TCP proxy relay or disable SSL for
2595               untrusted sites</p>
2596             </dd>
2597             <dt>Effect:</dt>
2598             <dd>
2599               <p>Specifies to which ports HTTP CONNECT requests are allowable.</p>
2600             </dd>
2601             <dt>Type:</dt>
2602             <dd>
2603               <p>Parameterized.</p>
2604             </dd>
2605             <dt>Parameter:</dt>
2606             <dd>
2607               <p>A comma-separated list of ports or port ranges (the latter using dashes, with the minimum defaulting
2608               to 0 and the maximum to 65K).</p>
2609             </dd>
2610             <dt>Notes:</dt>
2611             <dd>
2612               <p>By default, i.e. if no <tt class="LITERAL">limit-connect</tt> action applies, <span class=
2613               "APPLICATION">Privoxy</span> allows HTTP CONNECT requests to all ports. Use <tt class=
2614               "LITERAL">limit-connect</tt> if fine-grained control is desired for some or all destinations.</p>
2615               <p>The CONNECT methods exists in HTTP to allow access to secure websites (<span class=
2616               "QUOTE">"https://"</span> URLs) through proxies. It works very simply: the proxy connects to the server
2617               on the specified port, and then short-circuits its connections to the client and to the remote server.
2618               This means CONNECT-enabled proxies can be used as TCP relays very easily.</p>
2619               <p><span class="APPLICATION">Privoxy</span> relays HTTPS traffic without seeing the decoded content.
2620               Websites can leverage this limitation to circumvent <span class="APPLICATION">Privoxy</span>'s filters.
2621               By specifying an invalid port range you can disable HTTPS entirely.</p>
2622             </dd>
2623             <dt>Example usages:</dt>
2624             <dd>
2625               <table border="0" bgcolor="#E0E0E0" width="90%">
2626                 <tr>
2627                   <td>
2628                     <pre class="SCREEN">+limit-connect{443}                   # Port 443 is OK.
2629 +limit-connect{80,443}                # Ports 80 and 443 are OK.
2630 +limit-connect{-3, 7, 20-100, 500-}   # Ports less than 3, 7, 20 to 100 and above 500 are OK.
2631 +limit-connect{-}                     # All ports are OK
2632 +limit-connect{,}                     # No HTTPS/SSL traffic is allowed</pre>
2633                   </td>
2634                 </tr>
2635               </table>
2636             </dd>
2637           </dl>
2638         </div>
2639       </div>
2640       <div class="SECT3">
2641         <h4 class="SECT3"><a name="LIMIT-COOKIE-LIFETIME" id="LIMIT-COOKIE-LIFETIME">8.5.31.
2642         limit-cookie-lifetime</a></h4>
2643         <div class="VARIABLELIST">
2644           <dl>
2645             <dt>Typical use:</dt>
2646             <dd>
2647               <p>Limit the lifetime of HTTP cookies to a couple of minutes or hours.</p>
2648             </dd>
2649             <dt>Effect:</dt>
2650             <dd>
2651               <p>Overwrites the expires field in Set-Cookie server headers if it's above the specified limit.</p>
2652             </dd>
2653             <dt>Type:</dt>
2654             <dd>
2655               <p>Parameterized.</p>
2656             </dd>
2657             <dt>Parameter:</dt>
2658             <dd>
2659               <p>The lifetime limit in minutes, or 0.</p>
2660             </dd>
2661             <dt>Notes:</dt>
2662             <dd>
2663               <p>This action reduces the lifetime of HTTP cookies coming from the server to the specified number of
2664               minutes, starting from the time the cookie passes Privoxy.</p>
2665               <p>Cookies with a lifetime below the limit are not modified. The lifetime of session cookies is set to
2666               the specified limit.</p>
2667               <p>The effect of this action depends on the server.</p>
2668               <p>In case of servers which refresh their cookies with each response (or at least frequently), the
2669               lifetime limit set by this action is updated as well. Thus, a session associated with the cookie
2670               continues to work with this action enabled, as long as a new request is made before the last limit set is
2671               reached.</p>
2672               <p>However, some servers send their cookies once, with a lifetime of several years (the year 2037 is a
2673               popular choice), and do not refresh them until a certain event in the future, for example the user
2674               logging out. In this case this action may limit the absolute lifetime of the session, even if requests
2675               are made frequently.</p>
2676               <p>If the parameter is <span class="QUOTE">"0"</span>, this action behaves like <tt class=
2677               "LITERAL"><a href="actions-file.html#SESSION-COOKIES-ONLY">session-cookies-only</a></tt>.</p>
2678             </dd>
2679             <dt>Example usages:</dt>
2680             <dd>
2681               <table border="0" bgcolor="#E0E0E0" width="90%">
2682                 <tr>
2683                   <td>
2684                     <pre class="SCREEN">+limit-cookie-lifetime{60}</pre>
2685                   </td>
2686                 </tr>
2687               </table>
2688             </dd>
2689           </dl>
2690         </div>
2691       </div>
2692       <div class="SECT3">
2693         <h4 class="SECT3"><a name="PREVENT-COMPRESSION" id="PREVENT-COMPRESSION">8.5.32. prevent-compression</a></h4>
2694         <div class="VARIABLELIST">
2695           <dl>
2696             <dt>Typical use:</dt>
2697             <dd>
2698               <p>Ensure that servers send the content uncompressed, so it can be passed through <tt class=
2699               "LITERAL"><a href="actions-file.html#FILTER">filter</a></tt>s.</p>
2700             </dd>
2701             <dt>Effect:</dt>
2702             <dd>
2703               <p>Removes the Accept-Encoding header which can be used to ask for compressed transfer.</p>
2704             </dd>
2705             <dt>Type:</dt>
2706             <dd>
2707               <p>Boolean.</p>
2708             </dd>
2709             <dt>Parameter:</dt>
2710             <dd>
2711               <p>N/A</p>
2712             </dd>
2713             <dt>Notes:</dt>
2714             <dd>
2715               <p>More and more websites send their content compressed by default, which is generally a good idea and
2716               saves bandwidth. But the <tt class="LITERAL"><a href="actions-file.html#FILTER">filter</a></tt> and
2717               <tt class="LITERAL"><a href="actions-file.html#DEANIMATE-GIFS">deanimate-gifs</a></tt> actions need
2718               access to the uncompressed data.</p>
2719               <p>When compiled with zlib support (available since <span class="APPLICATION">Privoxy</span> 3.0.7),
2720               content that should be filtered is decompressed on-the-fly and you don't have to worry about this action.
2721               If you are using an older <span class="APPLICATION">Privoxy</span> version, or one that hasn't been
2722               compiled with zlib support, this action can be used to convince the server to send the content
2723               uncompressed.</p>
2724               <p>Most text-based instances compress very well, the size is seldom decreased by less than 50%, for
2725               markup-heavy instances like news feeds saving more than 90% of the original size isn't unusual.</p>
2726               <p>Not using compression will therefore slow down the transfer, and you should only enable this action if
2727               you really need it. As of <span class="APPLICATION">Privoxy</span> 3.0.7 it's disabled in all predefined
2728               action settings.</p>
2729               <p>Note that some (rare) ill-configured sites don't handle requests for uncompressed documents correctly.
2730               Broken PHP applications tend to send an empty document body, some IIS versions only send the beginning of
2731               the content. If you enable <tt class="LITERAL">prevent-compression</tt> per default, you might want to