Log a message right before exiting gracefully
[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-2020 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 #    https://sourceforge.net/p/ijbswa/support-requests/
15 #  * Submit bugs only thru our bug forum:
16 #    https://sourceforge.net/p/ijbswa/bugs/
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 #    https://sourceforge.net/p/ijbswa/feature-requests/
25 #
26 # For any other issues, feel free to use the mailing lists.
27 # Anyone interested in actively participating in development and related
28 # discussions can join the appropriate mailing list here:
29 # https://lists.privoxy.org/mailman/listinfo Archives are available
30 # here too.
31 #
32 #################################################################################
33 #
34 # Syntax:
35 #
36 # Generally filters start with a line like "FILTER: name description".
37 # They are then referrable from the actionsfile with +filter{name}
38 #
39 # FILTER marks a filter as content filter, other filter
40 # types are CLIENT-HEADER-FILTER, CLIENT-HEADER-TAGGER,
41 # SERVER-HEADER-FILTER and SERVER-HEADER-TAGGER.
42 #
43 # Inside the filters, write one Perl-Style substitution (job) per line.
44 # Jobs that precede the first FILTER: line are ignored.
45 #
46 # For Details see the pcrs manpage contained in this distribution.
47 # (and the perlre, perlop and pcre manpages)
48 #
49 # Note that you are free to choose the delimiter as you see fit.
50 #
51 # Note2: In addition to the Perl options gimsx, the following nonstandard
52 # options are supported:
53 #
54 # 'U' turns the default to ungreedy matching.  Add ? to quantifiers to
55 #     switch back to greedy.
56 #
57 # 'T' (trivial) prevents parsing for backreferences in the substitute.
58 #     Use if you want to include text like '$&' in your substitute without
59 #     quoting.
60 #
61 # 'D' (Dynamic) allows the use of variables. Supported variables are:
62 #     $host, $listen-address, $origin (the IP address the request came
63 #     from), $path and $url.
64 #
65 #     Note that '$' is a bad choice as delimiter for dynamic filters as you
66 #     might end up with unintended variables if you use a variable name
67 #     directly after the delimiter. Variables will be resolved without
68 #     escaping anything, therefore you also have to be careful not to chose
69 #     delimiters that appear in the replacement text. For example '<' should
70 #     be save, while '?' will sooner or later cause conflicts with $url.
71 #
72 #################################################################################