Update version-related entities.

[privoxy.git] / doc / source / developer-manual.sgml

diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index 8a5af0c..60ca51b 100644 (file)
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -1,5 +1,5 @@
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[
 <!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V3.1//EN"[

-<!entity % dummy "INCLUDE"> 
+<!entity % dummy "IGNORE"> 

 <!entity supported SYSTEM "supported.sgml">
 <!entity newfeatures SYSTEM "newfeatures.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">
 <!entity supported SYSTEM "supported.sgml">
 <!entity newfeatures SYSTEM "newfeatures.sgml">
 <!entity p-intro SYSTEM "privoxy.sgml">


@@ -7,12 +7,14 @@
 <!entity seealso SYSTEM "seealso.sgml">
 <!entity contacting SYSTEM "contacting.sgml">
 <!entity copyright SYSTEM "copyright.sgml">
 <!entity seealso SYSTEM "seealso.sgml">
 <!entity contacting SYSTEM "contacting.sgml">
 <!entity copyright SYSTEM "copyright.sgml">

-<!entity p-version "2.9.14">
-<!entity p-status "beta">
-<!entity % p-not-stable "INCLUDE">
-<!entity % p-stable "IGNORE">
+<!entity license SYSTEM "license.sgml">
+<!entity p-version "3.0.10">
+<!entity p-status "stable">
+<!entity % p-not-stable "IGNORE">
+<!entity % p-stable "INCLUDE">

 <!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
 <!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->
 <!entity % p-text "IGNORE">        <!-- define we are not a text only doc -->
 <!entity % p-doc "INCLUDE">        <!-- and we are a formal doc           -->

+<!entity  my-copy "&copy;">        <!-- kludge for docbook2man            -->

 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $
 ]>
 <!--
  File        :  $Source: /cvsroot/ijbswa/current/doc/source/developer-manual.sgml,v $


@@ -21,15 +23,10 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 

- $Id: developer-manual.sgml,v 1.27 2002/04/08 15:31: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
+ $Id: developer-manual.sgml,v 2.20 2008/06/14 13:21:24 fabiankeil Exp $

 
 

+ Copyright (C) 2001-2008 Privoxy Developers http://www.privoxy.org/
+ See LICENSE.

 
  ========================================================================
  NOTE: Please read developer-manual/documentation.html before touching 
 
  ========================================================================
  NOTE: Please read developer-manual/documentation.html before touching 


@@ -43,18 +40,37 @@
 <article id="index">
   <artheader>
     <title>Privoxy Developer Manual</title>
 <article id="index">
   <artheader>
     <title>Privoxy Developer Manual</title>

+    <pubdate>
+     <subscript>
+    <!-- Completely the wrong markup, but very little is allowed  -->
+    <!-- in this part of an article. FIXME -->
+      <link linkend="copyright">Copyright</link> &my-copy; 2001-2008 by 
+      <ulink url="http://www.privoxy.org/">Privoxy Developers</ulink>
+     </subscript>
+    </pubdate>
+
+
+    <pubdate>$Id: developer-manual.sgml,v 2.20 2008/06/14 13:21:24 fabiankeil Exp $</pubdate>
+
+<!--
+
+Note: this should generate a separate page, and a live link to it. 
+But it doesn't for some mysterious reason. Please leave commented
+unless it can be fixed proper. For the time being, the copyright 
+statement will be in copyright.smgl.
+
+Hal.

 
 

-    <pubdate>$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $</pubdate>
+<legalnotice id="legalnotice"> 
+ <para>
+  text goes here ........
+ </para>
+</legalnotice>

 
 

-    <authorgroup>
-      <author>
-        <affiliation>
-          <orgname>By: Privoxy Developers</orgname>
-        </affiliation>
-      </author>
-    </authorgroup>
+-->

 
     <abstract>
 
     <abstract>

+

 <![%dummy;[
  <para>
  <comment>
 <![%dummy;[
  <para>
  <comment>


@@ -65,23 +81,28 @@
  </para>
  ]]>
 <para>
  </para>
  ]]>
 <para>

- The developer manual gives the users information on how to help the developer
- team. It provides guidance on coding, testing, documentation and other
- issues. 
- </para>
+ The developer manual provides guidance on coding, testing, packaging, documentation
+ and other issues of importance to those involved with
+ <application>Privoxy</application> development. It is mandatory (and helpful!) reading
+ for anyone who wants to join the team. Note that it's currently out of date
+ and may not be entirely correct. As always, patches are welcome.
+</para>

 
 <!-- Include privoxy.sgml boilerplate text: -->
 
 
 <!-- Include privoxy.sgml boilerplate text: -->
 

- &p-intro;
+<!--  &p-intro; Someone interested enough in the project to contribute
+                will already know at this point what Privoxy is. -->

 
 <!-- end boilerplate -->
 
 <para>
 
 <!-- end boilerplate -->
 
 <para>

+ Please note that this document is constantly evolving. This copy represents
+ the state at the release of version &p-version;.

  You can find the latest version of the this manual at <ulink
  url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.
  You can find the latest version of the this manual at <ulink
  url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.

- Please see the Contact section on how to contact the developers.
+ Please see <link linkend="contact">the Contact section</link> 
+ on how to contact the developers.

 </para>
 </para>

-

 <!--        <para> -->
 <!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
 <!--   </para> -->
 <!--        <para> -->
 <!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
 <!--   </para> -->


@@ -89,18 +110,9 @@
     </abstract>
   </artheader>
 
     </abstract>
   </artheader>
 

-<!--   ~~~~~       New section      ~~~~~     -->
-<sect1 id="intro" label=""><title></title>
-<!-- dummy section to force TOC on page by itself -->
-<!-- DO NOT REMOVE! please ;) -->
-<para> </para>
-</sect1>
-
-<!--   ~~~~~       New section      ~~~~~     -->
-

 
 <!--   ~~~~~       New section      ~~~~~     -->
 
 <!--   ~~~~~       New section      ~~~~~     -->

-  <sect1 label="1" id="introduction"><title>Introduction</title>
+  <sect1 id="introduction"><title>Introduction</title>

 <!--
 
  I don't like seeing blank space :) So added *something* here.
 <!--
 
  I don't like seeing blank space :) So added *something* here.


@@ -108,54 +120,217 @@
  --> 
     <para>
      <application>Privoxy</application>, as an heir to
  --> 
     <para>
      <application>Privoxy</application>, as an heir to

-     <application>Junkbuster</application>, is an Open Source project 
-     and licensed under the GPL. As such, <application>Privoxy</application>
-     development is potentially open to anyone who has the time, knowledge,
-     and desire to contribute in any capacity. Our goals are simply to
-     continue the mission, to improve <application>Privoxy</application>, and
+     <application>Junkbuster</application>, is a Free Software project 
+     and the code is licensed under the GNU General Public License version 2.
+     As such, <application>Privoxy</application> development is potentially open
+     to anyone who has the time, knowledge, and desire to contribute
+     in any capacity. Our goals are simply to continue the mission,
+     to improve <application>Privoxy</application>, and

      to make it available to as wide an audience as possible. 
     </para>
     <para>
      One does not have to be a programmer to contribute. Packaging, testing,
      to make it available to as wide an audience as possible. 
     </para>
     <para>
      One does not have to be a programmer to contribute. Packaging, testing,

-     and porting, are all important jobs as well.
+     documenting and porting, are all important jobs as well.
+    </para>
+
+  <!--   ~~~~~       New section      ~~~~~     -->
+  <sect2 id="quickstart"><title>Quickstart to Privoxy Development</title>
+   <!-- 
+    <para>
+      You'll need an account on <ulink
+      url="http://sourceforge.net/">Sourceforge</ulink> to support our
+      development.  Mail your ID to <ulink
+      url="mailto:developers@privoxy.org">the list</ulink> and wait until a
+      project manager has added you.

     </para>
     </para>

+   --> 
+   <para>
+    The first step is to join the <ulink
+      url="mailto:ijbswa-developers@lists.sourceforge.net">developer's mailing list</ulink>.
+    You can submit your ideas, or even better patches. Patches are best 
+    submitted to the Sourceforge tracker set up for this purpose, but 
+    can be sent to the list for review too.
+   </para>
+    <para>
+     You will also need to have a cvs package installed, which will 
+     entail having ssh installed as well (which seems to be a requirement of
+     SourceForge), in order to access the cvs repository. Having the GNU build
+     tools is also going to be important (particularly, autoconf and gmake).
+    </para>
+    <para>
+      For the time being (read, this section is under construction), you can 
+      also refer to the extensive comments in the source code. In fact, 
+      reading the code is recommended in any case.
+    </para>
+   </sect2>

   </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->
   </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->

-  <sect1 id="quickstart"><title>Quickstart to Privoxy Development</title>
+  <sect1 id="cvs"><title>The CVS Repository</title>

     <para>
     <para>

-You'll need an account on <ulink
-url="http://sourceforge.net">Sourceforge</ulink> to support our development.
-Mail your ID to the list and wait until a project manager has added you.
-</para>
+      If you become part of the active development team, you will eventually
+      need write access to our holy grail, the CVS repository. One of the 
+      team members will need to set this up for you. Please read
+      this chapter completely before accessing via CVS.
+    </para>

 
 

-<para>
-For the time being (read, this section is under construction), please note the
-following guidelines for changing stuff in the code. If it is
-       <orderedlist numeration="arabic">
-                       <listitem><para>
-               A bugfix / clean-up / cosmetic thing: shoot
-                       </para></listitem>
-               <listitem><para>
-               A new feature that can be turned off: shoot
-                       </para></listitem>
-               <listitem><para>
-               A clear improvement w/o side effects on other parts of the code: shoot
-                </para></listitem>
-               <listitem><para>
-               A matter of taste: ask the list
-               </para></listitem>
-               <listitem><para>
-               A major redesign of some part of the code: ask the list
-                </para></listitem>
-        </orderedlist> 
- </para>               
-</sect1>       
+    <sect2 id="cvsaccess"><title>Access to CVS</title>
+      <para>
+        The project's CVS repository is hosted on
+        <ulink url="http://sourceforge.net/">SourceForge.</ulink>
+        Please refer to the chapters 6 and 7 in
+        <ulink url="http://sourceforge.net/docman/?group_id=1">SF's site
+        documentation</ulink> for the technical access details for your
+        operating system. For historical reasons, the CVS server is
+        called <literal>ijbswa.cvs.sourceforge.net</literal>, the repository is
+        called <literal>ijbswa</literal>, and the source tree module is called
+        <literal>current</literal>.
+      </para>
+    </sect2>
+
+    <sect2 id="cvsbranches">
+    <title>Branches</title>
+     <para>
+       Within the CVS repository, there are modules and branches. As
+       mentioned, the sources are in the <literal>current</literal>
+       <quote>module</quote>. Other modules are present for platform specific
+       issues. There is a webview of the CVS hierarchy at <ulink
+       url="http://ijbswa.cvs.sourceforge.net/ijbswa/">http://ijbswa.cvs.sourceforge.net/ijbswa/</ulink>,
+       which might help with visualizing how these pieces fit together.
+     </para>
+     <para>
+       Branches are used to fork a sub-development path from the main trunk.
+       Within the <literal>current</literal> module where the sources are, there
+       is always at least one <quote>branch</quote> from the main trunk
+       devoted to a stable release series. The main trunk is where active
+       development takes place for the next stable series (e.g. 3.2.x).
+       So just prior to each stable series (e.g. 3.0.x), a branch is created
+       just for stable series releases (e.g. 3.0.0 -> 3.0.1 -> 3.0.2, etc).
+       Once the initial stable release of any stable branch has taken place,
+       this branch is <emphasis>only used for bugfixes</emphasis>, which have
+       had prior testing before being committed to CVS. (See <link
+       linkend="versionnumbers">Version Numbers</link> below for details on
+       versioning.)
+     </para>
+     <para>
+      At one time there were two distinct branches: stable and unstable. The
+      more drastic changes were to be in the unstable branch. These branches 
+      have now been merged to minimize time and effort of maintaining two 
+      branches.
+     </para>
+    <!-- 
+     <para>
+       This will result in at least two active branches, which means there may
+       be occasions that require the same (or similar) item to be 
+       checked into to two different places (assuming its a bugfix and needs 
+       fixing in both the stable and unstable trees). This also means that in
+       order to have access to both trees, both will have to be checked out 
+       separately. Use the <literal>cvs -r</literal> flag to check out a 
+       branch, e.g: <literal>cvs co -r v_3_0_branch current</literal>.
+     </para>
+    --> 
+    </sect2>
+
+    <sect2 id="cvscommit"><title>CVS Commit Guidelines</title>
+      <para>
+        The source tree is the heart of every software project. Every effort must
+        be made to ensure that it is readable, compilable and consistent at all
+        times. There are differing guidelines for the stable branch and the
+        main development trunk, and we ask anyone with CVS access to strictly
+        adhere to the following guidelines:
+      </para>
+      
+      <para>
+       Basic Guidelines, for all branches:
+      </para>
+      <para>
+        <itemizedlist>
+          <listitem><para>
+            Please don't commit even 
+            a small change without testing it thoroughly first. When we're
+            close to a public release, ask a fellow developer to review your 
+            changes.
+          </para></listitem>
+          <listitem><para>
+            Your commit message should give a concise overview of <emphasis>what you
+            changed</emphasis> (no big details) and <emphasis>why you changed it</emphasis>
+            Just check previous messages for good examples.
+          </para></listitem>
+          <listitem><para>
+            Don't use the same message on multiple files, unless it equally applies to
+            all those files.
+          </para></listitem>
+          <listitem><para>
+            If your changes span multiple files, and the code won't recompile unless
+            all changes are committed (e.g. when changing the signature of a function),
+            then commit all files one after another, without long delays in between.
+            If necessary, prepare the commit messages in advance.
+          </para></listitem>
+          <listitem><para>
+            Before changing things on CVS, make sure that your changes are in line
+            with the team's general consensus on what should be done.
+          </para></listitem>
+          <listitem>
+           <para>
+            Note that near a major public release, we get more cautious.
+            There is always the possibility to submit a patch to the <ulink
+            url="http://sourceforge.net/tracker/?atid=311118&amp;group_id=11118&amp;func=browse">patch
+            tracker</ulink> instead.
+          </para>
+         </listitem> 
+        </itemizedlist>
+      </para>
+      
+<!--
+      <para>
+       Stable branches are handled with more care, especially after the 
+       initial *.*.0 release, and we are just in bugfix mode. In addition to 
+       the above, the below applies only to the stable branch (currently the 
+       <literal>v_3_0_branch</literal> branch):
+      </para>
+      
+      <para>
+       <itemizedlist>
+        <listitem>
+         <para>
+           Do not commit <emphasis>anything</emphasis> unless your proposed
+           changes have been well tested first, preferably by other members of the
+           project, or have prior approval of the project leaders or consensus
+           of the devel list.
+         </para>
+        </listitem> 
+       <listitem>
+        <para>
+         Where possible, bugfixes and changes should be tested in the main 
+         development trunk first. There may be occasions where this is not 
+         feasible, though.
+        </para>
+       </listitem> 
+       <listitem>
+        <para>
+          Alternately, proposed changes can be submitted as patches to the patch tracker on 
+          Sourceforge first: <ulink
+          url="http://sourceforge.net/tracker/?group_id=11118&#38;atid=311118">http://sourceforge.net/tracker/?group_id=11118&#38;atid=311118</ulink>.
+          Then ask for peer review. 
+        </para>
+       </listitem> 
+        <listitem>
+         <para>
+          Do not even think about anything except bugfixes. No new features!
+         </para>
+        </listitem> 
+     
+       </itemizedlist>
+      </para> 
+    -->
+    </sect2>
+
+  </sect1>

        
   <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="documentation"><title>Documentation Guidelines</title>
   <para>
        
   <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="documentation"><title>Documentation Guidelines</title>
   <para>

-    All formal documents are maintained in docbook SGML and located in the
+    All formal documents are maintained in Docbook SGML and located in the

     <computeroutput>doc/source/*</computeroutput> directory. You will need
     <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook 
     DTD's and the Docbook modular stylesheets (or comparable alternatives),
     <computeroutput>doc/source/*</computeroutput> directory. You will need
     <ulink url="http://www.docbook.org">Docbook</ulink>, the Docbook 
     DTD's and the Docbook modular stylesheets (or comparable alternatives),


@@ -165,25 +340,39 @@ following guidelines for changing stuff in the code. If it is
     url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
     <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
     course this, the <citetitle>developer-manual</citetitle> in this format.
     url="../user-manual/index.html"><citetitle>user-manual</citetitle></ulink>,
     <ulink url="../faq/index.html"><citetitle>FAQ</citetitle></ulink>, and, of
     course this, the <citetitle>developer-manual</citetitle> in this format.

-    The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>
-    <citetitle>privoxy.1</citetitle> (man page) files are also now maintained
-    as Docbook SGML. The finished files are all in the top-level source
-    directory are generated files! Also, <filename>index.html</filename>, the
-    <application>Privoxy</application> home page, is maintained as SGML.
+    The <citetitle>README</citetitle>, <citetitle>AUTHORS</citetitle>,
+    <citetitle>INSTALL</citetitle>,
+    <citetitle>privoxy.1</citetitle> (man page), and
+    <citetitle>config</citetitle> files are also now maintained as Docbook
+    SGML. These files, when built, in the top-level source directory are
+    generated files! Also, the <application>Privoxy</application> <filename>index.html</filename> (and a 
+    variation on this file, <filename>privoxy-index.html</filename>, 
+    meant for inclusion with doc packages), are maintained as SGML as well.

     <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or
     <emphasis>DO NOT edit these directly</emphasis>. Edit the SGML source, or

-    contact someone involved in the documentation (at present Stefan and
-    Hal).
+    contact someone involved in the documentation.

     </para> 
     <para>
     </para> 
     <para>

-     Other, less formal documents (e.g. <filename>LICENSE</filename>,
-     <filename>INSTALL</filename>) are maintained as plain text files in the
-     toplevel source directory. At least for the time being.
+     <filename>config</filename> requires some special handling. The reason it
+     is maintained this way is so that the extensive comments in the file
+     mirror those in <citetitle>user-manual</citetitle>. But the conversion 
+     process requires going from SGML to HTML to text to special formatting 
+     required for the embedded comments. Some of this does not survive so
+     well. Especially some of the examples that are longer than 80 characters.
+     The build process for this file outputs to <filename>config.new</filename>, 
+     which should be reviewed for errors and mis-formatting. Once satisfied
+     that it is correct, then it should be hand copied to
+     <filename>config</filename>.
+    </para>
+    <para>
+     Other, less formal documents (e.g. <filename>LICENSE</filename>) are
+     maintained as plain text files in the top-level source directory.

     </para>
     <para>
      Packagers are encouraged to include this documentation. For those without
      the ability to build the docs locally, text versions of each are kept in
     </para>
     <para>
      Packagers are encouraged to include this documentation. For those without
      the ability to build the docs locally, text versions of each are kept in

-     CVS. HTML versions are also now being kept in CVS under 
-     <filename>doc/webserver/*</filename>.
+     CVS. HTML versions are also being kept in CVS under 
+     <filename>doc/webserver/*</filename>. And PDF version are kept in 
+     <filename>doc/pdf/*</filename>.

     </para>
     <para>
      Formal documents are built with the Makefile targets of
     </para>
     <para>
      Formal documents are built with the Makefile targets of


@@ -196,7 +385,7 @@ following guidelines for changing stuff in the code. If it is
     </para>
     <para>
      Documentation writers should please make sure documents build
     </para>
     <para>
      Documentation writers should please make sure documents build

-     successfully before committing to CVS.
+     successfully before committing to CVS, if possible.

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


@@ -205,7 +394,8 @@ following guidelines for changing stuff in the code. If it is
       <listitem><para>
         First, build the docs by running <computeroutput>make
         dok</computeroutput> (or alternately <computeroutput>make
       <listitem><para>
         First, build the docs by running <computeroutput>make
         dok</computeroutput> (or alternately <computeroutput>make

-        redhat-dok</computeroutput>).                 
+        redhat-dok</computeroutput>). For PDF docs, do <computeroutput>make
+        dok-pdf</computeroutput>.

       </para></listitem>
       <listitem><para>
         Run <computeroutput>make webserver</computeroutput> which copies all
       </para></listitem>
       <listitem><para>
         Run <computeroutput>make webserver</computeroutput> which copies all


@@ -215,6 +405,15 @@ following guidelines for changing stuff in the code. If it is
      </orderedlist>
   </para>
 
      </orderedlist>
   </para>
 

+  <para>
+   Finished docs should be occasionally submitted to CVS
+   (<filename>doc/webserver/*/*.html</filename>) so that those without 
+   the ability to build them locally, have access to them if needed.
+   This is especially important just prior to a new release! Please
+   do this <emphasis>after</emphasis> the <literal>$VERSION</literal> and
+   other release specific data in <filename>configure.in</filename> has been
+   updated (this is done just prior to a new release).
+  </para>

 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2 id="sgml">
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2 id="sgml">


@@ -260,51 +459,57 @@ following guidelines for changing stuff in the code. If it is
  Some common elements that you likely will use: 
 </para>
 
  Some common elements that you likely will use: 
 </para>
 

-<simplelist>
- <member>
-  <emphasis>&lt;para&gt;&lt;/para&gt;</emphasis>, paragraph delimiter. Most 
-  text needs to be within paragraph elements (there are some exceptions).
- </member>
- <member>
-  <emphasis>&lt;emphasis&gt;&lt;/emphasis&gt;</emphasis>, the stylesheets make this
- italics.
- </member>
-  <member>
-  <emphasis>&lt;filename&gt;&lt;/filename&gt;</emphasis>, files and directories.
- </member>
- <member>
-  <emphasis>&lt;command&gt;&lt;/command&gt;</emphasis>, command examples.
- </member>
- <member>
-  <emphasis>&lt;literallayout&gt;&lt;/literllayout&gt;</emphasis>, like 
-  <literal>&lt;pre&gt;</literal>, more or less.
- </member>
-  <member>
-  <emphasis>&lt;itemizedlist&gt;&lt;/itemizdelist&gt;</emphasis>, list with bullets.
- </member>
- <member>
-  <emphasis>&lt;listitem&gt;&lt;/listitem&gt;</emphasis>, member of the above.
- </member>
-  <member>
-   <emphasis>&lt;screen&gt;&lt;/screen&gt;</emphasis>, screen output, implies 
-   <literal>&lt;literallayout&gt;</literal>.
- </member>
- <member>
-  <emphasis>&lt;ulink url="example.com"&gt;&lt;/ulink&gt;</emphasis>, like 
-  HTML <literal>&lt;a&gt;</literal> tag.
- </member>
-  <member>
-   <emphasis>&lt;quote&gt;&lt;/quote&gt;</emphasis>, for, doh, quoting text. 
- </member>
-</simplelist>
+<para>
+  <simplelist>
+    <member>
+      <emphasis>&lt;para&gt;&lt;/para&gt;</emphasis>, paragraph delimiter. Most 
+      text needs to be within paragraph elements (there are some exceptions).
+    </member>
+    <member>
+      <emphasis>&lt;emphasis&gt;&lt;/emphasis&gt;</emphasis>, the stylesheets
+      make this italics.
+    </member>
+    <member>
+      <emphasis>&lt;filename&gt;&lt;/filename&gt;</emphasis>, files and directories.
+    </member>
+    <member>
+      <emphasis>&lt;command&gt;&lt;/command&gt;</emphasis>, command examples.
+    </member>
+    <member>
+      <emphasis>&lt;literallayout&gt;&lt;/literallayout&gt;</emphasis>, like 
+      <literal>&lt;pre&gt;</literal>, more or less.
+    </member>
+    <member>
+      <emphasis>&lt;itemizedlist&gt;&lt;/itemizedlist&gt;</emphasis>, list with bullets.
+    </member>
+    <member>
+      <emphasis>&lt;listitem&gt;&lt;/listitem&gt;</emphasis>, member of the above.
+    </member>
+    <member>
+      <emphasis>&lt;screen&gt;&lt;/screen&gt;</emphasis>, screen output, implies 
+      <literal>&lt;literallayout&gt;</literal>.
+    </member>
+    <member>
+      <emphasis>&lt;ulink url="example.com"&gt;&lt;/ulink&gt;</emphasis>, like 
+      HTML <literal>&lt;a&gt;</literal> tag.
+    </member>
+    <member>
+      <emphasis>&lt;quote&gt;&lt;/quote&gt;</emphasis>, for, doh, quoting text. 
+    </member>
+  </simplelist>
+</para>

 
 <para>
  Look at any of the existing docs for examples of all these and more.
 </para>
 
 
 <para>
  Look at any of the existing docs for examples of all these and more.
 </para>
 

+<para>
+ You might also find <quote><ulink
+ url="http://opensource.bureau-cornavin.com/crash-course/index.html">Writing Documentation
+ Using DocBook - A Crash Course</ulink></quote> useful.
+</para>

 </sect2>
 
 </sect2>
 

-

 <!--   ~~~~~       New section      ~~~~~     -->
   <sect2 id="docstyle">
   <title><application>Privoxy</application> Documentation Style</title>
 <!--   ~~~~~       New section      ~~~~~     -->
   <sect2 id="docstyle">
   <title><application>Privoxy</application> Documentation Style</title>


@@ -374,20 +579,21 @@ following guidelines for changing stuff in the code. If it is
   <listitem>
    <para>
      We have an international audience. Refrain from slang, or English 
   <listitem>
    <para>
      We have an international audience. Refrain from slang, or English 

-     idiosyncrasies (too many to list :).
+     idiosyncrasies (too many to list :). Humor also does not translate 
+     well sometimes.

    </para>
   </listitem> 
   <listitem>
    <para>
     Try to keep overall line lengths in source files to 80 characters or less
    </para>
   </listitem> 
   <listitem>
    <para>
     Try to keep overall line lengths in source files to 80 characters or less

-    for obvious reasons. This is not always possible, with lenghty URLs for
+    for obvious reasons. This is not always possible, with lengthy URLs for

     instance.
    </para>
   </listitem> 
   <listitem>
    <para>
     Our documents are available in differing formats. Right now, they 
     instance.
    </para>
   </listitem> 
   <listitem>
    <para>
     Our documents are available in differing formats. Right now, they 

-    are just plain text, and HTML, but PDF, and others is always a 
+    are just plain text, HTML, and PDF, but others are always a 

     future possibility. Be careful with URLs (&lt;ulink&gt;), and avoid 
     this mistake:
    </para>
     future possibility. Be careful with URLs (&lt;ulink&gt;), and avoid 
     this mistake:
    </para>


@@ -448,7 +654,7 @@ following guidelines for changing stuff in the code. If it is
   <itemizedlist>
   <listitem>
    <para>
   <itemizedlist>
   <listitem>
    <para>

-    Re-cyclable <quote>boilerplate</quote> text entities are defined like:
+    Re- <quote>boilerplate</quote> text entities are defined like:

    </para>
    <para>
     <literal>&lt;!entity supported SYSTEM "supported.sgml"&gt;</literal>
    </para>
    <para>
     <literal>&lt;!entity supported SYSTEM "supported.sgml"&gt;</literal>


@@ -469,15 +675,15 @@ following guidelines for changing stuff in the code. If it is
   <simplelist>
    <member>
     <emphasis>p-version</emphasis>: the <application>Privoxy</application> 
   <simplelist>
    <member>
     <emphasis>p-version</emphasis>: the <application>Privoxy</application> 

-    version string, e.g. <quote>2.9.13</quote>.
+    version string, e.g. <quote>&p-version;</quote>.

    </member>
    <member>
     <emphasis>p-status</emphasis>: the project status, either 
    </member>
    <member>
     <emphasis>p-status</emphasis>: the project status, either 

-    <quote>ALPHA</quote>, <quote>BETA</quote>, or <quote>STABLE</quote>.
+    <quote>alpha</quote>, <quote>beta</quote>, or <quote>stable</quote>.

    </member>
    <member>
     <emphasis>p-not-stable</emphasis>: use to conditionally include 
    </member>
    <member>
     <emphasis>p-not-stable</emphasis>: use to conditionally include 

-    text in <quote>not stable</quote> releases (e.g. <quote>BETA</quote>).
+    text in <quote>not stable</quote> releases (e.g. <quote>beta</quote>).

    </member>
    <member>
     <emphasis>p-stable</emphasis>: just the opposite.
    </member>
    <member>
     <emphasis>p-stable</emphasis>: just the opposite.


@@ -527,8 +733,8 @@ following guidelines for changing stuff in the code. If it is
     <para><emphasis>Explanation:</emphasis></para>
 
     <para>Comment as much as possible without commenting the obvious.
     <para><emphasis>Explanation:</emphasis></para>
 
     <para>Comment as much as possible without commenting the obvious.

-    For example do not comment "aVariable is equal to bVariable".
-    Instead explain why aVariable should be equal to the bVariable.
+    For example do not comment "variable_a is equal to variable_b".
+    Instead explain why variable_a should be equal to the variable_b.

     Just because a person can read code does not mean they will
     understand why or what is being done. A reader may spend a lot
     more time figuring out what is going on when a simple comment
     Just because a person can read code does not mean they will
     understand why or what is being done. A reader may spend a lot
     more time figuring out what is going on when a simple comment


@@ -542,13 +748,13 @@ following guidelines for changing stuff in the code. If it is
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 /* if page size greater than 1k ... */
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 /* if page size greater than 1k ... */

-if ( PageLength() > 1024 )
+if ( page_length() > 1024 )

 {
     ... "block" the page up ...
 }
 
 /* if page size is small, send it in blocks */
 {
     ... "block" the page up ...
 }
 
 /* if page size is small, send it in blocks */

-if ( PageLength() > 1024 )
+if ( page_length() > 1024 )

 {
     ... "block" the page up ...
 }
 {
     ... "block" the page up ...
 }


@@ -576,28 +782,28 @@ is actually being done.
 /*********************************************************************
  * This will stand out clearly in your code!
  *********************************************************************/
 /*********************************************************************
  * This will stand out clearly in your code!
  *********************************************************************/

-if ( thisVariable == thatVariable )
+if ( this_variable == that_variable )

 {
 {

-   DoSomethingVeryImportant();
+   do_something_very_important();

 }
 
 
 /* unfortunately, this may not */
 }
 
 
 /* unfortunately, this may not */

-if ( thisVariable == thatVariable )
+if ( this_variable == that_variable )

 {
 {

-   DoSomethingVeryImportant();
+   do_something_very_important();

 }
 
 
 }
 
 

-if ( thisVariable == thatVariable ) /* this may not either */
+if ( this_variable == that_variable ) /* this may not either */

 {
 {

-   DoSomethingVeryImportant();
+   do_something_very_important();

 }</programlisting>
 
     <para><emphasis>Exception:</emphasis></para>
 
     <para>If you are trying to add a small logic comment and do not
 }</programlisting>
 
     <para><emphasis>Exception:</emphasis></para>
 
     <para>If you are trying to add a small logic comment and do not

-    wish to "disrubt" the flow of the code, feel free to use a 1
+    wish to "disrupt" the flow of the code, feel free to use a 1

     line comment which is NOT on the same line as the code.</para>
 
     
     line comment which is NOT on the same line as the code.</para>
 
     


@@ -623,14 +829,14 @@ if ( thisVariable == thatVariable ) /* this may not either */
  * This will stand out clearly in your code,
  * But the second example won't.
  *********************************************************************/
  * This will stand out clearly in your code,
  * But the second example won't.
  *********************************************************************/

-if ( thisVariable == thatVariable )
+if ( this_variable == this_variable )

 {
 {

-   DoSomethingVeryImportant();
+   do_something_very_important();

 }
 
 }
 

-if ( thisVariable == thatVariable ) /*can you see me?*/
+if ( this_variable == this_variable ) /*can you see me?*/

 {
 {

-   DoSomethingVeryImportant(); /*not easily*/
+   do_something_very_important(); /*not easily*/

 }
 
 
 }
 
 


@@ -642,17 +848,17 @@ int urls_rejected = 0;     /* # of urls rejected */
 
 if ( 1 == X )
 {
 
 if ( 1 == X )
 {

-   DoSomethingVeryImportant();
+   do_something_very_important();

 }
 
 
 }
 
 

-short DoSomethingVeryImportant(
+short do_something_very_important(

    short firstparam,   /* represents something */
    short nextparam     /* represents something else */ )
 {
    ...code here...
 
    short firstparam,   /* represents something */
    short nextparam     /* represents something else */ )
 {
    ...code here...
 

-}   /* -END- DoSomethingVeryImportant */
+}   /* -END- do_something_very_important */

 </programlisting>
   </sect3>
     
 </programlisting>
   </sect3>
     


@@ -719,7 +925,7 @@ short DoSomethingVeryImportant(
 <programlisting>
 if ( 1 == X )
 {
 <programlisting>
 if ( 1 == X )
 {

-   DoSomethingVeryImportant();
+   do_something_very_important();

    ...some long list of commands...
 } /* -END- if x is 1 */
 
    ...some long list of commands...
 } /* -END- if x is 1 */
 


@@ -727,7 +933,7 @@ or:
 
 if ( 1 == X )
 {
 
 if ( 1 == X )
 {

-   DoSomethingVeryImportant();
+   do_something_very_important();

    ...some long list of commands...
 } /* -END- if ( 1 == X ) */
 </programlisting>
    ...some long list of commands...
 } /* -END- if ( 1 == X ) */
 </programlisting>


@@ -743,7 +949,7 @@ if ( 1 == X )
 
     <para><emphasis>Explanation:</emphasis></para>
 
 
     <para><emphasis>Explanation:</emphasis></para>
 

-    <para>Use all lowercase, and seperate words via an underscore
+    <para>Use all lowercase, and separate words via an underscore

     ('_'). Do not start an identifier with an underscore. (ANSI C
     reserves these for use by the compiler and system headers.) Do
     not use identifiers which are reserved in ANSI C++. (E.g.
     ('_'). Do not start an identifier with an underscore. (ANSI C
     reserves these for use by the compiler and system headers.) Do
     not use identifiers which are reserved in ANSI C++. (E.g.


@@ -770,7 +976,7 @@ int msiis5hack = 0; int msIis5Hack = 0;
 
     <para><emphasis>Explanation:</emphasis></para>
 
 
     <para><emphasis>Explanation:</emphasis></para>
 

-    <para>Use all lowercase, and seperate words via an underscore
+    <para>Use all lowercase, and separate words via an underscore

     ('_'). Do not start an identifier with an underscore. (ANSI C
     reserves these for use by the compiler and system headers.) Do
     not use identifiers which are reserved in ANSI C++. (E.g.
     ('_'). Do not start an identifier with an underscore. (ANSI C
     reserves these for use by the compiler and system headers.) Do
     not use identifiers which are reserved in ANSI C++. (E.g.


@@ -912,11 +1118,11 @@ if ( this == that )
 
     <para><emphasis>Note:</emphasis> In the special case that the if-statement is
     inside a loop, and it is trivial, i.e. it tests for a
 
     <para><emphasis>Note:</emphasis> In the special case that the if-statement is
     inside a loop, and it is trivial, i.e. it tests for a

-    condidtion that is obvious from the purpose of the block,
+    condition that is obvious from the purpose of the block,

     one-liners as above may optically preserve the loop structure
     and make it easier to read.</para>
 
     one-liners as above may optically preserve the loop structure
     and make it easier to read.</para>
 

-    <para><emphasis>Status:</emphasis> developer-discrection.</para>
+    <para><emphasis>Status:</emphasis> developer-discretion.</para>

 
     <para><emphasis>Example exception:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example exception:</emphasis></para>
 <programlisting>


@@ -944,17 +1150,17 @@ while ( more lines are read )
 <programlisting>
 if ( this == that )
 {
 <programlisting>
 if ( this == that )
 {

-   DoSomething();
-   DoSomethingElse();
+   do_something();
+   do_something_else();

 }</programlisting>
 
     <para><emphasis>Instead of:</emphasis></para>
 
 }</programlisting>
 
     <para><emphasis>Instead of:</emphasis></para>
 

-    <para>if ( this == that ) DoSomething(); DoSomethingElse();</para>
+    <para>if ( this == that ) do_something(); do_something_else();</para>

 
     <para>or</para>
 
 
     <para>or</para>
 

-    <para>if ( this == that ) DoSomething();</para>
+    <para>if ( this == that ) do_something();</para>

 
     <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
     in a manner other than that which the developer desired (per
 
     <para><emphasis>Note:</emphasis> The first example in "Instead of" will execute
     in a manner other than that which the developer desired (per


@@ -978,7 +1184,7 @@ structure->flag = ( condition );</programlisting>
     <para>if ( condition ) { structure->flag = 1; } else {
     structure->flag = 0; }</para>
 
     <para>if ( condition ) { structure->flag = 1; } else {
     structure->flag = 0; }</para>
 

-    <para><emphasis>Note:</emphasis> The former is readable and consice. The later
+    <para><emphasis>Note:</emphasis> The former is readable and concise. The later

     is wordy and inefficient. Please assume that any developer new
     to the project has at least a "good" knowledge of C/C++. (Hope
     I do not offend by that last comment ... 8-)</para>
     is wordy and inefficient. Please assume that any developer new
     to the project has at least a "good" knowledge of C/C++. (Hope
     I do not offend by that last comment ... 8-)</para>


@@ -997,14 +1203,14 @@ structure->flag = ( condition );</programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>

-int firstValue   = 0;
-int someValue    = 0;
-int anotherValue = 0;
-int thisVariable = 0;
+int first_value   = 0;
+int some_value    = 0;
+int another_value = 0;
+int this_variable = 0;

 
 

-if ( thisVariable == thatVariable )
+if ( this_variable == this_variable )

 
 

-firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
+first_value = old_value + ( ( some_value - another_value ) - whatever )

 </programlisting>
   </sect3>
     
 </programlisting>
   </sect3>
     


@@ -1024,12 +1230,12 @@ firstValue = oldValue + ( ( someValue - anotherValue ) - whatever )
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>

-aStruct->aMember;
-aStruct.aMember;
-FunctionName();</programlisting>
+a_struct->a_member;
+a_struct.a_member;
+function_name();</programlisting>

 
 

-    <para><emphasis>Instead of:</emphasis> aStruct -> aMember; aStruct . aMember;
-    FunctionName ();</para>
+    <para><emphasis>Instead of:</emphasis> a_struct -> a_member; a_struct . a_member;
+    function_name ();</para>

 
     
   </sect3>
 
     
   </sect3>


@@ -1043,7 +1249,7 @@ FunctionName();</programlisting>
 int function1( ... )
 {
    ...code...
 int function1( ... )
 {
    ...code...

-   return( retCode );
+   return( ret_code );

 
 }   /* -END- function1 */
 
 
 }   /* -END- function1 */
 


@@ -1055,18 +1261,18 @@ int function2( ... )
 
     <para><emphasis>Instead of:</emphasis></para>
 
 
     <para><emphasis>Instead of:</emphasis></para>
 

-    <para>int function1( ... ) { ...code... return( retCode ); } int
+    <para>int function1( ... ) { ...code... return( ret_code ); } int

     function2( ... ) { }</para>
 
     <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2
     function2( ... ) { }</para>
 
     <para><emphasis>Note:</emphasis> Use 1 blank line before the closing brace and 2

-    lines afterwards. This makes the end of function standout to
+    lines afterward. This makes the end of function standout to

     the most casual viewer. Although function comments help
     the most casual viewer. Although function comments help

-    seperate functions, this is still a good coding practice. In
+    separate functions, this is still a good coding practice. In

     fact, I follow these rules when using blocks in "for", "while",
     "do" loops, and long if {} statements too. After all whitespace
     is free!</para>
 
     fact, I follow these rules when using blocks in "for", "while",
     "do" loops, and long if {} statements too. After all whitespace
     is free!</para>
 

-    <para><emphasis>Status:</emphasis> developer-discrection on the number of blank
+    <para><emphasis>Status:</emphasis> developer-discretion on the number of blank

     lines. Enforced is the end of function comments.</para>
 
     
     lines. Enforced is the end of function comments.</para>
 
     


@@ -1125,16 +1331,16 @@ int function1( ... )
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>

-short anShort = 0;
-float aFloat  = 0;
+short a_short = 0;
+float a_float  = 0;

 struct *ptr = NULL;</programlisting>
 
     <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
     message says you are trying to access memory address 00000000
 struct *ptr = NULL;</programlisting>
 
     <para><emphasis>Note:</emphasis> It is much easier to debug a SIGSEGV if the
     message says you are trying to access memory address 00000000

-    and not 129FA012; or arrayPtr[20] causes a SIGSEV vs.
-    arrayPtr[0].</para>
+    and not 129FA012; or array_ptr[20] causes a SIGSEV vs.
+    array_ptr[0].</para>

 
 

-    <para><emphasis>Status:</emphasis> developer-discrection if and only if the
+    <para><emphasis>Status:</emphasis> developer-discretion if and only if the

     variable is assigned a value "shortly after" declaration.</para>
 
   </sect3>
     variable is assigned a value "shortly after" declaration.</para>
 
   </sect3>


@@ -1155,9 +1361,9 @@ struct *ptr = NULL;</programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>

-ShouldWeBlockThis();
-ContainsAnImage();
-IsWebPageBlank();
+should_we_block_this();
+contains_an_image();
+is_web_page_blank();

 </programlisting>
   </sect3>
     
 </programlisting>
   </sect3>
     


@@ -1186,7 +1392,7 @@ IsWebPageBlank();
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>

-for ( size_t cnt = 0; cnt &lt; blockListLength(); cnt ++ )
+for ( size_t cnt = 0; cnt &lt; block_list_length(); cnt++ )

 {
    ....
 }</programlisting>
 {
    ....
 }</programlisting>


@@ -1195,10 +1401,10 @@ for ( size_t cnt = 0; cnt &lt; blockListLength(); cnt ++ )
     each and every iteration. This increases the overhead in the
     program, because the compiler has to look up the function each
     time, call it, and return a value. Depending on what occurs in
     each and every iteration. This increases the overhead in the
     program, because the compiler has to look up the function each
     time, call it, and return a value. Depending on what occurs in

-    the blockListLength() call, it might even be creating and
+    the block_list_length() call, it might even be creating and

     destroying structures with each iteration, even though in each
     case it is comparing "cnt" to the same value, over and over.
     destroying structures with each iteration, even though in each
     case it is comparing "cnt" to the same value, over and over.

-    Remember too - even a call to blockListLength() is a function
+    Remember too - even a call to block_list_length() is a function

     call, with the same overhead.</para>
 
     <para>Instead of using a function call during the iterations,
     call, with the same overhead.</para>
 
     <para>Instead of using a function call during the iterations,


@@ -1207,15 +1413,15 @@ for ( size_t cnt = 0; cnt &lt; blockListLength(); cnt ++ )
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>

-size_t len = blockListLength();
+size_t len = block_list_length();

 
 

-for ( size_t cnt = 0; cnt &lt; len; cnt ++ )
+for ( size_t cnt = 0; cnt &lt; len; cnt++ )

 {
    ....
 }</programlisting>
 
 {
    ....
 }</programlisting>
 

-    <para><emphasis>Exceptions:</emphasis> if the value of blockListLength() *may*
-    change or could *potentially* change, then you must code the
+    <para><emphasis>Exceptions:</emphasis> if the value of block_list_length()
+    *may* change or could *potentially* change, then you must code the

     function call in the for/while loop.</para>
 
     
     function call in the for/while loop.</para>
 
     


@@ -1287,7 +1493,7 @@ for ( size_t cnt = 0; cnt &lt; len; cnt ++ )
 
     <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
     without a _very_ good reason. This duplicates the #include
 
     <para><emphasis>Note:</emphasis> Please! do not add "-I." to the Makefile
     without a _very_ good reason. This duplicates the #include

-    "file.h" behaviour.</para>
+    "file.h" behavior.</para>

 
     
   </sect3>
 
     
   </sect3>


@@ -1360,9 +1566,9 @@ extern file_list *xyz;</programlisting>
     <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
     pointer), then including the proper header file is necessary.
     If you only want to prototype a pointer, however, the header
     <para><emphasis>Note:</emphasis> If you declare "file_list xyz;" (without the
     pointer), then including the proper header file is necessary.
     If you only want to prototype a pointer, however, the header

-    file is unneccessary.</para>
+    file is unnecessary.</para>

 
 

-    <para><emphasis>Status:</emphasis> Use with discrection.</para>
+    <para><emphasis>Status:</emphasis> Use with discretion.</para>

 
     
   </sect3>
 
     
   </sect3>


@@ -1408,7 +1614,7 @@ switch( hash_string( cmd ) )
 
    default :
       log_error( ... );
 
    default :
       log_error( ... );

-      ... anomly code goes here ...
+      ... anomaly code goes here ...

       continue; / break; / exit( 1 ); / etc ...
 
 } /* end switch( hash_string( cmd ) ) */</programlisting>
       continue; / break; / exit( 1 ); / etc ...
 
 } /* end switch( hash_string( cmd ) ) */</programlisting>


@@ -1419,9 +1625,9 @@ switch( hash_string( cmd ) )
     This API call *should* be included in a default statement.</para>
 
     <para><emphasis>Another Note:</emphasis> This is not so much a readability issue
     This API call *should* be included in a default statement.</para>
 
     <para><emphasis>Another Note:</emphasis> This is not so much a readability issue

-    as a robust programming issue. The "anomly code goes here" may
+    as a robust programming issue. The "anomaly code goes here" may

     be no more than a print to the STDERR stream (as in
     be no more than a print to the STDERR stream (as in

-    load_config). Or it may really be an ABEND condition.</para>
+    load_config). Or it may really be an abort condition.</para>

 
     <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
 
 
     <para><emphasis>Status:</emphasis> Programmer discretion is advised.</para>
 


@@ -1480,8 +1686,7 @@ switch( hash_string( cmd ) )
     assumptions about whether it is signed or unsigned, or about
     how long it is. Do not compare a size_t against another
     variable of a different type (or even against a constant)
     assumptions about whether it is signed or unsigned, or about
     how long it is. Do not compare a size_t against another
     variable of a different type (or even against a constant)

-    without casting one of the values. Try to avoid using size_t if
-    you can.</para>
+    without casting one of the values.</para>

 
     
   </sect3>
 
     
   </sect3>


@@ -1513,10 +1718,10 @@ long c = 0;</programlisting>
 
     <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
     variables or other trivial variables; feel free to declare them
 
     <para><emphasis>Exceptions:</emphasis> when you want to declare a bunch of loop
     variables or other trivial variables; feel free to declare them

-    on 1 line. You should, although, provide a good comment on
+    on one line. You should, although, provide a good comment on

     their functions.</para>
 
     their functions.</para>
 

-    <para><emphasis>Status:</emphasis> developer-discrection.</para>
+    <para><emphasis>Status:</emphasis> developer-discretion.</para>

 
     
   </sect3>
 
     
   </sect3>


@@ -1526,7 +1731,7 @@ long c = 0;</programlisting>
 
     <para><emphasis>Explanation:</emphasis></para>
 
 
     <para><emphasis>Explanation:</emphasis></para>
 

-    <para>Create a local stuct (on the stack) if the variable will
+    <para>Create a local struct (on the stack) if the variable will

     live and die within the context of one function call.</para>
 
     <para>Only "malloc" a struct (on the heap) if the variable's life
     live and die within the context of one function call.</para>
 
     <para>Only "malloc" a struct (on the heap) if the variable's life


@@ -1535,7 +1740,7 @@ long c = 0;</programlisting>
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 If a function creates a struct and stores a pointer to it in a
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 If a function creates a struct and stores a pointer to it in a

-list, then it should definately be allocated via `malloc'.
+list, then it should definitely be allocated via `malloc'.

 </programlisting>
   </sect3>
     
 </programlisting>
   </sect3>
     


@@ -1551,7 +1756,7 @@ list, then it should definately be allocated via `malloc'.
     responsible for ensuring that deletion is timely (i.e. not too
     soon, not too late). This is known as "low-coupling" and is a
     "good thing (tm)". You may need to offer a
     responsible for ensuring that deletion is timely (i.e. not too
     soon, not too late). This is known as "low-coupling" and is a
     "good thing (tm)". You may need to offer a

-    free/unload/destuctor type function to accomodate this.</para>
+    free/unload/destructor type function to accommodate this.</para>

 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example:</emphasis></para>
 <programlisting>


@@ -1564,7 +1769,7 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
     functions for C run-time library functions ... such as
     `strdup'.</para>
 
     functions for C run-time library functions ... such as
     `strdup'.</para>
 

-    <para><emphasis>Status:</emphasis> developer-discrection. The "main" use of this
+    <para><emphasis>Status:</emphasis> developer-discretion. The "main" use of this

     standard is for allocating and freeing data structures (complex
     or nested).</para>
 
     standard is for allocating and freeing data structures (complex
     or nested).</para>
 


@@ -1591,16 +1796,16 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
     
 
     <sect3 id="s45"><title>"Uncertain" new code and/or changes to
     
 
     <sect3 id="s45"><title>"Uncertain" new code and/or changes to

-    exitinst code, use FIXME</title>
+    existing code, use FIXME or XXX</title>

 
     <para><emphasis>Explanation:</emphasis></para>
 
     <para>If you have enough confidence in new code or confidence in
 
     <para><emphasis>Explanation:</emphasis></para>
 
     <para>If you have enough confidence in new code or confidence in

-    your changes, but are not *quite* sure of the reprocussions,
+    your changes, but are not *quite* sure of the repercussions,

     add this:</para>
 
     <para>/* FIXME: this code has a logic error on platform XYZ, *
     add this:</para>
 
     <para>/* FIXME: this code has a logic error on platform XYZ, *

-    attempthing to fix */ #ifdef PLATFORM ...changed code here...
+    attempting to fix */ #ifdef PLATFORM ...changed code here...

     #endif</para>
 
     <para>or:</para>
     #endif</para>
 
     <para>or:</para>


@@ -1615,7 +1820,7 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
 
     <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
     be a "good thing (tm)", it will be easier to identify and
 
     <para><emphasis>Note:</emphasis> If you make it clear that this may or may not
     be a "good thing (tm)", it will be easier to identify and

-    include in the project (or conversly exclude from the
+    include in the project (or conversely exclude from the

     project).</para>
 
     
     project).</para>
 
     


@@ -1628,14 +1833,14 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
 
     <para><emphasis>Example for file comments:</emphasis></para>
 <programlisting>
 
     <para><emphasis>Example for file comments:</emphasis></para>
 <programlisting>

-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 2.20 2008/06/14 13:21:24 fabiankeil Exp $";

 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
  *
  * Purpose     :  (Fill me in with a good description!)
  *
 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
  *
  * Purpose     :  (Fill me in with a good description!)
  *

- * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge

  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written


@@ -1657,8 +1862,9 @@ const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:
  *                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
  *                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

  *
  * Revisions   :
  *    $L<!-- Break CVS Substitution -->og$
  *
  * Revisions   :
  *    $L<!-- Break CVS Substitution -->og$


@@ -1680,7 +1886,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
 
     <para><emphasis>Note:</emphasis> The formfeed character that is present right
     after the comment flower box is handy for (X|GNU)Emacs users to
 
     <para><emphasis>Note:</emphasis> The formfeed character that is present right
     after the comment flower box is handy for (X|GNU)Emacs users to

-    skip the verbige and get to the heart of the code (via
+    skip the verbiage and get to the heart of the code (via

     `forward-page' and `backward-page'). Please include it if you
     can.</para>
 
     `forward-page' and `backward-page'). Please include it if you
     can.</para>
 


@@ -1688,14 +1894,14 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
 <programlisting>
 #ifndef _FILENAME_H
 #define _FILENAME_H
 <programlisting>
 #ifndef _FILENAME_H
 #define _FILENAME_H

-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.27 2002/04/08 15:31:18 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 2.20 2008/06/14 13:21:24 fabiankeil Exp $"

 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
  *
  * Purpose     :  (Fill me in with a good description!)
  *
 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
  *
  * Purpose     :  (Fill me in with a good description!)
  *

- * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001-2007 the SourceForge

  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written


@@ -1717,8 +1923,9 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
  *                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
  *                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

  *
  * Revisions   :
  *    $L<!-- Break CVS Substitution -->og$
  *
  * Revisions   :
  *    $L<!-- Break CVS Substitution -->og$


@@ -1784,13 +1991,6 @@ int FUNCTION_NAME( void *param1, const char *x )
 
   </sect1>
 
 
   </sect1>
 

-  <!--   ~~~~~       New section      ~~~~~     -->
-  <sect1 id="cvs"><title>Version Control Guidelines</title>
-    <para>To be filled. note on cvs comments. Don't only comment what you did,
-    but also why you did it!
-</para>
-  </sect1>
-

   <!--   ~~~~~       New section      ~~~~~     -->
   <sect1 id="testing"><title>Testing Guidelines</title>
     <para>To be filled.
   <!--   ~~~~~       New section      ~~~~~     -->
   <sect1 id="testing"><title>Testing Guidelines</title>
     <para>To be filled.


@@ -1840,31 +2040,123 @@ at sourceforge. Three simple steps:
               intelligent (keep it short and precise).</para>
           </listitem>
         </itemizedlist>
               intelligent (keep it short and precise).</para>
           </listitem>
         </itemizedlist>

-        Do not mail to the mailinglist (we cannot keep track on issues there).
+        Do not mail to the mailing list (we cannot keep track on issues there).

       </para>
     </sect2>
     
   </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->
       </para>
     </sect2>
     
   </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->

-  <sect1 id="newrelease"><title>Releasing a new version</title>
+  <sect1 id="newrelease"><title>Releasing a New Version</title>

     <para>
     <para>

-       To minimize trouble with distribution contents, webpage
-       errors and the like, we strongly encourage you
-       to follow this section if you prepare a new release of
-       code or new pages on the webserver.
+        When we release versions of <application>Privoxy</application>,
+        our work leaves our cozy secret lab and has to work in the cold
+        RealWorld[tm]. Once it is released, there is no way to call it
+        back, so it is very important that great care is taken to ensure
+        that everything runs fine, and not to introduce problems in the
+        very last minute.

     </para>
     </para>

+    <para>
+        So when releasing a new version, please adhere exactly to the
+        procedure outlined in this chapter.
+    </para>
+

     <para>
        The following programs are required to follow this process:
     <para>
        The following programs are required to follow this process:

-       <filename>ncftpput</filename> (ncftp), <filename>scp</filename> (ssh),
-<filename>gmake</filename> (GNU's version of make), autoconf, cvs, ???.
+       <filename>ncftpput</filename> (ncftp), <filename>scp, ssh</filename> (ssh),
+        <filename>gmake</filename> (GNU's version of make), autoconf, cvs.

     </para>
     </para>

+
+    <sect2 id="versionnumbers">
+    <title>Version numbers</title>
+
+    <para>
+      First you need to determine which version number the release will have. 
+      <application>Privoxy</application> version numbers consist of three numbers,
+      separated by dots, like in X.Y.Z (e.g. 3.0.0), where:
+        <itemizedlist>
+          <listitem>
+            <para>
+              X, the version major, is rarely ever changed. It is increased by one if
+              turning a development branch into stable substantially changes the functionality,
+              user interface or configuration syntax. Majors 1 and 2 were 
+              <application>Junkbuster</application>, and 3 will be the first stable
+              <application>Privoxy</application> release.
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              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
+              which the further development of <application>Privoxy</application> takes
+              place.
+              This enables us to turn the code upside down and inside out, while at the same time
+              providing and maintaining a stable version.
+              The minor is reset to zero (and one) when the major is incremented. When a development
+              branch has matured to the point where it can be turned into stable, the old stable branch
+              2N is given up (i.e. no longer maintained), the former development branch 2N+1 becomes the
+              new stable branch 2N+2, and a new development branch 2N+3 is opened.
+            </para>
+          </listitem>
+          <listitem>
+            <para>
+              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 CVS in between.
+              It follows that Z is odd on CVS 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 CVS snapshots are easily distinguished from released versions.
+              The point version is reset to zero when the minor changes.
+            </para>
+            <para>
+              Stable branches work a little differently, since there should be
+              little to no development happening in such branches. Remember,
+              only bugfixes, which presumably should have had some testing
+              before being committed. Stable branches will then have their 
+              version reported as <literal>0.0.0</literal>, during that period 
+              between releases when changes are being added. This is to denote 
+              that this code is <emphasis>not for release</emphasis>. Then 
+              as the release nears, the version is bumped according: e.g. 
+              <literal>3.0.1 -> 0.0.0 -> 3.0.2</literal>.
+            </para>
+          </listitem>
+        </itemizedlist>
+    </para>
+    <para>
+     In summary, the main CVS trunk is the development branch where new
+     features are being worked on for the next stable series. This should
+     almost always be where the most activity takes place. There is always at
+     least one stable branch from the trunk, e.g now it is
+     <literal>3.0</literal>, which is only used to release stable versions.
+     Once the initial *.0 release of the stable branch has been done, then as a
+     rule, only bugfixes that have had prior testing should be committed to
+     the stable branch. Once there are enough bugfixes to justify a new
+     release, the version of this branch is again incremented Example: 3.0.0
+     -> 3.0.1 -> 3.0.2, etc are all stable releases from within the stable
+     branch. 3.1.x is currently the main trunk, and where work on 3.2.x is
+     taking place. If any questions, please post to the devel list
+     <emphasis>before</emphasis> committing to a stable branch!
+    </para>
+    <para>
+     Developers should remember too that if they commit a bugfix to the stable 
+     branch, this will more than likely require a separate submission to the 
+     main trunk, since these are separate development trees within CVS. If you 
+     are working on both, then this would require at least two separate check
+     outs (i.e main trunk, <emphasis>and</emphasis> the stable release branch,
+     which is <literal>v_3_0_branch</literal> at the moment).
+    </para>
+
+    </sect2>

      
     <sect2 id="beforerelease">
      
     <sect2 id="beforerelease">

-    <title>Before the Release</title>
+    <title>Before the Release: Freeze</title>

      <para>
        The following <emphasis>must be done by one of the
      <para>
        The following <emphasis>must be done by one of the

-       developers</emphasis> prior to each new release:
+       developers</emphasis> prior to each new release.

      </para>
      <para>
       <itemizedlist>
      </para>
      <para>
       <itemizedlist>


@@ -1872,136 +2164,366 @@ at sourceforge. Three simple steps:
         <para>
          Make sure that everybody who has worked on the code in the last
          couple of days has had a chance to yell <quote>no!</quote> in case
         <para>
          Make sure that everybody who has worked on the code in the last
          couple of days has had a chance to yell <quote>no!</quote> in case

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

         </para>
       </listitem> 
       <listitem>
        <para>
         </para>
       </listitem> 
       <listitem>
        <para>

-         Increment the version number in <filename>configure.in</filename> in
-         CVS. Also, the RPM release number in
-         <filename>configure.in</filename>. Do NOT touch version information
-         after export from CVS. <emphasis>All packages</emphasis> will use the
-         version and release data from <filename>configure.in</filename>.
-         Local files should not be changed, except prior to a CVS commit!!!
-         This way we are all on the same page!
+         Increment the version number (point from odd to even in development
+         branches!) in <filename>configure.in</filename>. (RPM spec files 
+         will need to be incremented as well.)

        </para>
       </listitem> 
       <listitem>
        <para>
        </para>
       </listitem> 
       <listitem>
        <para>

-        If the default actionsfile has changed since last release,
-        bump up its version info in this line:
+        If <filename>default.action</filename> has changed since last
+        release (i.e. software release or standalone actions file release),
+        bump up its version info to A.B in this line:

        </para>
        <para> 
         <programlisting>
   {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}
        </para>
        <para> 
         <programlisting>
   {+add-header{X-Actions-File-Version: A.B} -filter -no-popups}

-        </programlisting>
+</programlisting>

        </para>
        <para> 
         Then change the version info in doc/webserver/actions/index.php,
         line: '$required_actions_file_version = "A.B";'
        </para>
        </para>
        <para> 
         Then change the version info in doc/webserver/actions/index.php,
         line: '$required_actions_file_version = "A.B";'
        </para>

+      </listitem>
+      <listitem>
+       <para>
+        All documentation should be rebuild after the version bump.
+        Finished docs should be then be committed to CVS (for those 
+        without the ability to build these). Some docs may require 
+        rather obscure processing tools. <filename>config</filename>,
+        the man page (and the html version of the man page), and the PDF docs
+        fall in this category. REAMDE, the man page, AUTHORS, and config
+        should all also be committed to CVS for other packagers. The 
+        formal docs should be uploaded to the webserver. See the
+        Section "Updating the webserver" in this manual for details.
+       </para>

       </listitem> 
       <listitem>
        <para>
       </listitem> 
       <listitem>
        <para>

-        Tag all files in CVS with the version number with
-        <quote><command>cvs tag v_X_Y_Z</command></quote> (where X = major, Y
-        = minor, Z = point). Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work)
-        etc.
+         The <citetitle>User Manual</citetitle> is also used for context 
+         sensitive help for the CGI editor. This is version sensitive, so that
+         the user will get appropriate help for his/her release. So with 
+         each release a fresh version should be uploaded to the webserver
+         (this is in addition to the main <citetitle>User Manual</citetitle>
+         link from the main page since we need to keep manuals for various 
+         versions available). The CGI pages will link to something like 
+         <literal>http://privoxy.org/$(VERSION)/user-manual/</literal>. This
+         will need to be updated for each new release. There is no Makefile
+         target for this at this time!!! It needs to be done manually.

        </para>
       </listitem> 
       <listitem>
        <para>
        </para>
       </listitem> 
       <listitem>
        <para>

-        The first package uploaded should be the official
-        <quote>tarball</quote> release. This is built with the
-        <quote><command>make tarball-dist</command></quote> Makefile 
-        target, and then can be uploaded with 
-        <quote><command>make tarball-upload</command></quote> (see below).
+        All developers should look at the <filename>ChangeLog</filename> and
+        make sure noteworthy changes are referenced.
+       </para>
+     </listitem> 
+      <listitem>
+       <para>
+        <emphasis>Commit all files that were changed in the above steps!</emphasis>
+       </para>
+      </listitem>
+      <listitem>
+       <para>
+        Tag all files in CVS with the version number with
+        <quote><command>cvs tag v_X_Y_Z</command></quote>.
+        Don't use vX_Y_Z, ver_X_Y_Z, v_X.Y.Z (won't work) etc.
+       </para>
+      </listitem> 
+     <listitem>
+       <para>
+        If the release was in a development branch, increase the point version
+        from even to odd (X.Y.(Z+1)) again in <filename>configure.in</filename> and
+        commit your change.
+       </para>
+      </listitem> 
+     <listitem>
+       <para>
+        On the webserver, copy the user manual to a new top-level directory
+        called <filename>X.Y.Z</filename>. This ensures that help links from the CGI
+        pages, which have the version as a prefix, will go into the right version of the manual.
+        If this is a development branch release, also symlink <filename>X.Y.(Z-1)</filename>
+        to <filename>X.Y.Z</filename> and <filename>X.Y.(Z+1)</filename> to
+        <filename>.</filename> (i.e. dot). 

        </para>
       </listitem> 
       </itemizedlist>
      </para> 
     </sect2>
     
        </para>
       </listitem> 
       </itemizedlist>
      </para> 
     </sect2>
     

-    <sect2 id="newrelease-web"><title>Update the webserver</title>
+    <sect2 id="therelease">
+    <title>Building and Releasing the Packages</title>
+     <para>
+      Now the individual packages can be built and released. Note that for
+      GPL reasons the first package to be released is always the source tarball.
+     </para>
+ 
+     <para>
+      For <emphasis>all</emphasis> types of packages, including the source tarball,
+      <emphasis>you must make sure that you build from clean sources by exporting
+      the right version from CVS into an empty directory</emphasis> (just press return when
+      asked for a password):
+     </para>
+      
+     <para>
+      <programlisting>
+  mkdir dist # delete or choose different name if it already exists
+  cd dist
+  cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa export -r v_X_Y_Z current
+</programlisting>
+    </para>
+  
+    <para>
+     <emphasis>Do NOT change</emphasis> a single bit, including, but not limited to
+     version information after export from CVS. This is to make sure that
+     all release packages, and with them, all future bug reports, are based
+     on exactly the same code.
+    </para>
+  
+    <warning>
+     <para>
+      Every significant release of Privoxy has included at least one 
+      package that either had incorrect versions of files, missing files, 
+      or incidental leftovers from a previous build process that gave 
+      unknown numbers of users headaches to try to figure out what was 
+      wrong. PLEASE, make sure you are using pristene sources, and are
+      following the prescribed process!
+     </para>
+    </warning>
+
+    <para>
+     Please find additional instructions for the source tarball and the
+     individual platform dependent binary packages below. And details 
+     on the Sourceforge release process below that.
+    </para>
+
+    <sect3 id="pack-guidelines">
+    <title>Note on Privoxy Packaging</title>
+     <para>
+      Please keep these general guidelines in mind when putting together 
+      your package. These apply to <emphasis>all</emphasis> platforms!
+     </para>
+     <para>
+      <itemizedlist>
+       <listitem>
+        <para>
+          <application>Privoxy</application> <emphasis>requires</emphasis>
+          write access to: all <filename>*.action</filename> files, all 
+          logfiles, and the <filename>trust</filename> file. You will 
+          need to determine the best way to do this for your platform.
+        </para>
+       </listitem> 
+       <listitem>
+        <para>
+          Please include up to date documentation. At a bare minimum:
+        </para>
+        <simplelist>
+         <member>
+          <filename>LICENSE</filename> (top-level directory)
+         </member>
+        </simplelist>
+        <simplelist>
+         <member>
+          <filename>README</filename> (top-level directory)
+         </member>
+        </simplelist>
+        <simplelist>
+         <member>
+          <filename>AUTHORS</filename> (top-level directory)
+         </member>
+        </simplelist>
+        <simplelist>
+         <member>
+          <filename>man page</filename> (top-level directory, Unix-like
+          platforms only)
+         </member>
+        </simplelist>
+        <simplelist>
+         <member>
+          <filename>The User Manual</filename> (doc/webserver/user-manual/)
+         </member>
+        </simplelist>
+        <simplelist>
+         <member>
+          <filename>FAQ</filename> (doc/webserver/faq/)
+         </member>
+        </simplelist>
+        <para>
+          Also suggested: <filename>Developer Manual</filename>
+          (doc/webserver/developer-manual) and <filename>ChangeLog</filename>
+          (top-level directory). <filename>FAQ</filename> and the manuals are
+          HTML docs. There are also text versions in
+          <filename>doc/text/</filename> which could conceivably also be
+          included.
+        </para>
+        <para>
+         The documentation has been designed such that the manuals are linked
+         to each other from parallel directories, and should be packaged 
+         that way. <filename>privoxy-index.html</filename> can also be
+         included and can serve as a focal point for docs and other links of
+         interest (and possibly renamed to <filename>index.html</filename>).
+         This should be one level up from the manuals. There is a link also 
+         on this page to an HTMLized version of the man page. To avoid 404 for
+         this, it is in CVS as
+         <filename>doc/webserver/man-page/privoxy-man-page.html</filename>,
+         and should be included along with the manuals. There is also a
+         css stylesheets that can be included for better presentation:
+         <filename>p_doc.css</filename>. This should be in the same directory
+         with <filename>privoxy-index.html</filename>, (i.e. one level up from
+         the manual directories).
+        </para>
+      </listitem> 
+      <listitem>
+       <para>
+        <filename>user.action</filename> and <filename>user.filter</filename>
+        are designed for local preferences. Make sure these do not get overwritten!
+        <filename>config</filename> should not be overwritten either. This 
+        has especially important configuration data in it.
+        <filename>trust</filename> should be left in tact as well.
+       </para>
+      </listitem> 
+      <listitem>
+       <para>
+        Other configuration files (<filename>default.action</filename>,
+        <filename>default.filter</filename> and
+        <filename>standard.action</filename>) should be installed as the new
+        defaults, but all previously installed configuration files should be
+        preserved as backups. This is just good manners :-) These files are
+        likely to change between releases and contain important new features
+        and bug fixes.
+       </para>
+     </listitem> 
+     <listitem>

       <para>
       <para>

-       All files must be group-readable and group-writable (or no one else
-       will be able to change them). To update the webserver, create any
-       pages locally in the <filename>doc/webserver</filename> directory (or
-       create new directories under <filename>doc/webserver</filename>), then do
+       Please check platform specific notes in this doc, if you haven't 
+       done <quote>Privoxy</quote> packaging before for other platform 
+       specific issues. Conversely, please add any notes that you know 
+       are important for your platform (or contact one of the doc 
+       maintainers to do this if you can't).
+      </para>
+    </listitem> 
+    <listitem>
+     <para>
+       Packagers should do a <quote>clean</quote> install of their 
+       package after building it. So any previous installs should be 
+       removed first to ensure the integrity of the newly built package. 
+       Then run the package for a while to make sure there are no 
+       obvious problems, before uploading.
+     </para>
+    </listitem> 
+
+      </itemizedlist>
+     </para> 
+    
+    </sect3>
+
+    <sect3 id="newrelease-tarball"><title>Source Tarball</title>
+        <para>
+       First, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then run:

        </para>
        <para>
        </para>
        <para>

-       <programlisting>
-  make webserver
-       </programlisting>
+       <programlisting>
+  cd current
+  autoheader && autoconf && ./configure
+</programlisting>

        </para>
        <para>
        </para>
        <para>

-       Note that <quote><command>make dok</command></quote> 
-     (or <quote><command>make redhat-dok</command></quote>) creates
-       <filename>doc/webserver/user-manual</filename>,
-       <filename>doc/webserver/developer-manual</filename>,
-       <filename>doc/webserver/faq</filename> and
-       <filename>doc/webserver/man-page</filename> automatically.
-      </para>
-      <para>
-      Please do NOT use any other means of transferring files to the
-      webserver. <quote><command>make webserver</command></quote> not only
-      uploads, but will make sure that the appropriate permissions are 
-      preserved for shared group access.
+       Then do:
+       </para>
+       <para>
+       <programlisting>
+  make tarball-dist
+</programlisting>
+       </para>
+       <para>
+       To upload the package to Sourceforge, simply issue
+       </para>
+       <para>
+       <programlisting>
+  make tarball-upload
+</programlisting>
+       </para>
+       <para>
+       Go to the displayed URL and release the file publicly on Sourceforge.
+        For the change log field, use the relevant section of the
+        <filename>ChangeLog</filename> file.

       </para>
       </para>

-    </sect2>
+    </sect3>

 
 

-    <sect2 id="newrelease-rpm"><title>SuSE or Red Hat</title>
-      <para>
-       Ensure that you have the latest code version. Hence run:
+    <sect3 id="newrelease-rpm"><title>SuSE, Conectiva or Red Hat RPM</title>
+        <para>
+        In following text, replace <replaceable class="parameter">dist</replaceable>
+        with either <quote>rh</quote> for Red Hat or <quote>suse</quote> for SuSE.
+        </para>
+        <para>
+       First, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). 

        </para>
        <para>
        </para>
        <para>

-       <programlisting>
-  cd current
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
+        As the only exception to not changing anything after export from CVS,
+        now examine the file <filename>privoxy-</filename><replaceable class="parameter">dist</replaceable><filename>.spec</filename>
+        and make sure that the version information and the RPM release number are
+        correct. The RPM release numbers for each version start at one. Hence it must
+        be reset to one if this is the first RPM for
+        <replaceable class="parameter">dist</replaceable> which is built from version
+        X.Y.Z. Check the
+        <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">file
+        list</ulink> if unsure. Else, it must be set to the highest already available RPM
+        release number for that version plus one.

        </para>
        <para>
        </para>
        <para>

-        first. 
+        Then run:

        </para>
        <para>
        <programlisting>
        </para>
        <para>
        <programlisting>

+  cd current

   autoheader && autoconf && ./configure
   autoheader && autoconf && ./configure

-       </programlisting>
+</programlisting>

        </para>
        <para>
        Then do
        </para>
        <para>
        <programlisting>
        </para>
        <para>
        Then do
        </para>
        <para>
        <programlisting>

-  make suse-dist or make redhat-dist
-       </programlisting>
+  make <replaceable class="parameter">dist</replaceable>-dist
+</programlisting>

        </para>
        <para>
        To upload the package to Sourceforge, simply issue
        </para>
        <para>
        <programlisting>
        </para>
        <para>
        To upload the package to Sourceforge, simply issue
        </para>
        <para>
        <programlisting>

-  make suse-upload or make redhat-upload
-       </programlisting>
+  make <replaceable class="parameter">dist</replaceable>-upload <replaceable class="parameter">rpm_packagerev</replaceable>
+</programlisting>

        </para>
        <para>
        </para>
        <para>

+        where <replaceable class="parameter">rpm_packagerev</replaceable> is the
+        RPM release number as determined above.

        Go to the displayed URL and release the file publicly on Sourceforge.
        Go to the displayed URL and release the file publicly on Sourceforge.

+        Use the release notes and change log from the source tarball package.

       </para>
       </para>

-    </sect2>
+    </sect3>

 
 

-    <sect2 id="newrelease-os2"><title>OS/2</title>
+    <sect3 id="newrelease-os2"><title>OS/2</title>

       <para>
       <para>

-       Ensure that you have the latest code version. Hence run:
+       First, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then get the OS/2 Setup module:

        </para>
        <para>
        <programlisting>
        </para>
        <para>
        <programlisting>

-  cd current
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-  cd ..
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co os2setup
-       </programlisting>
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co os2setup
+</programlisting>

        </para>
        <para>
        You will need a mix of development tools.
        </para>
        <para>
        You will need a mix of development tools.


@@ -2017,55 +2539,58 @@ at sourceforge. Three simple steps:
        Change directory to the <filename>os2setup</filename> directory.
        Edit the os2build.cmd file to set the final executable filename.
        For example, 
        Change directory to the <filename>os2setup</filename> directory.
        Edit the os2build.cmd file to set the final executable filename.
        For example, 

+       </para>
+       <para>

        <programlisting>
   installExeName='privoxyos2_setup_X.Y.Z.exe'
        <programlisting>
   installExeName='privoxyos2_setup_X.Y.Z.exe'

-       </programlisting>
+</programlisting>
+       </para>
+       <para>

        Next, edit the <filename>IJB.wis</filename> file so the release number matches
        in the <filename>PACKAGEID</filename> section:
        Next, edit the <filename>IJB.wis</filename> file so the release number matches
        in the <filename>PACKAGEID</filename> section:

-       <programlisting>
+       </para>
+       <para>
+       <programlisting>

   PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"
   PACKAGEID="Privoxy Team\Privoxy\Privoxy Package\X\Y\Z"

-       </programlisting>
+</programlisting>
+       </para>
+       <para>

        You're now ready to build.  Run:
        You're now ready to build.  Run:

+       </para>
+       <para>

        <programlisting>
   os2build
        <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.
+</programlisting>

        </para>
        </para>

-    </sect2>
+       <para>
+         You will find the  WarpIN-installable executable in the
+        <filename>./files</filename> directory. Upload this anonymously to
+         <filename>uploads.sourceforge.net/incoming</filename>, create a release
+         for it, and you're done. Use the release notes and Change Log from the
+         source tarball package.
+       </para>
+    </sect3>

 
 

-    <sect2 id="newrelease-solaris"><title>Solaris</title>
+    <sect3 id="newrelease-solaris"><title>Solaris</title>

       <para>
       <para>

-       Login to Sourceforge's compilefarm via ssh
+       Login to Sourceforge's compilefarm via ssh:

        </para>
        <para>
        <programlisting>
   ssh cf.sourceforge.net
        </para>
        <para>
        <programlisting>
   ssh cf.sourceforge.net

-       </programlisting>
+</programlisting>

        </para>
        <para>
        </para>
        <para>

-       Choose the right operating system (not the Debian one). If you have
-       downloaded <application>Privoxy</application> before,
+       Choose the right operating system (not the Debian one).
+        When logged in, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then run:

        </para>
        <para>
        <programlisting>
   cd current
        </para>
        <para>
        <programlisting>
   cd current

-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
-       </para>
-       <para>
-       If not, please <ulink
-       url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
-       Privoxy via CVS first</ulink>. Run:
-       </para>
-       <para>
-       <programlisting>

   autoheader && autoconf && ./configure
   autoheader && autoconf && ./configure

-       </programlisting>
+</programlisting>

        </para>
        <para>
        Then run
        </para>
        <para>
        Then run


@@ -2073,82 +2598,105 @@ at sourceforge. Three simple steps:
        <para>
        <programlisting>
   gmake solaris-dist
        <para>
        <programlisting>
   gmake solaris-dist

-       </programlisting>
+</programlisting>

        </para>
        <para>
        which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
        solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
        to manually upload the archive to Sourceforge's ftp server and release
        </para>
        <para>
        which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
        solaris-upload</command> on the Sourceforge machine (no ncftpput). You now have
        to manually upload the archive to Sourceforge's ftp server and release

-       the file publicly.
+       the file publicly. Use the release notes and Change Log from the
+        source tarball package.

        </para>
        </para>

-    </sect2>
+    </sect3>

 
 

-    <sect2 id="newrelease-windows"><title>Windows</title>
+    <sect3 id="newrelease-windows"><title>Windows</title>

       <para>
       <para>

-       Ensure that you have the latest code version. Hence run
-       </para>
-       <para>
-       <programlisting>
-  cd current
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
-       </para>
-       <para>
-        Run:
-       </para>
-       <para>
-       <programlisting>
-  autoheader && autoconf && ./configure
-       </programlisting>
-       </para>
-       <para>
-       Then do FIXME.
-       </para>
-    </sect2>
+        You should ensure you have the latest version of Cygwin (from
+        <ulink url="http://www.cygwin.com/">http://www.cygwin.com/</ulink>).
+        Run the following commands from within a Cygwin bash shell.
+      </para>
+      <para>
+       First, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then get the Windows setup module:
+      </para>
+      <para>
+      <programlisting>
+  cvs -z3  -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co winsetup
+</programlisting>
+      </para>
+      <para>
+        Then you can build the package.  This is fully automated, and is
+        controlled by <filename>winsetup/GNUmakefile</filename>.
+        All you need to do is:
+      </para>
+      <para>
+      <programlisting>
+  cd winsetup
+  make
+</programlisting>
+      </para>
+      <para>
+        Now you can manually rename <filename>privoxy_setup.exe</filename> to
+        <filename>privoxy_setup_X_Y_Z.exe</filename>, and upload it to
+        SourceForge. When releasing the package on SourceForge, use the release notes
+        and Change Log from the source tarball package.
+      </para>
+    </sect3>

 
 

-    <sect2 id="newrelease-debian"><title>Debian</title>
+    <sect3 id="newrelease-debian"><title>Debian</title>

       <para>
       <para>

-       Ensure that you have the latest code version. Hence run:
-       </para>
-       <para>
-       <programlisting>
-  cd current
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
-       </para>
-       <para>
-       first. Run:
-       </para>
-       <para>
-       <programlisting>
-  autoheader && autoconf && ./configure
-       </programlisting>
-       </para>
-       <para>
-       Then do FIXME.
-       </para>
-    </sect2>
+        First, <emphasis>make sure that you have freshly exported the
+        right version into an empty directory</emphasis>. (See
+        "Building and releasing packages" above).  Then add a log
+        entry to <filename>debian/changelog</filename>, if it is not
+        already there, for example by running:
+      </para>
+      <para>
+        <programlisting>
+  debchange -v &p-version;-&p-status;-1 "New upstream version"
+</programlisting>
+      </para>
+      <para>
+        Then, run: 
+      </para>
+      <para>
+        <programlisting>
+  dpkg-buildpackage -rfakeroot -us -uc -b
+</programlisting>
+      </para>
+      <para>
+        This will create
+        <filename>../privoxy_&p-version;-&p-status;-1_i386.deb</filename>
+        which can be uploaded.  To upload the package to Sourceforge, simply
+       issue
+      </para>
+      <para>
+        <programlisting>
+  make debian-upload
+</programlisting>
+      </para>
+    </sect3>

 
 

-    <sect2 id="newrelease-macosx"><title>Mac OSX</title>
+    <sect3 id="newrelease-macosx"><title>Mac OS X</title>

       <para>
       <para>

-       Ensure that you have the latest code version. Hence run:
+       First, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then get the Mac OS X setup module:

        </para>
        <para>
        <programlisting>
        </para>
        <para>
        <programlisting>

-  cd current
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-  cd ..
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co osxsetup
-       </programlisting>
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co osxsetup
+</programlisting>
+       </para>
+       <para>
+       Then run:

        </para>
        <para>
        </para>
        <para>

-       From the osxsetup directory, run:

        <programlisting>
        <programlisting>

+  cd osxsetup

   build
   build

-       </programlisting>
+</programlisting>

        </para>
        <para>
        This will run <filename>autoheader</filename>, <filename>autoconf</filename> and
        </para>
        <para>
        This will run <filename>autoheader</filename>, <filename>autoconf</filename> and


@@ -2161,52 +2709,40 @@ at sourceforge. Three simple steps:
        name to match the release, and hit the "Create package" button.
        If you specify ./Privoxy.pkg as the output package name, you can then create
        the distributable zip file with the command:
        name to match the release, and hit the "Create package" button.
        If you specify ./Privoxy.pkg as the output package name, you can then create
        the distributable zip file with the command:

+       </para>
+       <para>

        <programlisting>
        <programlisting>

-zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
-       </programlisting>
+  zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
+</programlisting>
+       </para>
+       <para>

        You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to 
        <filename>uploads.sourceforge.net/incoming</filename>,
        You can then upload <filename>privoxyosx_setup_x.y.z.zip</filename> anonymously to 
        <filename>uploads.sourceforge.net/incoming</filename>,

-       create a release for it, and you're done.
+       create a release for it, and you're done. Use the release notes
+        and Change Log from the source tarball package.

        </para>
        </para>

-    </sect2>
+    </sect3>

 
 

-    <sect2 id="newrelease-freebsd"><title>FreeBSD</title>
-      <para>
-       Change the version number of <application>Privoxy</application> in the
-       configure.in file. Run:
-       <programlisting>
-  autoheader && autoconf && ./configure
-       </programlisting>
-       Then ...
-      </para>
+    <sect3 id="newrelease-freebsd"><title>FreeBSD</title>

       <para>
       <para>

-       Login to Sourceforge's compilefarm via ssh:
+       Login to Sourceforge's compile-farm via ssh:

        </para>
        <para>
        <programlisting>
   ssh cf.sourceforge.net
        </para>
        <para>
        <programlisting>
   ssh cf.sourceforge.net

-       </programlisting>
+</programlisting>

        </para>
        <para>
        </para>
        <para>

-       Choose the right operating system. If you have downloaded Privoxy
-       before,
+       Choose the right operating system.
+        When logged in, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then run:

        </para>
        <para>
        <programlisting>
   cd current
        </para>
        <para>
        <programlisting>
   cd current

-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
-       </para>
-       <para>
-       If not, please <ulink
-       url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
-       Privoxy via CVS first</ulink>. Run:
-       </para>
-       <para>
-       <programlisting>

   autoheader && autoconf && ./configure
   autoheader && autoconf && ./configure

-       </programlisting>
+</programlisting>

        </para>
        <para>
        Then run:
        </para>
        <para>
        Then run:


@@ -2214,134 +2750,71 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
        <para>
        <programlisting>
   gmake freebsd-dist
        <para>
        <programlisting>
   gmake freebsd-dist

-       </programlisting>
+</programlisting>

        </para>
        <para>
        which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
        freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
        to manually upload the archive to Sourceforge's ftp server and release
        </para>
        <para>
        which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
        freebsd-upload</command> on the Sourceforge machine (no ncftpput). You now have
        to manually upload the archive to Sourceforge's ftp server and release

-       the file publicly.
+       the file publicly. Use the release notes and Change Log from the
+        source tarball package.

        </para>
        </para>

-    </sect2>
+    </sect3>

 
 

-    <sect2 id="newrelease-tarball"><title>Tarball</title>
+    <sect3 id="newrelease-hpux"><title>HP-UX 11</title>

       <para>
       <para>

-       Ensure that you have the latest code version. Hence run:
+       First, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then run:

        </para>
        <para>
        <programlisting>
   cd current
        </para>
        <para>
        <programlisting>
   cd current

-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
-       </para>
-       <para>
-       first. Run:
-       </para>
-       <para>
-       <programlisting>
-  make clobber

   autoheader && autoconf && ./configure
   autoheader && autoconf && ./configure

-       </programlisting>
-       </para>
-       <para>
-       Then do:
-       </para>
-       <para>
-       <programlisting>
-  make tarball-dist
-       </programlisting>
-       </para>
-       <para>
-       To upload the package to Sourceforge, simply issue
-       </para>
-       <para>
-       <programlisting>
-  make tarball-upload
-       </programlisting>
-       </para>
-       <para>
-       Goto the displayed URL and release the file publicly on Sourceforge.
-      </para>
-    </sect2>
-
-    <sect2 id="newrelease-hpux"><title>HP-UX 11</title>
-      <para>
-       Ensure that you have the latest code version. Hence run:
-       </para>
-       <para>
-       <programlisting>
-  cd current
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
-       </para>
-       <para>
-       first. Run:
-       </para>
-       <para>
-       <programlisting>
-  autoheader && autoconf && ./configure
-       </programlisting>
+</programlisting>

        </para>
        <para>
        Then do FIXME.
        </para>
        </para>
        <para>
        Then do FIXME.
        </para>

-    </sect2>
+    </sect3>

 
 

-    <sect2 id="newrelease-amiga"><title>Amiga OS</title>
+    <sect3 id="newrelease-amiga"><title>Amiga OS</title>

       <para>
       <para>

-       Ensure that you have the latest code version. Hence run:
+       First, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then run:

        </para>
        <para>
        <programlisting>
   cd current
        </para>
        <para>
        <programlisting>
   cd current

-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
-       </para>
-       <para>
-       first. Run:
-       </para>
-       <para>
-       <programlisting>

   autoheader && autoconf && ./configure
   autoheader && autoconf && ./configure

-       </programlisting>
+</programlisting>

        </para>
        <para>
        Then do FIXME.
        </para>
        </para>
        <para>
        Then do FIXME.
        </para>

-    </sect2>
+    </sect3>

 
 

-    <sect2 id="newrelease-aix"><title>AIX</title>
+    <sect3 id="newrelease-aix"><title>AIX</title>

       <para>
        Login to Sourceforge's compilefarm via ssh:
        </para>
        <para>
        <programlisting>
   ssh cf.sourceforge.net
       <para>
        Login to Sourceforge's compilefarm via ssh:
        </para>
        <para>
        <programlisting>
   ssh cf.sourceforge.net

-       </programlisting>
+</programlisting>

        </para>
        <para>
        </para>
        <para>

-       Choose the right operating system. If you have downloaded Privoxy
-       before:
+       Choose the right operating system.
+        When logged in, <emphasis>make sure that you have freshly exported the right
+        version into an empty directory</emphasis>. (See "Building and releasing
+        packages" above). Then run:

        </para>
        <para>
        <programlisting>
   cd current
        </para>
        <para>
        <programlisting>
   cd current

-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
-  cvs -z3  -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa export -r  v_X_Y_Z current
-       </programlisting>
-       </para>
-       <para>
-       If not, please <ulink
-       url="http://www.privoxy.org/user-manual/user-manual/installation.html#INSTALLATION-SOURCE">checkout
-       Privoxy via CVS first</ulink>. Run:
-       </para>
-       <para>
-       <programlisting>

   autoheader && autoconf && ./configure
   autoheader && autoconf && ./configure

-       </programlisting>
+</programlisting>

        </para>
        <para>
        Then run:
        </para>
        <para>
        Then run:


@@ -2349,18 +2822,151 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
        <para>
        <programlisting>
   make aix-dist
        <para>
        <programlisting>
   make aix-dist

-       </programlisting>
+</programlisting>

        </para>
        <para>
        which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
        aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
        to manually upload the archive to Sourceforge's ftp server and release
        </para>
        <para>
        which creates a gzip'ed tar archive. Sadly, you cannot use <command>make
        aix-upload</command> on the Sourceforge machine (no ncftpput). You now have
        to manually upload the archive to Sourceforge's ftp server and release

-       the file publicly.
+       the file publicly. Use the release notes and Change Log from the
+        source tarball package.

        </para>
        </para>

-    </sect2>
+    </sect3>
+   </sect2>
+
+   <sect2 id="releasing">
+   <title>Uploading and Releasing Your Package</title>
+    <para>
+      After the package is ready, it is time to upload it 
+      to SourceForge, and go through the release steps. The upload
+      is done via FTP:
+    </para>
+     <para>
+      <itemizedlist>
+       <listitem>
+        <para>
+          Upload to: <ulink url="ftp://upload.sourceforge.net/incoming">ftp://upload.sourceforge.net/incoming</ulink>
+        </para>
+      </listitem> 
+      <listitem>
+       <para>
+         user: <literal>anonymous</literal>
+       </para>
+      </listitem> 
+      <listitem>
+       <para>
+         password: <literal>ijbswa-developers@lists.sourceforge.net</literal>
+       </para>
+      </listitem> 
+     </itemizedlist>
+    </para> 
+    <para>
+     Or use the <command>make</command> targets as described above.
+    </para>
+    <para>
+     Once this done go to <ulink
+      url="https://sourceforge.net/project/admin/editpackages.php?group_id=11118"
+      >https://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>, 
+     making sure you are logged in. Find your target platform in the 
+     second column, and click <literal>Add Release</literal>. You will 
+     then need to create a new release for your package, using the format 
+     of <literal>$VERSION ($CODE_STATUS)</literal>, e.g. <emphasis>&p-version;
+     (beta)</emphasis>.
+    </para>
+    <para>
+     Now just follow the prompts. Be sure to add any appropriate Release
+     notes. You should see your freshly uploaded packages in 
+     <quote>Step 2. Add Files To This Release</quote>. Check the 
+     appropriate box(es). Remember at each step to hit the 
+     <quote>Refresh/Submit</quote> buttons! You should now see your 
+     file(s) listed in Step 3. Fill out the forms with the appropriate 
+     information for your platform, being sure to hit <quote>Update</quote>
+     for each file. If anyone is monitoring your platform, check the 
+     <quote>email</quote> box at the very bottom to notify them of 
+     the new package. This should do it!
+    </para>
+    <para>
+     If you have made errors, or need to make changes, you can go through 
+     essentially the same steps, but select <literal>Edit Release</literal>, 
+     instead of <literal>Add Release</literal>.
+    </para>
+   </sect2>
+
+    <sect2 id="afterrelease">
+    <title>After the Release</title>
+     <para>
+      When all (or: most of the) packages have been uploaded and made available,
+      send an email to the <ulink url="mailto:ijbswa-announce@lists.sourceforge.net">announce
+      mailing list</ulink>, Subject: "Version X.Y.Z available for download". Be sure to
+      include the
+      <ulink url="http://sourceforge.net/project/showfiles.php?group_id=11118">download
+      location</ulink>, 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.
+     </para>
+   </sect2>

 
   </sect1>
   
 
   </sect1>
   

+  <!--   ~~~~~       New section      ~~~~~     -->
+  <sect1 id="webserver-update"><title>Update the Webserver</title>
+   <para>
+    The webserver should be updated at least with each stable release. When
+    updating, please follow these steps to make sure that no broken links,
+    inconsistent contents or permission problems will occur (as it has many 
+    times in the past!):
+   </para>
+   <para>
+    If you have changed anything in the stable-branch documentation source
+    SGML files, do:
+   </para>
+   <para>
+    <programlisting>
+  make dok dok-pdf # (or 'make redhat-dok dok-pdf' if 'make dok' doesn't work for you)
+</programlisting>
+   </para>
+   <para>
+    That will generate <filename>doc/webserver/user-manual</filename>,
+    <filename>doc/webserver/developer-manual</filename>,
+    <filename>doc/webserver/faq</filename>, 
+    <filename>doc/pdf/*.pdf</filename> and
+    <filename>doc/webserver/index.html</filename> automatically.
+   </para>
+   <para>
+    If you changed the manual page sources, generate
+    <filename>doc/webserver/man-page/privoxy-man-page.html</filename>
+    by running <quote><command>make man</command></quote>. (This is
+    a separate target due to dependencies on some obscure perl scripts
+    [now in CVS, but not well tested]. See comments in <filename>GNUmakefile</filename>.)
+   </para>
+   <para>
+    If you want to add new files to the webserver, create them locally in
+    the <filename>doc/webserver/*</filename> directory (or
+    create new directories under <filename>doc/webserver</filename>).
+   </para>
+   <para>
+    Next, commit any changes from the above steps to CVS. All set? 
+    If these are docs in the stable branch, then do:
+   </para>
+   <para>
+    <programlisting>
+  make webserver
+</programlisting>
+   </para>
+   <para>
+    This will do the upload to <ulink url="http://www.privoxy.org/">the
+    webserver</ulink> (www.privoxy.org) and ensure all files and directories
+    there are group writable.
+   </para>
+   <para>
+    Please do <emphasis>NOT</emphasis> use any other means of transferring
+    files to the webserver to avoid permission problems. Also, please do not
+    upload docs from development branches or versions. The publicly posted
+    docs should be in sync with the last official release.
+   </para>
+  </sect1>
+

   <!--   ~~~~~       New section      ~~~~~     -->
   <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
 <!-- Include contacting.sgml  -->
   <!--   ~~~~~       New section      ~~~~~     -->
   <sect1 id="contact"><title>Contacting the developers, Bug Reporting and Feature Requests</title>
 <!-- Include contacting.sgml  -->


@@ -2368,22 +2974,30 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
 <!-- end contacting -->
   </sect1>
   
 <!-- end contacting -->
   </sect1>
   

-  <!--   ~~~~~       New section      ~~~~~     -->
-  <sect1 id="copyright"><title>Copyright and History</title>

 
 

-<sect2><title>Copyright</title>
+<!--   ~~~~~~~~       New section Header    ~~~~~~~~~     -->
+<sect1 id="copyright"><title>Privoxy Copyright, License and History</title>
+

 <!-- Include copyright.sgml -->
  &copyright;
 <!-- end -->
 <!-- Include copyright.sgml -->
  &copyright;
 <!-- end -->

+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2><title>License</title>
+<!-- Include copyright.sgml: -->
+ &license;
+<!-- end copyright -->

 </sect2>
 </sect2>

+<!--  ~  End section  ~  -->

 
 

+<!--   ~~~~~       New section      ~~~~~     -->

 <sect2><title>History</title>
 <!-- Include history.sgml -->
  &history;
 <!-- end -->
 </sect2>
 
 <sect2><title>History</title>
 <!-- Include history.sgml -->
  &history;
 <!-- end -->
 </sect2>
 

-  </sect1>
+</sect1>

   
   <!--   ~~~~~       New section      ~~~~~     -->
   <sect1 id="seealso"><title>See also</title>
   
   <!--   ~~~~~       New section      ~~~~~     -->
   <sect1 id="seealso"><title>See also</title>


@@ -2414,6 +3028,164 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
   $Log: developer-manual.sgml,v $
   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
   $Log: developer-manual.sgml,v $

+  Revision 2.20  2008/06/14 13:21:24  fabiankeil
+  Prepare for the upcoming 3.0.9 beta release.
+
+  Revision 2.19  2008/05/12 11:13:33  fabiankeil
+  Clarify that Privoxy is licensed under GPL version 2.
+
+  Revision 2.18  2008/02/04 12:14:06  fabiankeil
+  Change "Edit Packages" URL to use https.
+
+  Revision 2.17  2008/02/03 21:37:41  hal9
+  Apply patch from Mark: s/OSX/OS X/
+
+  Revision 2.16  2008/01/19 17:52:38  hal9
+  Re-commit to fix various minor issues for new release.
+
+  Revision 2.15  2008/01/19 15:03:05  hal9
+  Doc sources tagged for 3.0.8 release.
+
+  Revision 2.14  2008/01/17 01:49:51  hal9
+  Change copyright notice for docs s/2007/2008/. All these will be rebuilt soon
+  enough.
+
+  Revision 2.13  2007/10/30 17:59:31  fabiankeil
+  - Bump p-version, p-status and copyright date.
+  - Mention that the manual is out of date.
+  - Don't use examples with HardToReadCamelCase after
+    explaining that we actually don't like that.
+  - Minor cosmetics.
+
+  Revision 2.12  2006/11/14 01:57:46  hal9
+  Dump all docs prior to 3.0.6 release. Various minor changes to faq and user
+  manual.
+
+  Revision 2.11  2006/09/26 02:36:29  hal9
+  Fix broken link per bug tracker.
+
+  Revision 2.10  2006/09/22 01:27:55  hal9
+  Final commit of probably various minor changes here and there. Unless
+  something changes this should be ready for pending release.
+
+  Revision 2.9  2006/09/14 02:30:07  hal9
+  Fix ijbswa cvs links. Update notes on release process, and which config files
+  should be overwritten and which not.
+
+  Revision 2.8  2006/08/22 23:35:01  hal9
+  Fix email address, cvs URI, address branching changes and various other
+  small updates.
+
+  Revision 2.7  2006/07/18 14:48:50  david__schmidt
+  Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
+  with what was really the latest development (the v_3_0_branch branch)
+
+  Revision 1.46.2.11  2002/12/11 13:12:15  hal9
+  Rewrite cvs write access give-away section.
+
+  Revision 1.46.2.10  2002/09/26 21:53:45  hal9
+  Changes to reflect recent change in stable branch commit policy (hopefully
+  clearer now).
+
+  Revision 1.46.2.9  2002/09/26 01:21:40  hal9
+  Porting 3.1.1 changes: more on cvs and branches, more on versions and
+  releases.
+
+  Revision 1.46.2.8  2002/08/17 00:16:10  hal9
+  Add note on updating webserver for User-manual/CGI editor, which is version
+  dependent (and different from main UM link).
+
+  Revision 1.46.2.7  2002/08/14 17:29:25  hal9
+  Add small notes on post-release steps, and uploading docs to webserver.
+
+  Revision 1.46.2.6  2002/08/10 11:40:25  oes
+  Added disclaimer about probably being out-of-date and two small hints
+
+  Revision 1.46.2.5  2002/08/09 01:15:12  hal9
+  Added some notes on pre-release steps (test builds first, update ChangeLog).
+
+  Revision 1.46.2.4  2002/05/29 00:30:59  mal0rd
+  Fixed a little formatting.  Clarified debian section.
+
+  Revision 1.46.2.3  2002/05/28 04:32:45  hal9
+  Change hints on bundling index.html to privoxy-index.html
+
+  Revision 1.46.2.2  2002/05/26 17:04:24  hal9
+  -Spellcheck, very minor edits, and sync across branches
+
+  Revision 1.48  2002/05/26 12:48:31  roro
+  Add releasing information about Debian.
+
+  Revision 1.47  2002/05/26 04:55:11  mal0rd
+  Added debian-dist and debian-upload targets.  Also documented usage.
+
+  Revision 1.46  2002/05/22 17:15:00  oes
+  Updated intro
+
+  Revision 1.45  2002/05/19 23:01:54  hal9
+  Add small section on general packaging guidelines (e.g. actions files must
+  be writable).
+
+  Revision 1.44  2002/05/15 03:55:17  hal9
+  Fix ulink -> link, and minor modification to release process section for
+  clarification.
+
+  Revision 1.43  2002/05/10 01:48:19  hal9
+  This is mostly proposed copyright/licensing additions and changes. Docs
+  are still GPL, but licensing and copyright are more visible. Also, copyright
+  changed in doc header comments (eliminate references to JB except FAQ).
+
+  Revision 1.42  2002/05/05 20:26:02  hal9
+  Sorting out license vs copyright in these docs.
+
+  Revision 1.41  2002/05/04 08:44:44  swa
+  bumped version
+
+  Revision 1.40  2002/05/04 00:43:43  hal9
+  -Remove TOC/first page kludge with proper stylesheet fix.
+  -Combined the two very brief sections: Intro and Quickstart.
+
+  Revision 1.39  2002/05/02 15:08:25  oes
+  Added explanation about version numbers and RPM package revisions
+
+  Revision 1.38  2002/04/29 02:20:31  hal9
+  Add info on steps for uploading and the release process on SF.
+
+  Revision 1.37  2002/04/26 17:23:29  swa
+  bookmarks cleaned, changed structure of user manual, screen and programlisting cleanups, and numerous other changes that I forgot
+
+  Revision 1.36  2002/04/26 05:25:23  hal9
+  Mass commit to catch a few scattered fixes.
+
+  Revision 1.35  2002/04/17 15:16:15  oes
+  Added link to docbook crash course
+
+  Revision 1.34  2002/04/15 23:39:32  oes
+   - Extended & fixed the release section
+   - Added CVS guideline sections
+   - Separated webserver section from release section
+   - Commented out boilerplate inclusion (If you don't know yet what it is,
+     you shouldn't mess with its code ;-)
+   - Nits & fixes
+
+  Revision 1.33  2002/04/12 03:49:53  hal9
+  Spell checked. Clarification on where docs are kept.
+
+  Revision 1.32  2002/04/11 21:29:58  jongfoster
+  Documenting Win32 release procedure
+
+  Revision 1.31  2002/04/11 09:32:52  oes
+  more nits
+
+  Revision 1.30  2002/04/11 09:24:53  oes
+  nits
+
+  Revision 1.29  2002/04/10 18:45:14  swa
+  generated
+
+  Revision 1.28  2002/04/08 22:59:26  hal9
+  Version update. Spell chkconfig correctly :)
+

   Revision 1.27  2002/04/08 15:31:18  hal9
   Touch ups to documentation section.
 
   Revision 1.27  2002/04/08 15:31:18  hal9
   Touch ups to documentation section.
 


@@ -2444,7 +3216,7 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
   More boilerplate text for use across multiple docs.
 
   Revision 1.20  2002/04/04 03:28:27  david__schmidt
   More boilerplate text for use across multiple docs.
 
   Revision 1.20  2002/04/04 03:28:27  david__schmidt

-  Add Mac OSX section
+  Add Mac OS X section

 
   Revision 1.19  2002/04/03 15:09:42  david__schmidt
   Add OS/2 build section
 
   Revision 1.19  2002/04/03 15:09:42  david__schmidt
   Add OS/2 build section