X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=doc%2Fsource%2Fdeveloper-manual.sgml;h=ab6b9bae3398277be87b4ef8bf3a820093d8040d;hp=2c3fb12df271b259693640c454c40bf1513c12f6;hb=97110184221edacdb7d4dfc29de0e38d63f4d831;hpb=0c0171d3f0339ee3075ae384a58613ca88334460 diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml index 2c3fb12d..ab6b9bae 100644 --- 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/ - $Id: developer-manual.sgml,v 1.6 2002/02/24 14:25:06 jongfoster Exp $ + $Id: developer-manual.sgml,v 1.10 2002/03/24 12:33:01 swa Exp $ 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 @@ -18,14 +18,14 @@
- Junkbuster Developer Manual + Privoxy Developer Manual - $Id: developer-manual.sgml,v 1.6 2002/02/24 14:25:06 jongfoster Exp $ + $Id: developer-manual.sgml,v 1.10 2002/03/24 12:33:01 swa Exp $ - By: Junkbuster Developers + By: Privoxy Developers @@ -34,17 +34,17 @@ The developer manual gives the users information on how to help the developer team. It provides guidance on coding, testing, documentation and other -issues. Internet Junkbuster 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. Junkbuster has a very flexible -configuration and can be customized to suit individual needs and -tastes. Internet Junkbuster has application for -both stand-alone systems and multi-user networks. +issues. Privoxy 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. Privoxy has a very +flexible configuration and can be customized to suit individual needs and +tastes. Privoxy has application for both stand-alone +systems and multi-user networks. You can find the latest version of the user manual at http://ijbswa.sourceforge.net/developer-manual/. +url="http://www.privoxy.org/developer-manual/">http://www.privoxy.org/developer-manual/. Please see the Contact section in the user-manual if you want to contact the developers. @@ -62,11 +62,33 @@ Please see the Contact section in the user-manual if you want to contact the dev - Quickstart to Junkbuster Development - To be filled. - - - + Quickstart to Privoxy Development + +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 + + + A bugfix / clean-up / cosmetic thing: shoot + + + A new feature that can be turned off: shoot + + + A clear improvement w/o side effects on other parts of the code: shoot + + + A matter of taste: ask the list + + + A major redesign of some part of the code: ask the list + + + + + Documentation Guidelines @@ -89,7 +111,7 @@ via scp. - + @@ -97,16 +119,16 @@ via scp. Introduction - 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. + 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 + Privoxy" consistent and reliable. Thus making + maintenance easier and increasing chances of success of the + project. - 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. ;-> + 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. ;-> @@ -339,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 - decide to port JunkBuster to C++. + decide to port Privoxy to C++. Example: @@ -366,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 - decide to port JunkBuster to C++. + decide to port Privoxy to C++. Example: @@ -824,7 +846,7 @@ for ( size_t cnt = 0; cnt < len; cnt ++ ) char *s2 ); 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" ); } Both these pointers are *const*! If the c runtime library @@ -1219,7 +1241,7 @@ static void unload_re_filterfile( void *f ) { ... } Example for file comments: -const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.6 2002/02/24 14:25:06 jongfoster Exp $"; +const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.10 2002/03/24 12:33:01 swa Exp $"; /********************************************************************* * * File : $Source$ @@ -1227,7 +1249,7 @@ const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.6 2002/02/24 14:25:0 * 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 @@ -1279,7 +1301,7 @@ const char FILENAME_h_rcs[] = FILENAME_H_VERSION; #ifndef _FILENAME_H #define _FILENAME_H -#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.6 2002/02/24 14:25:06 jongfoster Exp $" +#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.10 2002/03/24 12:33:01 swa Exp $" /********************************************************************* * * File : $Source$ @@ -1287,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 - * 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 @@ -1399,20 +1421,20 @@ Remove any existing rpm with rpm -e Remove any file that was left over. This includes (but is not limited to) - /var/log/junkbuster - /etc/junkbuster - /usr/sbin/junkbuster - /etc/init.d/junkbuster - /usr/doc/junkbuster* + /var/log/privoxy + /etc/privoxy + /usr/sbin/privoxy + /etc/init.d/privoxy + /usr/doc/privoxy* Install the rpm. Any error messages? - start,stop,status junkbuster with the specific script - (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does + start,stop,status Privoxy with the specific script + (e.g. /etc/rc.d/init/privoxy stop). Reboot your machine. Does autostart work? - Start browsing. Does the junkbuster work? Logfile written? + Start browsing. Does Privoxy work? Logfile written? Remove the rpm. Any error messages? All files removed? @@ -1426,7 +1448,7 @@ at sourceforge. Three simple steps: Select category: the distribution you test on. - Select group: the version of Junkbuster that we are about to release. + Select group: the version of Privoxy that we are about to release. Fill the Summary and Detailed Description with something intelligent (keep it short and precise). @@ -1476,6 +1498,21 @@ at sourceforge. Three simple steps: 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.