X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=README;h=ab199e0c23fef7557288cddd1588d182de8748ea;hp=dc0281acc460bfada2b49e735fca4b8df8da3f56;hb=7ad3cc3818b921ee55547d540cb19807583a4751;hpb=d509e7d943d00d9b0b453b4ab1252fe69aaf82bf

diff --git a/README b/README
index dc0281ac..ab199e0c 100644
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 /*********************************************************************
  *
- * File        :  $Source: /cvsroot/ijbswa/current/config.h.in,v $
+ * File        :  $Source: /cvsroot/ijbswa/current/README,v $
  *
  * Purpose     :  README file to give a short intro.
  *
@@ -30,57 +30,88 @@
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
  *********************************************************************/
-
 
 This README is included with the development version of Junkbuster,
 which will eventually become Junkbuster v3.0. See
 http://ijbswa.sourceforge.net.
 
 Internet Junkbuster is a web proxy with advanced filtering
-capabilities for protecting privacy and removing ads, banners, pop-ups
-and other obnoxious Internet Junk.
+capabilities for protecting privacy, filtering web page content,
+managing cookies, controlling access, and removing ads, banners,
+pop-ups and other obnoxious Internet Junk. Junkbuster has a very
+flexible configuration and can be customized to suit individual needs
+and tastes. Internet Junkbuster has application for both stand-alone
+systems and multi-user networks.
+
+JunkBuster was originally written by JunkBusters Corporation, and was
+released as free open-source software under the GNU GPL. Stefan
+Waldherr made many improvements, and started the SourceForge project
+to continue development.
 
  INSTALL
 --------
 
 For tarball, first unpack:
 
- tar zxvf ijb_source_*
- cd ijb_source_2.9.8_alpha
+ tar xzvf ijb_source_* [.tgz or .tar.gz]
+ cd ijb_source_2.9.10_alpha
 
- ./configure
- make
- su
- make install
+ autoheader   [suggested for CVS source]
+ autoconf     [suggested for CVS source]
+ ./configure	(--help to see options)
+ gmake        	(the make from gnu) 
+ su 
+ make -n install	(to see where all the files will go)
+ make install		(to really install)
 
 Redhat and SuSE src and binary RPMs can be built with 'make
-redhat-dist' or 'make suse-dist'.
+redhat-dist' or 'make suse-dist' (run ./configure first). BSD
+will (probably?) require gmake (from http://gnu.org). See the 
+user-manual for OS/2 build instructions.
 
-Junkbuster is also availabe via anonymous CVS:
+Junkbuster is also available via anonymous CVS:
 
  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co
-current
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
 
 This will create a directory named 'current'. Then, 'cd current', and then
 build as above.
 
+
  RUN
 ----
 
- junkbuster /etc/junkbuster/config &
+ junkbuster /etc/junkbuster/config 
+
+Or for RedHat: /etc/rc.d/init.d/junkbuster start
+Or for SuSE:   /etc/rc.d/junkbuster start
+
+The only command line option supported is the location of the 
+main configuration file. If none is specified, Junkbuster will 
+look for a file named 'config' for unix, config.txt for Win32 
+in the current directory.
+
 
-Or for RPMS: /etc/rc.d/init.d/junkbuster start
+ CONFIGURATION
+--------------
 
-CONFIGURATION
--------------
+See: 'config', 'ijb.action', and 're_filterfile'. These are all well
+commented. On Unix-like systems, these files are installed in /etc/junkbuster.
+On Windows, then wherever the executable itself is installed. There are many
+significant changes and advances since v2.0.x. The user-manual has a 
+run down of configuration options, and examples: 
+http://ijbswa.sourceforge.net/user-manual/.
 
-See: 'config', 'actionsfile', and 're_filterfile'. There are many changes and
-advances since v2.0.x. Be sure to set your browsers for HTTP Proxy at
-localhost:8000.
+Be sure to set your browser(s) for HTTP/HTTPS Proxy at <IP>:<Port>,
+or whatever you specify in the config file under 'listen-address'.
+DEFAULT is localhost:8000.
 
-DOCUMENTATION
--------------
+The ijb.action file can be configured via the web interface accessed via
+http://i.j.b/, as well other options.
+
+
+ DOCUMENTATION
+--------------
 
 The best source of information on the current development version, is
 either comments in the source code, or the included configuration
@@ -88,15 +119,16 @@ files, which are all well commented. These are 'config',
 'actionsfile', and 're_filterfile' in the toplevel source directory.
 
 There is a growing amount of new documentation in the 'doc'
-subdirectory, but it is sparse at this point. In particular, see the
-developer-manual and user-manual there.
+subdirectory, but it is sparse at this point. In particular, see 
+the user-manual there, which is 'nearly there'.
 
 Some legacy documentation is also included only to give an idea of
 what Junkbuster can do under doc/obsolete/*. Much has changed since
 these docs were written, so beware.
 
-BUGS
-----
+
+ BUGS
+-----
 
 Use the form at
 http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to
@@ -106,4 +138,4 @@ anything new.
 -------------------------------------------------------------------------
 ijbswa-developers@lists.sourceforge.net
 
-$Id$
+$Id: README,v 1.8 2001/11/05 21:54:48 steudten Exp $