From 4985684a0376e6a84c5f542c7324617259092575 Mon Sep 17 00:00:00 2001 From: Fabian Keil Date: Mon, 14 Dec 2020 08:50:13 +0100 Subject: [PATCH] Rebuild docs for 3.0.29 UNRELEASED --- INSTALL | 4 +-- README | 25 ++++++++++++------- .../developer-manual/documentation.html | 6 ++--- doc/webserver/developer-manual/git.html | 6 ++++- doc/webserver/developer-manual/index.html | 8 +++--- .../developer-manual/introduction.html | 8 +++--- .../developer-manual/newrelease.html | 6 ++--- doc/webserver/developer-manual/testing.html | 11 +++++++- doc/webserver/faq/index.html | 9 +++---- doc/webserver/faq/installation.html | 6 ++--- doc/webserver/index.html | 19 +++++++------- doc/webserver/privoxy-index.html | 9 +++---- doc/webserver/user-manual/actions-file.html | 7 +++--- doc/webserver/user-manual/appendix.html | 20 +++++++-------- doc/webserver/user-manual/config.html | 8 +++--- doc/webserver/user-manual/configuration.html | 14 +++++++---- doc/webserver/user-manual/contact.html | 4 +-- doc/webserver/user-manual/copyright.html | 4 +-- doc/webserver/user-manual/filter-file.html | 4 +-- doc/webserver/user-manual/index.html | 11 ++++---- doc/webserver/user-manual/installation.html | 8 +++--- doc/webserver/user-manual/introduction.html | 21 ++++++++++------ doc/webserver/user-manual/quickstart.html | 6 ++--- doc/webserver/user-manual/seealso.html | 4 +-- doc/webserver/user-manual/startup.html | 8 +++--- doc/webserver/user-manual/templates.html | 4 +-- doc/webserver/user-manual/whatsnew.html | 4 +-- 27 files changed, 137 insertions(+), 107 deletions(-) diff --git a/INSTALL b/INSTALL index 1d43f547..8e3c92f3 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-stable-src.tar.gz - cd privoxy-3.0.29-stable + tar xzvf privoxy-3.0.30-beta-src.tar.gz + cd privoxy-3.0.30-beta To build the development version, you can get the source code by doing: diff --git a/README b/README index ff4efa6e..890964c9 100644 --- a/README +++ b/README @@ -32,8 +32,9 @@ * *********************************************************************/ -This README is included with Privoxy 3.0.29. See https://www.privoxy.org/ for -more information. The current code maturity level is "stable". +This README is included with the development version of Privoxy 3.0.30. See +https://www.privoxy.org/ for more information. The current code maturity level +is "UNRELEASED", but seems stable to us :). ------------------------------------------------------------------------------- @@ -50,9 +51,9 @@ Privoxy is an associated project of Software in the Public Interest (SPI). Helping hands and donations are welcome: - * https://www.privoxy.org/faq/general.html#PARTICIPATE + * https://www.privoxy.org/participate - * https://www.privoxy.org/faq/general.html#DONATE + * https://www.privoxy.org/donate ------------------------------------------------------------------------------- @@ -104,16 +105,22 @@ 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. 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, 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. -The source and configuration files are all well commented. The main -configuration files are: 'config', 'default.action', and 'default.filter'. +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. 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/documentation.html b/doc/webserver/developer-manual/documentation.html index 86a725ac..be98dfc6 100644 --- a/doc/webserver/developer-manual/documentation.html +++ b/doc/webserver/developer-manual/documentation.html @@ -57,7 +57,7 @@

How do you update the webserver (i.e. the pages on privoxy.org)?

  1. -

    First, build the docs by running make dok.

    +

    First, build the docs by running make dok dok-tidy.

  2. Run make webserver which copies all files from

    -

    3.3. Privoxy Custom Entities

    +

    3.3. Privoxy Custom Entities

    Privoxy documentation is using a number of customized "entities" to facilitate documentation maintenance.

    We are using a set of "boilerplate" files with generic text, that is used by @@ -236,7 +236,7 @@ p-version: the Privoxy version string, e.g. "3.0.29". + "APPLICATION">Privoxy version string, e.g. "3.0.30". p-status: the project status, either diff --git a/doc/webserver/developer-manual/git.html b/doc/webserver/developer-manual/git.html index 8360a0a2..6e4e77a3 100644 --- a/doc/webserver/developer-manual/git.html +++ b/doc/webserver/developer-manual/git.html @@ -48,6 +48,8 @@

    Whilst the central repository contains only the master branch, developers are of course free to create branches in their local repositories as they develop features, fixes, or update the target-dependent tools. Only once such changes are fully tested ought they be pushed back to the central repository master branch.

    +

    Before pushing stuff, please rebase it on a current master so we get an uncomplicated commit history. Avoid + merges where possible.

    At one time there were two distinct branches: stable and unstable. The more drastic changes were to be in the unstable branch. These branches have now been merged to minimize time and effort of maintaining two branches.

    @@ -81,7 +83,9 @@

  3. Note that near a major public release, we get more cautious. There is always the possibility to submit a - patch to the patch tracker instead.

    + patch to the patch tracker or the + privoxy-devel mailing + list instead.

    4. diff --git a/doc/webserver/developer-manual/index.html b/doc/webserver/developer-manual/index.html index 5f206b0a..e504f74a 100644 --- a/doc/webserver/developer-manual/index.html +++ b/doc/webserver/developer-manual/index.html @@ -22,7 +22,7 @@ helpful!) reading for anyone who wants to join the team. Note that it's currently out of date and may not be entirely correct. As always, patches are welcome.

    Please note that this document is constantly evolving. This copy represents the state at the release of - version 3.0.29. You can find the latest version of the this manual at https://www.privoxy.org/developer-manual/. Please have a look at the contact section in the user manual if you are interested in contacting the developers.

    @@ -53,7 +53,7 @@
    3.1. Quickstart to Docbook and SGML
    3.2. Privoxy Documentation Style
    -
    3.3. Privoxy Custom Entities
    +
    3.3. Privoxy Custom Entities
    4. Coding Guidelines
    @@ -138,7 +138,9 @@
    5.1. Testplan for releases
    -
    5.2. Fuzzing Privoxy
    +
    5.2. Testing with Privoxy-Regression-Test
    +
    5.3. Fuzzing Privoxy
    6. Releasing a New Version
    diff --git a/doc/webserver/developer-manual/introduction.html b/doc/webserver/developer-manual/introduction.html index 1c81cd60..c6f41714 100644 --- a/doc/webserver/developer-manual/introduction.html +++ b/doc/webserver/developer-manual/introduction.html @@ -26,10 +26,10 @@

    1. Introduction

    -

    Privoxy, as an heir to Junkbuster, is a Free - Software project and the code is licensed under the GNU General Public License version 2. As such, Privoxy development is potentially open to anyone who has the time, knowledge, and desire to - contribute in any capacity. Our goals are simply to continue the mission, to improve Privoxy, as an heir to Junkbuster, is a + Free Software project. As such, + Privoxy development is potentially open to anyone who has the time, knowledge, and + desire to contribute in any capacity. Our goals are simply to continue the mission, to improve Privoxy, and to make it available to as wide an audience as possible.

    One does not have to be a programmer to contribute. Packaging, testing, documenting and porting, are all important jobs as well.

    diff --git a/doc/webserver/developer-manual/newrelease.html b/doc/webserver/developer-manual/newrelease.html index 7d4ed88a..6d630d2a 100644 --- a/doc/webserver/developer-manual/newrelease.html +++ b/doc/webserver/developer-manual/newrelease.html @@ -493,7 +493,7 @@ for-privoxy-version=3.0.11
    - 
      debchange -v 3.0.29-stable-1 "New upstream version"
    + 
      debchange -v 3.0.30-UNRELEASED-1 "New upstream version"
    @@ -505,7 +505,7 @@ for-privoxy-version=3.0.11 -

    This will create ../privoxy_3.0.29-stable-1_i386.deb which can be uploaded. To +

    This will create ../privoxy_3.0.30-UNRELEASED-1_i386.deb which can be uploaded. To upload the package to Sourceforge, simply issue

    @@ -628,7 +628,7 @@ for-privoxy-version=3.0.11 "_top">https://sourceforge.net/project/admin/editpackages.php?group_id=11118, making sure you are logged in. Find your target platform in the second column, and click Add Release. You will then need to create a new release for your package, using the format of $VERSION - ($CODE_STATUS), e.g. 3.0.29 (beta).

    + ($CODE_STATUS), e.g. 3.0.30 (beta).

    Now just follow the prompts. Be sure to add any appropriate Release notes. You should see your freshly uploaded packages in "Step 2. Add Files To This Release". Check the appropriate box(es). Remember at each step to hit the "Refresh/Submit" buttons! You should now see diff --git a/doc/webserver/developer-manual/testing.html b/doc/webserver/developer-manual/testing.html index 46c398c8..fae9e65e 100644 --- a/doc/webserver/developer-manual/testing.html +++ b/doc/webserver/developer-manual/testing.html @@ -70,7 +70,16 @@

    -

    5.2. Fuzzing Privoxy

    +

    5.2. Testing with Privoxy-Regression-Test

    +

    If you compiled, packaged or merely installed Privoxy, it is recommended to run Privoxy-Regression-Test to verify that at least the tested parts of Privoxy are working as expected.

    +

    This is actually pretty easy. For details, please see perldoc + privoxy-regression-test.pl.

    +
    +
    +

    5.3. Fuzzing Privoxy

    To make fuzzing more convenient, Privoxy can be configured with --enable-fuzz which will result in the --fuzz option becoming available.

    Example (tested on ElectroBSD):

    diff --git a/doc/webserver/faq/index.html b/doc/webserver/faq/index.html index 8358b84e..318e5670 100644 --- a/doc/webserver/faq/index.html +++ b/doc/webserver/faq/index.html @@ -30,16 +30,15 @@

    Helping hands and donations are welcome:

    Please note that this document is a work in progress. This copy represents the state at the release of - version 3.0.29. You can find the latest version of the document at https://www.privoxy.org/faq/. Please see the Contact section if you want to contact the developers.

    diff --git a/doc/webserver/faq/installation.html b/doc/webserver/faq/installation.html index ee82fdc2..e47a94be 100644 --- a/doc/webserver/faq/installation.html +++ b/doc/webserver/faq/installation.html @@ -38,9 +38,9 @@

    2.2. Which operating systems are supported?

    At present, Privoxy is known to run on Windows 95 and later versions (98, ME, - 2000, XP, Vista, Windows 7 etc.), GNU/Linux (RedHat, SuSE, Debian, Fedora, Gentoo, Slackware and others), Mac OS - X (10.4 and upwards on PPC and Intel processors), Haiku, DragonFly, ElectroBSD, FreeBSD, NetBSD, OpenBSD, - Solaris, and various other flavors of Unix.

    + 2000, XP, Vista, Windows 7, Windows 10 etc.), GNU/Linux (RedHat, SuSE, Debian, Fedora, Gentoo, Slackware and + others), Mac OS X (10.4 and upwards on PPC and Intel processors), Haiku, DragonFly, ElectroBSD, FreeBSD, NetBSD, + OpenBSD, Solaris, and various other flavors of Unix.

    But any operating system that runs TCP/IP, can conceivably take advantage of Privoxy in a networked situation where Privoxy would run as a server on a LAN gateway. Then only the "gateway" needs to be running one of the diff --git a/doc/webserver/index.html b/doc/webserver/index.html index b0d23a1b..81feb1d1 100644 --- a/doc/webserver/index.html +++ b/doc/webserver/index.html @@ -15,25 +15,24 @@

    -

    Privoxy is a non-caching web proxy with advanced filtering - capabilities for enhancing privacy, modifying web page data and HTTP headers, controlling access, and - removing ads and other obnoxious Internet junk. Privoxy has a flexible configuration and can be customized to - suit individual needs and tastes. It has application for both stand-alone systems and multi-user - networks.

    +

    Privoxy logo Privoxy is a non-caching web proxy with + advanced filtering capabilities for enhancing privacy, modifying web page data and HTTP headers, controlling + access, and removing ads and other obnoxious Internet junk. Privoxy has a flexible configuration and can be + customized to suit individual needs and tastes. It has application for both stand-alone systems and + multi-user networks.

    Privoxy is Free Software and licensed under the GNU GPLv2 or later.

    Privoxy is an associated project of Software in the Public Interest (SPI).

    Helping hands and donations are welcome:

    -

    The most recent release is 3.0.29 (stable).

    +

    The most recent release is 3.0.30 (UNRELEASED).

    diff --git a/doc/webserver/privoxy-index.html b/doc/webserver/privoxy-index.html index cfc0ff42..d0513c7b 100644 --- a/doc/webserver/privoxy-index.html +++ b/doc/webserver/privoxy-index.html @@ -12,7 +12,7 @@

    Privoxy - The Privacy Enhancing Proxy

    -

    Project Index Page v3.0.29

    +

    Project Index Page v3.0.30

    @@ -25,12 +25,11 @@

    Helping hands and donations are welcome:

    diff --git a/doc/webserver/user-manual/actions-file.html b/doc/webserver/user-manual/actions-file.html index 44a6f9f0..3a496e90 100644 --- a/doc/webserver/user-manual/actions-file.html +++ b/doc/webserver/user-manual/actions-file.html @@ -4,7 +4,7 @@ Actions Files - + @@ -15,7 +15,7 @@
    - + @@ -2493,7 +2493,8 @@ nasty-banner-server.example.com/junk.cgi\?output=trash
    Privoxy 3.0.29 User ManualPrivoxy 3.0.30 User Manual
    Prev
    - 
    +hide-user-agent{Netscape 6.1 (X11; I; Linux 2.4.18 i686)}
    + 
    +hide-user-agent{Mozilla/5.0 (X11; ElectroBSD i386; rv:78.0) Gecko/20100101 Firefox/78.0}
    diff --git a/doc/webserver/user-manual/appendix.html b/doc/webserver/user-manual/appendix.html index 919ab35e..c071be1a 100644 --- a/doc/webserver/user-manual/appendix.html +++ b/doc/webserver/user-manual/appendix.html @@ -4,7 +4,7 @@ Appendix - + @@ -14,7 +14,7 @@
    - + @@ -202,7 +202,7 @@ these. If not, you will get a friendly error message. Internet access is not necessary either.

    Privoxy 3.0.29 User ManualPrivoxy 3.0.30 User Manual
    Prev
    - + @@ -2504,8 +2504,8 @@
    Notes:
    -

    This directive specifies the name of the CA key file in ".pem" format. See the ca-cert-file for a command to generate it.

    +

    This directive specifies the name of the CA key file in ".pem" format. The ca-cert-file section contains a command to generate it.

    Example:
    diff --git a/doc/webserver/user-manual/configuration.html b/doc/webserver/user-manual/configuration.html index 4f044628..bb6cf300 100644 --- a/doc/webserver/user-manual/configuration.html +++ b/doc/webserver/user-manual/configuration.html @@ -4,7 +4,7 @@ Privoxy Configuration - + @@ -15,7 +15,7 @@
    Privoxy 3.0.29 User ManualPrivoxy 3.0.30 User Manual
    Prev
    - + @@ -40,7 +40,7 @@
    Privoxy 3.0.29 User ManualPrivoxy 3.0.30 User Manual
    Prev
    -

        Privoxy Menu

    +

        Privoxy Menu


    @@ -69,7 +69,7 @@ + "https://www.privoxy.org/3.0.30/user-manual/" target="_top">Documentation
            ▪  Documentation
    @@ -94,7 +94,8 @@

    6.2. Configuration Files Overview

    For Unix, *BSD and GNU/Linux, all configuration files are located in /etc/privoxy/ by default. For MS Windows these are all in the same directory as the Privoxy - executable.

    + executable. The name and number of configuration files has changed from previous versions, and is subject to + change as development progresses.

    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: