source files for junkbuster documentation
authorswa <swa@users.sourceforge.net>
Wed, 12 Sep 2001 15:36:41 +0000 (15:36 +0000)
committerswa <swa@users.sourceforge.net>
Wed, 12 Sep 2001 15:36:41 +0000 (15:36 +0000)
doc/source/developer-manual.sgml [new file with mode: 0644]
doc/source/faq.sgml [new file with mode: 0644]
doc/source/ldp.dsl [new file with mode: 0644]
doc/source/user-manual.sgml [new file with mode: 0644]

diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml
new file mode 100644 (file)
index 0000000..60f7ece
--- /dev/null
@@ -0,0 +1,194 @@
+<!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
+<!--
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+ File        :  $Source: /cvsroot/ijbswa/current/doc/webserver/faq.html,v $
+
+ Purpose     :  FAQ
+                This file belongs into
+                ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
+                
+ $Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $
+
+ Written by and Copyright (C) 2001 the SourceForge
+ IJBSWA team.  http://ijbswa.sourceforge.net
+
+ Based on the Internet Junkbuster originally written
+ by and Copyright (C) 1997 Anonymous Coders and 
+ Junkbusters Corporation.  http://www.junkbusters.com
+-->
+
+<article id="index">
+<artheader>
+<title>Junkbuster Developer Manual</title>
+
+<pubdate>$Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $</pubdate>
+
+<authorgroup>
+ <author>
+  <affiliation>
+   <orgname>By: Junkbuster Developers</orgname>
+   </affiliation>
+ </author>
+</authorgroup>
+
+<abstract>
+ <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. The Internet Junkbuster is an application
+that provides privacy and security to the user of the world wide web.
+ </para>
+ <para>
+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>.
+ </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="introduction"><title>Introduction</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="quickstart"><title>Quickstart to Junkbuster Development</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="documentation"><title>Documentation Guidelines</title>
+<para>
+All docs should be ...
+<ItemizedList>
+  <ListItem>in a format that is widely used. I propose HTML.</ListItem>
+  <ListItem>we either
+      <ItemizedList>
+       <ListItem>generate man pages from the documentation (let's _NOT_ write them manually), or </ListItem>
+       <ListItem>we have a man page that points to the documentation (I propose</ListItem>
+           this option)
+      </ItemizedList></ListItem>
+  <ListItem>have a consistent layout</ListItem>
+  <ListItem>have a link to the latest version of the document (i.e. point to a URL at sf)</ListItem>
+  <ListItem>be consistent with the redirect script (i.e. the junkbuster program
+      points via the redirect URL at sf to valid end-points in the document)</ListItem>
+  <ListItem>started from scratch but recycle parts from the original junkbuster documents</ListItem>
+</ItemizedList>
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="coding"><title>Coding Guidelines</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="testing"><title>Testing Guidelines</title>
+<para>To be filled.
+</para>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2 id="testing-plan"><title>Testplan for releases</title>
+<para>
+<OrderedList Numeration="Arabic">
+  <ListItem>
+Remove any existing rpm with rpm -e
+</ListItem>
+  <ListItem>
+Remove any file that was left over. This includes (but is not limited to)
+      <ItemizedList>
+       <ListItem>/var/log/junkbuster</ListItem>
+       <ListItem>/etc/junkbuster</ListItem>
+       <ListItem>/usr/sbin/junkbuster</ListItem>
+       <ListItem>/etc/init.d/junkbuster</ListItem>
+       <ListItem>/usr/doc/junkbuster*</ListItem>
+      </ItemizedList>
+</ListItem>
+<ListItem>
+Install the rpm. Any error messages?
+</ListItem>
+  <ListItem>start,stop,status junkbuster with the specific script
+      (e.g. /etc/rc.d/init/junkbuster stop). Reboot your machine. Does
+      autostart work?</ListItem>
+  <ListItem>Start browsing. Does the junkbuster work? Logfile written?</ListItem>
+  <ListItem>Remove the rpm. Any error messages? All files removed?</ListItem>
+</OrderedList>
+</para>
+</sect2>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2 id="testing-report"><title>Test reports</title>
+<para>
+Please submit test reports only with the <ulink url="http://sourceforge.net/tracker/?func=add&group_id=11118&atid=395005">test form</ulink>
+at sourceforge. Three simple steps:
+<ItemizedList>
+  <ListItem>Select category: the distribution you test on.</ListItem>
+  <ListItem>Select group: the version of Junkbuster that we are about to release.</ListItem>
+  <ListItem>Fill the Summary and Detailed Description with something intelligent (keep it short and precise).</ListItem>
+</ItemizedList>
+Do not mail to the mailinglist (we cannot keep track on issues there).
+</para>
+</sect2>
+
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="contact"><title>Contact the developers</title>
+<para>Please see the user manual for information on how to contact the developers.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="copyright"><title>Copyright and History</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="seealso"><title>See also</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!-- hhmts end -->
+ <!--
+ Tue 09/11/01 06:38:14 PM EST: Test SGML doc by Hal Burgiss.
+ Last modified: Mon Sep 10 19:22:09 CEST 2001
+ This program is free software; you can redistribute it 
+ and/or modify it under the terms of the GNU General
+ Public License as published by the Free Software
+ Foundation; either version 2 of the License, or (at
+ your option) any later version.
+
+ This program is distributed in the hope that it will
+ be useful, but WITHOUT ANY WARRANTY; without even the
+ implied warranty of MERCHANTABILITY or FITNESS FOR A
+ PARTICULAR PURPOSE.  See the GNU General Public
+ License for more details.
+
+ The GNU General Public License should be included with
+ this file.  If not, you can view it at
+ http://www.gnu.org/copyleft/gpl.html
+ or write to the Free Software Foundation, Inc., 59
+ Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+$Log: faq.html,v $
+Revision 1.3  2001/09/10 17:43:59  swa
+first proposal of a structure.
+
+Revision 1.2  2001/06/13 14:28:31  swa
+docs should have an author.
+
+Revision 1.1  2001/06/13 14:20:37  swa
+first import of project's documentation for the webserver.
+
+-->
+
+</article>
diff --git a/doc/source/faq.sgml b/doc/source/faq.sgml
new file mode 100644 (file)
index 0000000..7c202c0
--- /dev/null
@@ -0,0 +1,167 @@
+<!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
+<!--
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+ File        :  $Source: /cvsroot/ijbswa/current/doc/webserver/faq.html,v $
+
+ Purpose     :  FAQ
+                This file belongs into
+                ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
+                
+ $Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $
+
+ Written by and Copyright (C) 2001 the SourceForge
+ IJBSWA team.  http://ijbswa.sourceforge.net
+
+ Based on the Internet Junkbuster originally written
+ by and Copyright (C) 1997 Anonymous Coders and 
+ Junkbusters Corporation.  http://www.junkbusters.com
+-->
+
+<article id="index">
+<artheader>
+<title>Junkbuster Frequently Asked Questions</title>
+
+<pubdate>$Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $</pubdate>
+
+<authorgroup>
+ <author>
+  <affiliation>
+   <orgname>By: Junkbuster Developers</orgname>
+   </affiliation>
+ </author>
+</authorgroup>
+
+<abstract>
+ <para>
+    The FAQ document gives users and developers alike answers to frequently
+asked questions about the Internet Junkbuster. The Internet Junkbuster is an application
+that provides privacy and security to the user of the world wide web.
+ </para>
+ <para>
+You can find the latest version of the document at <ulink url="http://ijbswa.sourceforge.net/doc/faq/">http://ijbswa.sourceforge.net/faq/</ulink>.
+ </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="introduction"><title>Introduction</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+
+<sect1 id="questions"><title>Frequently Asked Questions</title>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+
+<sect2 id="installation"><title>Installation</title>
+ <para>
+  To be done later.
+ </para>
+</sect2>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+
+<sect2 id="configuration"><title>Configuration</title>
+
+<sect3 id="yahoo"><title>How can I make my Yahoo account work?</title>
+ <para>
+  <comment>Blank para tag to quiet jade processing errors</comment>
+ </para>
+</sect3>
+
+<sect3 id="hotmail"> <title>How can I make my Hotmail account work?</title>
+  <para>
+  </para>
+</sect3>
+
+<sect3 id="gmx"> <title>How can I make my GMX account work?</title>
+ <para>
+ </para>
+</sect3>
+
+</sect2>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+
+<sect2 id="misc"><title>Misc</title>
+
+<sect3 id="ip"><title>How can I hide my IP address?</title>
+<para>
+ You cannot hide your IP address with Junkbuster.
+</para>
+</sect3>
+
+<sect3 id="image"><title>What is the imagefile (simage.ini, etc.) for?</title>
+<para>
+ Anytime the Junkbuster determines (with the help of the blocklist) that a URL
+ contains an advertisement, it has to decide whether this advertisement is an
+ image or not. The Junkbuster uses the imagefile for that purpose..
+</para>
+</sect3>
+
+</sect2>
+
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="contact"><title>Contact the developers</title>
+<para>Please see the user manual for information on how to contact the developers.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="copyright"><title>Copyright and History</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="seealso"><title>See also</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!-- hhmts end -->
+ <!--
+ Tue 09/11/01 06:38:14 PM EST: Test SGML doc by Hal Burgiss.
+ Last modified: Mon Sep 10 19:22:09 CEST 2001
+ This program is free software; you can redistribute it 
+ and/or modify it under the terms of the GNU General
+ Public License as published by the Free Software
+ Foundation; either version 2 of the License, or (at
+ your option) any later version.
+
+ This program is distributed in the hope that it will
+ be useful, but WITHOUT ANY WARRANTY; without even the
+ implied warranty of MERCHANTABILITY or FITNESS FOR A
+ PARTICULAR PURPOSE.  See the GNU General Public
+ License for more details.
+
+ The GNU General Public License should be included with
+ this file.  If not, you can view it at
+ http://www.gnu.org/copyleft/gpl.html
+ or write to the Free Software Foundation, Inc., 59
+ Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+$Log: faq.html,v $
+Revision 1.3  2001/09/10 17:43:59  swa
+first proposal of a structure.
+
+Revision 1.2  2001/06/13 14:28:31  swa
+docs should have an author.
+
+Revision 1.1  2001/06/13 14:20:37  swa
+first import of project's documentation for the webserver.
+
+-->
+
+</article>
diff --git a/doc/source/ldp.dsl b/doc/source/ldp.dsl
new file mode 100644 (file)
index 0000000..4c2578b
--- /dev/null
@@ -0,0 +1,95 @@
+<!DOCTYPE style-sheet PUBLIC "-//James Clark//DTD DSSSL Style Sheet//EN" [\r
+<!ENTITY % html "IGNORE">\r
+<![%html;[\r
+<!ENTITY % print "IGNORE">\r
+<!ENTITY docbook.dsl SYSTEM "/usr/share/sgml/docbook/dsssl-stylesheets/html/docbook.dsl" CDATA dsssl>\r
+]]>\r
+<!ENTITY % print "INCLUDE">\r
+<![%print;[\r
+<!ENTITY docbook.dsl SYSTEM "/usr/share/sgml/docbook/dsssl-stylesheets/print/docbook.dsl" CDATA dsssl>\r
+]]>\r
+]>\r
+\r
+<style-sheet>\r
+\r
+<style-specification id="print" use="docbook">\r
+<style-specification-body> \r
+\r
+;; ==============================\r
+;; customize the print stylesheet\r
+;; ==============================\r
+\r
+</style-specification-body>\r
+</style-specification>\r
+\r
+\r
+<!--\r
+;; ===================================================\r
+;; customize the html stylesheet; borrowed from Cygnus\r
+;; at http://sourceware.cygnus.com/ (cygnus-both.dsl)\r
+;; ===================================================\r
+-->\r
+\r
+<style-specification id="html" use="docbook">\r
+<style-specification-body> \r
+\r
+;; this is necessary because right now jadetex does not understand\r
+;; symbolic entities, whereas things work well with numeric entities.\r
+(declare-characteristic preserve-sdata?\r
+  "UNREGISTERED::James Clark//Characteristic::preserve-sdata?"\r
+  #f)\r
+\r
+;; put the legal notice in a separate file\r
+(define %generate-legalnotice-link%\r
+  #t)\r
+\r
+;; use graphics in admonitions, and have their path be "stylesheet-images"\r
+;; NO: they do not yet look very good\r
+(define %admon-graphics-path%\r
+  "./stylesheet-images/")\r
+\r
+(define %admon-graphics%\r
+  #f)\r
+\r
+(define %funcsynopsis-decoration%\r
+  ;; make funcsynopsis look pretty\r
+  #t)\r
+\r
+(define %html-ext%\r
+  ".html")\r
+\r
+(define %generate-article-toc% \r
+  ;; Should a Table of Contents be produced for Articles?\r
+  ;; If true, a Table of Contents will be generated for each 'Article'.\r
+  #t)\r
+\r
+(define %root-filename%\r
+  ;; The filename of the root HTML document (e.g, "index").\r
+  "index")\r
+\r
+(define %generate-part-toc%\r
+  #t)\r
+\r
+(define %shade-verbatim%\r
+  #t)\r
+\r
+(define %use-id-as-filename%\r
+  ;; Use ID attributes as name for component HTML files?\r
+  #t)\r
+\r
+(define %graphic-default-extension% \r
+  "gif")\r
+\r
+(define %section-autolabel%\r
+  ;; For enumerated sections (1.1, 1.1.1, 1.2, etc.)\r
+  #t)\r
+\r
+(define (toc-depth nd)\r
+  2)\r
+\r
+</style-specification-body>\r
+</style-specification>\r
+\r
+<external-specification id="docbook" document="docbook.dsl">\r
+\r
+</style-sheet>\r
diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml
new file mode 100644 (file)
index 0000000..6318290
--- /dev/null
@@ -0,0 +1,154 @@
+<!DOCTYPE Article PUBLIC "-//OASIS//DTD DocBook V3.1//EN">
+<!--
+<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML//EN">
+ File        :  $Source: /cvsroot/ijbswa/current/doc/webserver/faq.html,v $
+
+ Purpose     :  FAQ
+                This file belongs into
+                ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
+                
+ $Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $
+
+ Written by and Copyright (C) 2001 the SourceForge
+ IJBSWA team.  http://ijbswa.sourceforge.net
+
+ Based on the Internet Junkbuster originally written
+ by and Copyright (C) 1997 Anonymous Coders and 
+ Junkbusters Corporation.  http://www.junkbusters.com
+-->
+
+<article id="index">
+<artheader>
+<title>Junkbuster User Manual</title>
+
+<pubdate>$Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $</pubdate>
+
+<authorgroup>
+ <author>
+  <affiliation>
+   <orgname>By: Junkbuster Developers</orgname>
+   </affiliation>
+ </author>
+</authorgroup>
+
+<abstract>
+ <para>
+    The user manual gives the users information on how to install and
+configure the Internet Junkbuster. The Internet Junkbuster is an application
+that provides privacy and security to the user of the world wide web.
+ </para>
+ <para>
+You can find the latest version of the user manual at  <ulink url="http://ijbswa.sourceforge.net/doc/user-manual/">http://ijbswa.sourceforge.net/doc/user-manual/</ulink>.
+ </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="introduction"><title>Introduction</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="installation"><title>Installation</title>
+<para>To be filled.
+</para>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2 id="installation-rh"><title>Red Hat</title>
+<para>To be filled.
+</para>
+</sect2>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2 id="installation-suse"><title>SuSE</title>
+<para>To be filled.
+</para>
+</sect2>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2 id="installation-win"><title>Windows</title>
+<para>To be filled.
+</para>
+</sect2>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2 id="installation-other"><title>Other</title>
+<para>To be filled.
+</para>
+</sect2>
+
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="configuration"><title>Configuration</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="contact"><title>Contact the developers</title>
+<para>To be filled. mention the support forums as the primary channel of
+communication (bugs, feature requests, etc.)
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="copyright"><title>Copyright and History</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect1 id="seealso"><title>See also</title>
+<para>To be filled.
+</para>
+</sect1>
+
+<!-- hhmts end -->
+ <!--
+ Tue 09/11/01 06:38:14 PM EST: Test SGML doc by Hal Burgiss.
+ Last modified: Mon Sep 10 19:22:09 CEST 2001
+ This program is free software; you can redistribute it 
+ and/or modify it under the terms of the GNU General
+ Public License as published by the Free Software
+ Foundation; either version 2 of the License, or (at
+ your option) any later version.
+
+ This program is distributed in the hope that it will
+ be useful, but WITHOUT ANY WARRANTY; without even the
+ implied warranty of MERCHANTABILITY or FITNESS FOR A
+ PARTICULAR PURPOSE.  See the GNU General Public
+ License for more details.
+
+ The GNU General Public License should be included with
+ this file.  If not, you can view it at
+ http://www.gnu.org/copyleft/gpl.html
+ or write to the Free Software Foundation, Inc., 59
+ Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+
+$Log: faq.html,v $
+Revision 1.3  2001/09/10 17:43:59  swa
+first proposal of a structure.
+
+Revision 1.2  2001/06/13 14:28:31  swa
+docs should have an author.
+
+Revision 1.1  2001/06/13 14:20:37  swa
+first import of project's documentation for the webserver.
+
+-->
+
+</article>