From b67871ce6e1570bc6afdfe3ff8db4c9c659d64ed Mon Sep 17 00:00:00 2001 From: hal9 Date: Fri, 22 Sep 2006 10:38:05 +0000 Subject: [PATCH] More prep for 3.0.5 release. --- INSTALL | 39 ++++++++-------- README | 4 +- doc/source/buildsource.sgml | 23 +++++----- privoxy.1 | 91 +++++++++++++++++++++---------------- 4 files changed, 85 insertions(+), 72 deletions(-) diff --git a/INSTALL b/INSTALL index 51464e9b..6bb2ae50 100644 --- a/INSTALL +++ b/INSTALL @@ -1,10 +1,10 @@ /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/INSTALL,v $ + * File : $Source: /cvsroot/ijbswa/current/doc/source/install.sgml,v $ * * Purpose : INSTALL file to help with installing from source. * - * Copyright : Written by and Copyright (C) 2001,2002 the SourceForge + * Copyright : Written by and Copyright (C) 2001-2006 the SourceForge * Privoxy team. http://www.privoxy.org/ * * Based on the Internet Junkbuster originally written @@ -26,30 +26,27 @@ * The GNU General Public License should be included with * this file. If not, you can view it at * http://www.gnu.org/copyleft/gpl.html - * or write to the Free Software Foundation, Inc., 59 - * Temple Place - Suite 330, Boston, MA 02111-1307, USA. + * or write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, + * USA * *********************************************************************/ ------------------------------------------------------------------------------- -This file describes installing Privoxy from source. If you are installing a -pre-built binary installation, you should probably read the appropriate section -in User Manual. - To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C compiler like gcc are required. -When building from a source tarball (either release version or nightly CVS -tarball), first unpack the source: +When building from a source tarball, first unpack the source: - tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz] - cd privoxy-3.1.1-beta + tar xzvf privoxy-3.0.5-beta-src* [.tgz or .tar.gz] + cd privoxy-3.0.5-beta -For retrieving the current CVS sources, you'll need CVS installed. Note that -sources from CVS are development quality, and may not be stable, or well -tested. To download CVS source: +For retrieving the current CVS sources, you'll need a CVS client installed. +Note that sources from CVS are typicially development quality, and may not be +stable, or well tested. To download CVS source, check the Sourceforge +documentation, which might give commands like: cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current @@ -137,17 +134,19 @@ user to determine how and where to start Privoxy. The init script should be checked for correct paths and values, if anything other than a default install is done. -If install finds previous versions of any configuration files, these will not -be overwritten, and the new ones will be installed with a "new" extension. You -will then need to manually update the installed configuration files as needed. -All template files will be overwritten. If you have customized, local +If install finds previous versions of any local configuration files, these will +not be overwritten, and the new ones will be installed with a "new" extension. +default.action, default.filter, and standard.action will be overwritten. You +will then need to manually update the other installed configuration files as +needed. All template files will be overwritten. If you have customized, local templates, you should save these first. If a previous version of Privoxy is already running, you will have to restart it manually. -For more detailed instructions on how to build Redhat and SuSE RPMs, Windows +For more detailed instructions on how to build Redhat RPMs, Windows self-extracting installers, building on platforms with special requirements etc, please consult the developer manual. The simplest command line to start Privoxy is $path/privoxy --user=privoxy $path/etc/privoxy/config. See privoxy --usage, or the man page, for other options, and configuration. + diff --git a/README b/README index 1562f4be..0c38fa0c 100644 --- a/README +++ b/README @@ -228,8 +228,8 @@ Please be sure to provide the following information: * Please provide your SF login, or email address, in case we need to contact you. -The appendix of the user manual also has helpful information on understanding -actions, and action debugging. +The appendix of the Privoxy User Manual also has helpful information on +understanding actions, and action debugging. ------------------------------------------------------------------------------- diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml index f87138e7..f6a7c676 100644 --- a/doc/source/buildsource.sgml +++ b/doc/source/buildsource.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: buildsource.sgml,v 2.7 2006/08/29 11:11:33 hal9 Exp $ + $Id: buildsource.sgml,v 2.8 2006/09/22 01:27:55 hal9 Exp $ Copyright (C) 2001-2006 Privoxy Developers http://privoxy.org See LICENSE. @@ -48,8 +48,8 @@ - For retrieving the current CVS sources, you'll need CVS installed. - Note that sources from CVS are development quality, and may not be + For retrieving the current CVS sources, you'll need a CVS client installed. + Note that sources from CVS are typicially development quality, and may not be stable, or well tested. To download CVS source, check the Sourceforge documentation, which might give commands like: @@ -206,17 +206,18 @@ - If install finds previous versions of any configuration files, these will not - be overwritten, and the new ones will be installed with a new - extension. You will then need to manually update the installed configuration - files as needed. All template files will be overwritten. If you have - customized, local templates, you should save these first. If a previous - version of Privoxy is already running, you will - have to restart it manually. + If install finds previous versions of any local configuration files, these + will not be overwritten, and the new ones will be installed with a + new extension. default.action, default.filter, and + standard.action will be overwritten. You will then need to manually update + the other installed configuration files as needed. All template files will be + overwritten. If you have customized, local templates, you should save these + first. If a previous version of Privoxy is + already running, you will have to restart it manually. - For more detailed instructions on how to build Redhat and SuSE RPMs, + For more detailed instructions on how to build Redhat RPMs, Windows self-extracting installers, building on platforms with special requirements etc, please consult the developer manual. diff --git a/privoxy.1 b/privoxy.1 index de4b32ab..706e90c8 100644 --- a/privoxy.1 +++ b/privoxy.1 @@ -3,7 +3,7 @@ .\" .\" Please send any bug reports, improvements, comments, patches, .\" etc. to Steve Cheng . -.TH "PRIVOXY" "1" "05 September 2006" "Privoxy 3.0.4 beta" "" +.TH "PRIVOXY" "1" "21 September 2006" "Privoxy 3.0.5 BETA" "" .SH NAME privoxy \- Privacy Enhancing Proxy .SH SYNOPSIS @@ -54,16 +54,17 @@ If the \fIconfigfile\fR is not specified on the command line, fail to start. .SH "DESCRIPTION" .PP -\fBPrivoxy\fR is a web proxy with advanced filtering -capabilities for protecting privacy, modifying web page data, managing -cookies, controlling access, and removing ads, banners, pop-ups and other -obnoxious Internet junk. \fBPrivoxy\fR has a very -flexible configuration and can be customized to suit individual needs and -tastes. \fBPrivoxy\fR has application for both -stand-alone systems and multi-user networks. +Privoxy is a +web proxy +with advanced filtering capabilities for protecting +privacy, modifying web page data, managing +cookies, +controlling access, and removing ads, banners, pop-ups and other obnoxious +Internet junk. Privoxy has a very flexible configuration and can be +customized to suit individual needs and tastes. Privoxy has application for +both stand-alone systems and multi-user networks. .PP -\fBPrivoxy\fR is based on \fBInternet -Junkbuster\fR (tm). +Privoxy is based on Internet Junkbuster (tm). .SH "INSTALLATION AND USAGE" .PP Browsers must be individually configured to use \fBPrivoxy\fR as @@ -102,15 +103,23 @@ locally defined filters. These are well commented. On Unix and Unix-like systems, these are located in \fI/etc/privoxy/\fR by default. .PP -See the \fIUser Manual\fR for a detailed -explanation of installation, general usage, all configuration options, new -features and notes on upgrading. +\fBPrivoxy\fR uses the concept of \fBactions\fR +in order to manipulate the data stream between the browser and remote sites. +There are various actions available with specific functions for such things +as blocking web sites, managing cookies, etc. These actions can be invoked +individually or combined, and used against individual URLs, or groups of URLs +that can be defined using wildcards and regular expressions. The result is +that the user has greatly enhanced control and freedom. .PP The actions list (ad blocks, etc) can also be configured with your web browser at http://config.privoxy.org/. \fBPrivoxy's\fR configuration parameters can also be viewed at the same page. In addition, \fBPrivoxy\fR can be toggled on/off. This is an internal page, and does not require Internet access. +.PP +See the \fIUser Manual\fR for a detailed +explanation of installation, general usage, all configuration options, new +features and notes on upgrading. .SH "SAMPLE CONFIGURATION" .PP A brief example of what a simple \fIdefault.action\fR @@ -120,10 +129,10 @@ configuration might look like: # Define a few useful custom aliases for later use {{alias}} - # Useful aliases + # Useful aliases that combine more than one action +crunch-cookies = +crunch-incoming-cookies +crunch-outgoing-cookies -crunch-cookies = -crunch-incoming-cookies -crunch-outgoing-cookies - +imageblock = +block +handle-as-image + +block-as-image = +block +handle-as-image # Fragile sites should have the minimum changes fragile = -block -deanimate-gifs -fast-redirects -filter \\ @@ -145,12 +154,12 @@ configuration might look like: +deanimate-gifs{last} \\ -downgrade-http-version \\ -fast-redirects \\ -+filter{js-annoyances} \\ +-filter{js-annoyances} \\ -filter{js-events} \\ -+filter{html-annoyances} \\ +-filter{html-annoyances} \\ -filter{content-cookies} \\ +filter{refresh-tags} \\ -+filter{unsolicited-popups} \\ +-filter{unsolicited-popups} \\ -filter{all-popups} \\ +filter{img-reorder} \\ +filter{banners-by-size} \\ @@ -195,22 +204,23 @@ configuration might look like: # Block, and treat these URL patterns as if they were 'images'. # We would expect these to be ads. - {+imageblock} + { +block-as-image } .ad.doubleclick.net .a[0-9].yimg.com/(?:(?!/i/).)*$ ad.*.doubleclick.net - # Block any URLs that match these patterns - {+block} + # Block all URLs that match these patterns + { +block } ad*. .*ads. banner?. /.*count(er)?\\.(pl|cgi|exe|dll|asp|php[34]?) .hitbox.com + media./.*(ads|banner) # Make exceptions for these harmless ones that would be # caught by our +block patterns just above. - {-block} + { -block } adsl. advice. .*downloads. @@ -228,15 +238,20 @@ narrowly defined exceptions: # Set personal exceptions to the policies in default.action ####### - # Sites where we want persistant cookies, so allow *all* cookies - {-crunch-cookies -session-cookies-only} + # Sites where we want persistent cookies, so allow *all* cookies + { -crunch-cookies -session-cookies-only } .redhat.com .sun.com .msdn.microsoft.com - # This site breaks easily. - {-block -fast-redirects} + # These sites breaks easily. Use our "fragile" alias here. + { fragile } .forbes.com + mybank.example.com + + # Replace example.com's style sheet with one of my choosing + { +redirect{http://localhost/css-replacements/example.com.css} } + example.com/stylesheet.css .fi .PP See the comments in the configuration files themselves, or the @@ -273,7 +288,7 @@ config file changes by \fBSIGHUP\fR -- it will detect them automatically. .SH "NOTES" .PP -This is a beta version of \fBPrivoxy\fR. Not +This is a BETA version of \fBPrivoxy\fR. Not all features are well tested. .PP Please see the \fIUser Manual\fR on how to contact the @@ -314,7 +329,7 @@ http://www.squid-cache.org/, a very popular caching proxy, which is often used together with \fBPrivoxy\fR. http://tor.eff.org/, -\fBTOR\fR can help anonymize web browsing, +\fBTor\fR can help anonymize web browsing, web publishing, instant messaging, IRC, SSH, and other applications. http://www.privoxy.org/developer-manual/, @@ -322,14 +337,12 @@ the \fBPrivoxy\fR developer manual. .SH "DEVELOPMENT TEAM" .nf - Fabian Keil - David Schmidt - - - Johny Agotnes - Moritz Barsnick + Fabian Keil, developer + David Schmidt, developer + Hal Burgiss - Mattes Dolak + Ian Cummings + Félix Rauch Roland Rosenfeld .fi .SH "COPYRIGHT AND LICENSE" @@ -351,11 +364,11 @@ This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the \fIGNU General Public License\fR for -more details, which is available from the Free Software Foundation, Inc, 59 -Temple Place - Suite 330, Boston, MA 02111-1307, USA. +more details, which is available from the Free Software Foundation, Inc, +51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA .PP You should have received a copy of the \fIGNU General Public License\fR along with this program; if not, write to the Free Software -Foundation, Inc. 59 Temple Place - Suite 330 -Boston, MA 02111-1307 +Foundation, Inc. 51 Franklin Street, Fifth Floor +Boston, MA 02110-1301 USA -- 2.39.2