/*********************************************************************
*
- * File : $Source: /cvsroot/ijbswa/current/README,v $
+ * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
*
* 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
*
*********************************************************************/
-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 2.9.14, which
+will eventually become Privoxy v3.0 (and soon we hope!). See http://
+www.privoxy.org/ for more information. 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.
+
+Privoxy is based on Internet Junkbuster (tm).
+
+
+ IMPORTANT CHANGES
+------------------
+
+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 17 Mar 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.
-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:
+To build Privoxy from source, autoheader, autoconf, GNU make (gmake), and, of
+course, a C compiler are required.
+
+When building from a source tarball (either release version or nightly CVS
+tarball), first unpack the source:
+
+ tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]
+ cd privoxy-2.9.14-beta
- tar xzvf ijb-2.9.11-beta-src.tar.gz
- cd ijb-2.9.11-beta
+For retrieving the current CVS sources, you'll need CVS installed. Note that
+sources from CVS are development quality, and may not be stable, or well
+tested. To download CVS source:
- 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)
+ cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
+ cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
+ cd current
-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.
+This will create a directory named current/, which will contain the source
+tree.
-Junkbuster is also available via anonymous CVS:
+Then, in either case, to build from unpacked tarball or CVS source:
- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
+ autoheader
+ autoconf
+ ./configure # (--help to see options)
+ make # (the make from gnu, gmake for *BSD)
+ su
+ make -n install # (to see where all the files will go)
+ make install # (to really install)
-This will create a directory named 'current'. Then, 'cd current', and then
-build as above.
+If you have gnu make, you can have the first four steps automatically done for
+you by just typing:
+
+ make
+
+in the freshly downloaded or unpacked source directory.
+
+For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
+self-extracting installers, building on platforms with special requirements
+etc, please consult the developer manual.
+
+For binary RPM installation, and other platforms, see the user-manual as well.
RUN
-----
+----
- junkbuster /etc/junkbuster/config
+privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
+[.GROUP]] [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 option.
-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.
+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.
+
+Or for Red Hat: /etc/rc.d/init.d/privoxy start
+
+Or for SuSE: /etc/rc.d/privoxy start
CONFIGURATION
---------------
+--------------
+
+See: 'config', 'default.action', 'user.action', and 'default.filter'.
+'user.action' is for personal configuration. These are all well commented. Most
+of the magic is in '*.action' files. 'user.action' should be used for any
+actions customizations. 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/.
-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.
-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.
+The actions list can be configured via the web interface accessed via http://
+p.p/, as well other options.
-The ijb.action file can be configured via the web interface accessed via
-http://i.j.b/, 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, but it is not finished at this point. In particular, see
-the user-manual there, and developers should look at
-developer-manual.
+There should be documentation in the 'doc' subdirectory, but it is not
+completed at this point. In particular, see the user-manual there, the faq, and
+those interested in Privoxy development, 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.
+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. The source and configuration files are all well commented. The main
+configuration files are: 'config', 'default.action', and 'default.filter' in
+the toplevel source directory.
-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.
+Included documentation may vary according to platform and packager.
- BUGS
------
+ CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
+--------------------------------------------------------------
-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. 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
--------------------------------------------------------------------------
-ijbswa-developers@lists.sourceforge.net
+$Id: readme.sgml,v 1.12 2002/04/26 17:45:36 swa Exp $
-$Id: README,v 1.11 2002/02/27 15:07:26 oes Exp $