From 75397537c3986cafa8dc1b4b37af40f93ab9372f Mon Sep 17 00:00:00 2001
From: Fabian Keil <fk@fabiankeil.de>
Date: Fri, 21 Dec 2018 18:07:09 +0100
Subject: [PATCH] Rebuild docs for Privoxy 3.0.27 stable
---
INSTALL | 4 ++--
README | 21 +++++++------------
doc/webserver/developer-manual/index.html | 2 +-
.../developer-manual/newrelease.html | 11 +++++-----
doc/webserver/index.html | 4 ++--
doc/webserver/privoxy-index.html | 2 +-
doc/webserver/user-manual/actions-file.html | 2 +-
doc/webserver/user-manual/appendix.html | 16 +++++++-------
doc/webserver/user-manual/configuration.html | 8 ++-----
doc/webserver/user-manual/installation.html | 4 ++--
doc/webserver/user-manual/introduction.html | 13 +++---------
doc/webserver/user-manual/quickstart.html | 2 +-
doc/webserver/user-manual/startup.html | 4 ++--
13 files changed, 38 insertions(+), 55 deletions(-)
diff --git a/INSTALL b/INSTALL
index 67995e57..1f00e94c 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.27-beta-src.tar.gz
- cd privoxy-3.0.27-beta
+ tar xzvf privoxy-3.0.27-stable-src.tar.gz
+ cd privoxy-3.0.27-stable
To build the development version, you can get the source code by doing:
diff --git a/README b/README
index 7b27a1c1..80878943 100644
--- a/README
+++ b/README
@@ -32,9 +32,8 @@
*
*********************************************************************/
-This README is included with the development version of Privoxy 3.0.27. 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.27. 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/index.html b/doc/webserver/developer-manual/index.html
index 4d584ace..9c8c8c6e 100644
--- a/doc/webserver/developer-manual/index.html
+++ b/doc/webserver/developer-manual/index.html
@@ -145,7 +145,7 @@
<dd>
<dl>
<dt>6.1. <a href="newrelease.html#VERSIONNUMBERS">Version numbers</a></dt>
- <dt>6.2. <a href="newrelease.html#BEFORERELEASE">Before the Release: Freeze</a></dt>
+ <dt>6.2. <a href="newrelease.html#BEFORERELEASE">Before the Release</a></dt>
<dt>6.3. <a href="newrelease.html#THERELEASE">Building and Releasing the Packages</a></dt>
<dd>
<dl>
diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html
index 265edc7e..8aa7015f 100644
--- a/doc/webserver/developer-manual/newrelease.html
+++ b/doc/webserver/developer-manual/newrelease.html
@@ -84,7 +84,7 @@
"LITERAL">v_3_0_branch</tt> at the moment).</p>
</div>
<div class="SECT2">
- <h2 class="SECT2"><a name="BEFORERELEASE" id="BEFORERELEASE">6.2. Before the Release: Freeze</a></h2>
+ <h2 class="SECT2"><a name="BEFORERELEASE" id="BEFORERELEASE">6.2. Before the Release</a></h2>
<p>The following <span class="emphasis"><i class="EMPHASIS">must be done by one of the developers</i></span>
prior to each new release.</p>
<ul>
@@ -175,9 +175,10 @@ for-privoxy-version=3.0.11</pre>
<table border="0" bgcolor="#E0E0E0" width="90%">
<tr>
<td>
- <pre class="PROGRAMLISTING"> $ make dok
+ <pre class="PROGRAMLISTING"> $ make man
+ $ make dok
+ $ make dok-man
$ make dok-tidy
- $ make man
$ make config-file</pre>
</td>
</tr>
@@ -540,7 +541,7 @@ for-privoxy-version=3.0.11</pre>
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
- <pre class="PROGRAMLISTING"> debchange -v 3.0.27-UNRELEASED-1 "New upstream version"</pre>
+ <pre class="PROGRAMLISTING"> debchange -v 3.0.27-stable-1 "New upstream version"</pre>
</td>
</tr>
</table>
@@ -552,7 +553,7 @@ for-privoxy-version=3.0.11</pre>
</td>
</tr>
</table>
- <p>This will create <tt class="FILENAME">../privoxy_3.0.27-UNRELEASED-1_i386.deb</tt> which can be uploaded. To
+ <p>This will create <tt class="FILENAME">../privoxy_3.0.27-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/index.html b/doc/webserver/index.html
index b0aedab1..d0f30288 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.27 (UNRELEASED)</a>.</p>
+ <p>The most recent release is <a href="announce.txt" target="_top">3.0.27 (stable)</a>.</p>
</div>
</div>
<hr>
@@ -40,7 +40,7 @@
<div class="SECT1">
<h3 class="SECT1"><a name="DOWNLOAD" id="DOWNLOAD">Download</a></h3>
<p>You can <a href="/sf-download-mirror/" target="_top">download Privoxy here</a>, from <a href=
- "http://www.silvester.org.uk/privoxy/" target="_top">this mirror</a>, or from <a href=
+ "https://www.silvester.org.uk/privoxy/" target="_top">this mirror</a>, or from <a href=
"https://sourceforge.net/projects/ijbswa/files/" target="_top">SourceForge</a>.</p>
<p>Note that the Privoxy project currently has no trusted build infrastructure. Binary packages are built and
uploaded by individual members of the Privoxy project or external contributors. For details check the
diff --git a/doc/webserver/privoxy-index.html b/doc/webserver/privoxy-index.html
index 9c58695d..bd33dd85 100644
--- a/doc/webserver/privoxy-index.html
+++ b/doc/webserver/privoxy-index.html
@@ -40,7 +40,7 @@
<div class="SECT1">
<h3 class="SECT1"><a name="DOWNLOAD" id="DOWNLOAD">Download</a></h3>
<p>You can <a href="/sf-download-mirror/" target="_top">download Privoxy here</a>, from <a href=
- "http://www.silvester.org.uk/privoxy/" target="_top">this mirror</a>, or from <a href=
+ "https://www.silvester.org.uk/privoxy/" target="_top">this mirror</a>, or from <a href=
"https://sourceforge.net/projects/ijbswa/files/" target="_top">SourceForge</a>.</p>
<p>Note that the Privoxy project currently has no trusted build infrastructure. Binary packages are built and
uploaded by individual members of the Privoxy project or external contributors. For details check the
diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html
index 5fc01d7d..d1c0e092 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="AEN2871" id="AEN2871"></a>
+ <a name="AEN2866" id="AEN2866"></a>
<p><b>Table 1. Default Configurations</b></p>
<table border="1" frame="border" rules="all" class="CALSTABLE">
<col width="1*" title="C1">
diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html
index 0148eec2..38dd3763 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="AEN5990" id="AEN5990"></a>
+ <p>Privoxy main page:</p><a name="AEN5985" id="AEN5985"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/" target="_top">http://config.privoxy.org/</a></p>
</blockquote>
@@ -212,28 +212,28 @@
</li>
<li>
<p>Show information about the current configuration, including viewing and editing of actions
- files:</p><a name="AEN5998" id="AEN5998"></a>
+ files:</p><a name="AEN5993" id="AEN5993"></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 source code version numbers:</p><a name="AEN6003" id="AEN6003"></a>
+ <p>Show the source code version numbers:</p><a name="AEN5998" id="AEN5998"></a>
<blockquote class="BLOCKQUOTE">
<p><a href="http://config.privoxy.org/show-version" target=
"_top">http://config.privoxy.org/show-version</a></p>
</blockquote>
</li>
<li>
- <p>Show the browser's request headers:</p><a name="AEN6008" id="AEN6008"></a>
+ <p>Show the browser's request headers:</p><a name="AEN6003" id="AEN6003"></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="AEN6013" id="AEN6013"></a>
+ <p>Show which actions apply to a URL and why:</p><a name="AEN6008" id="AEN6008"></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="AEN6021" id="AEN6021"></a>
+ but only as a pass-through proxy, with no actions taking place:</p><a name="AEN6016" id="AEN6016"></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="AEN6025" id="AEN6025"></a>
+ <p>Short cuts. Turn off, then on:</p><a name="AEN6020" id="AEN6020"></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="AEN6028" id="AEN6028"></a>
+ </blockquote><a name="AEN6023" id="AEN6023"></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/configuration.html b/doc/webserver/user-manual/configuration.html
index 9bc54926..0dc23c0d 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="AEN915"></a> Privoxy Menu</h2>
+ <h2 class="BRIDGEHEAD"><a name="AEN912"></a> Privoxy Menu</h2>
<pre><br></pre>
<table border="0">
<tbody>
@@ -93,8 +93,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 and OS/2 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>
+ "APPLICATION">Privoxy</span> 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/installation.html b/doc/webserver/user-manual/installation.html
index 283ec9a6..68270a14 100644
--- a/doc/webserver/user-manual/installation.html
+++ b/doc/webserver/user-manual/installation.html
@@ -140,8 +140,8 @@
<table border="0" bgcolor="#E0E0E0" width="100%">
<tr>
<td>
- <pre class="SCREEN"> tar xzvf privoxy-3.0.27-beta-src.tar.gz
- cd privoxy-3.0.27-beta</pre>
+ <pre class="SCREEN"> tar xzvf privoxy-3.0.27-stable-src.tar.gz
+ cd privoxy-3.0.27-stable</pre>
</td>
</tr>
</table>
diff --git a/doc/webserver/user-manual/introduction.html b/doc/webserver/user-manual/introduction.html
index feecba64..a1044a99 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.27, 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.27.</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
diff --git a/doc/webserver/user-manual/quickstart.html b/doc/webserver/user-manual/quickstart.html
index ebf55f54..70d9d45d 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="AEN674" id="AEN674"></a>
+ <a name="AEN671" id="AEN671"></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 a55dfd0e..fa653dd7 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="AEN728" id="AEN728"></a>
+ <a name="AEN725" id="AEN725"></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="AEN772" id="AEN772"></a>
+ <a name="AEN769" id="AEN769"></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