Show enablement/disablement status in almost all templates.

[privoxy.git] / README

diff --git a/README b/README
index dc0281a..694844f 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 /*********************************************************************\r
  *\r
 /*********************************************************************\r
  *\r

- * File        :  $Source: /cvsroot/ijbswa/current/config.h.in,v $\r
+ * File        :  $Source: /cvsroot/ijbswa/current/README,v $\r

  *\r
  * Purpose     :  README file to give a short intro.\r
  *\r
  *\r
  * Purpose     :  README file to give a short intro.\r
  *\r


@@ -30,15 +30,23 @@
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
  *\r
  *********************************************************************/\r
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
  *\r
  *********************************************************************/\r

-\f\r

 \r
 This README is included with the development version of Junkbuster,\r
 which will eventually become Junkbuster v3.0. See\r
 http://ijbswa.sourceforge.net.\r
 \r
 Internet Junkbuster is a web proxy with advanced filtering\r
 \r
 This README is included with the development version of Junkbuster,\r
 which will eventually become Junkbuster v3.0. See\r
 http://ijbswa.sourceforge.net.\r
 \r
 Internet Junkbuster is a web proxy with advanced filtering\r

-capabilities for protecting privacy and removing ads, banners, pop-ups\r
-and other obnoxious Internet Junk.\r
+capabilities for protecting privacy, filtering web page content,\r
+managing cookies, controlling access, and removing ads, banners,\r
+pop-ups and other obnoxious Internet Junk. Junkbuster has a very\r
+flexible configuration and can be customized to suit individual needs\r
+and tastes. Internet Junkbuster has application for both stand-alone\r
+systems and multi-user networks.\r
+\r
+JunkBuster was originally written by JunkBusters Corporation, and was\r
+released as free open-source software under the GNU GPL. Stefan\r
+Waldherr made many improvements, and started the SourceForge project\r
+to continue development.\r

 \r
  INSTALL\r
 --------\r
 \r
  INSTALL\r
 --------\r


@@ -46,41 +54,57 @@ and other obnoxious Internet Junk.
 For tarball, first unpack:\r
 \r
  tar zxvf ijb_source_*\r
 For tarball, first unpack:\r
 \r
  tar zxvf ijb_source_*\r

- cd ijb_source_2.9.8_alpha\r
+ cd ijb_source_2.9.9_alpha\r

 \r
 \r

+ autoheader   [suggested for CVS source]\r
+ autoconf     [suggested for CVS source]\r

  ./configure\r
  ./configure\r

- make\r
+ make         (gmake on BSD?)\r

  su\r
  make install\r
 \r
 Redhat and SuSE src and binary RPMs can be built with 'make\r
  su\r
  make install\r
 \r
 Redhat and SuSE src and binary RPMs can be built with 'make\r

-redhat-dist' or 'make suse-dist'.\r
+redhat-dist' or 'make suse-dist' (run ./configure first). BSD\r
+will (probably?) require gmake (from http://gnu.org). See the \r
+user-manual for OS/2 build instructions.\r

 \r
 Junkbuster is also availabe via anonymous CVS:\r
 \r
  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login\r
 \r
 Junkbuster is also availabe via anonymous CVS:\r
 \r
  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login\r

- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co\r
-current\r
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current\r

 \r
 This will create a directory named 'current'. Then, 'cd current', and then\r
 build as above.\r
 \r
 \r
 This will create a directory named 'current'. Then, 'cd current', and then\r
 build as above.\r
 \r

+\r

  RUN\r
 ----\r
 \r
  junkbuster /etc/junkbuster/config &\r
 \r
  RUN\r
 ----\r
 \r
  junkbuster /etc/junkbuster/config &\r
 \r

-Or for RPMS: /etc/rc.d/init.d/junkbuster start\r
+Or for RedHat: /etc/rc.d/init.d/junkbuster start\r
+Or for SuSE: /etc/rc.d/junkbuster start\r
+\r
+The only command line option supported is the location of the \r
+main configuration file. If none is specified, Junkbuster will \r
+look for a file named 'config' in the current directory.\r
+\r
+\r
+ CONFIGURATION\r
+--------------\r

 \r
 \r

-CONFIGURATION\r
--------------\r
+See: 'config', 'actionsfile', and 're_filterfile'. These are all well\r
+commented. On Unix-like systems, these files are installed in /etc/junkbuster.\r
+On Windows, then wherever the executable itself is installed. There are many\r
+significant changes and advances since v2.0.x. The user-manual has a \r
+run down of configuration options, and examples: \r
+http://ijbswa.sourceforge.net/user-manual/.\r

 \r
 \r

-See: 'config', 'actionsfile', and 're_filterfile'. There are many changes and\r
-advances since v2.0.x. Be sure to set your browsers for HTTP Proxy at\r
-localhost:8000.\r
+Be sure to set your browser(s) for HTTP/HTTPS Proxy at localhost:8000.\r

 \r
 \r

-DOCUMENTATION\r
--------------\r
+\r
+ DOCUMENTATION\r
+--------------\r

 \r
 The best source of information on the current development version, is\r
 either comments in the source code, or the included configuration\r
 \r
 The best source of information on the current development version, is\r
 either comments in the source code, or the included configuration\r


@@ -88,15 +112,16 @@ files, which are all well commented. These are 'config',
 'actionsfile', and 're_filterfile' in the toplevel source directory.\r
 \r
 There is a growing amount of new documentation in the 'doc'\r
 'actionsfile', and 're_filterfile' in the toplevel source directory.\r
 \r
 There is a growing amount of new documentation in the 'doc'\r

-subdirectory, but it is sparse at this point. In particular, see the\r
-developer-manual and user-manual there.\r
+subdirectory, but it is sparse at this point. In particular, see \r
+the user-manual there, which is 'nearly there'.\r

 \r
 Some legacy documentation is also included only to give an idea of\r
 what Junkbuster can do under doc/obsolete/*. Much has changed since\r
 these docs were written, so beware.\r
 \r
 \r
 Some legacy documentation is also included only to give an idea of\r
 what Junkbuster can do under doc/obsolete/*. Much has changed since\r
 these docs were written, so beware.\r
 \r

-BUGS\r
-----\r
+\r
+ BUGS\r
+-----\r

 \r
 Use the form at\r
 http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to\r
 \r
 Use the form at\r
 http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to\r


@@ -106,4 +131,4 @@ anything new.
 -------------------------------------------------------------------------\r
 ijbswa-developers@lists.sourceforge.net\r
 \r
 -------------------------------------------------------------------------\r
 ijbswa-developers@lists.sourceforge.net\r
 \r

-$Id$\r
+$Id: README,v 1.6 2001/10/24 18:47:54 hal9 Exp $\r