From 2d1af75a04189057eb4cf4949908a3cdf9ca2b6e Mon Sep 17 00:00:00 2001
From: Fabian Keil <fk@fabiankeil.de>
Date: Mon, 23 Nov 2020 12:20:26 +0100
Subject: [PATCH] Rebuild docs for 3.0.29 stable
---
INSTALL | 4 ++--
README | 21 +++++++------------
.../developer-manual/newrelease.html | 4 ++--
doc/webserver/faq/configuration.html | 2 +-
doc/webserver/faq/copyright.html | 4 ++--
doc/webserver/faq/general.html | 11 ++++++----
doc/webserver/faq/index.html | 6 +++---
doc/webserver/index.html | 2 +-
doc/webserver/user-manual/actions-file.html | 7 ++++---
doc/webserver/user-manual/appendix.html | 16 +++++++-------
doc/webserver/user-manual/config.html | 5 ++++-
doc/webserver/user-manual/configuration.html | 8 ++-----
doc/webserver/user-manual/index.html | 2 +-
doc/webserver/user-manual/installation.html | 4 ++--
doc/webserver/user-manual/introduction.html | 16 ++++++--------
doc/webserver/user-manual/quickstart.html | 2 +-
doc/webserver/user-manual/startup.html | 4 ++--
17 files changed, 55 insertions(+), 63 deletions(-)
diff --git a/INSTALL b/INSTALL
index 7cba5011..1d43f547 100644
--- a/INSTALL
+++ b/INSTALL
@@ -39,8 +39,8 @@ compiler like gcc are required.
When building from a source tarball, first unpack the source:
- tar xzvf privoxy-3.0.29-beta-src.tar.gz
- cd privoxy-3.0.29-beta
+ tar xzvf privoxy-3.0.29-stable-src.tar.gz
+ cd privoxy-3.0.29-stable
To build the development version, you can get the source code by doing:
diff --git a/README b/README
index 07db0310..9739c748 100644
--- a/README
+++ b/README
@@ -32,9 +32,8 @@
*
*********************************************************************/
-This README is included with the development version of Privoxy 3.0.29. See
-https://www.privoxy.org/ for more information. The current code maturity level
-is "UNRELEASED", but seems stable to us :).
+This README is included with Privoxy 3.0.29. See https://www.privoxy.org/ for
+more information. The current code maturity level is "stable".
-------------------------------------------------------------------------------
@@ -105,22 +104,16 @@ try it with FTP or other protocols for the simple reason it does not work.
The actions list can be configured via the web interface accessed via http://
p.p/, as well other options.
-All configuration files are subject to unannounced changes during the
-development process.
-
-------------------------------------------------------------------------------
5. DOCUMENTATION
-There should be documentation in the 'doc' subdirectory, but it may not be
-completed at this point. In particular, see the User Manual there, the FAQ, and
-those interested in Privoxy development, should look at developer-manual.
+There should be documentation in the 'doc' subdirectory. In particular, see the
+User Manual there, the FAQ, and those interested in Privoxy development, should
+look at developer-manual.
-The most up to date source of information on the current development version,
-may still be either comments in the source code, or the included configuration
-files. The source and configuration files are all well commented. The main
-configuration files are: 'config', 'default.action', and 'default.filter' in
-the top-level source directory.
+The source and configuration files are all well commented. The main
+configuration files are: 'config', 'default.action', and 'default.filter'.
Included documentation may vary according to platform and packager. All
documentation is posted on https://www.privoxy.org, in case you don't have it,
diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html
index cdf2f04d..6e355381 100644
--- a/doc/webserver/developer-manual/newrelease.html
+++ b/doc/webserver/developer-manual/newrelease.html
@@ -494,7 +494,7 @@ for-privoxy-version=3.0.11</pre>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
- <pre class="PROGRAMLISTING"> debchange -v 3.0.29-UNRELEASED-1 "New upstream version"</pre>
+ <pre class="PROGRAMLISTING"> debchange -v 3.0.29-stable-1 "New upstream version"</pre>
</td>
</tr>
</table>
@@ -506,7 +506,7 @@ for-privoxy-version=3.0.11</pre>
</td>
</tr>
</table>
- <p>This will create <tt class="FILENAME">../privoxy_3.0.29-UNRELEASED-1_i386.deb</tt> which can be uploaded. To
+ <p>This will create <tt class="FILENAME">../privoxy_3.0.29-stable-1_i386.deb</tt> which can be uploaded. To
upload the package to Sourceforge, simply issue</p>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
diff --git a/doc/webserver/faq/configuration.html b/doc/webserver/faq/configuration.html
index f9c4c4db..6ed183b7 100644
--- a/doc/webserver/faq/configuration.html
+++ b/doc/webserver/faq/configuration.html
@@ -66,7 +66,7 @@
"../user-manual/config.html#ENABLE-EDIT-ACTIONS" target="_top">enable-edit-actions</a>).</p>
</div>
<div class="SECT2">
- <h3 class="SECT2"><a name="AEN411" id="AEN411">3.4. There are several different <span class=
+ <h3 class="SECT2"><a name="AEN413" id="AEN413">3.4. There are several different <span class=
"QUOTE">"actions"</span> files. What are the differences?</a></h3>
<p>Please have a look at the <a href="../user-manual/actions-file.html" target="_top">the actions chapter</a> in
the <a href="../user-manual/index.html" target="_top">User Manual</a> for a detailed explanation.</p>
diff --git a/doc/webserver/faq/copyright.html b/doc/webserver/faq/copyright.html
index 09f69649..9b27c3d3 100644
--- a/doc/webserver/faq/copyright.html
+++ b/doc/webserver/faq/copyright.html
@@ -33,7 +33,7 @@
"APPLICATION">Junkbuster</span> (tm) FAQ, and modified as appropriate for <span class=
"APPLICATION">Privoxy</span>.</p>
<div class="SECT2">
- <h2 class="SECT2"><a name="AEN1498" id="AEN1498">7.1. License</a></h2>
+ <h2 class="SECT2"><a name="AEN1500" id="AEN1500">7.1. License</a></h2>
<p><span class="APPLICATION">Privoxy</span> is free software; you can redistribute and/or modify its source code
under the terms of the <i class="CITETITLE">GNU General Public License</i> as published by the Free Software
Foundation, either version 2 of the license, or (at your option) any later version.</p>
@@ -48,7 +48,7 @@
"CITETITLE">license</i></a> for details.</p>
</div>
<div class="SECT2">
- <h2 class="SECT2"><a name="AEN1512" id="AEN1512">7.2. History</a></h2>
+ <h2 class="SECT2"><a name="AEN1514" id="AEN1514">7.2. History</a></h2>
<p>A long time ago, there was the <span class="APPLICATION">Internet Junkbuster</span>, by Anonymous Coders and
Junkbusters Corporation. This saved many users a lot of pain in the early days of web advertising and user
tracking.</p>
diff --git a/doc/webserver/faq/general.html b/doc/webserver/faq/general.html
index e4cf8d43..7be6d347 100644
--- a/doc/webserver/faq/general.html
+++ b/doc/webserver/faq/general.html
@@ -139,6 +139,9 @@
<li>
<p>Supports tagging which allows to change the behaviour based on client and server headers.</p>
</li>
+ <li>
+ <p>Supports https inspection which allows to filter https requests.</p>
+ </li>
<li>
<p>Can be run as an "intercepting" proxy, which obviates the need to configure browsers individually.</p>
</li>
@@ -337,13 +340,13 @@
<dl>
<dt>Gold (12000 USD/year)</dt>
<dd>
- <p>Logo shown at the bottom of the <a href="https://www.privoxy.org/" target="_top">Privoxy homepage</a>.
- Logo, link and self description on the <a href="https://www.privoxy.org/sponsors/" target="_top">sponsor
- page</a>.</p>
+ <p>Logo or text link shown at the bottom of the <a href="https://www.privoxy.org/" target="_top">Privoxy
+ homepage</a>. Logo, link and self description on the <a href="https://www.privoxy.org/sponsors/" target=
+ "_top">sponsor page</a>.</p>
</dd>
<dt>Silver (1200 USD/year)</dt>
<dd>
- <p>Logo shown randomly at the bottom of the <a href="https://www.privoxy.org/" target="_top">Privoxy
+ <p>Logo or text link shown at the bottom of the <a href="https://www.privoxy.org/" target="_top">Privoxy
homepage</a>. Logo, link and self description on the <a href="https://www.privoxy.org/sponsors/" target=
"_top">sponsor page</a>.</p>
</dd>
diff --git a/doc/webserver/faq/index.html b/doc/webserver/faq/index.html
index c576a21e..6ea03321 100644
--- a/doc/webserver/faq/index.html
+++ b/doc/webserver/faq/index.html
@@ -110,7 +110,7 @@
me. Please list some of these <span class="QUOTE">"actions"</span>.</a></dt>
<dt>3.3. <a href="configuration.html#ACTCONFIG">How are actions files configured? What is the easiest way
to do this?</a></dt>
- <dt>3.4. <a href="configuration.html#AEN411">There are several different <span class=
+ <dt>3.4. <a href="configuration.html#AEN413">There are several different <span class=
"QUOTE">"actions"</span> files. What are the differences?</a></dt>
<dt>3.5. <a href="configuration.html#GETUPDATES">Where can I get updated Actions Files?</a></dt>
<dt>3.6. <a href="configuration.html#NEWCONFIG">Can I use my old config files?</a></dt>
@@ -285,8 +285,8 @@
<dt>7. <a href="copyright.html">Privoxy Copyright, License and History</a></dt>
<dd>
<dl>
- <dt>7.1. <a href="copyright.html#AEN1498">License</a></dt>
- <dt>7.2. <a href="copyright.html#AEN1512">History</a></dt>
+ <dt>7.1. <a href="copyright.html#AEN1500">License</a></dt>
+ <dt>7.2. <a href="copyright.html#AEN1514">History</a></dt>
</dl>
</dd>
</dl>
diff --git a/doc/webserver/index.html b/doc/webserver/index.html
index d204aeb1..346be7b0 100644
--- a/doc/webserver/index.html
+++ b/doc/webserver/index.html
@@ -32,7 +32,7 @@
"_top">https://www.privoxy.org/faq/general.html#DONATE</a></p>
</li>
</ul>
- <p>The most recent release is <a href="announce.txt" target="_top">3.0.28 (stable)</a>.</p>
+ <p>The most recent release is <a href="announce.txt" target="_top">3.0.29 (stable)</a>.</p>
</div>
</div>
<hr>
diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html
index 68c0b5e8..a5a7d7a4 100644
--- a/doc/webserver/user-manual/actions-file.html
+++ b/doc/webserver/user-manual/actions-file.html
@@ -73,7 +73,7 @@
<p>The default profiles, and their associated actions, as pre-defined in <tt class=
"FILENAME">default.action</tt> are:</p>
<div class="TABLE">
- <a name="AEN3124" id="AEN3124"></a>
+ <a name="AEN3123" id="AEN3123"></a>
<p><b>Table 1. Default Configurations</b></p>
<table border="1" frame="border" rules="all" class="CALSTABLE">
<col width="1*" title="C1">
@@ -2526,8 +2526,9 @@ nasty-banner-server.example.com/junk.cgi\?output=trash</pre>
<p>This action allows <span class="APPLICATION">Privoxy</span> to filter encrypted requests and
responses. For this to work <span class="APPLICATION">Privoxy</span> has to generate a certificate and
send it to the client which has to accept it.</p>
- <p>Before this works the directives in the <tt class="LITERAL"><a href="config.html#TLS" target=
- "_top">TLS section</a></tt> of the config file have to be configured.</p>
+ <p>Before this works the directives in the <tt class="LITERAL"><a href=
+ "config.html#HTTPS-INSPECTION-DIRECTIVES" target="_top">HTTPS inspection section</a></tt> of the config
+ file have to be configured.</p>
<p>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 <span class=
"APPLICATION">Privoxy</span> if the action is already enabled.</p>
diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html
index d809b3ed..0f598070 100644
--- a/doc/webserver/user-manual/appendix.html
+++ b/doc/webserver/user-manual/appendix.html
@@ -202,7 +202,7 @@
these. If not, you will get a friendly error message. Internet access is not necessary either.</p>
<ul>
<li>
- <p>Privoxy main page:</p><a name="AEN6325" id="AEN6325"></a>
+ <p>Privoxy main page:</p><a name="AEN6324" id="AEN6324"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/" target="_top">http://config.privoxy.org/</a></p>
</blockquote>
@@ -211,7 +211,7 @@
"APPLICATION">Privoxy</span>)</p>
</li>
<li>
- <p>View and toggle client tags:</p><a name="AEN6333" id="AEN6333"></a>
+ <p>View and toggle client tags:</p><a name="AEN6332" id="AEN6332"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/client-tags" target=
"_top">http://config.privoxy.org/client-tags</a></p>
@@ -219,21 +219,21 @@
</li>
<li>
<p>Show information about the current configuration, including viewing and editing of actions
- files:</p><a name="AEN6338" id="AEN6338"></a>
+ files:</p><a name="AEN6337" id="AEN6337"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/show-status" target=
"_top">http://config.privoxy.org/show-status</a></p>
</blockquote>
</li>
<li>
- <p>Show the browser's request headers:</p><a name="AEN6343" id="AEN6343"></a>
+ <p>Show the browser's request headers:</p><a name="AEN6342" id="AEN6342"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/show-request" target=
"_top">http://config.privoxy.org/show-request</a></p>
</blockquote>
</li>
<li>
- <p>Show which actions apply to a URL and why:</p><a name="AEN6348" id="AEN6348"></a>
+ <p>Show which actions apply to a URL and why:</p><a name="AEN6347" id="AEN6347"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/show-url-info" target=
"_top">http://config.privoxy.org/show-url-info</a></p>
@@ -242,15 +242,15 @@
<li>
<p>Toggle Privoxy on or off. This feature can be turned off/on in the main <tt class="FILENAME">config</tt>
file. When toggled <span class="QUOTE">"off"</span>, <span class="QUOTE">"Privoxy"</span> continues to run,
- but only as a pass-through proxy, with no actions taking place:</p><a name="AEN6356" id="AEN6356"></a>
+ but only as a pass-through proxy, with no actions taking place:</p><a name="AEN6355" id="AEN6355"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/toggle" target="_top">http://config.privoxy.org/toggle</a></p>
</blockquote>
- <p>Short cuts. Turn off, then on:</p><a name="AEN6360" id="AEN6360"></a>
+ <p>Short cuts. Turn off, then on:</p><a name="AEN6359" id="AEN6359"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/toggle?set=disable" target=
"_top">http://config.privoxy.org/toggle?set=disable</a></p>
- </blockquote><a name="AEN6363" id="AEN6363"></a>
+ </blockquote><a name="AEN6362" id="AEN6362"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/toggle?set=enable" target=
"_top">http://config.privoxy.org/toggle?set=enable</a></p>
diff --git a/doc/webserver/user-manual/config.html b/doc/webserver/user-manual/config.html
index 016c04ab..ad7c8179 100644
--- a/doc/webserver/user-manual/config.html
+++ b/doc/webserver/user-manual/config.html
@@ -2406,7 +2406,10 @@
</div>
</div>
<div class="SECT2">
- <h2 class="SECT2"><a name="TLS" id="TLS">7.7. TLS/SSL Inspection (Experimental)</a></h2>
+ <h2 class="SECT2"><a name="HTTPS-INSPECTION-DIRECTIVES" id="HTTPS-INSPECTION-DIRECTIVES">7.7. HTTPS Inspection
+ (Experimental)</a></h2>
+ <p>HTTPS inspection allows to filter encrypted requests. This is only supported when <span class=
+ "APPLICATION">Privoxy</span> has been built with FEATURE_HTTPS_INSPECTION.</p>
<div class="SECT3">
<h4 class="SECT3"><a name="CA-DIRECTORY" id="CA-DIRECTORY">7.7.1. ca-directory</a></h4>
<div class="VARIABLELIST">
diff --git a/doc/webserver/user-manual/configuration.html b/doc/webserver/user-manual/configuration.html
index 8460cb1e..9bcba226 100644
--- a/doc/webserver/user-manual/configuration.html
+++ b/doc/webserver/user-manual/configuration.html
@@ -40,7 +40,7 @@
<tr>
<td>
<pre class="SCREEN"> </pre>
- <h2 class="BRIDGEHEAD"><a name="AEN898"></a> Privoxy Menu</h2>
+ <h2 class="BRIDGEHEAD"><a name="AEN897"></a> Privoxy Menu</h2>
<pre><br></pre>
<table border="0">
<tbody>
@@ -94,8 +94,7 @@
<h2 class="SECT2"><a name="CONFOVERVIEW">6.2. Configuration Files Overview</a></h2>
<p>For Unix, *BSD and GNU/Linux, all configuration files are located in <tt class="FILENAME">/etc/privoxy/</tt>
by default. For MS Windows these are all in the same directory as the <span class="APPLICATION">Privoxy</span>
- executable. The name and number of configuration files has changed from previous versions, and is subject to
- change as development progresses.</p>
+ executable.</p>
<p>The installed defaults provide a reasonable starting point, though some settings may be aggressive by some
standards. For the time being, the principle configuration files are:</p>
<ul>
@@ -146,9 +145,6 @@
listening address of <span class="APPLICATION">Privoxy</span>, these <span class="QUOTE">"wake up"</span>
requests must obviously be sent to the <span class="emphasis"><i class="EMPHASIS">old</i></span> listening
address.</p>
- <p>While under development, the configuration content is subject to change. The below documentation may not be
- accurate by the time you read this. Also, what constitutes a <span class="QUOTE">"default"</span> setting, may
- change, so please check all your configuration files on important issues.</p>
</div>
</div>
<div class="NAVFOOTER">
diff --git a/doc/webserver/user-manual/index.html b/doc/webserver/user-manual/index.html
index 082b58a9..bf530d48 100644
--- a/doc/webserver/user-manual/index.html
+++ b/doc/webserver/user-manual/index.html
@@ -194,7 +194,7 @@
<dt>7.6.19. <a href="config.html#RECEIVE-BUFFER-SIZE">receive-buffer-size</a></dt>
</dl>
</dd>
- <dt>7.7. <a href="config.html#TLS">TLS/SSL Inspection (Experimental)</a></dt>
+ <dt>7.7. <a href="config.html#HTTPS-INSPECTION-DIRECTIVES">HTTPS Inspection (Experimental)</a></dt>
<dd>
<dl>
<dt>7.7.1. <a href="config.html#CA-DIRECTORY">ca-directory</a></dt>
diff --git a/doc/webserver/user-manual/installation.html b/doc/webserver/user-manual/installation.html
index e57e4e6c..3f5be857 100644
--- a/doc/webserver/user-manual/installation.html
+++ b/doc/webserver/user-manual/installation.html
@@ -128,8 +128,8 @@
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
- <pre class="SCREEN"> tar xzvf privoxy-3.0.29-beta-src.tar.gz
- cd privoxy-3.0.29-beta</pre>
+ <pre class="SCREEN"> tar xzvf privoxy-3.0.29-stable-src.tar.gz
+ cd privoxy-3.0.29-stable</pre>
</td>
</tr>
</table>
diff --git a/doc/webserver/user-manual/introduction.html b/doc/webserver/user-manual/introduction.html
index 210e8579..13cd1933 100644
--- a/doc/webserver/user-manual/introduction.html
+++ b/doc/webserver/user-manual/introduction.html
@@ -27,20 +27,13 @@
</div>
<div class="SECT1">
<h1 class="SECT1"><a name="INTRODUCTION" id="INTRODUCTION">1. Introduction</a></h1>
- <p>This documentation is included with the current UNRELEASED version of <span class="APPLICATION">Privoxy</span>,
- 3.0.29, and is mostly complete at this point. The most up to date reference for the time being is still the
- comments in the source files and in the individual configuration files. Development of a new version is currently
- nearing completion, and includes significant changes and enhancements over earlier versions.</p>
- <p>Since this is a UNRELEASED version, not all new features are well tested. This documentation may be slightly out
- of sync as a result (especially with <a href="https://www.privoxy.org/gitweb/?p=privoxy.git;a=summary" target=
- "_top">git sources</a>). And there <span class="emphasis"><i class="EMPHASIS">may be</i></span> bugs, though
- hopefully not many!</p>
+ <p>This documentation is included with the current stable version of <span class="APPLICATION">Privoxy</span>,
+ 3.0.29.</p>
<div class="SECT2">
<h2 class="SECT2"><a name="FEATURES" id="FEATURES">1.1. Features</a></h2>
<p>In addition to the core features of ad blocking and <a href="http://en.wikipedia.org/wiki/Browser_cookie"
target="_top">cookie</a> management, <span class="APPLICATION">Privoxy</span> provides many supplemental
- features, some of them currently under development, that give the end-user more control, more privacy and more
- freedom:</p>
+ features, that give the end-user more control, more privacy and more freedom:</p>
<ul>
<li>
<p>Supports "Connection: keep-alive". Outgoing connections can be kept alive independently from the
@@ -52,6 +45,9 @@
<li>
<p>Supports tagging which allows to change the behaviour based on client and server headers.</p>
</li>
+ <li>
+ <p>Supports https inspection which allows to filter https requests.</p>
+ </li>
<li>
<p>Can be run as an "intercepting" proxy, which obviates the need to configure browsers individually.</p>
</li>
diff --git a/doc/webserver/user-manual/quickstart.html b/doc/webserver/user-manual/quickstart.html
index 1193746c..7409cf27 100644
--- a/doc/webserver/user-manual/quickstart.html
+++ b/doc/webserver/user-manual/quickstart.html
@@ -219,7 +219,7 @@
<p>Find <tt class="FILENAME">user.action</tt> in the top section, and click on <span class=
"QUOTE">"<span class="GUIBUTTON">Edit</span>"</span>:</p>
<div class="FIGURE">
- <a name="AEN663" id="AEN663"></a>
+ <a name="AEN662" id="AEN662"></a>
<p><b>Figure 1. Actions Files in Use</b></p>
<div class="MEDIAOBJECT">
<p><img src="files-in-use.jpg"></p>
diff --git a/doc/webserver/user-manual/startup.html b/doc/webserver/user-manual/startup.html
index ddcad779..48ca3d2c 100644
--- a/doc/webserver/user-manual/startup.html
+++ b/doc/webserver/user-manual/startup.html
@@ -35,7 +35,7 @@
<p>Please note that <span class="APPLICATION">Privoxy</span> can only proxy HTTP and HTTPS traffic. It will not
work with FTP or other protocols.</p>
<div class="FIGURE">
- <a name="AEN717" id="AEN717"></a>
+ <a name="AEN716" id="AEN716"></a>
<p><b>Figure 2. Proxy Configuration Showing Mozilla/Netscape HTTP and HTTPS (SSL) Settings</b></p>
<div class="MEDIAOBJECT">
<p><img src="proxy_setup.jpg"></p>
@@ -67,7 +67,7 @@
protocols"</span> is <span class="emphasis"><i class="EMPHASIS">UNCHECKED</i></span>. You want only HTTP and HTTPS
(SSL)!</p>
<div class="FIGURE">
- <a name="AEN761" id="AEN761"></a>
+ <a name="AEN760" id="AEN760"></a>
<p><b>Figure 3. Proxy Configuration Showing Internet Explorer HTTP and HTTPS (Secure) Settings</b></p>
<div class="MEDIAOBJECT">
<p><img src="proxy2.jpg"></p>
--
2.49.0