Adding new function cgi_edit_actions_section_swap(), to reorder
[privoxy.git] / doc / source / user-manual.sgml
index fca2a47..88adb4f 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.23 2001/12/02 00:20:41 hal9 Exp $
+ $Id: user-manual.sgml,v 1.26 2002/01/09 20:02:50 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.23 2001/12/02 00:20:41 hal9 Exp $</pubdate>
+<pubdate>$Id: user-manual.sgml,v 1.26 2002/01/09 20:02:50 hal9 Exp $</pubdate>
 
 <authorgroup>
  <author>
@@ -111,7 +111,7 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
  <listitem>
   <para>
    Modularized configuration that will allow for system wide settings, and
-   individual user settings. (not implemented yet)
+   individual user settings. (not implemented yet, probably a 3.1 feature)
   </para>
  </listitem> 
 
@@ -147,11 +147,18 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
   </para>
  </listitem> 
 
+ <listitem>
+  <para>
+   Auto-detection of config file changes.
+  </para>
+ </listitem> 
+
+
  </itemizedlist>
 </para>
 
 <para>
- In addition, the configuration is more versatile overall.
+ In addition, the configuration is much more versatile overall.
 </para>
 
 </sect2>
@@ -183,7 +190,7 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 <para>
  <screen>
  tar xzvf ijb_source_* [.tgz or .tar.gz]
- cd ijb_source_2.9.9_alpha
+ cd ijb_source_2.9.10_beta
  </screen>
 </para>
 
@@ -246,10 +253,10 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 </para>
 
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/redhat/RPMS/i686/junkbuster-2.9.8-1.i686.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
 </para>
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/redhat/SRPMS/junkbuster-2.9.9-1.src.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/redhat/SRPMS/junkbuster-2.9.10-1.src.rpm
 </para>
 
 <para>
@@ -258,7 +265,7 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 
 <para>
  <screen>
- rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/redhat/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
  </screen>
 </para>
 
@@ -290,10 +297,10 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 </para>
 
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
 </para>
 <para>
- &nbsp;&nbsp;&nbsp;/usr/src/packages/SRPMS/junkbuster-2.9.9-1.src.rpm
+ &nbsp;&nbsp;&nbsp;/usr/src/packages/SRPMS/junkbuster-2.9.10-1.src.rpm
 </para>
 
 <para>
@@ -302,7 +309,7 @@ You can find the latest version of the user manual at  <ulink url="http://ijbswa
 
 <para>
  <screen>
- rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.9-1.i686.rpm
+ rpm -Uvv /usr/src/packages/RPMS/i686/junkbuster-2.9.10-1.i686.rpm
  </screen>
 </para>
 
@@ -382,7 +389,7 @@ configuration section below. HB.)
 </para>
 
 <para>
- For FreeBSD (and other *BSDs?), the build will need <command>gmake</command> 
+ For FreeBSD (and other *BSDs?), the build will require <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.
@@ -407,9 +414,9 @@ configuration section below. HB.)
 </para>
 
 <para>
- The installed defaults provide a reasonable starting point. For the
- time being, there are only three default configuration files (this will
- change in time):
+ The installed defaults provide a reasonable starting point, though possibly
+ aggressive by some standards. For the time being, there are only three
default configuration files (this will change in time):
 </para>
 
 <para>
@@ -431,7 +438,9 @@ configuration section below. HB.)
     restrictions, banners and cookies. There is a CGI based editor for this
     file that can be accessed via <ulink
     url="http://i.j.b">http://i.j.b</ulink>. This is the easiest method of
-    configuring actions. (Still under active development.)
+    configuring actions. (Still under active development. Other actions 
+    files are included as well with differing levels of filtering 
+    and blocking, e.g. <filename>ijb-basic.action</filename>.)
    </para>
   </listitem> 
 
@@ -450,8 +459,10 @@ configuration section below. HB.)
  can use Perl style regular expressions for maximum flexibility. All files use
  the <quote><literal>#</literal></quote> character to denote a comment. Such
  lines are not processed by <application>Junkbuster</application>. After
- making any changes, restart <application>Junkbuster</application> in order
- for the changes to take effect.
+ making any changes, there is no need to restart
+ <application>Junkbuster</application> in order for the changes to take
+ effect. <application>Junkbuster</application> should detect such changes 
+ automatically.
 </para>
 
 <para>
@@ -1738,7 +1749,9 @@ Removed references to Win32. HB 09/23/01
  handled. Images can be anything you want, including ads, banners, or just
  some obnoxious image that you would rather not see. Cookies can be accepted
  or rejected, or accepted only during the current browser session (i.e. 
- not written to disk). 
+ not written to disk). Changes to <filename>ijb.action</filename> should 
+ be immediately visible to <application>Junkbuster</application> without 
+ the need to restart.
 </para>
 
 <para>
@@ -2709,8 +2722,30 @@ Removed references to Win32. HB 09/23/01
 
 </sect2>
 
+<!--  ~  End section  ~  -->
+
+
+
+<!--   ~~~~~       New section      ~~~~~     -->
+
+<sect2>
+<title>Templates</title>
+<para>
+ When <application>Junkbuster</application> displays one of its internal 
+ pages, such as a 404 Not Found error page, it uses the appropriate template.
+ On Linux, BSD, and Unix, these are locate in
+ <filename>/etc/junkbuster/templates</filename> by default. These may be
+ customized, if desired.
+
+</para>
+</sect2>
+
 </sect1>
 
+<!--  ~  End section  ~  -->
+
+
+
 <!--   ~~~~~       New section      ~~~~~     -->
 <sect1 id="quickstart"><title>Quickstart to Using Junkbuster</title>
 <para>
@@ -3203,6 +3238,15 @@ communication (bugs, feature requests, etc.)
  Temple Place - Suite 330, Boston, MA  02111-1307, USA.
 
  $Log: user-manual.sgml,v $
+ Revision 1.26  2002/01/09 20:02:50  hal9
+ Fix bug re: auto-detect config file changes.
+
+ Revision 1.25  2002/01/09 18:20:30  hal9
+ Touch ups for *.action files.
+
+ Revision 1.24  2001/12/02 01:13:42  hal9
+ Fix typo.
+
  Revision 1.23  2001/12/02 00:20:41  hal9
  Updates for recent changes.