From 3e837e6e9561de90b1db799199f8036977cb36b0 Mon Sep 17 00:00:00 2001 From: Lee Date: Fri, 10 Aug 2018 15:40:35 -0400 Subject: [PATCH] rebuild docs --- INSTALL | 29 +- doc/source/buildsource.sgml | 47 ++- doc/source/developer-manual.sgml | 164 ++++++--- doc/source/faq.sgml | 10 +- doc/source/install.sgml | 2 +- doc/source/p-config.sgml | 126 ++----- doc/source/privoxy.sgml | 10 +- doc/source/user-manual.sgml | 194 +++++++++-- .../developer-manual/documentation.html | 9 +- .../developer-manual/newrelease.html | 202 +++++++---- doc/webserver/faq/configuration.html | 6 +- doc/webserver/faq/copyright.html | 4 +- doc/webserver/faq/index.html | 15 +- doc/webserver/faq/misc.html | 9 +- doc/webserver/index.html | 11 +- doc/webserver/privoxy-index.html | 11 +- doc/webserver/user-manual/actions-file.html | 33 +- doc/webserver/user-manual/appendix.html | 2 +- doc/webserver/user-manual/config.html | 103 +----- doc/webserver/user-manual/configuration.html | 2 +- doc/webserver/user-manual/index.html | 20 +- doc/webserver/user-manual/installation.html | 314 +++++++++++++++--- doc/webserver/user-manual/quickstart.html | 2 +- doc/webserver/user-manual/startup.html | 4 +- 24 files changed, 844 insertions(+), 485 deletions(-) diff --git a/INSTALL b/INSTALL index 1695a06a..67995e57 100644 --- a/INSTALL +++ b/INSTALL @@ -31,7 +31,6 @@ * USA * *********************************************************************/ - ------------------------------------------------------------------------------- @@ -43,26 +42,22 @@ 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 -For retrieving the current CVS sources, you'll need a CVS client installed. -Note that sources from CVS are typically development quality, and may not be -stable, or well tested. To download CVS source, check the Sourceforge -documentation, which might give commands like: +To build the development version, you can get the source code by doing: - cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current - cd current + cd + git clone https://www.privoxy.org/git/privoxy.git -This will create a directory named current/, which will contain the source -tree. +This will create a directory named /privoxy/, which will contain the +source tree. -You can also check out any Privoxy "branch", just exchange the current name -with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs tree). +Note that source code in GIT is development quality, and may not be stable or +well tested. -It is also strongly recommended to not run Privoxy as root. You should -configure/install/run Privoxy as an unprivileged user, preferably by creating a -"privoxy" user and group just for this purpose. See your local documentation -for the correct command line to do add new users and groups (something like -adduser, but the command syntax may vary from platform to platform). +It is strongly recommended to not run Privoxy as root. You should configure/ +install/run Privoxy as an unprivileged user, preferably by creating a "privoxy" +user and group just for this purpose. See your local documentation for the +correct command line to do add new users and groups (something like adduser, +but the command syntax may vary from platform to platform). /etc/passwd might then look like: diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml index b5a0e36f..ea330746 100644 --- a/doc/source/buildsource.sgml +++ b/doc/source/buildsource.sgml @@ -22,56 +22,55 @@ To build Privoxy from source, autoconf, - GNU make - (gmake), and, of course, a C compiler like gcc are required. + GNU make (gmake), + and, of course, a C compiler like + gcc are required. When building from a source tarball, - first unpack the source: + + first unpack the source: - + tar xzvf privoxy-&p-version;-src.tar.gz cd privoxy-&p-version; - For retrieving the current CVS sources, you'll need a CVS client installed. - Note that sources from CVS are typically development quality, and may not be - stable, or well tested. To download CVS source, check the Sourceforge - documentation, which might give commands like: + To build the development version, you can get the source code by doing: - - cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current - cd current + + cd <root-dir> + git clone https://www.privoxy.org/git/privoxy.git - This will create a directory named current/, which will - contain the source tree. + This will create a directory named <root-dir>/privoxy/, + which will contain the source tree. + Note that source code in GIT is development quality, and may not be + stable or well tested. + + + - It is also strongly recommended to not run Privoxy + It is strongly recommended to not run Privoxy as root. You should configure/install/run Privoxy as - an unprivileged user, preferably by creating a privoxy user + an unprivileged user, preferably by creating a privoxy user and group just for this purpose. See your local documentation for the correct command line to do add new users and groups (something like adduser, but the command syntax may vary from platform diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index 6b1333fb..9a4fe6d5 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -518,13 +518,13 @@ Hal. <para> Some text goes here. </para> - + Tags marking individual words, or few words, should be in-line: Just to <emphasis>emphasize</emphasis>, some text goes here. - + @@ -541,7 +541,7 @@ Hal. </para> </itemizedlist> </para> - + This makes it easier to find the text amongst the tags ;-) @@ -651,6 +651,7 @@ Hal. the finished doc at that point. + Commonly used internal entities: @@ -2069,6 +2070,7 @@ $ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla. + Y, the version minor, represents the branch within the major version. At any point in time, there are two branches being maintained: The stable branch, with an even minor, say, 2N, in which no functionality is @@ -2086,13 +2088,15 @@ $ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla. Z, the point or sub version, represents a release of the software within a branch. - It is therefore incremented immediately before each code freeze. + It is therefore incremented immediately after each software release. + The point version is reset to zero when the minor changes. @@ -2140,27 +2144,34 @@ $ afl-fuzz -i input/ -o output/ -f bla.filter -m none privoxy --fuzz filter bla. The following must be done by one of the developers prior to each new release. - - - + + + Make sure that everybody who has worked on the code in the last couple of days has had a chance to yell no! in case they have pending changes/fixes in their pipelines. Announce the freeze so that nobody will interfere with last minute changes. - + + + + + Update the code status (CODE_STATUS="xxx") in configure.in to one of + "alpha", "beta" or "stable". + - Increment the version number (point from odd to even in development - branches!) in configure.in and update the code - status (CODE_STATUS="xxx") to one of "alpha", "beta" or "stable". - Rebuild configure and GNUMakefile to make sure the updated values are - being used. + Rebuild configure and GNUMakefile to make sure the updated values are being used. + + +$ autoheader && autoconf # rebuild configure +$ ./configure # rebuild GNUmakefile + - Use the dok-release target to update the sgml documentation source files. + make dok-release to update the sgml documentation source files. @@ -2178,15 +2189,16 @@ for-privoxy-version=3.0.11 - All documentation should be rebuild after the version bump. + All documentation should be rebuild after the code status has been changed. Finished docs should be then be committed to Git (for those without the ability to build these). Some docs may require rather obscure processing tools. config, the man page (and the html version of the man page) fall in this category. README, the man page, AUTHORS, and config should all also be committed to Git for other packagers. The - formal docs should be uploaded to the webserver. See the - Section "Updating the webserver" in this manual for details. + formal docs should be uploaded to the webserver. See the section + "Updating the webserver" + in this manual for details. @@ -2562,33 +2574,50 @@ for-privoxy-version=3.0.11 - Windows + Windows + - Use the - Cygwin Time Machine to install the last 1.5 version of Cygwin. - Run the following commands from within the Cygwin 1.5 bash shell. + Note that the docbook generated files might need some hand editing, + so the Windows build makefile does not rebuild the docs. + First, make sure that you have freshly exported the right version into an empty directory. (See "Building and releasing - packages" above). Then get the Windows setup module: + packages" above). + - - cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup - Then you can build the package. This is fully automated, and is - controlled by winsetup/GNUmakefile. + controlled by windows/GNUmakefile. All you need to do is: - cd winsetup + cd windows make Now you can manually rename privoxy_setup.exe to - privoxy_setup_X_Y_Z.exe, and upload it to - SourceForge. When releasing the package on SourceForge, use the release notes + privoxy_setup_X.Y.Z.exe, and the build + directory to privoxy_X.Y.Z. + Create a .zip file of the newly renamed privoxy_X.Y.Z directory, + GPG sign the installer and zip file, + + + $ gpg --armor --detach --sign privoxy_setup_X.Y.Z.exe + $ gpg --armor --detach --sign privoxy_X.Y.Z.zip + + + and upload the files to SourceForge. + + + + When releasing the package on SourceForge, use the release notes and Change Log from the source tarball package. @@ -2736,30 +2765,30 @@ for-privoxy-version=3.0.11 to SourceForge, and go through the release steps. The upload is done via FTP: - - - - Upload to: ftp://upload.sourceforge.net/incoming - - - - - user: anonymous - - - - - password: ijbswa-developers@lists.sourceforge.net - - - + + + + Upload to: ftp://upload.sourceforge.net/incoming + + + + + user: anonymous + + + + + password: ijbswa-developers@lists.sourceforge.net + + + Or use the make targets as described above. - Once this done go to https://sourceforge.net/project/admin/editpackages.php?group_id=11118, + Once this done go to + + 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 @@ -2789,15 +2818,44 @@ for-privoxy-version=3.0.11 After the Release When all (or: most of the) packages have been uploaded and made available, - send an email to the announce - mailing list, Subject: "Version X.Y.Z available for download". Be sure to + send an email to the + announce mailing + list, Subject: "Version X.Y.Z available for download". Be sure to include the - download - location, the release notes and the Changelog. Also, post an + + download location, the release notes and the Changelog. Also, post an updated News item on the project page Sourceforge, and update the Home page and docs linked from the Home page (see below). Other news sites and release oriented sites, such as Freshmeat, should also be notified. + + Then update the source code for the next version to be released: + + + + + Increment the version number and change the code status to "UNRELEASED" + in configure.in + + + + + Rebuild configure (autoheader && autoconf) + and GNUMakefile (./configure) + + + + + make dok-release to update the sgml documentation source files. + + + + + Commit all your changes. + + + + diff --git a/doc/source/faq.sgml b/doc/source/faq.sgml index 69f2deb4..9d82bfdb 100644 --- a/doc/source/faq.sgml +++ b/doc/source/faq.sgml @@ -1208,7 +1208,7 @@ on Win2K/NT/XP? Windows service - functionality. See + functionality. See the User Manual for details on how to install and configure Privoxy as a service. @@ -1516,7 +1516,7 @@ and thus avoid individual browser configuration? during upgrades. You can, however, create completely new templates, place them in another directory and specify the alternate path in the main config. For details, have a look at the templdir option. + url="../user-manual/config.html#TEMPLDIR">templdir option. @@ -1837,7 +1837,7 @@ us help you. Your efforts are not wasted, and we do appreciate them. # forward-socks5t / 127.0.0.1:9050 . - + Note that if you got Tor through one of the bundles, you may have to change the port from 9050 to 9150 (or even another one). @@ -1854,7 +1854,7 @@ us help you. Your efforts are not wasted, and we do appreciate them. # forward 192.168.*.*/ . # forward 10.*.*.*/ . # forward 127.*.*.*/ . - + Unencrypted connections to systems in these address ranges will be as (un)secure as the local network is, but the alternative is @@ -1870,7 +1870,7 @@ us help you. Your efforts are not wasted, and we do appreciate them. # forward localhost/ . - + Save the modified configuration file and open http://config.privoxy.org/show-status diff --git a/doc/source/install.sgml b/doc/source/install.sgml index 5f569e2c..072987bb 100644 --- a/doc/source/install.sgml +++ b/doc/source/install.sgml @@ -83,7 +83,7 @@ * USA * *********************************************************************/ - + diff --git a/doc/source/p-config.sgml b/doc/source/p-config.sgml index 6bf7fbe1..84bde7e5 100644 --- a/doc/source/p-config.sgml +++ b/doc/source/p-config.sgml @@ -55,14 +55,9 @@ example: - - - - - confdir /etc/privoxy - - - + + confdir /etc/privoxy + Assigns the value /etc/privoxy to the option @@ -98,8 +93,7 @@ Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/ - - + ################################################################## # Table of Contents # @@ -116,11 +110,11 @@ Copyright (C) 2001-2018 Privoxy Developers https://www.privoxy.org/ 7. WINDOWS GUI OPTIONS # # ################################################################## - - -I. INTRODUCTION - =============== + +I. INTRODUCTION + =============== + This file holds Privoxy's main configuration. Privoxy detects @@ -261,7 +255,7 @@ II. FORMAT OF THE CONFIGURATION FILE PATH to where the User Manual is located: -   user-manual  /usr/share/doc/privoxy/user-manual + user-manual /usr/share/doc/privoxy/user-manual The User Manual is then available to anyone with access to Privoxy, by following the built-in URL: @@ -272,7 +266,7 @@ II. FORMAT OF THE CONFIGURATION FILE If the documentation is not on the local system, it can be accessed from a remote server, as: -   user-manual  http://example.com/privoxy/user-manual/ + user-manual http://example.com/privoxy/user-manual/ @@ -2268,8 +2262,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t forward 192.168.*.*/ . - forward 10.*.*.*/ . - forward 127.*.*.*/ . + forward 10.*.*.*/ . + forward 127.*.*.*/ . Unencrypted connections to systems in these address ranges will @@ -3318,8 +3312,8 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t This directive was added as a work-around for Firefox bug 492459: Websites are no longer rendered if SSL requests for JavaScripts are blocked by a proxy. - (https://bugzilla.mozilla.org/show_bug.cgi?id=492459), + ( + https://bugzilla.mozilla.org/show_bug.cgi?id=492459), the bug has been fixed for quite some time, but this directive is also useful to make it harder for websites to detect whether or not resources are being blocked. @@ -3441,15 +3435,17 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t # Best speed (compared to the other levels) compression-level 1 + # Best compression compression-level 9 + # No compression. Only useful for testing as the added header # slightly increases the amount of data that has to be sent. # If your benchmark shows that using this compression level # is superior to using no compression at all, the benchmark # is likely to be flawed. compression-level 0 - + @@ -3602,7 +3598,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t # that are enabled based on CLIENT-TAG patterns. client-specific-tag circumvent-blocks Overrule blocks but do not affect other actions disable-content-filters Disable content-filters but do not affect other actions - + @@ -3663,7 +3659,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t # Increase the time to life for temporarily enabled tags to 3 minutes client-tag-lifetime 180 - + @@ -3736,7 +3732,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t # Allow systems that can reach Privoxy to provide the client # IP address with a X-Forwarded-For header. trust-x-forwarded-for 1 - + @@ -3808,7 +3804,7 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t # Increase the receive buffer size receive-buffer-size 32768 - + @@ -3837,15 +3833,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#activity-animation 1]]> - - activity-animation 1 - - - - + ]]> @@ -3859,15 +3849,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#log-messages 1]]> - - log-messages 1 - - - - + ]]> @@ -3885,15 +3869,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#log-buffer-size 1]]> - - log-buffer-size 1 - - - - + ]]> @@ -3905,15 +3883,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#log-max-lines 200]]> - - log-max-lines 200 - - - - + ]]> @@ -3926,15 +3898,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#log-highlight-messages 1]]> - - log-highlight-messages 1 - - - - + ]]> @@ -3945,15 +3911,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#log-font-name Comic Sans MS]]> - - log-font-name Comic Sans MS - - - - + ]]> @@ -3964,15 +3924,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#log-font-size 8]]> - - log-font-size 8 - - - - + ]]> @@ -3985,15 +3939,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#show-on-task-bar 0]]> - - show-on-task-bar 0 - - - - + ]]> @@ -4006,15 +3954,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#close-button-minimizes 1]]> - - close-button-minimizes 1 - - - - + ]]> @@ -4028,15 +3970,9 @@ forward-socks4, forward-socks4a, forward-socks5 and forward-socks5t @@#hide-console]]> - - #hide-console - - - - + ]]> diff --git a/doc/source/privoxy.sgml b/doc/source/privoxy.sgml index 1f796e56..53b0ddc8 100644 --- a/doc/source/privoxy.sgml +++ b/doc/source/privoxy.sgml @@ -42,17 +42,19 @@ Helping hands and donations are welcome: + + - https://www.privoxy.org/faq/general.html#PARTICIPATE + + https://www.privoxy.org/faq/general.html#PARTICIPATE - https://www.privoxy.org/faq/general.html#DONATE + + https://www.privoxy.org/faq/general.html#DONATE diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 62cf7c62..09854fd2 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -53,7 +53,7 @@ - Copyright &my-copy; 2001-2017 by + Copyright &my-copy; 2001-2018 by Privoxy Developers @@ -339,30 +339,155 @@ How to install the binary packages depends on your operating system: Building from Source - The most convenient way to obtain the Privoxy sources - is to download the source tarball from our - project download - page. - - - - If you like to live on the bleeding edge and are not afraid of using - possibly unstable development versions, you can check out the up-to-the-minute - version directly from the - CVS repository. - + The most convenient way to obtain the Privoxy source + code is to download the source tarball from our + + project download page, + or you can get the up-to-the-minute, possibly unstable, development version from + https://www.privoxy.org/. &buildsource; + + Windows + + Setup + + Install the Cygwin utilities needed to build Privoxy. + If you have a 64 bit CPU (which most people do by now), get the + Cygwin setup-x86_64.exe program here + (the .sig file is here). + + + Run the setup program and from View / Category select: + + + Devel + autoconf 2.5 + automake 1.15 + binutils + cmake + gcc-core + gcc-g++ + git + make + mingw64-i686-gcc-core + mingw64-i686-zlib + Editors + vim + Libs + libxslt: GNOME XSLT library (runtime) + Net + curl + openssh + Text + docbook-dssl + docbook-sgml31 + docbook-utils + openjade + Utils + gnupg + Web + w3m + + + + If you haven't already downloaded the Privoxy source code, get it now: + + + mkdir <root-dir> + cd <root-dir> + git clone https://www.privoxy.org/git/privoxy.git + + + + Get the source code (.zip or .tar.gz) for tidy from + + https://github.com/htacg/tidy-html5/releases, + unzip into <root-dir> and build the software: + + + cd <root-dir> + cd tidy-html5-x.y.z/build/cmake + cmake ../.. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIB:BOOL=OFF -DCMAKE_INSTALL_PREFIX=/usr/local + make && make install + + + + If you want to be able to make a Windows release package, get the NSIS .zip file from + + + https://sourceforge.net/projects/nsis/files/NSIS%203/ + and extract the NSIS directory to privoxy/windows. + Then edit the windows/GNUmakefile to set the location of the NSIS executable - eg: + + +# Path to NSIS +MAKENSIS = ./nsis/makensis.exe + + + + + Build + + + To build just the Privoxy executable and not the whole installation package, do: + + + cd <root-dir>/privoxy + ./windows/MYconfigure && make + + + + Privoxy uses the GNU Autotools + for building software, so the process is: + + + $ autoheader # creates config.h.in + $ autoconf # uses config.h.in to create the configure shell script + $ ./configure [options] # creates GNUmakefile + $ make [options] # builds the program + + + + The usual configure options for building a native Windows application under cygwin are + + + + --host=i686-w64-mingw32 + --enable-mingw32 + --enable-zlib + --enable-static-linking + --disable-pthread + --disable-dynamic-pcre + + + + You can set the CFLAGS and LDFLAGS envars before + running configure to set compiler and linker flags. For example: + + + + $ export CFLAGS="-O2" # set gcc optimization level + $ export LDFLAGS="-Wl,--nxcompat" # Enable DEP + $ ./configure --host=i686-w64-mingw32 --enable-mingw32 --enable-zlib \ + > --enable-static-linking --disable-pthread --disable-dynamic-pcre + $ make # build Privoxy + + + + See the Developer's Manual + for building a Windows release package. + + + + + + Keeping your Installation Up-to-Date @@ -1383,10 +1508,9 @@ for details. - +     Privoxy Menu -         ▪  View & change the current configuration @@ -2943,7 +3067,7 @@ TAG:^User-Agent: RPM APT-HTTP/ TAG:^User-Agent: fetch libfetch/ TAG:^User-Agent: Ubuntu APT-HTTP/ TAG:^User-Agent: MPlayer/ - + # Tag all requests with the Range header set @@ -2958,7 +3082,7 @@ TAG:^User-Agent: MPlayer/ # parts of multimedia files. {-filter -deanimate-gifs} TAG:^RANGE-REQUEST$ - + # Tag all requests with the client IP address @@ -2972,7 +3096,7 @@ TAG:^RANGE-REQUEST$ # Change forwarding settings for requests coming from address 10.0.0.1 {+forward-override{forward-socks5 127.0.1.2:2222 .}} TAG:^IP-ADDRESS: 10\.0\.0\.1$ - + @@ -3162,7 +3286,7 @@ new action # Block the non-existent "Privacy-Violation:" client header { +crunch-client-header{Privacy-Violation:} } / - + @@ -3244,7 +3368,8 @@ new action {+hide-if-modified-since{-60} \ +overwrite-last-modified{randomize} \ +crunch-if-none-match} -/ +/ + @@ -3391,7 +3516,8 @@ new action # Crunch server headers that try to prevent caching { +crunch-server-header{no-cache} } -/ +/ + @@ -4123,7 +4249,7 @@ new action +force-text-mode - + @@ -4268,7 +4394,7 @@ new action -overwrite-last-modified \ } TAG:^User-Agent: fetch libfetch/2\.0$ - + @@ -4344,7 +4470,7 @@ new action # but send an empty document instead of the usual HTML message. {+block{Blocked JavaScript} +handle-as-empty-document} example.org/.*\.js$ - + @@ -4513,7 +4639,8 @@ new action {+hide-accept-language{en-ca} \ +hide-user-agent{Mozilla/5.0 (X11; U; OpenBSD i386; en-CA; rv:1.8.0.4) Gecko/20060628 Firefox/1.5.0.4} \ } -/ +/ + @@ -5515,7 +5642,7 @@ example.org/xml-instance-that-is-delivered-as-html {+server-header-filter{xml-to-html}} example.org/instance-that-is-delivered-as-xml-but-is-not - + @@ -5986,7 +6113,7 @@ hal stop here +set-image-blocker{pattern} \ } / # Match all URLs - + The default behavior is now set. @@ -8252,7 +8379,8 @@ In file: user.action [ View ] [ Edit ] + +set-image-blocker {pattern} + Notice the only difference here to the previous listing, is to diff --git a/doc/webserver/developer-manual/documentation.html b/doc/webserver/developer-manual/documentation.html index b8d53484..cb3e797e 100644 --- a/doc/webserver/developer-manual/documentation.html +++ b/doc/webserver/developer-manual/documentation.html @@ -565,15 +565,13 @@ CLASS="EMPHASIS" CLASS="LITERALLAYOUT" > <para>
  Some text goes here.
- </para>
-       

Tags marking individual words, or few words, should be in-line:

  Just to <emphasis>emphasize</emphasis>, some text goes here.
-       

  Just to <emphasis>emphasize</emphasis>, some text goes here.

  •    </para>
      </itemizedlist>
    - </para>
    -       

    This makes it easier to find the text amongst the tags ;-)

  • Y, the version minor, represents the branch within the major version. +> + Y, the version minor, represents the branch within the major version. At any point in time, there are two branches being maintained: The stable branch, with an even minor, say, 2N, in which no functionality is being added and only bug-fixes are made, and 2N+1, the development branch, in @@ -164,13 +165,8 @@ CLASS="APPLICATION" >

  • Z, the point or sub version, represents a release of the software within a branch. - It is therefore incremented immediately before each code freeze. - In development branches, only the even point versions correspond to actual releases, - while the odd ones denote the evolving state of the sources on Git in between. - It follows that Z is odd on Git in development branches most of the time. There, it gets - increased to an even number immediately before a code freeze, and is increased to an odd - number again immediately thereafter. - This ensures that builds from Git snapshots are easily distinguished from released versions. + It is therefore incremented immediately after each software release. + The point version is reset to zero when the minor changes.

    in case they have pending changes/fixes in their pipelines. Announce the freeze so that nobody will interfere with last minute changes. -

  • Increment the version number (point from odd to even in development - branches!) in configure.in and update the code - status (CODE_STATUS="xxx") to one of "alpha", "beta" or "stable". - Rebuild configure and GNUMakefile to make sure the updated values are - being used. +> Update the code status (CODE_STATUS="xxx") in configure.in to one of + "alpha", "beta" or "stable".

  • Use the dok-release target to update the sgml documentation source files. +> Rebuild configure and GNUMakefile to make sure the updated values are being used. + 

    $ autoheader && autoconf     # rebuild configure
+$ ./configure                # rebuild GNUmakefile

  • make dok-release to update the sgml documentation source files.

  • All documentation should be rebuild after the version bump. +> All documentation should be rebuild after the code status has been changed. Finished docs should be then be committed to Git (for those without the ability to build these). Some docs may require rather obscure processing tools. "Updating the webserver" + in this manual for details.

  • 6.3.6. Windows

    Use the Cygwin Time Machine to install the last 1.5 version of Cygwin. - Run the following commands from within the Cygwin 1.5 bash shell. +> Note that the docbook generated files might need some hand editing, + so the Windows build makefile does not rebuild the docs.

    First, . (See "Building and releasing - packages" above). Then get the Windows setup module: + packages" above). + +

    Then you can build the package. This is fully automated, and is + controlled by windows/GNUmakefile. + All you need to do is: 

      cvs -z3  -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
    cd windows + make

    Then you can build the package. This is fully automated, and is - controlled by Now you can manually rename privoxy_setup.exe to + winsetup/GNUmakefileprivoxy_setup_X.Y.Z.exe, and the build + directory to privoxy_X.Y.Z. - All you need to do is: + Create a .zip file of the newly renamed privoxy_X.Y.Z directory, + GPG sign the installer and zip file, 

      cd winsetup
-  make
    $ gpg --armor --detach --sign privoxy_setup_X.Y.Z.exe + $ gpg --armor --detach --sign privoxy_X.Y.Z.zip

    Now you can manually rename privoxy_setup.exe to - privoxy_setup_X_Y_Z.exe, and upload it to - SourceForge. When releasing the package on SourceForge, use the release notes +> and upload the files to SourceForge. +

    When releasing the package on SourceForge, use the release notes and Change Log from the source tarball package.

    targets as described above.

    Once this done go to Once this done go to + https://sourceforge.net/project/admin/editpackages.php?group_id=11118 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

    When all (or: most of the) packages have been uploaded and made available, - send an email to the announce - mailing listannounce mailing + list, Subject: "Version X.Y.Z available for download". Be sure to include the download - location download location, the release notes and the Changelog. Also, post an updated News item on the project page Sourceforge, and update the Home page and docs linked from the Home page (see below). Other news sites and release oriented sites, such as Freshmeat, should also be notified.

    Then update the source code for the next version to be released: +

    • Increment the version number and change the code status to "UNRELEASED" + in configure.in +

    • Rebuild configure ("autoheader && autoconf") + and GNUMakefile ("./configure") +

    • "make dok-release" to update the sgml documentation source files. +

    • Commit all your changes. +

    3.4. There are several different "actions"Windows service functionality. See the config. For details, have a look at the templdir option.

    7.1. License

    7.2. History

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

    Helping hands and donations are welcome: -

    Helping hands and donations are welcome:

        Privoxy Menu

    Copyright © 2001-2017 by +> © 2001-2018 by

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

    Helping hands and donations are welcome: -

    Helping hands and donations are welcome:

    • https://www.privoxy.org/faq/general.html#PARTICIPATE https://www.privoxy.org/faq/general.html#PARTICIPATE

      • https://www.privoxy.org/faq/general.html#DONATE https://www.privoxy.org/faq/general.html#DONATE

      Building from Source
      2.2.1. Windows
      2.3. The most convenient way to obtain the Privoxy sources - is to download the source tarball from our +> source + code is to download the source tarball from our project download - page.

      If you like to live on the bleeding edge and are not afraid of using - possibly unstable development versions, you can check out the up-to-the-minute - version directly from project download page, + or you can get the up-to-the-minute, possibly unstable, development version from + the - CVS repositoryhttps://www.privoxy.org/.

      To build GNU make - (gmake), and, of course, a C compiler like GNU make (gmake), + and, of course, a C compiler like + gcc

      For retrieving the current CVS sources, you'll need a CVS client installed. - Note that sources from CVS are typically development quality, and may not be - stable, or well tested. To download CVS source, check the Sourceforge - documentation, which might give commands like:

      To build the development version, you can get the source code by doing:

        cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current
-  cd current
      cd <root-dir> + git clone https://www.privoxy.org/git/privoxy.git

      This will create a directory named current/, which will - contain the source tree.

      <root-dir>/privoxy/      , + which will contain the source tree.

      You can also check out any Privoxy - "branch", just exchange the current - name with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs - tree).

      Note that source code in GIT is development quality, and may not be + stable or well tested.

      It is also strongly recommended to not run It is strongly recommended to not run Privoxy @@ -506,7 +488,7 @@ CLASS="APPLICATION" CLASS="APPLICATION" >Privoxy as - an unprivileged user, preferably by creating a "privoxy" user @@ -848,6 +830,258 @@ HREF="https://www.privoxy.org/developer-manual/newrelease.html" TARGET="_top" >developer manual.

      2.2.1. Windows

      2.2.1.1. Setup

      Install the Cygwin utilities needed to build Privoxy. + If you have a 64 bit CPU (which most people do by now), get the + Cygwin setup-x86_64.exe program here + (the .sig file is here). +

      Run the setup program and from View / Category select: + 

        Devel
+    autoconf 2.5
+    automake 1.15
+    binutils
+    cmake
+    gcc-core
+    gcc-g++
+    git
+    make
+    mingw64-i686-gcc-core
+    mingw64-i686-zlib
+  Editors
+    vim
+  Libs
+    libxslt: GNOME XSLT library (runtime)
+  Net
+    curl
+    openssh
+  Text
+    docbook-dssl
+    docbook-sgml31
+    docbook-utils
+    openjade
+  Utils
+    gnupg
+  Web
+    w3m

      If you haven't already downloaded the Privoxy source code, get it now: + 

        mkdir <root-dir>
+  cd <root-dir>
+  git clone https://www.privoxy.org/git/privoxy.git

      Get the source code (.zip or .tar.gz) for tidy from + https://github.com/htacg/tidy-html5/releases, + unzip into <root-dir> and build the software: + 

        cd <root-dir>
+  cd tidy-html5-x.y.z/build/cmake
+  cmake ../.. -DCMAKE_BUILD_TYPE=Release -DBUILD_SHARED_LIB:BOOL=OFF -DCMAKE_INSTALL_PREFIX=/usr/local
+  make && make install

      If you want to be able to make a Windows release package, get the NSIS .zip file from + + https://sourceforge.net/projects/nsis/files/NSIS%203/ + and extract the NSIS directory to privoxy/windows. + Then edit the windows/GNUmakefile to set the location of the NSIS executable - eg: + 

      # Path to NSIS
+MAKENSIS = ./nsis/makensis.exe

      2.2.1.2. Build

      To build just the Privoxy executable and not the whole installation package, do: + 

        cd <root-dir>/privoxy
+  ./windows/MYconfigure && make

      Privoxy uses the GNU Autotools + for building software, so the process is: + 

        $ autoheader              # creates config.h.in
+  $ autoconf                # uses config.h.in to create the configure shell script
+  $ ./configure [options]   # creates GNUmakefile
+  $ make        [options]   # builds the program

      The usual configure options for building a native Windows application under cygwin are + 

        --host=i686-w64-mingw32
+  --enable-mingw32
+  --enable-zlib
+  --enable-static-linking
+  --disable-pthread
+  --disable-dynamic-pcre

      You can set the CFLAGS and LDFLAGS envars before + running configure to set compiler and linker flags. For example: + 

        $ export CFLAGS="-O2"              # set gcc optimization level
+  $ export LDFLAGS="-Wl,--nxcompat"  # Enable DEP
+  $ ./configure --host=i686-w64-mingw32 --enable-mingw32  --enable-zlib \
+  >             --enable-static-linking --disable-pthread --disable-dynamic-pcre
+  $ make                             # build Privoxy

      See the Developer's Manual + for building a Windows release package. +