moved to obsolete. use ChangeLog instead
[privoxy.git] / README
diff --git a/README b/README
index 7dc1fb5..37cd1f9 100644 (file)
--- a/README
+++ b/README
-/*********************************************************************\r
- *\r
- * File        :  $Source: /cvsroot/ijbswa/current/README,v $\r
- *\r
- * Purpose     :  README file to give a short intro.\r
- *\r
- * Copyright   :  Written by and Copyright (C) 2001 the SourceForge\r
- *                IJBSWA team.  http://ijbswa.sourceforge.net\r
- *\r
- *                Based on the Internet Junkbuster originally written\r
- *                by and Copyright (C) 1997 Anonymous Coders and \r
- *                Junkbusters Corporation.  http://www.junkbusters.com\r
- *\r
- *                This program is free software; you can redistribute it \r
- *                and/or modify it under the terms of the GNU General\r
- *                Public License as published by the Free Software\r
- *                Foundation; either version 2 of the License, or (at\r
- *                your option) any later version.\r
- *\r
- *                This program is distributed in the hope that it will\r
- *                be useful, but WITHOUT ANY WARRANTY; without even the\r
- *                implied warranty of MERCHANTABILITY or FITNESS FOR A\r
- *                PARTICULAR PURPOSE.  See the GNU General Public\r
- *                License for more details.\r
- *\r
- *                The GNU General Public License should be included with\r
- *                this file.  If not, you can view it at\r
- *                http://www.gnu.org/copyleft/gpl.html\r
- *                or write to the Free Software Foundation, Inc., 59\r
- *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.\r
- *\r
- *********************************************************************/\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
-\r
-\r
- INSTALL\r
---------\r
-\r
-For tarball, first unpack:\r
-\r
- tar zxvf ijb_source_*\r
- cd ijb_source_2.9.9_alpha\r
-\r
- autoconf     [suggested for CVS source]\r
- ./configure\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
-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
- 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
- RUN\r
-----\r
-\r
- junkbuster /etc/junkbuster/config &\r
-\r
-Or for RPMS: /etc/rc.d/init.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
-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
-Be sure to set your browser(s) for HTTP/HTTPS Proxy at localhost:8000.\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
-files, which are all well commented. These are 'config',\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 \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
- BUGS\r
------\r
-\r
-Use the form at\r
-http://sourceforge.net/tracker/index.php?group_id=11118&atid=111118 to\r
-report bugs. Please read the exising bug reports before submitting\r
-anything new.\r
-\r
--------------------------------------------------------------------------\r
-ijbswa-developers@lists.sourceforge.net\r
-\r
-$Id: README,v 1.5 2001/10/16 01:31:53 hal9 Exp $\r
+/*********************************************************************
+ *
+ * File        :  $Source: /cvsroot/ijbswa/current/README,v $
+ *
+ * Purpose     :  README file to give a short intro.
+ *
+ * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
+ *                IJBSWA team.  http://ijbswa.sourceforge.net
+ *
+ *                Based on the Internet Junkbuster originally written
+ *                by and Copyright (C) 1997 Anonymous Coders and 
+ *                Junkbusters Corporation.  http://www.junkbusters.com
+ *
+ *                This program 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.
+ *
+ *                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.
+ *
+ *                The GNU General Public License should be included with
+ *                this file.  If not, you can view it at
+ *                http://www.gnu.org/copyleft/gpl.html
+ *                or write to the Free Software Foundation, Inc., 59
+ *                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 (and soon we hope!). See
+http://ijbswa.sourceforge.net.
+
+Internet Junkbuster is a web proxy with advanced filtering
+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. 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
+--------
+
+For tarball, first unpack:
+
+ tar xzvf ijb-2.9.11-beta-src.tar.gz
+ cd ijb-2.9.11-beta
+
+ 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' (run ./configure first) from unpacked
+sources. BSD will (probably?) require gmake (from http://gnu.org). See
+the user-manual for OS/2 build instructions.
+
+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
+
+This will create a directory named 'current'. Then, 'cd current', and
+then build as above.
+
+
+ RUN
+----
+
+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
+
+See the man page or user-manual for a brief explanation of each.
+
+
+ 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/.
+
+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:8118.
+
+The ijb.action file can be configured via the web interface accessed
+via http://i.j.b/, as well other options.
+
+
+ DOCUMENTATION
+--------------
+
+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.
+
+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 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.
+
+
+ CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
+-----
+
+We value your feedback. However, to provide you with the best support,
+please note:
+   
+ * Use the support forum to get help:
+   http://sourceforge.net/tracker/?group_id=11118&atid=211118
+ * Submit bugs only thru our bug forum:
+   http://sourceforge.net/tracker/?group_id=11118&atid=111118 
+   Make sure that the bug has not already been submitted. Please try
+   to verify that it is a Junkbuster bug, and not a browser or site
+   bug first. If you are using your own custom configuration, please
+   try the stock configs to see if the problem is a configuration
+   related bug. And if not using the latest development snapshot,
+   please try the latest one. Or even better, CVS sources.
+ * Submit feature requests only thru our feature request forum:
+   http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
+     
+For any other issues, feel free to use the mailing lists:
+http://sourceforge.net/mail/?group_id=11118
+   
+Anyone interested in actively participating in development and related
+discussions can join the appropriate mailing list here:
+http://sourceforge.net/mail/?group_id=11118. Archives are available
+here too.
+
+-------------------------------------------------------------------------
+ijbswa-developers@lists.sourceforge.net
+
+$Id: README,v 1.15 2002/03/06 16:31:16 hal9 Exp $