projects / privoxy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Made script location indepandant
[privoxy.git] / README
diff --git a/README b/README
index 37cd1f9..f27df8e 100644 (file)
--- a/README
+++ b/README
@@ -5,7 +5,7 @@
  * Purpose     :  README file to give a short intro.
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
  * Purpose     :  README file to give a short intro.
  *
  * Copyright   :  Written by and Copyright (C) 2001 the SourceForge
- *                IJBSWA team.  http://ijbswa.sourceforge.net
+ *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and 
  *
  *                Based on the Internet Junkbuster originally written
  *                by and Copyright (C) 1997 Anonymous Coders and 
@@ -31,29 +31,38 @@
  *
  *********************************************************************/
 
  *
  *********************************************************************/
 
-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.
+This README is included with the development version of Privoxy,
+which will eventually become Privoxy v3.0 (and soon we hope!). See
+http://www.privoxy.org/. The current code level is BETA, and seems 
+stable to us :)
 
 
-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.
+Privoxy 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. Privoxy has a very flexible configuration and
+can be customized to suit individual needs and tastes. Privoxy
+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.
+Privoxy is based on the code of the Internet Junkbuster. 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 CHANGES
+------------------
 
 
-IMPORTANT! READ! Configuration Change as of 03/04/02: The default
+NEWS! As of 03/24/02, the name of this project has been changed 
+from ijbswa/Junkbuster to Privoxy. This is reflected in many of the 
+included files. 
+
+WARNING! If upgrading from earlier versions of this project via 
+RPM packages, the new package will delete any previously installed 
+'Junkbuster' packages.
+
+IMPORTANT! READ! Configuration Change as of 3 Apr 2002: 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.
 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.
@@ -64,11 +73,11 @@ firewall, etc.
 
 For tarball, first unpack:
 
 
 For tarball, first unpack:
 
- tar xzvf ijb-2.9.11-beta-src.tar.gz
- cd ijb-2.9.11-beta
+ tar xzvf privoxy-2.9.13-beta-src.tar.gz
+ cd privoxy-2.9.13-beta
 
 
- autoheader   [suggested for CVS source]
- autoconf     [suggested for CVS source]
+ autoheader
+ autoconf
  ./configure   (--help to see options)
  gmake         (the make from gnu) 
  su 
  ./configure   (--help to see options)
  gmake         (the make from gnu) 
  su 
@@ -80,7 +89,7 @@ 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.
 
 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:
+Privoxy 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 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
@@ -92,68 +101,80 @@ then build as above.
  RUN
 ----
 
  RUN
 ----
 
-junkbuster [--help] [--version] [--no-daemon] [--pidfile PIDFILE] 
- [--user USER] [config_file]
+privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] 
+ [--user USER[.GROUP]] [config_file]
+
+See the man page or user-manual for a brief explanation of each option.
 
 
-Or for RedHat: /etc/rc.d/init.d/junkbuster start
-Or for SuSE:   /etc/rc.d/junkbuster start
+If no config_file is specified on the command line, Privoxy will look for 
+a file named 'config' in the current directory (except Win32 which will look
+for 'config.txt'). If no config_file is found, Privoxy will fail to start.
 
 
-See the man page or user-manual for a brief explanation of each.
+Or for Red Hat: /etc/rc.d/init.d/privoxy start
+Or for SuSE:   /etc/rc.d/privoxy 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', 'default.action', and 'default.filter'. There are several 
+actions files included. These are all well commented. Most of the magic
+is in '*.action', and there are several of these included with varying degrees
+of aggressiveness. On Unix-like systems, these files are installed in
+/etc/privoxy.  On Windows, then wherever the executable itself is installed.
+There are many significant changes and advances since Junkbuster v2.0.x. The
+user-manual has a run down of configuration options, and examples:
+http://www.privoxy.org/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.
 
 
 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.
+The default.action file can be configured via the web interface accessed
+via http://p.p/, as well other options.
+
+All configuration files are subject to unannounced changes during the 
+development process.
 
 
  DOCUMENTATION
 --------------
 
 There is a growing amount of documentation in the 'doc' subdirectory,
 
 
  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.
+but it is not completed at this point. In particular, see the
+user-manual there, the faq, and developers should look at developer-manual.
 
 
-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.
+The most up to date 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', '*.action', and
+'default.filter' in the toplevel source directory.
 
 Included documentation may vary according to platform and packager.
 
 
  CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 
 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
 
 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 
  * 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
    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
+   to verify that it is a Privoxy 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,
    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.
+   please try the latest one. Or even better, CVS sources. Please 
+   be sure to include the Privoxy/Junkbuster version, platform, 
+   browser, any pertinent log data, any other relevant details 
+   (please be specific) and, if possible, some way to reproduce the 
+   bug.
+ 
  * Submit feature requests only thru our feature request forum:
    http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
      
  * Submit feature requests only thru our feature request forum:
    http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
      
@@ -168,4 +189,4 @@ here too.
 -------------------------------------------------------------------------
 ijbswa-developers@lists.sourceforge.net
 
 -------------------------------------------------------------------------
 ijbswa-developers@lists.sourceforge.net
 
-$Id: README,v 1.15 2002/03/06 16:31:16 hal9 Exp $
+$Id: README,v 1.22 2002/03/27 01:06:40 hal9 Exp $
The official Privoxy git repository