Reworked for 3.0.12 upcoming release.
[privoxy.git] / README
diff --git a/README b/README
index bea2598..931b457 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@
  *
  * Purpose     :  README file to give a short intro.
  *
  *
  * Purpose     :  README file to give a short intro.
  *
- * Copyright   :  Written by and Copyright (C) 2001-2007  the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001-2009  the SourceForge
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *
  *********************************************************************/
 
  *
  *********************************************************************/
 
-This README is included with the development version of Privoxy 3.0.7. See
-http://www.privoxy.org/ for more information. The current code maturity level
-is "beta", but seems stable to us :).
+This README is included with Privoxy 3.0.12. See http://www.privoxy.org/ for
+more information. The current code maturity level is "stable".
 
 -------------------------------------------------------------------------------
 
 Privoxy is a non-caching web proxy with advanced filtering capabilities for
 
 -------------------------------------------------------------------------------
 
 Privoxy is a non-caching web proxy with advanced filtering capabilities for
-enhancing privacy, modifying web page data, managing HTTP cookies, controlling
-access, and removing ads, banners, pop-ups and other obnoxious Internet junk.
-Privoxy has a flexible configuration and can be customized to suit individual
-needs and tastes. Privoxy has application for both stand-alone systems and
-multi-user networks.
+enhancing privacy, modifying web page data and HTTP headers, controlling
+access, and removing ads and other obnoxious Internet junk. Privoxy has a
+flexible configuration and can be customized to suit individual needs and
+tastes. It has application for both stand-alone systems and multi-user
+networks.
 
 
-Privoxy is based on Internet Junkbuster (tm).
+Privoxy is Free Software and licensed under the GPL2.
 
 -------------------------------------------------------------------------------
 
 1. IMPORTANT CHANGES
 
 
 -------------------------------------------------------------------------------
 
 1. IMPORTANT CHANGES
 
-December 2007, Privoxy 3.0.7 beta is released. This is a significant upgrade
-with many new and enhanced features, and many bugs fixed. See the "ChangeLog",
+March 2009, Privoxy 3.0.12 is released.
+
+This is primarily a bug fix release. See the "ChangeLog", and the "What's New"
+section and the "Upgrader's Notes" in the User Manual for details.
+
+February 2009, Privoxy 3.0.11 is released.
+
+As usual there are changes that effect the configuration. See the "ChangeLog",
 and the "What's New" section and the "Upgrader's Notes" in the User Manual for
 and the "What's New" section and the "Upgrader's Notes" in the User Manual for
-details and specifics. There are changes related to configuration, so anyone
-upgrading and keeping their old configuration should read ahead first.
+details and specifics.
 
 
-NEWS! November 2006, Privoxy 3.0.6 stable is released. This is a significant
-upgrade with many new and enhanced features, and many bugs fixed.
+This is a stable release, and marks a departure for Privoxy development.
 
 
-There was and will not be an official 3.0.4 release. This release cycle was
-used to gather our thoughts, play with some new ideas and refine some old ones.
-It will remain a development cycle with no actual release. 3.0.5 is the fruit
-of these efforts.
+Previously, odd numbered releases were considered beta versions and were only
+released at the end of the development cycle when the code was already believed
+to be stable. Usually it was, so the stable release contained pretty much the
+same code, but got a higher version number. In the future we intend to release
+several snapshots between stable releases. There will probably still be about
+two stable releases per year, but hopefully about six snapshots instead of the
+two betas we have now. The intentions is to make testing without CVS access
+easier.
 
 -------------------------------------------------------------------------------
 
 
 -------------------------------------------------------------------------------
 
@@ -76,8 +83,8 @@ User Manual, for all other installation types.
 
 3. RUN
 
 
 3. RUN
 
-privoxy [??help] [??version] [??no-daemon] [??pidfile PIDFILE] [??user USER
-[.GROUP]] [??chroot] [??pre?chroot?nslookup HOSTNAME ][config_file]
+privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
+[.GROUP]] [--chroot] [--pre-chroot-nslookup HOSTNAME ][config_file]
 
 See the man page or User Manual for an explanation of each option, and other
 configuration and usage issues.
 
 See the man page or User Manual for an explanation of each option, and other
 configuration and usage issues.
@@ -88,7 +95,7 @@ file named 'config' in the current directory (except Win32 which will look for
 
 Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
 
 
 Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
 
-Or Debian: /etc/init.d/privoxy start
+Or Debian and Ubuntu: /etc/init.d/privoxy start
 
 -------------------------------------------------------------------------------
 
 
 -------------------------------------------------------------------------------
 
@@ -112,22 +119,16 @@ 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.
 
 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
 
 -------------------------------------------------------------------------------
 
 5. DOCUMENTATION
 
-There should be documentation in the 'doc' subdirectory, but it may not be
-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 top-level 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,
 
 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,
@@ -151,6 +152,9 @@ http://sourceforge.net/tracker/?group_id=11118&atid=211118
 All users are of course welcome to discuss their issues on the users mailing
 list, where the developers also hang around.
 
 All users are of course welcome to discuss their issues on the users mailing
 list, where the developers also hang around.
 
+Please don't sent private support requests to individual Privoxy developers,
+either use the mailing lists or the support trackers.
+
 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
 addresses have to be accepted manually by a moderator. This may cause a delay
 of several days and if you use a subject that doesn't clearly mention Privoxy
 Note that the Privoxy mailing lists are moderated. Posts from unsubscribed
 addresses have to be accepted manually by a moderator. This may cause a delay
 of several days and if you use a subject that doesn't clearly mention Privoxy