X-Git-Url: http://www.privoxy.org/gitweb/?a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=c23a4c70c1be79e790a1f68bb8a03b1c632da36c;hb=8566fa5928990558ee7fb10b2fb662ac3d20fb90;hp=6f060fdf7641abe852f2815f0d6e5213cd322f6a;hpb=a6d3a235ba589754f6f64d1892783f93274e8bb0;p=privoxy.git
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 6f060fdf..c23a4c70 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -14,7 +14,7 @@
-
+
@@ -35,7 +35,7 @@
Purpose : user manual
- Copyright (C) 2001-2021 Privoxy Developers https://www.privoxy.org/
+ Copyright (C) 2001-2023 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
@@ -54,7 +54,7 @@
- Copyright &my-copy; 2001-2021 by
+ Copyright &my-copy; 2001-2023 by
Privoxy Developers
@@ -302,12 +302,16 @@ How to install the binary packages depends on your operating system:
-FreeBSD
+FreeBSD and ElectroBSD
Privoxy is part of FreeBSD's Ports Collection, you can build and install
it with cd /usr/ports/www/privoxy; make install clean.
+
+ If your system is configured to install binary packages you can
+ try to install &my-app; with pkg install privoxy.
+
@@ -409,8 +413,8 @@ MAKENSIS = /<root-dir>/nsis/makensis.exe
Get the latest 8.x PCRE code from
- PCRE
- https://ftp.pcre.org/pub/pcre/
+ PCRE
+ https://sourceforge.net/projects/pcre/files/pcre/
and build the static PCRE libraries with
@@ -437,9 +441,9 @@ export CPPFLAGS="-DPCRE_STATIC"
If you want to be able to have Privoxy do TLS Inspection, get the latest
- 2.16.x MBED-TLS library source code from
-
- https://github.com/ARMmbed/mbedtls/tags,
+ 2.28.x MBED-TLS library source code from
+
+ https://github.com/Mbed-TLS/mbedtls/tags,
extract the tar file into <root-dir>
and build the static libraries with
@@ -2536,12 +2540,6 @@ media.example.com/.*banners
-
-
- This is an experimental feature. The syntax is likely to change in future versions.
-
-
-
Client tag patterns are not set based on HTTP headers but based on
the client's IP address. Users can enable them themselves, but the
@@ -3135,6 +3133,85 @@ adserver.example.net/.*\.js$
+
+
+client-body-tagger
+
+
+
+ Typical use:
+
+
+ Block requests based on the content of the body data.
+
+
+
+
+
+ Effect:
+
+
+ Client request bodies to which this action applies are filtered on-the-fly through
+ the specified regular expression based substitutions, the result is used as tag.
+
+
+
+
+
+ Type:
+
+
+ Multi-value.
+
+
+
+
+ Parameter:
+
+
+ The name of a client-body tagger, as defined in one of the
+ filter files.
+
+
+
+
+
+ Notes:
+
+
+ Please refer to the filter file chapter
+ to learn how to create your own client-body tagger.
+
+
+ Client-body taggers are applied to each request body on its own,
+ and as the body isn't modified, each tagger "sees" the original.
+
+
+ Chunk-encoded request bodies currently can't be tagged.
+ Request bodies larger than the buffer-limit can't be tagged either.
+
+
+
+
+
+ Example usage (section):
+
+
+# Apply blafasel tagger.
+{+client-body-tagger{blafasel}}
+/
+
+# Block request based on the tag created by the blafasel tagger.
+{+block{Request body contains blafasel}}
+TAG:^content contains blafasel$
+
+
+
+
+
+
+
+
client-header-tagger
@@ -4026,6 +4103,12 @@ problem-host.example.com
linkend="external-filter-syntax">syntax
may change in the future.
+
+ If you want to apply external filters to images or other content
+ that isn't text-based, enable the
+ force-text-mode
+ action as well.
+
@@ -4386,6 +4469,10 @@ another.example.com/testing
+filter{no-ping} # Removes non-standard ping attributes in <a> and <area> tags.
+
+
+
+ +filter{bundeswehr.de} # Hide the cookie and privacy info banner on bundeswehr.de.
@@ -5371,9 +5458,6 @@ new action
a pattern with path doesn't work as the path is only seen
by &my-app; if the action is already enabled.
-
- This is an experimental feature.
-
@@ -7107,8 +7191,9 @@ webmail.example.com
- &my-app; also supports two tagger actions:
- client-header-tagger
+ &my-app; also supports three tagger actions:
+ client-header-tagger,
+ client-body-tagger
and
server-header-tagger.
Taggers and filters use the same syntax in the filter files, the difference
@@ -7642,9 +7727,9 @@ pre-defined filters for your convenience:
banners-by-link
- This is an experimental filter that attempts to kill any banners if
- their URLs seem to point to known or suspected click trackers. It is currently
- not of much value and is not recommended for use by default.
+ This filter attempts to kill any banners if their URLs seem to point
+ to known or suspected click trackers. It is currently not of much value
+ and is not recommended for use by default.
@@ -8126,7 +8211,7 @@ Requests
The same is true for Privoxy binaries
unless they are linked with a
- mbed TLS version
+ mbed TLS version
that is licensed under the Apache 2.0 license in which
case you can redistribute and/or modify the Privoxy
binaries under the terms of the GNU General Public License
@@ -8166,7 +8251,7 @@ Requests
When compiled with FEATURE_HTTPS_INSPECTION (optional),
Privoxy depends on a TLS library. The supported libraries are
LibreSSL,
- mbed TLS and
+ mbed TLS 2.28.x and
OpenSSL.