Structural changes to allow for conditional inclusion/exclusion of content
authorhal9 <hal9@users.sourceforge.net>
Thu, 4 Apr 2002 06:48:37 +0000 (06:48 +0000)
committerhal9 <hal9@users.sourceforge.net>
Thu, 4 Apr 2002 06:48:37 +0000 (06:48 +0000)
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 [new file with mode: 0644]
doc/source/contacting.sgml
doc/source/developer-manual.sgml
doc/source/faq.sgml
doc/source/privoxy.sgml
doc/source/readme.sgml
doc/source/supported.sgml
doc/source/user-manual.sgml

diff --git a/doc/source/buildsource.sgml b/doc/source/buildsource.sgml
new file mode 100644 (file)
index 0000000..bc439ba
--- /dev/null
@@ -0,0 +1,89 @@
+<!--
+ File        :  $Source: /cvsroot/ijbswa/current/doc/source/buildsource.sgml,v $
+
+ Purpose     :  Entity included in other project documents.
+                
+ $Id: buildsource.sgml,v 1.0 2002/04/04 01:14:18 hal9 Exp $
+
+ Written by and Copyright (C) 2001 the SourceForge
+ Privoxy team. http://www.privoxy.org/
+
+ 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.
+ ======================================================================
+
+-->
+<para>
+ There are several ways to install <application>Privoxy</application>.
+</para>
+
+<para>
+ To build <application>Privoxy</application> from source, 
+ autoconf and GNU make (gmake) are required. Source is available as gzipped
+ tar archives. For this, first unpack the source: 
+</para>
+
+<para>
+ <screen>
+ tar xzvf privoxy-&p-version;<![%p-not-stable;[-beta]]>-src* [.tgz or .tar.gz]
+ cd privoxy-&p-version;<![%p-not-stable;[-beta]]>
+ </screen>
+</para>
+
+
+<para>
+ 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:
+</para>
+
+<para>
+ <screen>
+  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
+ </screen>
+</para>
+
+<para>
+ This will create a directory named <filename>current/</filename>, which will 
+ contain the source tree.
+</para>
+
+<para>
+ Then, in either case, to build from unpacked tarball or CVS source:
+</para>
+
+<para>
+ <screen>
+ 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)
+ </screen>
+</para>
+
+<para>
+ Redhat and SuSE src and binary RPMs can be built with 
+ <quote><command>make redhat-dist</command></quote> or
+ <quote><command>make suse-dist</command></quote> from unpacked sources. You
+ will need to run <quote><command>autoconf; autoheader;
+ ./configure</command></quote> beforehand. *BSD will require gmake (from
+ <ulink url="http://gnu.org">http://gnu.org</ulink>). 
+ <![%p-readme;[See the user-manual for OS/2 build instructions.]]>
+</para>
+
+ <![%p-readme;[
+ <para>
+  For binary RPM installation, and other platforms, see the user-manual 
+  as well.
+ </para>
+]]>
index 892f683..0f173b3 100644 (file)
@@ -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/
  <para> forces a linebreak.
  ======================================================================
 
+
+ ======================================================================
+  This file used for inclusion with other documents only.
+ ======================================================================
+
 -->
 
 <para>
index 562a3df..5dc4bff 100644 (file)
@@ -3,6 +3,12 @@
 <!entity supported SYSTEM "supported.sgml">
 <!entity newfeatures SYSTEM "newfeatures.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">
+<!entity p-version "2.9.13">
+<!entity p-status "BETA">
+<!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release  -->
+<!entity % p-stable "IGNORE">      <!-- set INCLUDE for stable release    -->
+<!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
+<!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
@@ -11,7 +17,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: developer-manual.sgml,v 1.19 2002/04/03 15:09:42 david__schmidt Exp $
+ $Id: developer-manual.sgml,v 1.20 2002/04/04 03:28:27 david__schmidt Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
@@ -25,7 +31,7 @@
   <artheader>
     <title>Privoxy Developer Manual</title>
 
-    <pubdate>$Id: developer-manual.sgml,v 1.19 2002/04/03 15:09:42 david__schmidt Exp $</pubdate>
+    <pubdate>$Id: developer-manual.sgml,v 1.20 2002/04/04 03:28:27 david__schmidt Exp $</pubdate>
 
     <authorgroup>
       <author>
  team. It provides guidance on coding, testing, documentation and other
  issues. 
  </para>
-<!--
- Include privoxy.sgml:
--->
-&p-intro;
+
+<!-- Include privoxy.sgml boilerplate text: -->
+
+ &p-intro;
+
+<!-- end boilerplate -->
 
 <para>
  You can find the latest version of the this manual at <ulink
@@ -1312,7 +1320,7 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
 
     <para><emphasis>Example for file comments:</emphasis></para>
 <programlisting>
-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        :  $S<!-- Break CVS Substitution -->ource$
@@ -1372,7 +1380,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
 <programlisting>
 #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        :  $S<!-- Break CVS Substitution -->ource$
@@ -1713,9 +1721,11 @@ at sourceforge. Three simple steps:
        <programlisting>
   os2build
        </programlisting>
-       And in the <filename>./files</filename> directory you will have the WarpIN-installable executable.
-       Upload this anonymously to <filename>uploads.sourceforge.net/incoming</filename>,
-       create a release for it, and you're done.
+     And in the <filename>./files</filename> directory you will have the
+     WarpIN-installable executable. 
+     Upload this anonymously to
+     <filename>uploads.sourceforge.net/incoming</filename>, create a release
+     for it, and you're done.
        </para>
     </sect2>
 
@@ -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
 
index f4afd4d..4d17476 100644 (file)
@@ -4,6 +4,13 @@
 <!entity newfeatures SYSTEM "newfeatures.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">
 <!entity seealso SYSTEM "seealso.sgml">
+<!entity p-version "2.9.13">
+<!entity p-status "BETA">
+<!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release  -->
+<!entity % p-stable "IGNORE">      <!-- set INCLUDE for stable release    -->
+<!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
+<!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
+<!entity % p-supp-userman "INCLUDE"> <!-- Include all from supported.sgml -->
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/faq.sgml,v $
@@ -12,7 +19,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: faq.sgml,v 1.39 2002/04/03 03:53:03 hal9 Exp $
+ $Id: faq.sgml,v 1.40 2002/04/03 04:22:03 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
@@ -43,7 +50,7 @@
 <artheader>
 <title>Privoxy Frequently Asked Questions</title>
 
-<pubdate>$Id: faq.sgml,v 1.39 2002/04/03 03:53:03 hal9 Exp $</pubdate>
+<pubdate>$Id: faq.sgml,v 1.40 2002/04/03 04:22:03 hal9 Exp $</pubdate>
 
 <authorgroup>
  <author>
@@ -1380,6 +1387,9 @@ This is referenced in the doc header already. HB 03/25/02
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
 $Log: faq.sgml,v $
+Revision 1.40  2002/04/03 04:22:03  hal9
+Fixed several typos.
+
 Revision 1.39  2002/04/03 03:53:03  hal9
 Revert some changes, and then make some news, to layout, and appearance.
 
index 0128c6d..d6174e5 100644 (file)
@@ -3,7 +3,7 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: privoxy.sgml,v 1.0 2002/04/01 16:24:49 hal9 Exp $
+ $Id: privoxy.sgml,v 1.1 2002/04/02 00:54:19 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
  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.
+ ======================================================================
+
 -->
 
 <para>
index c795c1d..91a2a98 100644 (file)
@@ -1,16 +1,23 @@
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN" [
 <!entity % dummy "INCLUDE"> 
 <!entity supported SYSTEM "supported.sgml">
-<!entity newfeatures SYSTEM "newfeatures.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">
-<!entity seealso SYSTEM "seealso.sgml">
+<!entity contacting SYSTEM "contacting.sgml">
+<!entity buildsource SYSTEM "buildsource.sgml">
+<!entity p-version "2.9.13">
+<!entity p-status "BETA">
+<!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release -->
+<!entity % p-stable "IGNORE">      <!-- set INCLUDE for stable release   -->
+<!entity % p-text "INCLUDE">       <!-- define we are a text only doc    -->
+<!entity % p-doc "IGNORE">         <!-- and never a text doc             -->
+<!entity % p-readme "INCLUDE">     <!-- all your README belong to us     -->
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
 
  Purpose     :  README for Privoxy
                 
- $Id: readme.sgml,v 1.0 2002/04/03 03:53:43 hal9 Exp $
+ $Id: readme.sgml,v 1.1 2002/04/03 06:01:41 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
  Junkbusters Corporation.  http://www.junkbusters.com
 
  ===================================================================
- READ: Document note: This file generates the README in the top level 
+ READ: Document Note: This file generates the README in the top level 
  source directory. It is generated as only a plain text file. The 
  current markup is not suitable for other formats. Build from 
  Makefile with 'make readme'.
  ===================================================================
 
+ READ:
+
+ ======================================================================
+ NOTE: The left margin spacing is *important* when using 'literallayout'
+ WYSISWYG!!! Don't mess this up!!! Careful with linebreaks too, ie 
+ the para tag forces a linebreak. Tags need to be carefully placed as a result.
+ ======================================================================
+
+ For stable releases, change 
+  entity % p-not-stable "INCLUDE" 
+ to 
+  entity % not-stable "IGNORE" 
+  
+ in the DTD at the top. This will toggle various text 'off'. BOTH
+ MUST be toggled in this case.
+
 -->
 
 <article id="index">
@@ -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.
  *
 </para>
 
 <para>
- 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 :)
+ <!-- include some conditional text -->
+ This README is included with <![%p-not-stable;[ the development version of]]>
+ Privoxy &p-version;<![%p-not-stable;[, which will eventually become Privoxy v3.0 (and soon we
+ hope!)]]>. See http://www.privoxy.org/ for more information. The current code
+ level is &p-status;<![%p-not-stable;[, and seems stable to us :)]]>.
 </para>
 
-<!--
- Include privoxy.sgml
--->
+<!-- Include privoxy.sgml boilerplate: -->
 &p-intro;
+<!-- end boilerplate -->
 
 <para>
  <LiteralLayout>
  the new package will delete any previously installed 'Junkbuster' packages.
 </para>
 <para>
- 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.
 </para>
  INSTALL
 --------</LiteralLayout>
 </para>
-<para>
- For tarball, first unpack:
-</para>
-
-<programlisting>
- tar xzvf privoxy-2.9.13-beta-src.tar.gz
- cd privoxy-2.9.13-beta
-</programlisting>
-
-<programlisting>
- 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)
-</programlisting>
-
-<para>
- 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.
-</para>
-<para>
- Privoxy is also available via anonymous CVS:
-</para>
 
-<programlisting>
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
-</programlisting>
-<para>
- This will create a directory named 'current'. Then, 'cd current', and then
- build as above.
-</para>
+<!-- include buildsource.sgml boilerplate: -->
+ &buildsource;
+<!-- end boilderplate -->
 
 <para>
  <LiteralLayout>
@@ -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.
 </para>
+<![%p-not-stable;[
 <para>
  All configuration files are subject to unannounced changes during the
  development process.
 </para>
+]]>
 
 <para>
  <LiteralLayout>
 
  DOCUMENTATION
 --------------</LiteralLayout>
- 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<![%p-not-stable;[, but it
+ is not completed at this point]]>. In particular, see the user-manual there,
+ the faq, and those interested in Privoxy development, should look at
+ developer-manual. 
 </para>
 <para>
+ <![%p-not-stable;[
  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, which are all well commented. These are 'config',
- '*.action', and 'default.filter' in the toplevel source directory.
+ configuration files. ]]>The source and configuration files are all well
+ commented. The main configuration files are: 'config', 'default.action', and
+ 'default.filter'<![%p-not-stable;[ in the toplevel source directory]]>. There
+ are several *.action files included, with varying levels of aggressiveness.
 </para>
 
 <para>
@@ -242,56 +241,10 @@ See the man page or user-manual for a brief explanation of each option.
 --------------------------------------------------------------</LiteralLayout>
 </para>
 
-<para>
-We value your feedback. However, to provide you with the best support,
-please note:
-</para>
-<para>
- <LiteralLayout>
- * Use the support forum to get help:
-   http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118
-  </LiteralLayout>
-</para>
-<Para>
- <LiteralLayout>
- * Submit bugs only thru our bug forum:
-   http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118 
- </LiteralLayout>
-</Para>
-<para>
-   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.
-</para>
-<para>
- <LiteralLayout>
- * Submit feature requests only thru our feature request forum:
-   http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118&#38;func=browse
- </LiteralLayout>
-</para>
+<!-- Include contacting.sgml boilerplate: -->
+ &contacting;
+<!-- end boilerplate -->
 
-<para>
- <LiteralLayout>
- For any other issues, feel free to use the mailing lists:
- http://sourceforge.net/mail/?group_id=11118 
- </LiteralLayout>
-</para>
-
-<para>   
- <LiteralLayout>
- 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.
- </LiteralLayout>
-</para>
 <para>
  <LiteralLayout>
  -------------------------------------------------------------------------
@@ -299,7 +252,7 @@ please note:
  </LiteralLayout>
 </para>
 <para>
- $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 $
 </para>
 
 </article>
index dbb9e31..1b38fb3 100644 (file)
@@ -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/
  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.
+ ======================================================================
+
 -->
 <para>
  At present, <application>Privoxy</application> 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 
- <ulink
- url="http://sourceforge.net/project/showfiles.php?group_id=11118">http://sourceforge.net/project/showfiles.php?group_id=11118</ulink>.
+ OSX, OS/2, AmigaOS, Linux, and many flavors of Unix. There are source 
+ and binary releases for these available for download at 
+ <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">http://sourceforge.net/project/showfiles.php?group_id=11118</ulink>.
 </para>
+
+<![%p-supp-userman;[
 <para>
  But any operating system that runs TCP/IP, can conceivably take advantage of
  <application>Privoxy</application> in a networked situation where
@@ -31,4 +37,4 @@
  Source code is freely available, so porting to other operating systems, 
  is always a possibility.
 </para>
-
+]]>
index 36f39d8..02874ea 100644 (file)
@@ -4,6 +4,16 @@
 <!entity newfeatures SYSTEM "newfeatures.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">
 <!entity seealso SYSTEM "seealso.sgml">
+<!entity buildsource SYSTEM "buildsource.sgml">
+<!entity contacting SYSTEM "contacting.sgml">
+<!entity p-version "2.9.13">
+<!entity p-status "BETA">
+<!entity % p-not-stable "INCLUDE"> <!-- set to IGNORE for stable release  -->
+<!entity % p-stable "IGNORE">      <!-- set INCLUDE for stable release    -->
+<!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
+<!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
+<!entity % p-readme "IGNORE">
+<!entity % p-supp-userman "IGNORE"> <!-- Omit some from supported.sgml    -->
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/user-manual.sgml,v $
@@ -12,7 +22,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $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 $
 
  Written by and Copyright (C) 2001 the SourceForge
  Privoxy team. http://www.privoxy.org/
  Based on the Internet Junkbuster originally written
  by and Copyright (C) 1997 Anonymous Coders and 
  Junkbusters Corporation.  http://www.junkbusters.com
--->
-
-<!--
-Sat 03/02/02 04:53:47 PM
 
-This should be ready for BETA release.
-
-Hal Burgiss <hal@foobox.net>
 -->
 
 <article id="index">
 <artheader>
 <title>Privoxy User Manual</title>
 
-<pubdate>$Id: user-manual.sgml,v 1.64 2002/04/03 03:53:43 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.65 2002/04/03 19:52:07 swa Exp $</pubdate>
 
 <authorgroup>
  <author>
@@ -67,8 +70,9 @@ Hal Burgiss <hal@foobox.net>
   stand-alone systems and multi-user networks.
  </para>
  <para>
-You can find the latest version of the user manual at  <ulink url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
- </para>
+  You can find the latest version of the user manual at  <ulink
+  url="http://www.privoxy.org/user-manual/">http://www.privoxy.org/user-manual/</ulink>.
+  </para>
 
 <!--   <para> -->
 <!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
@@ -81,13 +85,13 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 <!--   ~~~~~       New section      ~~~~~     -->
 
 <sect1 id="introduction"><title>Introduction</title>
-<!--
- Include privoxy.sgml boilerplate:
--->
-&p-intro;
+
+<!-- Include privoxy.sgml boilerplate: -->
+ &p-intro;
+<!-- end boilerplate -->
 
 <para>
- This documentation is included with the current BETA version of
+ This documentation is included with the current &p-status; version of
  <application>Privoxy</application> 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  <ulink url="http://www.pr
  stable v3.0 is <quote>soon</quote> ;-)
 </para>
 
+<![%p-not-stable;[
+<!-- include only in non-stable versions -->
 <para>
- Since this is a BETA version, not all new features are well tested. This
+ Since this is a &p-status; version, not all new features are well tested. This
  documentation may be slightly out of sync as a result (especially with 
  CVS sources). And there <emphasis>may be</emphasis> bugs, though hopefully
  not many! 
 </para>
-
+]]>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2>
@@ -110,15 +116,13 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 <para>
  In addition to <application>Internet Junkbuster's</application> traditional
  feature of ad and banner blocking and cookie management,
- <application>Privoxy</application> provides new features, some of them
currently under development:
+ <application>Privoxy</application> provides new features<![%p-not-stable;[,
some of them currently under development]]>:
 </para>
 
-<!--
- Include newfeatures.sgml here:
--->
-
-&newfeatures;
+<!-- Include newfeatures.sgml boilerplate here: -->
+ &newfeatures;
+<!-- end boilerplate -->
 
 </sect2>
 
@@ -130,72 +134,38 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="installation"><title>Installation</title>
 <para>
- <application>Privoxy</application> is available as raw source code, or
pre-compiled binaries. See the <ulink
- url="http://sourceforge.net/projects/ijbswa/">Privoxy Home Page</ulink>
- for binaries and current release info. <application>Privoxy</application>
- is also available via <ulink
+ <application>Privoxy</application> is available as raw source code (tarball 
or via CVS), or pre-compiled binaries for various platforms. See the <ulink
+ url="http://sourceforge.net/projects/ijbswa/">Privoxy Project Page</ulink> for
+ the most up to date release information.
<application>Privoxy</application> is also available via <ulink
  url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
- This is the recommended approach at this time. But please be aware that CVS 
- is constantly changing, and it may break in mysterious ways.
+ <![%p-not-stable;[This is the recommended approach at this time.]]> But
+ please be aware that CVS is constantly changing, and it may break in
+ mysterious ways.
 </para>
 
+<!-- Include supported.sgml boilerplate -->
+ &supported;
+<!-- end boilerplate -->
+
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2 id="installation-source"><title>Source</title>
-<para>
- For gzipped tar archives, unpack the source:
-</para>
-
-<para>
- <screen>
- tar xzvf privoxy-2.9.13-beta-src* [.tgz or .tar.gz]
- cd privoxy-2.9.13-beta
- </screen>
-</para>
-
-<para>
- For retrieving the current CVS sources, you'll need the CVS 
- package installed first. To download CVS source:
-</para>
 
-<para>
- <screen>
-  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
- </screen>
-</para>
 
-<para>
- This will create a directory named <filename>current/</filename>, which will 
- contain the source tree.
-</para>
-
-<para>
- Then, in either case, to build from tarball/CVS source:
-</para>
-
-<para>
- <screen>
- ./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)
- </screen>
-</para>
+<!-- include buildsource.sgml boilerplate: -->
+ &buildsource;
+<!-- end boilerplate -->
 
 <para>
  For Redhat and SuSE Linux RPM packages, see below.
 </para>
 
-</sect2>
-
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-rh"><title>Red Hat</title>
+<sect3 id="installation-rh"><title>Red Hat</title>
 <para>
- To build Redhat RPM packages, install source as above. Then:
+ To build Redhat RPM packages from source, install source as above. Then:
 </para>
 
 <para>
@@ -212,10 +182,10 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 </para>
 
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/redhat/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/redhat/RPMS/i686/privoxy-&p-version;-1.i686.rpm
 </para>
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/redhat/SRPMS/privoxy-2.9.11-1.src.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/redhat/SRPMS/privoxy-&p-version;-1.src.rpm
 </para>
 
 <para>
@@ -224,20 +194,23 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 
 <para>
  <screen>
- 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
  </screen>
 </para>
 
 <para>
  This will place the <application>Privoxy</application> configuration 
  files in <filename>/etc/privoxy/</filename>, and log files in 
- <filename>/var/log/privoxy/</filename>.
+ <filename>/var/log/privoxy/</filename>. Run 
+ <command>ckconfig privoxy on</command> to have
+ <application>Privoxy</application> start automatically during init.
+
 </para>
 
-</sect2>
+</sect3>
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-suse"><title>SuSE</title>
+<sect3 id="installation-suse"><title>SuSE</title>
 <para>
  To build SuSE RPM packages, install source as above. Then:
 </para>
@@ -256,10 +229,10 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 </para>
 
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/packages/RPMS/i686/privoxy-2.9.11-1.i686.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/packages/RPMS/i686/privoxy-&p-version;-1.i686.rpm
 </para>
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/packages/SRPMS/privoxy-2.9.11-1.src.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/packages/SRPMS/privoxy-&p-version;-1.src.rpm
 </para>
 
 <para>
@@ -268,21 +241,21 @@ You can find the latest version of the user manual at  <ulink url="http://www.pr
 
 <para>
  <screen>
- 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
  </screen>
 </para>
 
 <para>
  This will place the <application>Privoxy</application> configuration 
  files in <filename>/etc/privoxy/</filename>, and log files in 
- <filename>/var/log/privoxy/</filename>.
+ <filename>/var/log/privoxy/</filename>. 
 </para>
 
-</sect2>
+</sect3>
 
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-os2"><title>OS/2</title>
+<sect3 id="installation-os2"><title>OS/2</title>
 
 <!--
 Thanx David Schmidt!
@@ -292,7 +265,7 @@ Thanx David Schmidt!
  <application>Privoxy</application> is packaged in a WarpIN self-
  installing archive.  The self-installing program will be named depending
  on the release version, something like:
- <filename>privoxyos2_setup_1.2.3.exe</filename>.  In order to install it, simply
+ <filename>privoxyos2_setup_&p-version;.exe</filename>.  In order to install it, simply
  run this executable or double-click on its icon and follow the WarpIN
  installation panels.  A shadow of the <application>Privoxy</application>
  executable will be placed in your startup folder so it will start 
@@ -338,18 +311,18 @@ Thanx David Schmidt!
  You will see this sequence laid out in <filename>os2build.cmd</filename>.
 </para>
 
-</sect2>
+</sect3>
 
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-win"><title>Windows</title>
+<sect3 id="installation-win"><title>Windows</title>
 <para>Click-click. (I need help on this. Not a clue here. Also for 
 configuration section below. HB.)
 </para>
-</sect2>
+</sect3>
 
 <!--   ~~~~~       New section      ~~~~~     -->
-<sect2 id="installation-other"><title>Other</title>
+<sect3 id="installation-other"><title>Other</title>
 <para>
  Some quick notes on other Operating Systems.
 </para>
@@ -361,6 +334,7 @@ configuration section below. HB.)
  The rest should be the same as above for Linux/Unix.
 </para>
 
+</sect3>
 </sect2>
 
 </sect1>
@@ -3187,50 +3161,12 @@ icon being being cached by the browser, which will speed up the display.
 
 <sect1 id="contact"><title>Contacting the Developers, Bug Reporting and Feature
 Requests</title>
-<para>
-We value your feedback. However, to provide you with the best support,
-please note:
-
- <itemizedlist>
-
-  <listitem><para>Use the <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=211118">Sourceforge support forum</ulink> to get
-  help.</para></listitem>
-  <listitem><para>Submit bugs only thru our <ulink url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=111118">Sourceforge bug
-      forum</ulink>. 
-  </para>
-  <para>
-   Make sure that the bug has not already been submitted.  Please try to
-   verify that it is a <application>Privoxy</application> 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
-   <application>Privoxy</application>/<application>Junkbuster</application>
-   version, platform, browser, any pertinent log data, any other relevant
-   details (please be specific) and, if possible, some way to reproduce the
-   bug.
-  </para>
- </listitem>
-  <listitem><para>Submit feature requests only thru our <ulink
-      url="http://sourceforge.net/tracker/?atid=361118&#38;group_id=11118&#38;func=browse">Sourceforge feature request forum</ulink>.</para></listitem>
-
 
- </itemizedlist>
+<!-- Include contacting.sgml boilerplate: -->
 
-</para>
+ &contacting;
 
-<para>
-For any other issues, feel free to use the <ulink url="http://sourceforge.net/mail/?group_id=11118">mailing lists</ulink>.
-</para>
-
-<para>
- Anyone interested in actively participating in development and related 
- discussions can join the appropriate mailing list  
- <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
- Archives are available here too.
-</para>
+<!-- end boilerplate -->
 
 </sect1>
 
@@ -3259,7 +3195,6 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
  License, or (at your option) any later version.
 </para>
 
-
 <para>
  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
@@ -3310,10 +3245,12 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="seealso"><title>See Also</title>
-<!--
- Include seealso.sgml:
--->
-&seealso;
+
+<!-- Include seealso.sgml: -->
+
+ &seealso;
+
+<!-- end boilerplate -->
 
 </sect1>
 
@@ -4050,6 +3987,9 @@ For any other issues, feel free to use the <ulink url="http://sourceforge.net/ma
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $
+ Revision 1.65  2002/04/03 19:52:07  swa
+ enhance squid section due to user suggestion
+
  Revision 1.64  2002/04/03 03:53:43  hal9
  A few minor bug fixes, and touch ups. Ready for review.