diff options
| author | rofl0r <rofl0r@users.noreply.github.com> | 2020-09-05 17:29:07 +0100 |
|---|---|---|
| committer | rofl0r <rofl0r@users.noreply.github.com> | 2020-09-05 17:33:53 +0100 |
| commit | c4dc3ba007fe34d6b7704ffb5ec812a436c326e7 (patch) | |
| tree | 46cdde748f7a5816d494725f4e69abb2d66d1a89 /docs/man5 | |
| parent | 281488a72924c6c28f8c7a0b534a4e030766a70f (diff) | |
filter: fix documentation about rules
the file docs/filter-howto.txt was removed, as it contained misleading
information since it was first checked in.
it suggests the syntax for filter rules is fnmatch()-like, when in
fact they need to be specified as posix regular expressions.
additionally it contained a lot of utterly unrelated and irrelevant/
outdated text.
a few examples with the correct syntax have now been added to
tinyproxy.conf.5 manpage.
closes #212
Diffstat (limited to 'docs/man5')
| -rw-r--r-- | docs/man5/tinyproxy.conf.txt.in | 21 |
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/man5/tinyproxy.conf.txt.in b/docs/man5/tinyproxy.conf.txt.in index b5619dd..66dd04e 100644 --- a/docs/man5/tinyproxy.conf.txt.in +++ b/docs/man5/tinyproxy.conf.txt.in @@ -256,6 +256,27 @@ Tinyproxy supports filtering of web sites based on URLs or domains. This option specifies the location of the file containing the filter rules, one rule per line. +Rules are specified as POSIX basic regular expressions (BRE), unless +FilterExtended is activated. +Comment lines start with a `#` character. + +Example filter file contents: + + # filter exactly cnn.com + ^cnn\.com$ + + # filter all subdomains of cnn.com, but not cnn.com itself + .*\.cnn.com$ + + # filter any domain that has cnn.com in it, like xcnn.comfy.org + cnn\.com + + # filter any domain that ends in cnn.com + cnn\.com$ + + # filter any domain that starts with adserver + ^adserver + =item B<FilterURLs> If this boolean option is set to `Yes` or `On`, filtering is |