we have a new homepage!

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

diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
index ddce0f5..ab6b9ba 100644 (file)
--- a/doc/source/developer-manual.sgml
+++ b/doc/source/developer-manual.sgml
@@ -6,10 +6,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.5 2001/10/31 18:16:51 swa Exp $
+ $Id: developer-manual.sgml,v 1.10 2002/03/24 12:33:01 swa Exp $

 
  Written by and Copyright (C) 2001 the SourceForge
 
  Written by and Copyright (C) 2001 the SourceForge

- IJBSWA team.  http://ijbswa.sourceforge.net
+ Privoxy team. http://www.privoxy.org/

 
  Based on the Internet Junkbuster originally written
  by and Copyright (C) 1997 Anonymous Coders and 
 
  Based on the Internet Junkbuster originally written
  by and Copyright (C) 1997 Anonymous Coders and 


@@ -18,34 +18,40 @@
 
 <article id="index">
   <artheader>
 
 <article id="index">
   <artheader>

-    <title>Junkbuster Developer Manual</title>
+    <title>Privoxy Developer Manual</title>

 
 

-    <pubdate>$Id: developer-manual.sgml,v 1.5 2001/10/31 18:16:51 swa Exp $</pubdate>
+    <pubdate>$Id: developer-manual.sgml,v 1.10 2002/03/24 12:33:01 swa Exp $</pubdate>

 
     <authorgroup>
       <author>
         <affiliation>
 
     <authorgroup>
       <author>
         <affiliation>

-          <orgname>By: Junkbuster Developers</orgname>
+          <orgname>By: Privoxy Developers</orgname>

         </affiliation>
       </author>
     </authorgroup>
 
     <abstract>
       <para>
         </affiliation>
       </author>
     </authorgroup>
 
     <abstract>
       <para>

-    The developer manual gives the users information on how to help the developer
+The developer manual gives the users information on how to help the developer

 team. It provides guidance on coding, testing, documentation and other
 team. It provides guidance on coding, testing, documentation and other

-issues. The Internet Junkbuster is an application
-that provides privacy and security to the user of the world wide web.
+issues. <application>Privoxy</application> is a web proxy with advanced
+filtering capabilities for protecting privacy, filtering web page content,
+managing cookies, controlling access, and removing ads, banners, pop-ups and
+other obnoxious Internet Junk. <application>Privoxy</application> has a very
+flexible configuration and can be customized to suit individual needs and
+tastes. <application>Privoxy</application> has application for both stand-alone
+systems and multi-user networks.

  </para>
       <para>
 You can find the latest version of the user manual at <ulink
  </para>
       <para>
 You can find the latest version of the user manual at <ulink

-url="http://ijbswa.sourceforge.net/developer-manual/">http://ijbswa.sourceforge.net/developer-manual/</ulink>.
+url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/</ulink>.

 Please see the Contact section in the user-manual if you want to contact the developers.
  </para>
 
 Please see the Contact section in the user-manual if you want to contact the developers.
  </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> -->
+

     </abstract>
   </artheader>
 
     </abstract>
   </artheader>
 


@@ -56,11 +62,33 @@ Please see the Contact section in the user-manual if you want to contact the dev
   </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->
   </sect1>
 
   <!--   ~~~~~       New section      ~~~~~     -->

-  <sect1 id="quickstart"><title>Quickstart to Junkbuster Development</title>
-    <para>To be filled.
-</para>
-  </sect1>
-
+  <sect1 id="quickstart"><title>Quickstart to Privoxy Development</title>
+    <para>
+You'll need an account on Sourceforge to support our development. Mail you ID
+to the list and wait until a project manager has added you.
+
+For the time beeing (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>     
+       

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


@@ -83,7 +111,7 @@ via scp.
   </para>
  </sect1>
 
   </para>
  </sect1>
 

-<!--     <listitem><para>be consistent with the redirect script (i.e. the junkbuster program -->
+<!--     <listitem><para>be consistent with the redirect script (i.e. the <application>Privoxy</application> program -->

 <!--       points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
 
   <!--   ~~~~~       New section      ~~~~~     -->
 <!--       points via the redirect URL at sf to valid end-points in the document)</para></listitem> -->
 
   <!--   ~~~~~       New section      ~~~~~     -->


@@ -91,16 +119,16 @@ via scp.
 
     <sect2 id="s1"><title>Introduction</title>
 
 
     <sect2 id="s1"><title>Introduction</title>
 

-    <para>This set of standards is designed to make our lives easier.
-    It is developed with the simple goal of helping us keep the
-    "new and improved Junkbusters" consistent and reliable. Thus
-    making maintenance easier and increasing chances of success of
-    the project.</para>
+    <para>This set of standards is designed to make our lives easier.  It is
+    developed with the simple goal of helping us keep the "new and improved
+    <application>Privoxy</application>" consistent and reliable. Thus making
+    maintenance easier and increasing chances of success of the
+    project.</para>

 
 

-    <para>And that of course comes back to us as individuals. If we
-    can increase our development and product efficiencies then we
-    can solve more of the request for changes/improvements and in
-    general feel good about ourselves. ;-></para>
+    <para>And that of course comes back to us as individuals. If we can
+    increase our development and product efficiencies then we can solve more
+    of the request for changes/improvements and in general feel good about
+    ourselves. ;-></para>

 
   </sect2>
 
 
   </sect2>
 


@@ -333,7 +361,7 @@ if ( 1 == X )
     reserves these for use by the compiler and system headers.) Do
     not use identifiers which are reserved in ANSI C++. (E.g.
     template, class, true, false, ...). This is in case we ever
     reserves these for use by the compiler and system headers.) Do
     not use identifiers which are reserved in ANSI C++. (E.g.
     template, class, true, false, ...). This is in case we ever

-    decide to port JunkBuster to C++.</para>
+    decide to port Privoxy to C++.</para>

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


@@ -360,7 +388,7 @@ int msiis5hack = 0; int msIis5Hack = 0;
     reserves these for use by the compiler and system headers.) Do
     not use identifiers which are reserved in ANSI C++. (E.g.
     template, class, true, false, ...). This is in case we ever
     reserves these for use by the compiler and system headers.) Do
     not use identifiers which are reserved in ANSI C++. (E.g.
     template, class, true, false, ...). This is in case we ever

-    decide to port JunkBuster to C++.</para>
+    decide to port Privoxy to C++.</para>

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


@@ -818,7 +846,7 @@ for ( size_t cnt = 0; cnt &lt; len; cnt ++ )
     char *s2 );</para>
 
     <para>I could then not use it to compare argv's in main: int main(
     char *s2 );</para>
 
     <para>I could then not use it to compare argv's in main: int main(

-    int argc, const char *argv[] ) { strcmp( argv[0], "junkbusters"
+    int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"

     ); }</para>
 
     <para>Both these pointers are *const*! If the c runtime library
     ); }</para>
 
     <para>Both these pointers are *const*! If the c runtime library


@@ -1213,7 +1241,7 @@ 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.5 2001/10/31 18:16:51 swa Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.10 2002/03/24 12:33:01 swa Exp $";

 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$


@@ -1221,7 +1249,7 @@ const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.5 2001/10/31 18:16:5
  * Purpose     :  (Fill me in with a good description!)
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  * Purpose     :  (Fill me in with a good description!)
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge

- *                IJBSWA team.  http://ijbswa.sourceforge.net
+ *                Privoxy team. http://www.privoxy.org/

  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and
  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and


@@ -1273,7 +1301,7 @@ 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.5 2001/10/31 18:16:51 swa Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.10 2002/03/24 12:33:01 swa Exp $"

 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$
 /*********************************************************************
  *
  * File        :  $S<!-- Break CVS Substitution -->ource$


@@ -1281,7 +1309,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION;
  * Purpose     :  (Fill me in with a good description!)
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  * Purpose     :  (Fill me in with a good description!)
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge

- *                IJBSWA team.  http://ijbswa.sourceforge.net
+ *                Privoxy team. http://www.privoxy.org/

  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and
  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and


@@ -1393,20 +1421,20 @@ Remove any existing rpm with rpm -e
           <listitem><para>
 Remove any file that was left over. This includes (but is not limited to)
       <itemizedlist>
           <listitem><para>
 Remove any file that was left over. This includes (but is not limited to)
       <itemizedlist>

-                <listitem><para>/var/log/junkbuster</para></listitem>
-                <listitem><para>/etc/junkbuster</para></listitem>
-                <listitem><para>/usr/sbin/junkbuster</para></listitem>
-                <listitem><para>/etc/init.d/junkbuster</para></listitem>
-                <listitem><para>/usr/doc/junkbuster*</para></listitem>
+                <listitem><para>/var/log/privoxy</para></listitem>
+                <listitem><para>/etc/privoxy</para></listitem>
+                <listitem><para>/usr/sbin/privoxy</para></listitem>
+                <listitem><para>/etc/init.d/privoxy</para></listitem>
+                <listitem><para>/usr/doc/privoxy*</para></listitem>

               </itemizedlist>
 </para></listitem>
           <listitem><para>
 Install the rpm. Any error messages?
 </para></listitem>
               </itemizedlist>
 </para></listitem>
           <listitem><para>
 Install the rpm. Any error messages?
 </para></listitem>

-          <listitem><para>start,stop,status junkbuster with the specific script
-      (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does
+          <listitem><para>start,stop,status <application>Privoxy</application> with the specific script
+      (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does

       autostart work?</para></listitem>
       autostart work?</para></listitem>

-          <listitem><para>Start browsing. Does the junkbuster work? Logfile written?</para></listitem>
+          <listitem><para>Start browsing. Does <application>Privoxy</application> work? Logfile written?</para></listitem>

           <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
         </orderedlist>
 </para>
           <listitem><para>Remove the rpm. Any error messages? All files removed?</para></listitem>
         </orderedlist>
 </para>


@@ -1420,7 +1448,7 @@ at sourceforge. Three simple steps:
         <itemizedlist>
           
           <listitem><para>Select category: the distribution you test on.</para></listitem>
         <itemizedlist>
           
           <listitem><para>Select category: the distribution you test on.</para></listitem>

-          <listitem><para>Select group: the version of Junkbuster that we are about to release.</para></listitem>
+          <listitem><para>Select group: the version of <application>Privoxy</application> that we are about to release.</para></listitem>

           <listitem><para>Fill the Summary and Detailed Description with something
               intelligent (keep it short and precise).</para>
           </listitem>
           <listitem><para>Fill the Summary and Detailed Description with something
               intelligent (keep it short and precise).</para>
           </listitem>


@@ -1470,6 +1498,25 @@ at sourceforge. Three simple steps:
   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 1.10  2002/03/24 12:33:01  swa
+  more additions.
+
+  Revision 1.9  2002/03/24 11:01:05  swa
+  name change
+
+  Revision 1.8  2002/03/23 15:13:11  swa
+  renamed every reference to the old name with foobar.
+  fixed "application foobar application" tag, fixed
+  "the foobar" with "foobar". left junkbustser in cvs
+  comments and remarks to history untouched.
+
+  Revision 1.7  2002/03/11 13:13:27  swa
+  correct feedback channels
+
+  Revision 1.6  2002/02/24 14:25:06  jongfoster
+  Formatting changes.  Now changing the doctype to DocBook XML 4.1
+  will work - no other changes are needed.
+

   Revision 1.5  2001/10/31 18:16:51  swa
   documentation added: howto generate docs in text and html
   format, howto move stuff to the webserver.
   Revision 1.5  2001/10/31 18:16:51  swa
   documentation added: howto generate docs in text and html
   format, howto move stuff to the webserver.