Ditto.
[privoxy.git] / doc / source / user-manual.sgml
index e7c6334..f5fd8b2 100644 (file)
@@ -7,7 +7,7 @@
                 This file belongs into
                 ijbswa.sourceforge.net:/home/groups/i/ij/ijbswa/htdocs/
                 
- $Id: user-manual.sgml,v 1.2 2001/09/13 15:27:40 swa Exp $
+ $Id: user-manual.sgml,v 1.10 2001/09/28 02:18:12 hal9 Exp $
 
  Written by and Copyright (C) 2001 the SourceForge
  IJBSWA team.  http://ijbswa.sourceforge.net
@@ -30,7 +30,7 @@ Hal Burgiss <hal@foobox.net>
 <artheader>
 <title>Junkbuster User Manual</title>
 
-<pubdate>$Id: user-manual.sgml,v 1.2 2001/09/13 15:27:40 swa Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.10 2001/09/28 02:18:12 hal9 Exp $</pubdate>
 
 <authorgroup>
  <author>
@@ -78,50 +78,124 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
  point. The most up to date reference for the time being is still the comments
  in the source files and in the individual configuration files. Development
  of version 3.0 is currently underway, and includes significant changes and
- enhancements over earlier verions.
+ enhancements over earlier verions. The target release date for stable v3.0 is 
+ December 2001.
 </para>
 
 <para>
- Since this is a development version, there <emphasis>are</emphasis> bugs!
+ Since this is a development version, some features are in the process of
+ being implemented. And there <emphasis>are</emphasis> bugs! 
 </para>
 
-<!--   ~~~~~       New section      ~~~~~     -->
 
+<!--   ~~~~~       New section      ~~~~~     -->
 <sect2>
-<title>License</title>
+<title>New Features</title>
 <para>
- <application>Internet Junkbuster</application> 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.
+ In addition to <application>Junkbuster's</application> traditional features
+ of ad and banner blocking and cookie management, this is a list of new
+ features currently under development:
 </para>
 
 <para>
- 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, which is available from <ulink
- url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
- Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
-</para>
+ <itemizedlist>
 
-</sect2>
+ <listitem>
+  <para>
+   Modularized configuration that will allow for system wide settings, and
+   individual user settings. 
+  </para>
+ </listitem> 
 
-<!--  ~  End section  ~  -->
+ <listitem>
+  <para>
+   A web based GUI configuration utility.
+  </para>
+ </listitem> 
 
+ <listitem>
+  <para>
+    Blocking of annoying pop-up browser windows (previously available as a
+    patch). 
+  </para>
+ </listitem> 
 
-<!--   ~~~~~       New section      ~~~~~     -->
+ <listitem>
+  <para>
+   Support for HTTP 1.1.
+  </para>
+ </listitem> 
+
+ <listitem>
+  <para>
+   Support for Perl Compatible Regular Expressions in the configuration files, and 
+   generally a more sophisticated configuration syntax.
+  </para>
+ </listitem> 
 
+ <listitem>
+  <para>
+   Web page content filtering.
+  </para>
+ </listitem> 
+ </itemizedlist>
+</para>
+
+</sect2>
+
+<!--   ~~~~~       New section      ~~~~~     -->
 <sect2>
-<title>History</title>
+<title>New Features</title>
 <para>
- <application>Junkbuster</application> was originally written by <ulink
- url="http://www.junkbusters.com/ht/en/ijbfaq.html">JunkBusters
- Corporation</ulink>, and was released as free open-source software under the
- GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
- Waldherr</ulink> made many improvements, and started the <ulink
- url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
- rekindle development. 
+ In addition to <application>Junkbuster's</application> traditional features
+ of ad and banner blocking and cookie management, this is a list of new
+ features currently under development:
+</para>
+
+<para>
+ <itemizedlist>
+
+ <listitem>
+  <para>
+   Modularized configuration that will allow for system wide settings, and
+   individual user settings. 
+  </para>
+ </listitem> 
+
+ <listitem>
+  <para>
+   A web based GUI configuration utility.
+  </para>
+ </listitem> 
+
+ <listitem>
+  <para>
+    Blocking of annoying pop-up browser windows (previously available as a
+    patch). 
+  </para>
+ </listitem> 
+
+ <listitem>
+  <para>
+   Support for HTTP 1.1.
+  </para>
+ </listitem> 
+
+ <listitem>
+  <para>
+   Support for Perl Compatible Regular Expressions in the configuration files, and 
+   generally a more sophisticated configuration syntax.
+  </para>
+ </listitem> 
+
+ <listitem>
+  <para>
+   Web page content filtering.
+  </para>
+ </listitem> 
+ </itemizedlist>
 </para>
 
 </sect2>
@@ -140,7 +214,8 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
  for current releases. <application>Junkbuster</application> is also available
  via <ulink
  url="http://cvs.sourceforge.net/cgi-bin/viewcvs.cgi/ijbswa/current/">CVS</ulink>.
- This is the recommended approach at this time.
+ This is the recommended approach at this time. But please be aware that CVS 
+ is constantly changing, and it may break in mysterious ways.
 </para>
 
 <!--   ~~~~~       New section      ~~~~~     -->
@@ -279,6 +354,59 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 </sect2>
 
 
+<!--   ~~~~~       New section      ~~~~~     -->
+<sect2 id="installation-os2"><title>OS/2</title>
+
+<!--
+Thanx David Schmidt!
+-->
+
+<para>
+ The OS/2 version of <application>Junkbuster</application> requires the EMX
+ runtime library to be installed.  The EMX runtime library is available on
+ the hobbes OS/2 archive, among many other locations:
+ <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&amp;button=Search&amp;key=emxrt.zip&amp;stype=all&amp;sort=type&amp;dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&amp;button=Search&amp;key=emxrt.zip&amp;stype=all&amp;sort=type&amp;dir=%2Fpub%2Fos2%2Fdev%2Femx%2Fv0.9d</ulink>
+</para>
+
+<para>
+ <application>Junkbuster</application> is packaged in a WarpIN self-
+ installing archive.  The self-installing program will be named depending
+ on the release version, something like:
+ <filename>ijbos123.exe</filename>.  In order to install it, simply run
+ this executable or double-click on its icon and follow the WarpIN
+ installation panels.  A shadow of the <application>Junkbuster</application>
+ executable will be placed in your startup folder so it will start 
+ automatically whenever OS/2 starts.
+</para>
+
+<para>
+ The directory you choose to install <application>Junkbuster</application>
+ into will contain all of the configuration files.
+</para>
+
+<para>
+ If you would like to build binary images on OS/2 yourself, you will need
+ a working EMX/GCC environment, plus several Unix-like tools.  The Hobbes
+ OS/2 archive is a good place to start when building such an environment.
+ A set of Unix-like tools named gnupack is located here:
+ <ulink url="http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&amp;key=gnupack&amp;stype=all&amp;sort=type&amp;dir=%2Fpub%2Fos2%2Fapps">http://hobbes.nmsu.edu/cgi-bin/h-search?sh=1&amp;key=gnupack&amp;stype=all&amp;sort=type&amp;dir=%2Fpub%2Fos2%2Fapps</ulink>
+</para>
+<para>
+ Once you have the source code unpacked as above, you can build the binaries
+ from the <filename>current/</filename> directory:
+</para>
+
+<para>
+ <screen>
+ autoconf
+ sh configure
+ make
+ </screen>
+</para>
+
+</sect2>
+
+
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2 id="installation-win"><title>Windows</title>
 <para>I need help on this. Not a clue here. Also for 
@@ -288,8 +416,17 @@ configuration section below.
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect2 id="installation-other"><title>Other</title>
-<para>I need help on this too. OS/2? What others?
+<para>
+ Some quick notes on other Operating Systems.
+</para>
+
+<para>
+ For FreeBSD (and other *BSDs?), the build will need <command>gmake</command> 
+ instead of the included <command>make</command>. <command>gmake</command> is
+ available from <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>.
+ The rest should be the same as above for Linux/Unix.
 </para>
+
 </sect2>
 
 </sect1>
@@ -300,11 +437,12 @@ configuration section below.
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="configuration"><title>Junkbuster Configuration</title>
 <para>
- For Unix and Linux, all configuraton files are located in
- <filename>/etc/junkbuster/</filename> by default. For MS Windows, these 
- are all in the same directory as the <application>Junkbuster</application>
- executable. The name and number of configuration files has changed from
- previous versions, and is subject to change as development progresses.
+ For Unix, *BSD and Linux, all configuraton files are located in
+ <filename>/etc/junkbuster/</filename> by default. For MS Windows and OS/2,
+ these are all in the same directory as the
+ <application>Junkbuster</application> executable. The name and number of
+ configuration files has changed from previous versions, and is subject to
+ change as development progresses.
 </para>
 
 <para>
@@ -319,7 +457,8 @@ configuration section below.
   <listitem>
    <para>
      The main configuration file is named <filename>config</filename>
-     on Linux and Unix, and <filename>junkbustr.txt</filename> on Windows.
+     on Linux, Unix, BSD, and OS/2, and <filename>junkbustr.txt</filename> on
+     Windows.
    </para>
   </listitem> 
 
@@ -356,7 +495,7 @@ configuration section below.
 <title>The Main Configuration File</title>
 <para>
  Again, the main configuration file is named <filename>config</filename> on
- Linux and Unix, and <filename>junkbustr.txt</filename> on Windows.
+ Linux/Unix/BSD and OS/2, and <filename>junkbustr.txt</filename> on Windows.
  Configuration lines consist of an initial keyword followed by a list of
  values, all separated by whitespace (any number of spaces or tabs). For
  example:
@@ -419,8 +558,8 @@ configuration section below.
 
 <para>
  On <application>Windows</application>, <application>Junkbuster</application>
- looks for these files in the same directory as the executable.  On Unix,
- <application>Junkbuster</application> looks for these files in the current
+ looks for these files in the same directory as the executable.  On Unix and 
OS/2, <application>Junkbuster</application> looks for these files in the current
  working directory.  In either case, an absolute path name can be used to
  avoid problems.
 </para>
@@ -2406,27 +2545,121 @@ Removed references to Win32. HB 09/23/01
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
-<para>To be filled.
+<para>
+ Install package, then run and enjoy! Be sure your browser is set to use 
+ the proxy which is by default at localhost, port 8000. With 
+ <application>Netscape</application> (and <application>Mozilla</application>),
+ this can be set under <literal>Edit -&gt; Preferences -&gt; Advanced -&gt;
+ Proxies -&gt; HTTP Proxy</literal>. For <application>Internet
+ Explorer</application>: <literal>Internet Properties -&gt; Connections -&gt;
+ LAN Setting</literal>. Then, check <quote>Use Proxy</quote> and fill in the 
+ appropriate info (Address: localhost, Port: 8000).
 </para>
+
+<para>
+ The included default configuration files should give a reasonable starting
+ point, though may be somewhat aggressive in blocking junk. You will probably
+ want to keep an eye out for sites that require cookies, and add these to
+ <filename>actionsfile</filename> as needed. By default, most of these will
+ be blocked until you add them to the configuration. If you want the browser
+ to handle this, you will need to edit <filename>actionsfile</filename> and
+ disable this feature. If you use more than one browser, it would make more
+ sense to let <application>Junkbuster</application> handle this. In which
+ case, the browser(s) should be set to accept all cookies.
+</para>
+
+<para>
+ If you encounter problems, please verify it is a
+ <application>Junkbuster</application> bug, by disabling
+ <application>Junkbuster</application>, and then trying the same page. 
+ Before reporting it as a bug, see if there is not a configuration 
+ option that is enabled that is causing the page not to load. You can 
+ then add an exception for that page or site. If a bug, please report it to
+ the developers (see below). 
+</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
+<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.)
+-->
+ Feature requests and other questions should be posted to the <ulink
+ url="http://sourceforge.net/tracker/?atid=361118&amp;group_id=11118&amp;func=browse">Feature
+ request page</ulink> at SourceForge. There is also an archive there.
+</para>
+
+<para>
+ Anyone interested in actively participating in development and related 
+ discussions can join the appropriate mailing list  
+ <ulink url="http://sourceforge.net/mail/?group_id=11118">here</ulink>.
+ Archives are available here too.
 </para>
+
+<para>
+ Please report bugs, using the form at 
+ <ulink url="http://sourceforge.net/tracker/?group_id=11118&amp;atid=111118">Sourceforge</ulink>.
+ Please try to verify that it is a <application>Junkbuster</application> bug,
+ and not a browser or site bug first. Also, check to make sure this is not
+ already a known bug.
+</para>
+
 </sect1>
 
+
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="copyright"><title>Copyright and History</title>
-<para>To be filled.
+
+<sect2>
+<title>License</title>
+<para>
+ <application>Internet Junkbuster</application> 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.
+</para>
+
+<para>
+ 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, which is available from <ulink
+ url="http://www.gnu.org/copyleft/gpl.html">the Free Software Foundation,
+ Inc</ulink>, 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+</para>
+
+</sect2>
+
+<!--  ~  End section  ~  -->
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+
+<sect2>
+<title>History</title>
+<para>
+ <application>Junkbuster</application> was originally written by Anonymous 
+ Coders and <ulink
+ url="http://www.junkbusters.com/ht/en/ijbfaq.html">JunkBusters
+ Corporation</ulink>, and was released as free open-source software under the
+ GNU GPL. <ulink url="http://www.waldherr.org/junkbuster/">Stefan
+ Waldherr</ulink> made many improvements, and started the <ulink
+ url="http://sourceforge.net/projects/ijbswa/">SourceForge project</ulink> to
+ rekindle development. The last stable release was v2.0.2, which has now 
+ grown whiskers ;-).
 </para>
+
+</sect2>
+
 </sect1>
 
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="seealso"><title>See also</title>
-<para>To be filled.
+<para>To be filled. What should go here :/
 </para>
 </sect1>
 
@@ -2440,7 +2673,228 @@ communication (bugs, feature requests, etc.)
 <sect2 id="regex">
 <title>Regular Expressions</title>
 <para>
- WIP
+ <application>Junkbuster</application> can use <quote>regular expressions</quote> 
+ in various config files. Assuming support for <quote>pcre</quote> (Perl
+ Compatible Regular Expressions) is compiled in, which is the default. Such
+ configuration directives do not require regular expressions, but they can be
+ used to increase flexibility by matching a pattern with wildcards against
+ URLs.
+</para>
+
+<para>
+ If you are reading this, you probably don't understand what <quote>regular
+ expressions</quote> are, or what they can do. So this will be a very brief
+ introduction only. A full explanation would require a book ;-)
+</para>
+
+<para>
+ <quote>Regular expressions</quote> is a way of matching one character
+ expression against another to see if it matches or not. One of the
+ <quote>expressions</quote> is a literal string of readable characters
+ (letter, numbers, etc), and the other is a complex string of literal
+ characters combined with wildcards, and other special characters, called
+ metacharacters. The <quote>metacharacters</quote> have special meanings and
+ are used to build the complex pattern to be matched against. Perl Compatible
+ Regular Expressions is an enhanced form of the regular expression language
+ with backward compatibility.
+</para>
+
+<para>
+ To make a simple analogy, we do something similar when we use wildcard
+ characters when listing files with the <command>dir</command> command in DOS. 
+ <literal>*.*</literal> matches all filenames. The <quote>special</quote>
+ character here is the asterik which matches any and all characters. We can be
+ more specific and use <literal>?</literal> to match just individual
+ characters. So <quote>dir file?.text</quote> would match
+ <quote>file1.txt</quote>, <quote>file2.txt</quote>, etc. We are pattern
+ matching, using a similar technique to <quote>regular expressions</quote>!
+</para>
+
+<para>
+ Regular expressions do essentially the same thing, but are much, much more
+ powerful. There are many more <quote>special characters</quote> and ways of 
+ building complex patterns however. Let's look at a few of the common ones,
+ and then some examples:
+</para>
+
+<simplelist>
+ <member>
+  <emphasis>.</emphasis> - Matches any single character, e.g. <quote>a</quote>,
+  <quote>A</quote>, <quote>4</quote>, <quote>:</quote>, or <quote>@</quote>.
+ </member>
+</simplelist>
+
+<simplelist>
+ <member>
+  <emphasis>?</emphasis> - The preceding character or expression is matched ZERO or ONE
+  times. Either/or.
+ </member>
+</simplelist>
+
+<simplelist>
+ <member>
+  <emphasis>+</emphasis> - The preceding character or expression is matched ONE or MORE
+  times.
+ </member>
+</simplelist>
+
+<simplelist>
+ <member>
+  <emphasis>*</emphasis> - The preceding character or expression is matched ZERO or MORE
+  times.
+ </member>
+</simplelist>
+
+<simplelist>
+ <member>
+  <emphasis>\</emphasis> - The <quote>escape</quote> character denotes that
+  the following character should be taken literally. This is used where one of the 
+  special characters (e.g. <quote>.</quote>) needs to be taken literally and
+  not as a special metacharacter.
+ </member>
+</simplelist>
+
+<simplelist>
+ <member>
+  <emphasis>[]</emphasis> - Characters enclosed in brackets will be matched if
+  any of the enclosed characters are encountered.
+ </member>
+</simplelist>
+
+<simplelist>
+ <member>
+  <emphasis>()</emphasis> - Pararentheses are used to group a sub-expression,
+  or multiple sub-expressions.
+ </member>
+</simplelist>
+
+<simplelist>
+ <member>
+  <emphasis>|</emphasis> - The <quote>bar</quote> character works like an
+  <quote>or</quote> conditional statement. A match is successful if the
+  sub-expression on either side of <quote>|</quote> matches.
+ </member>
+</simplelist>
+
+<simplelist>
+ <member>
+  <emphasis>s/string1/string2/g</emphasis> - This is used to rewrite strings of text. 
+  <quote>string1</quote> is replaced by <quote>string2</quote> in this
+  example.
+ </member>
+</simplelist>
+
+<para>
+ These are just some of the ones you are likely to use when matching URLs with 
+ <application>Junkbuster</application>, and is a long way from a definitive
+ list. This is enough to get us started with a few simple examples which may
+ be more illuminating:
+</para>
+
+<para>
+ <emphasis><literal>/.*/banners/.*</literal></emphasis> - A  simple example
+ that uses the common combination of <quote>.</quote> and <quote>*</quote> to 
+ denote any character, zero or more times. In other words, any string at all.
+ So we start with a literal forward slash, then our regular expression pattern 
+ (<quote>.*</quote>) another literal forward slash, the string
+ <quote>banners</quote>, another forward slash, and lastly another
+ <quote>.*</quote>. We are building 
+ a directory path here. This will match any file with the path that has a
+ directory named <quote>banners</quote> in it. The <quote>.*</quote> matches
+ any characters, and this could conceivably be more forward slashes, so it
+ might expand into a much longer looking path. For example, this could match:
+ <quote>/eye/hate/spammers/banners/annoy_me_please.gif</quote>, or just
+ <quote>/banners/annoying.html</quote>, or almost an infinite number of other
+ possible combinations, just so it has <quote>banners</quote> in the path
+ somewhere.
+</para>
+
+<para>
+ A now something a little more complex:
+</para>
+
+<para>
+ <emphasis><literal>/.*/adv((er)?ts?|ertis(ing|ements?))?/</literal></emphasis> - 
+ We have several literal forward slashes again (<quote>/</quote>), so we are
+ building another expression that is a file path statement. We have another 
+ <quote>.*</quote>, so we are matching against any conceivable sub-path, just so
+ it matches our expression. The only true literal that <emphasis>must
+ match</emphasis> our pattern is <application>adv</application>, together with
+ the forward slashes. What comes after the <quote>adv</quote> string is the
+ interesting part. 
+</para>
+
+<para>
+ Remember the <quote>?</quote> means the preceding expression (either a
+ literal character or anything grouped with <quote>(...)</quote> in this case)
+ can exist or not, since this means either zero or one match. So
+ <quote>((er)?ts?|ertis(ing|ements?))</quote> is optional, as are the
+ individual sub-expressions: <quote>(er)</quote>,
+ <quote>(ing|ements?)</quote>, and the <quote>s</quote>. The <quote>|</quote>
+ means <quote>or</quote>. We have two of those. For instance, 
+ <quote>(ing|ements?)</quote>, can expand to match either <quote>ing</quote> 
+ <emphasis>OR</emphasis> <quote>ements?</quote>. What is being done here, is an
+ attempt at matching as many variations of <quote>advertisement</quote>, and 
+ similar, as possible. So this would expand to match just <quote>adv</quote>,
+ or <quote>advert</quote>, or <quote>adverts</quote>, or
+ <quote>advertising</quote>, or <quote>advertisement</quote>, or
+ <quote>advertisements</quote>. You get the idea. But it would not match 
+ <quote>advertizements</quote> (with a <quote>z</quote>). We could fix that by
+ changing our regular expression to: 
+ <quote>/.*/adv((er)?ts?|erti(s|z)(ing|ements?))?/</quote>, which would then match
+ either spelling.
+</para>
+
+<para>
+ <emphasis><literal>/.*/advert[0-9]+\.(gif|jpe?g)</literal></emphasis> - Again 
+ another path statement with forward slashes. Anything in the square brackets 
+ <quote>[]</quote> can be matched. This is using <quote>0-9</quote> as a
+ shorthand expression to mean any digit one through nine. It is the same as
+ saying <quote>0123456789</quote>. So any digit matches. The <quote>+</quote>
+ means one or more of the preceding expression must be included. The preceding 
+ expression here is what is in the square brackets -- in this case, any digit 
+ one through nine. Then, at the end, we have a grouping: <quote>(gif|jpe?g)</quote>. 
+ This includes a <quote>|</quote>, so this needs to match the expression on
+ either side of that bar character also. A simple <quote>gif</quote> on one side, and the other
+ side will in turn match either <quote>jpeg</quote> or <quote>jpg</quote>,
+ since the <quote>?</quote> means the letter <quote>e</quote> is optional and
+ can be matched once or not at all. So we are building an expression here to
+ match image GIF or JPEG type image file. It must include the literal
+ string <quote>advert</quote>, then one or more digits, and a <quote>.</quote>
+ (which is now a literal, and not a special character, since it is escaped
+ with <quote>\</quote>), and lastly either <quote>gif</quote>, or
+ <quote>jpeg</quote>, or <quote>jpg</quote>. Some possible matches would
+ include: <quote>//advert1.jpg</quote>,
+ <quote>/nasty/ads/advert1234.gif</quote>,
+ <quote>/banners/from/hell/advert99.jpg</quote>. It would not match
+ <quote>advert1.gif</quote> (no leading slash), or
+ <quote>/adverts232.jpg</quote> (the expression does not include an
+ <quote>s</quote>), or <quote>/advert1.jsp</quote> (<quote>jsp</quote> is not
+ in the expression anywhere).
+</para>
+
+<para>
+ <emphasis><literal>s/microsoft(?!.com)/MicroSuck/i</literal></emphasis> - This is 
+ a substitution. <quote>MicroSuck</quote> will replace any occurence of 
+ <quote>microsoft</quote>.  The <quote>i</quote> at the end of the expression
+ means ignore case. The <quote>(?!.com)</quote> means 
+ the match should fail if <quote>microsoft</quote> is followed by
+ <quote>.com</quote>. In other words, this acts like a <quote>NOT</quote>
+ modifier. In case this is a hyperlink, we don't want to break it ;-).
+</para>
+
+<para>
+ We are barely scratching the surface of regular expressions here so that you
+ can understand the default <application>Junkbuster</application>
+ configuration files, and maybe use this knowledge to customize your own
+ installation. There is much, much more that can be done with regular
+ expressions. Now that you know enough to get started, you can learn more on
+ your own :/
+</para>
+
+<para>
+ More reading on Perl Compatible Regular expressions: 
+ <ulink url="http://www.perldoc.com/perl5.6/pod/perlre.html">http://www.perldoc.com/perl5.6/pod/perlre.html</ulink>
 </para>
 
 </sect2>
@@ -2468,6 +2922,19 @@ communication (bugs, feature requests, etc.)
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $
+ Revision 1.9  2001/09/27 23:50:29  hal9
+ A few changes. A short section on regular expression in appendix.
+
+ Revision 1.8  2001/09/25 00:34:59  hal9
+ Some additions, and re-arranging.
+
+ Revision 1.7  2001/09/24 14:31:36  hal9
+ Diddling.
+
+ Revision 1.6  2001/09/24 14:10:32  hal9
+ Including David's OS/2 installation instructions.
+
  Revision 1.2  2001/09/13 15:27:40  swa
  cosmetics