Fix comment typos
[privoxy.git] / user.filter
1 # ********************************************************************
2 #
3 #  File        :  user.filter
4 #
5 #  Purpose     :  Rules to process the content of web pages
6 #
7 #  Copyright   :  Written by and Copyright (C) 2006-2008 the
8 #                 Privoxy team. https://www.privoxy.org/
9 #
10 # We value your feedback. However, to provide you with the best support,
11 # please note:
12 #
13 #  * Use the support forum to get help:
14 #    http://sourceforge.net/tracker/?group_id=11118&atid=211118
15 #  * Submit bugs only thru our bug forum:
16 #    http://sourceforge.net/tracker/?group_id=11118&atid=111118
17 #    Make sure that the bug has not already been submitted. Please try
18 #    to verify that it is a Privoxy bug, and not a browser or site
19 #    bug first. If you are using your own custom configuration, please
20 #    try the stock configs to see if the problem is a configuration
21 #    related bug. And if not using the latest development snapshot,
22 #    please try the latest one. Or even better, CVS sources.
23 #  * Submit feature requests only thru our feature request forum:
24 #    http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
25 #
26 # For any other issues, feel free to use the mailing lists:
27 # http://sourceforge.net/mail/?group_id=11118
28 #
29 # Anyone interested in actively participating in development and related
30 # discussions can join the appropriate mailing list here:
31 # http://sourceforge.net/mail/?group_id=11118. Archives are available
32 # here too.
33 #
34 #################################################################################
35 #
36 # Syntax:
37 #
38 # Generally filters start with a line like "FILTER: name description".
39 # They are then referrable from the actionsfile with +filter{name}
40 #
41 # FILTER marks a filter as content filter, other filter
42 # types are CLIENT-HEADER-FILTER, CLIENT-HEADER-TAGGER,
43 # SERVER-HEADER-FILTER and SERVER-HEADER-TAGGER.
44 #
45 # Inside the filters, write one Perl-Style substitution (job) per line.
46 # Jobs that precede the first FILTER: line are ignored.
47 #
48 # For Details see the pcrs manpage contained in this distribution.
49 # (and the perlre, perlop and pcre manpages)
50 #
51 # Note that you are free to choose the delimiter as you see fit.
52 #
53 # Note2: In addition to the Perl options gimsx, the following nonstandard
54 # options are supported:
55 #
56 # 'U' turns the default to ungreedy matching.  Add ? to quantifiers to
57 #     switch back to greedy.
58 #
59 # 'T' (trivial) prevents parsing for backreferences in the substitute.
60 #     Use if you want to include text like '$&' in your substitute without
61 #     quoting.
62 #
63 # 'D' (Dynamic) allows the use of variables. Supported variables are:
64 #     $host, $listen-address, $origin (the IP address the request came
65 #     from), $path and $url.
66 #
67 #     Note that '$' is a bad choice as delimiter for dynamic filters as you
68 #     might end up with unintended variables if you use a variable name
69 #     directly after the delimiter. Variables will be resolved without
70 #     escaping anything, therefore you also have to be careful not to chose
71 #     delimiters that appear in the replacement text. For example '<' should
72 #     be save, while '?' will sooner or later cause conflicts with $url.
73 #
74 #################################################################################