Rename LOG_LEVEL_LOG to the more descriptive LOG_LEVEL_WRITING.
[privoxy.git] / README
diff --git a/README b/README
index 0d3f9f6..ee0ba55 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
 /*********************************************************************
  *
- * 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-2009  the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001-2010 the
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *
  *********************************************************************/
 
-This README is included with Privoxy 3.0.11. See http://www.privoxy.org/ for
+This README is included with Privoxy 3.0.16. 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
-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 GNU GPLv2.
 
--------------------------------------------------------------------------------
+Privoxy is an associated project of Software in the Public Interest (SPI).
 
-1. IMPORTANT CHANGES
+Helping hands and donations are welcome:
 
-February 2009, Privoxy 3.0.11 is released. This is a stable release, and marks
-a departure for Privoxy development. Previously, odd numbered releases were
-considered beta releases. Each release now will be considered stable.
+  * http://www.privoxy.org/faq/general.html#PARTICIPATE
 
-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
-details and specifics.
+  * http://www.privoxy.org/faq/general.html#DONATE
 
-August 2008, Privoxy 3.0.10 is released! There are not any major new features,
-but many improvements and refinements.
+-------------------------------------------------------------------------------
+
+1. IMPORTANT CHANGES
 
-June 2008, Privoxy 3.0.9 beta is released. There are no major new features, but
-many improvements and refinements.
+February 2010, Privoxy 3.0.16 stable is released.
+
+This is the first stable release since 3.0.12. It mainly contains bugfixes for
+the previous betas which introduced IPv6 support, improved keep-alive support
+and a bunch of minor improvements. See the "ChangeLog", and the "What's New"
+section and the "Upgrader's Notes" in the User Manual for details.
 
 -------------------------------------------------------------------------------
 
@@ -85,10 +86,6 @@ 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 and Fedora based distributions: /etc/rc.d/init.d/privoxy start
-
-Or Debian and Ubuntu: /etc/init.d/privoxy start
-
 -------------------------------------------------------------------------------
 
 4. CONFIGURATION
@@ -105,7 +102,7 @@ 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
+127.0.0.1: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://
@@ -235,12 +232,32 @@ Please be sure to provide the following information:
 
   * Any other pertinent information to help identify the problem such as config
     or log file excerpts (yes, you should have log file entries for each action
-    taken).
-
-You don't have to tell us your actual name when filing a problem report, but
-please use a nickname so we can differentiate between your messages and the
-ones entered by other "anonymous" users that may respond to your request if
-they have the same problem or already found a solution.
+    taken). To get a meaningful logfile, please make sure that the logfile
+    directive is being used and the following debug options are enabled:
+
+    debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
+    debug     2 # show each connection status
+    debug     4 # show I/O status
+    debug     8 # show header parsing
+    debug   128 # debug redirects
+    debug   256 # debug GIF de-animation
+    debug   512 # Common Log Format
+    debug  1024 # Log the destination for requests Privoxy didn't let through, and the reason why.
+    debug  4096 # Startup banner and warnings.
+    debug  8192 # Non-fatal errors
+
+    If you are having trouble with a filter, please additionally enable
+
+    debug    64 # debug regular expression filters
+
+    Note that Privoxy log files may contain sensitive information so please
+    don't submit any logfiles you didn't read first. You can mask sensitive
+    information as long as it's clear that you removed something.
+
+You don't have to tell us your actual name when filing a problem report, but if
+you don't, please use a nickname so we can differentiate between your messages
+and the ones entered by other "anonymous" users that may respond to your
+request if they have the same problem or already found a solution.
 
 Please also check the status of your request a few days after submitting it, as
 we may request additional information. If you use a SF id, you should