X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fuser-manual.sgml;h=886a200621e7bfd683ca125d7609c80d50d646d5;hp=0cb4a2661a53ea8c04c91614ae8c06b2e45d5607;hb=b23820b98f95fe68176ec2706f05e1044bac3900;hpb=4504be75e80c98d30e4dfbf36c878493430ca56d
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
index 0cb4a266..886a2006 100644
--- a/doc/source/user-manual.sgml
+++ b/doc/source/user-manual.sgml
@@ -10,6 +10,7 @@
+
@@ -34,7 +35,7 @@
Purpose : user manual
- Copyright (C) 2001-2019 Privoxy Developers https://www.privoxy.org/
+ Copyright (C) 2001-2020 Privoxy Developers https://www.privoxy.org/
See LICENSE.
========================================================================
@@ -53,7 +54,7 @@
- Copyright &my-copy; 2001-2019 by
+ Copyright &my-copy; 2001-2020 by
Privoxy Developers
@@ -226,31 +227,6 @@ How to install the binary packages depends on your operating system:
-
-OS/2
-
-
- First, make sure that no previous installations of
- Junkbuster and / or
- Privoxy are left on your
- system. Check that no Junkbuster
- or Privoxy objects are in
- your startup folder.
-
-
-
- Then, just double-click the WarpIN self-installing archive, which will
- guide you through the installation process. A shadow of the
- Privoxy executable will be placed in your
- startup folder so it will start automatically whenever OS/2 starts.
-
-
-
- The directory you choose to install Privoxy
- into will contain all of the configuration files.
-
-
-
Mac OS X
@@ -1217,16 +1193,6 @@ Example Unix startup command:
-
-OS/2
-
- During installation, Privoxy is configured to
- start automatically when the system restarts. You can start it manually by
- double-clicking on the Privoxy icon in the
- Privoxy folder.
-
-
-
Mac OS X
@@ -1517,7 +1483,7 @@ for details.
▪ View & change the current configuration
- ▪ View or toggle the tags that can be set based on the clients address
+ ▪ View or toggle the tags that can be set based on the client's address
▪ View the request headers.
@@ -1576,7 +1542,7 @@ for details.
Configuration Files Overview
For Unix, *BSD and GNU/Linux, all configuration files are located in
- /etc/privoxy/ by default. For MS Windows and OS/2
+ /etc/privoxy/ by default. For MS Windows
these are all in the same directory as the
Privoxy executable.
The main configuration file is named config
- on GNU/Linux, Unix, BSD, and OS/2, and config.txt
+ on GNU/Linux, Unix, BSD, and config.txt
on Windows. This is a required file.
@@ -2293,6 +2259,12 @@ for details.
While flexible, this is not the sophistication of full regular expression based syntax.
+
+ When compiled with FEATURE_PCRE_HOST_PATTERNS patterns can be prefixed with
+ PCRE-HOST-PATTERN: in which case full regular expression
+ (PCRE) can be used for the host pattern as well.
+
+
@@ -3802,71 +3774,6 @@ problem-host.example.com
-
-
-enable-https-filtering
-
-
-
- Typical use:
-
- Filter encrypted requests and responses
-
-
-
-
- Effect:
-
-
- Encrypted requests are decrypted, filtered and forwarded encrypted.
-
-
-
-
-
- Type:
-
-
- Boolean.
-
-
-
-
- Parameter:
-
-
- N/A
-
-
-
-
-
- Notes:
-
-
- This action allows &my-app; to filter encrypted requests and responses.
- For this to work &my-app; has to generate a certificate and send it
- to the client which has to accept it.
-
-
- Before this works the directives in the
- TLS section
- of the config file have to be configured.
-
-
-
-
-
- Example usage (section):
-
- {+enable-https-filtering}
-www.example.com
-
-
-
-
-
-
external-filter
@@ -4052,7 +3959,7 @@ www.example.com
looks for the string http://, either in plain text
(invalid but often used) or encoded as http%3a//.
Some sites use their own URL encoding scheme, encrypt the address
- of the target server or replace it with a database id. In theses cases
+ of the target server or replace it with a database id. In these cases
fast-redirects is fooled and the request reaches the
redirection server where it probably gets logged.
@@ -5212,6 +5119,81 @@ new action
+
+
+https-inspection
+
+
+
+ Typical use:
+
+ Filter encrypted requests and responses
+
+
+
+
+ Effect:
+
+
+ Encrypted requests are decrypted, filtered and forwarded encrypted.
+
+
+
+
+
+ Type:
+
+
+ Boolean.
+
+
+
+
+ Parameter:
+
+
+ N/A
+
+
+
+
+
+ Notes:
+
+
+ This action allows &my-app; to filter encrypted requests and responses.
+ For this to work &my-app; has to generate a certificate and send it
+ to the client which has to accept it.
+
+
+ Before this works the directives in the
+ TLS section
+ of the config file have to be configured.
+
+
+ Note that the action has to be enabled based on the CONNECT
+ request which doesn't contain a path. Enabling it based on
+ 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.
+
+
+
+
+
+ Example usage (section):
+
+ {+https-inspection}
+www.example.com
+
+
+
+
+
+
+
ignore-certificate-errors
@@ -5255,16 +5237,19 @@ new action
When the
- +enable-https-filtering
+ +https-inspection
action is used &my-app; by default verifies that the remote site uses a valid
certificate.
- If the certificate is invalid the connection is aborted.
+ If the certificate can't be validated by &my-app; the connection is aborted.
+
+
+ This action disables the certificate check so requests to sites
+ with certificates that can't be validated are allowed.
- This action disabled the certificate check allowing requests to sites
- with invalid certificates.
+ Note that enabling this action allows Man-in-the-middle attacks.
@@ -5516,9 +5501,10 @@ new action
Note that some (rare) ill-configured sites don't handle requests for uncompressed
documents correctly. Broken PHP applications tend to send an empty document body,
- some IIS versions only send the beginning of the content. If you enable
- prevent-compression per default, you might want to add
- exceptions for those sites. See the example for how to do that.
+ some IIS versions only send the beginning of the content and some content delivery
+ networks let the connection time out.
+ If you enable prevent-compression per default, you might
+ want to add exceptions for those sites. See the example for how to do that.
@@ -7466,7 +7452,7 @@ pre-defined filters for your convenience:
sometimes appear on some pages, or user agents that don't correct for this on
the fly.
@@ -7857,16 +7843,36 @@ Requests
Privoxy is free software; you can
- redistribute it and/or modify it under the terms of the
- GNU General Public License, version 2,
- as published by the Free Software Foundation and included in
- the next section.
+ redistribute and/or modify its source code under the terms
+ of the GNU General Public License
+ as published by the Free Software Foundation, either version 2
+ of the license, or (at your option) any later version.
+
+
+
+ The same is true for Privoxy binaries
+ unless they are linked with
+ mbed TLS in which
+ case you can redistribute them and/or modify them under the terms
+ of the GNU General Public License
+ as published by the Free Software Foundation, either version 3
+ of the license, or (at your option) any later version.
+
+
+
+ Both licenses are included in the next section.
License
+GNU General Public License version 2
+
+
+GNU General Public License version 3
+
+