builds cleanly. thanks to kukuk@suse.de

[privoxy.git] / README

diff --git a/README b/README
index 197c16b..0865e8a 100644 (file)
--- a/README
+++ b/README
@@ -46,7 +46,17 @@ 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.
+to continue development. Several other developers are now contributing.
+
+
+ IMPORTANT CHANGE
+-----------------
+
+IMPORTANT! READ! Configuration Change as of 03/04/02: The default 
+listening port is now 8118 due to conflicts with port 8000 assignment. 
+You will need to change your browser if upgrading!!! And maybe firewall, 
+etc.
+
 
  INSTALL
 --------
@@ -81,15 +91,13 @@ build as above.
  RUN
 ----
 
- junkbuster /etc/junkbuster/config 
+junkbuster [--help] [--version] [--no-daemon] [--pidfile PIDFILE] 
+ [--user USER] [config_file]
 
 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.
+See the man page or user-manual for a brief explanation of each.
 
 
  CONFIGURATION
@@ -104,7 +112,7 @@ http://ijbswa.sourceforge.net/user-manual/.
 
 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.
+DEFAULT is localhost:8118.
 
 The ijb.action file can be configured via the web interface accessed via
 http://i.j.b/, as well other options.
@@ -113,19 +121,22 @@ 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
-files, which are all well commented. These are 'config',
-'actionsfile', and 're_filterfile' in the toplevel source directory.
+There is a growing amount of documentation in the 'doc'
+subdirectory, but it is not finished at this point. In particular, see 
+the user-manual there, and developers should look at 
+developer-manual.
 
-There is a growing amount of new documentation in the 'doc'
-subdirectory, but it is sparse at this point. In particular, see 
-the user-manual there, which is 'nearly there'.
+The best source of information on the current development version, may 
+still be either comments in the source code, or the included configuration
+files, which are all well commented. These are 'config', 'ijb.action', and
+'re_filterfile' in the toplevel source directory.
 
-Some legacy documentation is also included only to give an idea of
+Some legacy documentation may also be included only to give an idea of
 what Junkbuster can do under doc/obsolete/*. Much has changed since
 these docs were written, so beware.
 
+Included documentation may vary according to platform and packager.
+
 
  BUGS
 -----
@@ -133,9 +144,11 @@ these docs were written, so beware.
 Use the form at
 http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to
 report bugs. Please read the exising bug reports before submitting
-anything new.
+anything new. We ask that these not be reported on the mailing lists, 
+since this is harder to track, and to make sure all reports are 
+addressed.
 
 -------------------------------------------------------------------------
 ijbswa-developers@lists.sourceforge.net
 
-$Id: README,v 1.10 2002/02/24 05:20:35 hal9 Exp $
+$Id: README,v 1.14 2002/03/05 01:18:45 hal9 Exp $