/*********************************************************************
*
- * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
+ * File : $Source: /cvsroot/ijbswa/current/README,v $
*
* Purpose : README file to give a short intro.
*
- * Copyright : Written by and Copyright (C) 2001,2002 the SourceForge
+ * Copyright : Written by and Copyright (C) 2001 - 2004 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 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..
+This README is included with Privoxy 3.0.4-beta. The current code maturity
+level is "beta". Various changes and improvements are underway, and
+preparations are being made for an update of Privoxy. Please report any
+problems to the developers.
-------------------------------------------------------------------------------
Privoxy is a web proxy with advanced filtering capabilities for protecting
-privacy, filtering web page content, managing cookies, controlling access, and
+privacy, modifying 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
1. IMPORTANT CHANGES
+MORE NEWS! January 2004, Privoxy 3.0.3 is released. This is the another
+maintenance release of Privoxy which fixes more bugs, further refines the
+configuration and works around some known third-party problems. See the
+ChangeLog for complete details. Upgrading from 3.0.2 is recommended.
+
+NEWS! March 2003, Privoxy 3.0.2 is released. This is the first maintenance
+release of Privoxy. There are no significant new features in this release. Some
+bugs are fixed, and some existing features have been enhanced. See ChangeLog
+for details. Upgrading from 3.0.0 is recommended.
+
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.
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)
-
-+-----------------------------------------------------------------------------+
-| Warning |
-|-----------------------------------------------------------------------------|
-|The "make install" target is temporary quite broken! It is recommended to use|
-|a binary package, or do a source build, and manually install the components. |
-|Sorry. |
-+-----------------------------------------------------------------------------+
-
-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.
-------------------------------------------------------------------------------
3. RUN
privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
-[.GROUP]] [config_file]
+[.GROUP]] [--chroot] [config_file]
See the man page or User Manual for an explanation of each option, and other
configuration and usage issues.
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. 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.
+you specify in the config file under 'listen-address'. DEFAULT is
+localhost: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.
-All configuration files are subject to unannounced changes during the
-development process.
-
-------------------------------------------------------------------------------
5. DOCUMENTATION
-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.
+There should be documentation in the 'doc' subdirectory. 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 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.
+The source and configuration files are all well commented. The main
+configuration files are: 'config', 'default.action', and 'default.filter'.
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,
6.1. Get Support
-For casual users, our support forum at SourceForge is probably best suited:
+For casual users, our support forum at SourceForge is probably best suited:
http://sourceforge.net/tracker/?group_id=11118&atid=211118
All users are of course welcome to discuss their issues on the users mailing
configs to see if the problem is configuration related.
If not using the latest version, chances are that the bug has been found and
-fixed in the meantime. We would appreciate if you could take the time to
+fixed in the meantime. We would appreciate if you could take the time to
upgrade to the latest version (or even the latest CVS snapshot) and verify your
bug, but this is not required for reporting.
-------------------------------------------------------------------------------
-6.4. Report Ads or Other Actions-Related Problems
-
-Please send feedback on ads that slipped through, innocent images that were
-blocked, and any other problems relating to the default.action file through our
-actions feedback mechanism located at http://www.privoxy.org/actions/. On this
-page, you will also find a bookmark which will take you back there from any
-troubled site and even pre-fill the form!
-
-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 the files section of our project page.
-
--------------------------------------------------------------------------------
-
6.5. Other
For any other issues, feel free to use the mailing lists. Technically
projects / privoxy.git / blobdiff