Add a couple of tests for +client-header-filter{no-brotli-accepted}
[privoxy.git] / README
diff --git a/README b/README
index ae82000..2da1e78 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
 /*********************************************************************
  *
- * File        :  $Source: /cvsroot/ijbswa/current/README,v $
+ * File        :  doc/source/readme.sgml
  *
  * Purpose     :  README file to give a short intro.
  *
- * Copyright   :  Written by and Copyright (C) 2001-2011 the
+ * Copyright   :  Written by and Copyright (C) 2001-2018 the
  *                Privoxy team. https://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
@@ -32,8 +32,9 @@
  *
  *********************************************************************/
 
-This README is included with Privoxy 3.0.26. See https://www.privoxy.org/ for
-more information. The current code maturity level is "stable".
+This README is included with the development version of Privoxy 3.0.29. See
+https://www.privoxy.org/ for more information. The current code maturity level
+is "UNRELEASED", but seems stable to us :).
 
 -------------------------------------------------------------------------------
 
@@ -104,16 +105,22 @@ 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. 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, 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.
 
-The source and configuration files are all well commented. The main
-configuration files are: 'config', 'default.action', and 'default.filter'.
+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.
 
 Included documentation may vary according to platform and packager. All
 documentation is posted on https://www.privoxy.org, in case you don't have it,
@@ -177,23 +184,26 @@ requesting support:
     directive is being used and the following debug options are enabled (all of
     them):
 
-    debug     1 # Log the destination for each request Privoxy let through. See also debug 1024.
+    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  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
+    debug 65536 # Log applying actions
 
     If you are having trouble with a filter, please additionally enable
 
     debug    64 # debug regular expression filters
 
-    If you are using Privoxy 3.0.17 or later and suspect that it interprets the
-    request or the response incorrectly, please enable
+    If you suspect that Privoxy interprets the request or the response
+    incorrectly, please enable
 
     debug 32768 # log all data read from the network