1 <!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
3 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
4 File : $Source: /cvsroot/ijbswa/current/doc/webserver/faq.html,v $
8 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
10 $Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $
12 Written by and Copyright (C) 2001 the SourceForge
13 IJBSWA team. http://ijbswa.sourceforge.net
15 Based on the Internet Junkbuster originally written
16 by and Copyright (C) 1997 Anonymous Coders and
17 Junkbusters Corporation. http://www.junkbusters.com
22 <title>Junkbuster Developer Manual</title>
24 <pubdate>$Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $</pubdate>
29 <orgname>By: Junkbuster Developers</orgname>
36 The developer manual gives the users information on how to help the developer
37 team. It provides guidance on coding, testing, documentation and other
38 issues. The Internet Junkbuster is an application
39 that provides privacy and security to the user of the world wide web.
42 You can find the latest version of the user manual at <ulink url="http://ijbswa.sourceforge.net/doc/developer-manual/">http://ijbswa.sourceforge.net/doc/developer-manual/</ulink>.
46 Feel free to send a note to the developers at <email>ijbswa-developers@lists.sourceforge.net</email>.
51 <!-- ~~~~~ New section ~~~~~ -->
52 <sect1 id="introduction"><title>Introduction</title>
57 <!-- ~~~~~ New section ~~~~~ -->
58 <sect1 id="quickstart"><title>Quickstart to Junkbuster Development</title>
63 <!-- ~~~~~ New section ~~~~~ -->
64 <sect1 id="documentation"><title>Documentation Guidelines</title>
66 All docs should be ...
68 <ListItem>in a format that is widely used. I propose HTML.</ListItem>
71 <ListItem>generate man pages from the documentation (let's _NOT_ write them manually), or </ListItem>
72 <ListItem>we have a man page that points to the documentation (I propose</ListItem>
74 </ItemizedList></ListItem>
75 <ListItem>have a consistent layout</ListItem>
76 <ListItem>have a link to the latest version of the document (i.e. point to a URL at sf)</ListItem>
77 <ListItem>be consistent with the redirect script (i.e. the junkbuster program
78 points via the redirect URL at sf to valid end-points in the document)</ListItem>
79 <ListItem>started from scratch but recycle parts from the original junkbuster documents</ListItem>
84 <!-- ~~~~~ New section ~~~~~ -->
85 <sect1 id="coding"><title>Coding Guidelines</title>
90 <!-- ~~~~~ New section ~~~~~ -->
91 <sect1 id="testing"><title>Testing Guidelines</title>
95 <!-- ~~~~~ New section ~~~~~ -->
96 <sect2 id="testing-plan"><title>Testplan for releases</title>
98 <OrderedList Numeration="Arabic">
100 Remove any existing rpm with rpm -e
103 Remove any file that was left over. This includes (but is not limited to)
105 <ListItem>/var/log/junkbuster</ListItem>
106 <ListItem>/etc/junkbuster</ListItem>
107 <ListItem>/usr/sbin/junkbuster</ListItem>
108 <ListItem>/etc/init.d/junkbuster</ListItem>
109 <ListItem>/usr/doc/junkbuster*</ListItem>
113 Install the rpm. Any error messages?
115 <ListItem>start,stop,status junkbuster with the specific script
116 (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does
117 autostart work?</ListItem>
118 <ListItem>Start browsing. Does the junkbuster work? Logfile written?</ListItem>
119 <ListItem>Remove the rpm. Any error messages? All files removed?</ListItem>
124 <!-- ~~~~~ New section ~~~~~ -->
125 <sect2 id="testing-report"><title>Test reports</title>
127 Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
128 at sourceforge. Three simple steps:
130 <ListItem>Select category: the distribution you test on.</ListItem>
131 <ListItem>Select group: the version of Junkbuster that we are about to release.</ListItem>
132 <ListItem>Fill the Summary and Detailed Description with something intelligent (keep it short and precise).</ListItem>
134 Do not mail to the mailinglist (we cannot keep track on issues there).
140 <!-- ~~~~~ New section ~~~~~ -->
141 <sect1 id="contact"><title>Contact the developers</title>
142 <para>Please see the user manual for information on how to contact the developers.
146 <!-- ~~~~~ New section ~~~~~ -->
147 <sect1 id="copyright"><title>Copyright and History</title>
152 <!-- ~~~~~ New section ~~~~~ -->
153 <sect1 id="seealso"><title>See also</title>
160 Tue 09/11/01 06:38:14 PM EST: Test SGML doc by Hal Burgiss.
162 Last modified: Mon Sep 10 19:22:09 CEST 2001
164 This program is free software; you can redistribute it
165 and/or modify it under the terms of the GNU General
166 Public License as published by the Free Software
167 Foundation; either version 2 of the License, or (at
168 your option) any later version.
170 This program is distributed in the hope that it will
171 be useful, but WITHOUT ANY WARRANTY; without even the
172 implied warranty of MERCHANTABILITY or FITNESS FOR A
173 PARTICULAR PURPOSE. See the GNU General Public
174 License for more details.
176 The GNU General Public License should be included with
177 this file. If not, you can view it at
178 http://www.gnu.org/copyleft/gpl.html
179 or write to the Free Software Foundation, Inc., 59
180 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
183 Revision 1.3 2001/09/10 17:43:59 swa
184 first proposal of a structure.
186 Revision 1.2 2001/06/13 14:28:31 swa
187 docs should have an author.
189 Revision 1.1 2001/06/13 14:20:37 swa
190 first import of project's documentation for the webserver.