From a50deb2b0141bc830f07c572aab6415be9c5b2b4 Mon Sep 17 00:00:00 2001 From: swa Date: Wed, 12 Sep 2001 15:36:41 +0000 Subject: [PATCH] source files for junkbuster documentation --- doc/source/developer-manual.sgml | 194 +++++++++++++++++++++++++++++++ doc/source/faq.sgml | 167 ++++++++++++++++++++++++++ doc/source/ldp.dsl | 95 +++++++++++++++ doc/source/user-manual.sgml | 154 ++++++++++++++++++++++++ 4 files changed, 610 insertions(+) create mode 100644 doc/source/developer-manual.sgml create mode 100644 doc/source/faq.sgml create mode 100644 doc/source/ldp.dsl create mode 100644 doc/source/user-manual.sgml diff --git a/doc/source/developer-manual.sgml b/doc/source/developer-manual.sgml new file mode 100644 index 00000000..60f7ece1 --- /dev/null +++ b/doc/source/developer-manual.sgml @@ -0,0 +1,194 @@ + + + +
+ +Junkbuster Developer Manual + +$Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $ + + + + + By: Junkbuster Developers + + + + + + + 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. + + +You can find the latest version of the user manual at http://ijbswa.sourceforge.net/doc/developer-manual/. + + + + Feel free to send a note to the developers at ijbswa-developers@lists.sourceforge.net. + + + + + +Introduction +To be filled. + + + + +Quickstart to Junkbuster Development +To be filled. + + + + +Documentation Guidelines + +All docs should be ... + + in a format that is widely used. I propose HTML. + we either + + generate man pages from the documentation (let's _NOT_ write them manually), or + we have a man page that points to the documentation (I propose + this option) + + have a consistent layout + have a link to the latest version of the document (i.e. point to a URL at sf) + 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) + started from scratch but recycle parts from the original junkbuster documents + + + + + +Coding Guidelines +To be filled. + + + + +Testing Guidelines +To be filled. + + + +Testplan for releases + + + +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* + + + +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 + autostart work? + Start browsing. Does the junkbuster work? Logfile written? + Remove the rpm. Any error messages? All files removed? + + + + + +Test reports + +Please submit test reports only with the test form +at sourceforge. Three simple steps: + + Select category: the distribution you test on. + Select group: the version of Junkbuster that we are about to release. + Fill the Summary and Detailed Description with something intelligent (keep it short and precise). + +Do not mail to the mailinglist (we cannot keep track on issues there). + + + + + + +Contact the developers +Please see the user manual for information on how to contact the developers. + + + + +Copyright and History +To be filled. + + + + +See also +To be filled. + + + + + + +
diff --git a/doc/source/faq.sgml b/doc/source/faq.sgml new file mode 100644 index 00000000..7c202c08 --- /dev/null +++ b/doc/source/faq.sgml @@ -0,0 +1,167 @@ + + + +
+ +Junkbuster Frequently Asked Questions + +$Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $ + + + + + By: Junkbuster Developers + + + + + + + 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. + + +You can find the latest version of the document at http://ijbswa.sourceforge.net/faq/. + + + + Feel free to send a note to the developers at ijbswa-developers@lists.sourceforge.net. + + + + + + +Introduction +To be filled. + + + + + +Frequently Asked Questions + + + +Installation + + To be done later. + + + + + +Configuration + +How can I make my Yahoo account work? + + Blank para tag to quiet jade processing errors + + + + How can I make my Hotmail account work? + + + + + How can I make my GMX account work? + + + + + + + + +Misc + +How can I hide my IP address? + + You cannot hide your IP address with Junkbuster. + + + +What is the imagefile (simage.ini, etc.) for? + + 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.. + + + + + + + + +Contact the developers +Please see the user manual for information on how to contact the developers. + + + + +Copyright and History +To be filled. + + + + +See also +To be filled. + + + + + + +
diff --git a/doc/source/ldp.dsl b/doc/source/ldp.dsl new file mode 100644 index 00000000..4c2578b8 --- /dev/null +++ b/doc/source/ldp.dsl @@ -0,0 +1,95 @@ + + + +]]> + + +]]> +]> + + + + + + +;; ============================== +;; customize the print stylesheet +;; ============================== + + + + + + + + + + +;; this is necessary because right now jadetex does not understand +;; symbolic entities, whereas things work well with numeric entities. +(declare-characteristic preserve-sdata? + "UNREGISTERED::James Clark//Characteristic::preserve-sdata?" + #f) + +;; put the legal notice in a separate file +(define %generate-legalnotice-link% + #t) + +;; use graphics in admonitions, and have their path be "stylesheet-images" +;; NO: they do not yet look very good +(define %admon-graphics-path% + "./stylesheet-images/") + +(define %admon-graphics% + #f) + +(define %funcsynopsis-decoration% + ;; make funcsynopsis look pretty + #t) + +(define %html-ext% + ".html") + +(define %generate-article-toc% + ;; Should a Table of Contents be produced for Articles? + ;; If true, a Table of Contents will be generated for each 'Article'. + #t) + +(define %root-filename% + ;; The filename of the root HTML document (e.g, "index"). + "index") + +(define %generate-part-toc% + #t) + +(define %shade-verbatim% + #t) + +(define %use-id-as-filename% + ;; Use ID attributes as name for component HTML files? + #t) + +(define %graphic-default-extension% + "gif") + +(define %section-autolabel% + ;; For enumerated sections (1.1, 1.1.1, 1.2, etc.) + #t) + +(define (toc-depth nd) + 2) + + + + + + + diff --git a/doc/source/user-manual.sgml b/doc/source/user-manual.sgml new file mode 100644 index 00000000..63182904 --- /dev/null +++ b/doc/source/user-manual.sgml @@ -0,0 +1,154 @@ + + + +
+ +Junkbuster User Manual + +$Id: faq.html,v 1.3 2001/09/10 17:43:59 swa Exp $ + + + + + By: Junkbuster Developers + + + + + + + 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. + + +You can find the latest version of the user manual at http://ijbswa.sourceforge.net/doc/user-manual/. + + + + Feel free to send a note to the developers at ijbswa-developers@lists.sourceforge.net. + + + + + +Introduction +To be filled. + + + + +Quickstart to Using Junkbuster +To be filled. + + + + +Installation +To be filled. + + + +Red Hat +To be filled. + + + + +SuSE +To be filled. + + + + +Windows +To be filled. + + + + +Other +To be filled. + + + + + + +Configuration +To be filled. + + + + +Contact the developers +To be filled. mention the support forums as the primary channel of +communication (bugs, feature requests, etc.) + + + + +Copyright and History +To be filled. + + + + +See also +To be filled. + + + + + + +
-- 2.39.2