This file belongs into
ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
- $Id: developer-manual.sgml,v 1.7 2002/03/11 13:13:27 swa Exp $
+ $Id: developer-manual.sgml,v 1.9 2002/03/24 11:01:05 swa Exp $
Written by and Copyright (C) 2001 the SourceForge
- FOOBAR team. http://ijbswa.sourceforge.net
+ Privoxy team. http://ijbswa.sourceforge.net
Based on the Internet Junkbuster originally written
by and Copyright (C) 1997 Anonymous Coders and
<article id="index">
<artheader>
- <title>foobar Developer Manual</title>
+ <title>Privoxy Developer Manual</title>
- <pubdate>$Id: developer-manual.sgml,v 1.7 2002/03/11 13:13:27 swa Exp $</pubdate>
+ <pubdate>$Id: developer-manual.sgml,v 1.9 2002/03/24 11:01:05 swa Exp $</pubdate>
<authorgroup>
<author>
<affiliation>
- <orgname>By: foobar Developers</orgname>
+ <orgname>By: Privoxy Developers</orgname>
</affiliation>
</author>
</authorgroup>
<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. <application>foobar</application> is a web proxy with advanced
+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>foobar</application> has a very
+other obnoxious Internet Junk. <application>Privoxy</application> has a very
flexible configuration and can be customized to suit individual needs and
-tastes. <application>foobar</application> has application for both stand-alone
+tastes. <application>Privoxy</application> has application for both stand-alone
systems and multi-user networks.
</para>
<para>
</sect1>
<!-- ~~~~~ New section ~~~~~ -->
- <sect1 id="quickstart"><title>Quickstart to Foobar 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>
</para>
</sect1>
-<!-- <listitem><para>be consistent with the redirect script (i.e. the <application>foobar</application> 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 ~~~~~ -->
<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>foobar</application>" consistent and reliable. Thus making
+ <application>Privoxy</application>" consistent and reliable. Thus making
maintenance easier and increasing chances of success of the
project.</para>
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 Foobar to C++.</para>
+ decide to port Privoxy to C++.</para>
<para><emphasis>Example:</emphasis></para>
<programlisting>
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 Foobar to C++.</para>
+ decide to port Privoxy to C++.</para>
<para><emphasis>Example:</emphasis></para>
<programlisting>
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], "foobars"
+ int argc, const char *argv[] ) { strcmp( argv[0], "privoxy"
); }</para>
<para>Both these pointers are *const*! If the c runtime library
<para><emphasis>Example for file comments:</emphasis></para>
<programlisting>
-const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.7 2002/03/11 13:13:27 swa Exp $";
+const char FILENAME_rcs[] = "$Id: developer-manual.sgml,v 1.9 2002/03/24 11:01:05 swa Exp $";
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
* Purpose : (Fill me in with a good description!)
*
* Copyright : Written by and Copyright (C) 2001 the SourceForge
- * FOOBAR team. http://ijbswa.sourceforge.net
+ * PRIVOXY team. http://ijbswa.sourceforge.net
*
* Based on the Internet Junkbuster originally written
* by and Copyright (C) 1997 Anonymous Coders and
<programlisting>
#ifndef _FILENAME_H
#define _FILENAME_H
-#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.7 2002/03/11 13:13:27 swa Exp $"
+#define FILENAME_H_VERSION "$Id: developer-manual.sgml,v 1.9 2002/03/24 11:01:05 swa Exp $"
/*********************************************************************
*
* File : $S<!-- Break CVS Substitution -->ource$
* Purpose : (Fill me in with a good description!)
*
* Copyright : Written by and Copyright (C) 2001 the SourceForge
- * FOOBAR team. http://ijbswa.sourceforge.net
+ * PRIVOXY team. http://ijbswa.sourceforge.net
*
* Based on the Internet Junkbuster originally written
* by and Copyright (C) 1997 Anonymous Coders and
<listitem><para>
Remove any file that was left over. This includes (but is not limited to)
<itemizedlist>
- <listitem><para>/var/log/foobar</para></listitem>
- <listitem><para>/etc/foobar</para></listitem>
- <listitem><para>/usr/sbin/foobar</para></listitem>
- <listitem><para>/etc/init.d/foobar</para></listitem>
- <listitem><para>/usr/doc/foobar*</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>
- <listitem><para>start,stop,status <application>foobar</application> with the specific script
- (e.g. /etc/rc.d/init/foobar 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>
- <listitem><para>Start browsing. Does <application>foobar</application> 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>
<itemizedlist>
<listitem><para>Select category: the distribution you test on.</para></listitem>
- <listitem><para>Select group: the version of <application>foobar</application> 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>
Temple Place - Suite 330, Boston, MA 02111-1307, USA.
$Log: developer-manual.sgml,v $
+ 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