*
* Purpose : README file to give a short intro.
*
- * Copyright : Written by and Copyright (C) 2001 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001,2002 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
*********************************************************************/
This README is included with the development version of Privoxy 3.1.1, which
-will eventually become Privoxy v3.2. See http://www.privoxy.org/ for more
-information. The current code level is alpha, and may break in mysterious ways
-:) There may be features only partially implemented, or worse, not functional.
+will someday become Privoxy v3.2. See http://www.privoxy.org/ for more
+information. The current code level is technically alpha, but is not yet
+significantly different from the 3.0.0 stable branch at this time (other
+than more bugs).
+
+There is not much reason to actually run this branch unless you want to help
+chase bugs, or with development.
-------------------------------------------------------------------------------
1. IMPORTANT CHANGES
+REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version of
+Privoxy 3.0 is finally released! This is way behind schedule, but better late
+than never. The developers all hope the wait was worth it.
+
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.
2. INSTALL
-To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
-compiler like gcc are required.
-
-When building from a source tarball (either release version or nightly CVS
-tarball), first unpack the source:
-
- tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz]
- cd privoxy-3.1.1-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:
-
- 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
-
-This will create a directory named current/, which will contain the source
-tree.
-
-Then, in either case, to build from unpacked tarball or CVS source:
-
- 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)
-
-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.
+See the INSTALL file in this directory, for installing from source, and the
+User Manual, for other installation types.
-------------------------------------------------------------------------------
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.
+8118. Note that Privoxy ONLY proxies HTTP (and HTTPS) traffic. Do not try it
+with FTP or other protocols for the simple reason it does not work.
The actions list can be configured via the web interface accessed via http://
p.p/, as well other options.
5. DOCUMENTATION
-There should be documentation in the 'doc' subdirectory, but it may not be in
-sync with current code. In particular, see the User Manual there, the FAQ, and
+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 most up to date source of information on the current development version,
-may be either comments in the source code, or the included configuration files.
-The source and configuration files are all well commented. The main
+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.
-Included documentation may vary according to platform and packager.
+Included documentation may vary according to platform and packager. All
+documentation is posted on http://www.privoxy.org, in case you don't have it,
+or can't find it.
-------------------------------------------------------------------------------
New, improved default.action files will occasionally be made available based on
your feedback. These will be announced on the ijbswa-announce list and
-available from our project page.
+available from our the files section of our project page.
-------------------------------------------------------------------------------
projects / privoxy.git / blobdiff