Fix ulink -> link, and minor modification to release process section for
[privoxy.git] / doc / source / developer-manual.sgml
index 995537f..89c1264 100644 (file)
@@ -7,12 +7,14 @@
 <!entity seealso SYSTEM "seealso.sgml">
 <!entity contacting SYSTEM "contacting.sgml">
 <!entity copyright SYSTEM "copyright.sgml">
-<!entity p-version "2.9.14">
+<!entity license SYSTEM "license.sgml">
+<!entity p-version "2.9.15">
 <!entity p-status "beta">
 <!entity % p-not-stable "INCLUDE">
 <!entity % p-stable "IGNORE">
 <!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 $
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: developer-manual.sgml,v 1.38 2002/04/29 02:20:31 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 1.43 2002/05/10 01:48:19 hal9 Exp $
 
+ Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
+ See LICENSE.
 
  ========================================================================
  NOTE: Please read developer-manual/documentation.html before touching 
 <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, 2002 by 
+      <ulink url="http://www.privoxy.org">Privoxy Developers</ulink>
+     </subscript>
+    </pubdate>
+
 
-    <pubdate>$Id: developer-manual.sgml,v 1.38 2002/04/29 02:20:31 hal9 Exp $</pubdate>
+    <pubdate>$Id: developer-manual.sgml,v 1.43 2002/05/10 01:48:19 hal9 Exp $</pubdate>
+
+<!--
 
-    <authorgroup>
-      <author>
-        <affiliation>
-          <orgname>By: Privoxy Developers</orgname>
-        </affiliation>
-      </author>
-    </authorgroup>
+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.
+
+<legalnotice id="legalnotice"> 
+ <para>
+  text goes here ........
+ </para>
+</legalnotice>
+
+-->
 
     <abstract>
+
 <![%dummy;[
  <para>
  <comment>
 <para>
  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 <ulink url="contact.html">the Contact section</ulink> 
+ Please see <link linkend="contact">the Contact section</link> 
  on how to contact the developers.
 </para>
-
 <!--        <para> -->
 <!--    Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>. -->
 <!--   </para> -->
     </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      ~~~~~     -->
-  <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.
      One does not have to be a programmer to contribute. Packaging, testing,
      and porting, are all important jobs as well.
     </para>
-  </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->
-  <sect1 id="quickstart"><title>Quickstart to Privoxy Development</title>
+  <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
       For the time being (read, this section is under construction), please
       refer to the extensive comments in the source code.
     </para>
+   </sect2>
   </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->
@@ -1720,7 +1726,7 @@ static void unload_re_filterfile( void *f ) { ... }</programlisting>
 
     <para><emphasis>Example for file comments:</emphasis></para>
 <programlisting>
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.38 2002/04/29 02:20:31 hal9 Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.43 2002/05/10 01:48:19 hal9 Exp $";
 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
@@ -1780,7 +1786,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
 <programlisting>
 #ifndef _FILENAME_H
 #define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.38 2002/04/29 02:20:31 hal9 Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.43 2002/05/10 01:48:19 hal9 Exp $"
 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
@@ -2113,7 +2119,8 @@ at sourceforge. Three simple steps:
   
     <para>
      Please find additional instructions for the source tarball and the
-     individual platform dependent binary packages below.
+     individual platform dependent binary packages below. And details 
+     on the Sourceforge release process below that.
     </para>
 
     <sect3 id="newrelease-tarball"><title>Source Tarball</title>
@@ -2151,7 +2158,7 @@ at sourceforge. Three simple steps:
       </para>
     </sect3>
 
-    <sect3 id="newrelease-rpm"><title>SuSE or Red Hat RPM</title>
+    <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.
@@ -2535,6 +2542,9 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
       </listitem> 
      </itemizedlist>
     </para> 
+    <para>
+     Or use the <command>make</command> targets as described above.
+    </para>
     <para>
      Once this done go to <ulink url="http://sourceforge.net/project/admin/editpackages.php?group_id=11118">http://sourceforge.net/project/admin/editpackages.php?group_id=11118</ulink>, 
      making sure you are logged in. Find your target platform in the 
@@ -2636,22 +2646,30 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
 <!-- 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 -->
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2><title>License</title>
+<!-- Include copyright.sgml: -->
+ &license;
+<!-- end copyright -->
 </sect2>
+<!--  ~  End section  ~  -->
 
+<!--   ~~~~~       New section      ~~~~~     -->
 <sect2><title>History</title>
 <!-- Include history.sgml -->
  &history;
 <!-- end -->
 </sect2>
 
-  </sect1>
+</sect1>
   
   <!--   ~~~~~       New section      ~~~~~     -->
   <sect1 id="seealso"><title>See also</title>
@@ -2682,6 +2700,24 @@ zip -r privoxyosx_setup_x.y.z.zip Privoxy.pkg
   Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
   $Log: developer-manual.sgml,v $
+  Revision 1.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.