From d7cc11956d778be9da159f012e80733d2d082706 Mon Sep 17 00:00:00 2001 From: hal9 Date: Thu, 4 Apr 2002 06:48:37 +0000 Subject: [PATCH 1/1] Structural changes to allow for conditional inclusion/exclusion of content based on entity toggles, e.g. 'entity % p-not-stable "INCLUDE"'. And definition of internal entities, e.g. 'entity p-version "2.9.13"' that will eventually be set by Makefile. More boilerplate text for use across multiple docs. --- doc/source/buildsource.sgml | 89 +++++++++++++ doc/source/contacting.sgml | 7 +- doc/source/developer-manual.sgml | 35 +++-- doc/source/faq.sgml | 14 +- doc/source/privoxy.sgml | 11 +- doc/source/readme.sgml | 161 ++++++++--------------- doc/source/supported.sgml | 18 ++- doc/source/user-manual.sgml | 218 +++++++++++-------------------- 8 files changed, 289 insertions(+), 264 deletions(-) create mode 100644 doc/source/buildsource.sgml diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml new file mode 100644 index 00000000..bc439bac --- /dev/null +++ b/doc/source/buildsource.sgml @@ -0,0 +1,89 @@ + + + There are several ways to install Privoxy. + + + + To build Privoxy from source, + autoconf and GNU make (gmake) are required. Source is available as gzipped + tar archives. For this, first unpack the source: + + + + + tar xzvf privoxy-&p-version;-src* [.tgz or .tar.gz] + cd privoxy-&p-version; + + + + + + For retrieving the current CVS sources, you'll need the CVS + package installed first. Note CVS source is development quality, + and may not be stable, or well tested. To download CVS source: + + + + + cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login + cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current + cd current + + + + + This will create a directory named current/, which will + contain the source tree. + + + + Then, in either case, to build from unpacked tarball or CVS source: + + + + + autoheader + autoconf + ./configure (--help to see options) + make (the make from gnu, gmake for *BSD) + su + make -n install (to see where all the files will go) + make install (to really install) + + + + + Redhat and SuSE src and binary RPMs can be built with + make redhat-dist or + make suse-dist from unpacked sources. You + will need to run autoconf; autoheader; + ./configure beforehand. *BSD will require gmake (from + http://gnu.org). + + + + + For binary RPM installation, and other platforms, see the user-manual + as well. + +]]> diff --git a/doc/source/contacting.sgml b/doc/source/contacting.sgml index 892f683c..0f173b3e 100644 --- a/doc/source/contacting.sgml +++ b/doc/source/contacting.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: contacting.sgml,v 1.0 2002/04/02 00:54:19 hal9 Exp $ + $Id: contacting.sgml,v 1.1 2002/04/04 01:14:18 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -22,6 +22,11 @@ forces a linebreak. ====================================================================== + + ====================================================================== + This file used for inclusion with other documents only. + ====================================================================== + --> diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index 562a3dfc..5dc4bff6 100644 --- a/doc/source/developer-manual.sgml +++ b/doc/source/developer-manual.sgml @@ -3,6 +3,12 @@ + + + + + + ]> -&p-intro; + + + + &p-intro; + + You can find the latest version of the this manual at Example for file comments: -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.19 2002/04/03 15:09:42 david__schmidt Exp $"; +const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.20 2002/04/04 03:28:27 david__schmidt Exp $"; /********************************************************************* * * File : $Source$ @@ -1372,7 +1380,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.19 2002/04/03 15:09:42 david__schmidt Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.20 2002/04/04 03:28:27 david__schmidt Exp $" /********************************************************************* * * File : $Source$ @@ -1713,9 +1721,11 @@ at sourceforge. Three simple steps: os2build - And in the ./files directory you will have the WarpIN-installable executable. - Upload this anonymously to uploads.sourceforge.net/incoming, - create a release for it, and you're done. + And in the ./files directory you will have the + WarpIN-installable executable. + Upload this anonymously to + uploads.sourceforge.net/incoming, create a release + for it, and you're done. @@ -2090,6 +2100,9 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg Temple Place - Suite 330, Boston, MA 02111-1307, USA. $Log: developer-manual.sgml,v $ + Revision 1.20 2002/04/04 03:28:27 david__schmidt + Add Mac OSX section + Revision 1.19 2002/04/03 15:09:42 david__schmidt Add OS/2 build section diff --git a/doc/source/faq.sgml b/doc/source/faq.sgml index f4afd4d1..4d174762 100644 --- a/doc/source/faq.sgml +++ b/doc/source/faq.sgml @@ -4,6 +4,13 @@ + + + + + + + ]> + + diff --git a/doc/source/readme.sgml b/doc/source/readme.sgml index c795c1d0..91a2a98e 100644 --- a/doc/source/readme.sgml +++ b/doc/source/readme.sgml @@ -1,16 +1,23 @@ - - + + + + + + + + + ]>
@@ -47,7 +73,7 @@ /********************************************************************* * - * File : $Source: /cvsroot/ijbswa/current/README,v $ + * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $ * * Purpose : README file to give a short intro. * @@ -83,16 +109,16 @@ - This README is included with the development version of Privoxy, which will - eventually become Privoxy v3.0 (and soon we hope!). See - http://www.privoxy.org/. The current code level is BETA, and seems stable to - us :) + + This README is included with + Privoxy &p-version;. See http://www.privoxy.org/ for more information. The current code + level is &p-status;. - + &p-intro; + @@ -110,7 +136,7 @@ the new package will delete any previously installed 'Junkbuster' packages. - IMPORTANT! READ! Configuration Change as of 3 Apr 2002: The default listening + IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening port is now 8118 due to conflicts with port 8000 assignment. You will need to change your browser if upgrading!!! And maybe firewall, etc. @@ -121,43 +147,10 @@ INSTALL -------- - - For tarball, first unpack: - - - - tar xzvf privoxy-2.9.13-beta-src.tar.gz - cd privoxy-2.9.13-beta - - - - autoheader - autoconf - ./configure (--help to see options) - gmake (the make from gnu) - su - make -n install (to see where all the files will go) - make install (to really install) - - - - Redhat and SuSE src and binary RPMs can be built with 'make redhat-dist' or - 'make suse-dist' (run ./configure first) from unpacked sources. BSD will - (probably?) require gmake (from http://gnu.org). See the user-manual for OS/2 - build instructions. - - - Privoxy is also available via anonymous CVS: - - - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current - - - This will create a directory named 'current'. Then, 'cd current', and then - build as above. - + + &buildsource; + @@ -210,25 +203,31 @@ See the man page or user-manual for a brief explanation of each option. The default.action file 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. +]]> DOCUMENTATION -------------- - There is a growing amount of documentation in the 'doc' subdirectory, but it - is not completed at this point. In particular, see the user-manual there, the - faq, and developers 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 source and configuration files are all well + commented. The main configuration files are: 'config', 'default.action', and + 'default.filter'. There + are several *.action files included, with varying levels of aggressiveness. @@ -242,56 +241,10 @@ See the man page or user-manual for a brief explanation of each option. -------------------------------------------------------------- - -We value your feedback. However, to provide you with the best support, -please note: - - - - * Use the support forum to get help: - http://sourceforge.net/tracker/?group_id=11118&atid=211118 - - - - - * Submit bugs only thru our bug forum: - http://sourceforge.net/tracker/?group_id=11118&atid=111118 - - - - Make sure that the bug has not already been submitted. Please try - to verify that it is a Privoxy bug, and not a browser or site - bug first. If you are using your own custom configuration, please - try the stock configs to see if the problem is a configuration - related bug. And if not using the latest development snapshot, - please try the latest one. Or even better, CVS sources. Please - be sure to include the Privoxy/Junkbuster version, platform, - browser, any pertinent log data, any other relevant details - (please be specific) and, if possible, some way to reproduce the - bug. - - - - * Submit feature requests only thru our feature request forum: - http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse - - + + &contacting; + - - - For any other issues, feel free to use the mailing lists: - http://sourceforge.net/mail/?group_id=11118 - - - - - - Anyone interested in actively participating in development and related - discussions can join the appropriate mailing list here: - http://sourceforge.net/mail/?group_id=11118. Archives are available here - too. - - ------------------------------------------------------------------------- @@ -299,7 +252,7 @@ please note: - $Id: readme.sgml,v 1.0 2002/03/31 02:03:36 hal9 Exp $ + $Id: readme.sgml,v 1.1 2002/04/03 06:01:41 hal9 Exp $
diff --git a/doc/source/supported.sgml b/doc/source/supported.sgml index dbb9e311..1b38fb33 100644 --- a/doc/source/supported.sgml +++ b/doc/source/supported.sgml @@ -3,7 +3,7 @@ Purpose : Entity included in other project documents. - $Id: supported.sgml,v 1.0 2002/04/01 16:24:49 hal9 Exp $ + $Id: supported.sgml,v 1.2 2002/04/02 00:56:06 hal9 Exp $ Written by and Copyright (C) 2001 the SourceForge Privoxy team. http://www.privoxy.org/ @@ -11,14 +11,20 @@ Based on the Internet Junkbuster originally written by and Copyright (C) 1997 Anonymous Coders and Junkbusters Corporation. http://www.junkbusters.com + + ====================================================================== + This file used for inclusion with other documents only. + ====================================================================== + --> At present, Privoxy is known to run on Win32, Mac - OSX, OS/2, AmigaOS, Linux, and many flavors of Unix. There are releases - for these available for download at - http://sourceforge.net/project/showfiles.php?group_id=11118. + OSX, OS/2, AmigaOS, Linux, and many flavors of Unix. There are source + and binary releases for these available for download at + http://sourceforge.net/project/showfiles.php?group_id=11118. + + But any operating system that runs TCP/IP, can conceivably take advantage of Privoxy in a networked situation where @@ -31,4 +37,4 @@ Source code is freely available, so porting to other operating systems, is always a possibility. - +]]> diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml index 36f39d87..02874eaf 100644 --- a/doc/source/user-manual.sgml +++ b/doc/source/user-manual.sgml @@ -4,6 +4,16 @@ + + + + + + + + + + ]> - -
Privoxy User Manual -$Id: user-manual.sgml,v 1.64 2002/04/03 03:53:43 hal9 Exp $ +$Id: user-manual.sgml,v 1.65 2002/04/03 19:52:07 swa Exp $ @@ -67,8 +70,9 @@ Hal Burgiss stand-alone systems and multi-user networks. -You can find the latest version of the user manual at http://www.privoxy.org/user-manual/. - + You can find the latest version of the user manual at http://www.privoxy.org/user-manual/. + @@ -81,13 +85,13 @@ You can find the latest version of the user manual at Introduction - -&p-intro; + + + &p-intro; + - This documentation is included with the current BETA version of + This documentation is included with the current &p-status; version of Privoxy 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 @@ -96,13 +100,15 @@ You can find the latest version of the user manual at In addition to Internet Junkbuster's traditional feature of ad and banner blocking and cookie management, - Privoxy provides new features, some of them - currently under development: + Privoxy provides new features: - - -&newfeatures; + + &newfeatures; + @@ -130,72 +134,38 @@ You can find the latest version of the user manual at Installation - Privoxy is available as raw source code, or - pre-compiled binaries. See the Privoxy Home Page - for binaries and current release info. Privoxy - is also available via Privoxy is available as raw source code (tarball + or via CVS), or pre-compiled binaries for various platforms. See the Privoxy Project Page for + the most up to date release information. + Privoxy is also available via CVS. - This is the recommended approach at this time. But please be aware that CVS - is constantly changing, and it may break in mysterious ways. + But + please be aware that CVS is constantly changing, and it may break in + mysterious ways. + + &supported; + + Source - - For gzipped tar archives, unpack the source: - - - - - tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz] - cd privoxy-2.9.13-beta - - - - - For retrieving the current CVS sources, you'll need the CVS - package installed first. To download CVS source: - - - - cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login - cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current - cd current - - - - This will create a directory named current/, which will - contain the source tree. - - - - Then, in either case, to build from tarball/CVS source: - - - - - ./configure (--help to see options) - make (the make from gnu, gmake for *BSD) - su - make -n install (to see where all the files will go) - make install (to really install) - - + + &buildsource; + For Redhat and SuSE Linux RPM packages, see below. - - -Red Hat +Red Hat - To build Redhat RPM packages, install source as above. Then: + To build Redhat RPM packages from source, install source as above. Then: @@ -212,10 +182,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm + rpm -Uvv /usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm This will place the Privoxy configuration files in /etc/privoxy/, and log files in - /var/log/privoxy/. + /var/log/privoxy/. Run + ckconfig privoxy on to have + Privoxy start automatically during init. + - + -SuSE +SuSE To build SuSE RPM packages, install source as above. Then: @@ -256,10 +229,10 @@ You can find the latest version of the user manual at - rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm + rpm -Uvv /usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm This will place the Privoxy configuration files in /etc/privoxy/, and log files in - /var/log/privoxy/. + /var/log/privoxy/. - + -OS/2 +OS/2 -Windows +Windows Click-click. (I need help on this. Not a clue here. Also for configuration section below. HB.) - + -Other +Other Some quick notes on other Operating Systems. @@ -361,6 +334,7 @@ configuration section below. HB.) The rest should be the same as above for Linux/Unix. + @@ -3187,50 +3161,12 @@ icon being being cached by the browser, which will speed up the display. Contacting the Developers, Bug Reporting and Feature Requests - -We value your feedback. However, to provide you with the best support, -please note: - - - - Use the Sourceforge support forum to get - help. - - Submit bugs only thru our Sourceforge bug - forum. - - - Make sure that the bug has not already been submitted. Please try to - verify that it is a Privoxy bug, and not a - browser or site bug first. If you are using your own custom configuration, - please try the stock configs to see if the problem is a configuration - related bug. And if not using the latest development snapshot, please try - the latest one. Or even better, CVS sources. Please be sure to include the - Privoxy/Junkbuster - version, platform, browser, any pertinent log data, any other relevant - details (please be specific) and, if possible, some way to reproduce the - bug. - - - - Submit feature requests only thru our Sourceforge feature request forum. - - + - + &contacting; - -For any other issues, feel free to use the mailing lists. - - - - Anyone interested in actively participating in development and related - discussions can join the appropriate mailing list - here. - Archives are available here too. - + @@ -3259,7 +3195,6 @@ For any other issues, feel free to use the See Also - -&seealso; + + + + &seealso; + + @@ -4050,6 +3987,9 @@ For any other issues, feel free to use the