/*********************************************************************
*
- * File : $Source: /cvsroot/ijbswa/current/README,v $
+ * File : $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
*
* Purpose : README file to give a short intro.
*
- * Copyright : Written by and Copyright (C) 2001-2010 the
+ * Copyright : Written by and Copyright (C) 2001-2011 the
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
*
*********************************************************************/
-This README is included with Privoxy 3.0.16. See http://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.18. See
+http://www.privoxy.org/ for more information. The current code maturity level
+is "UNRELEASED", but seems stable to us :).
-------------------------------------------------------------------------------
1. IMPORTANT CHANGES
-February 2010, Privoxy 3.0.16 stable is released.
+November 2010, Privoxy 3.0.17 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.
+This is mainly a bug-fix release for the previously released Privoxy 3.0.16.
+
+It contains fixes for two bugs that could cause connections to hang under
+certain circumstances when keep-alive support was enabled, until they timed out
+or where closed by the server.
+
+As usual, there are also a bunch of minor improvements. For details please see
+the "ChangeLog", the "What's New" section or the "Upgrader's Notes" in the User
+Manual.
-------------------------------------------------------------------------------
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 http://www.privoxy.org, in case you don't have it,
Please don't sent private support requests to individual Privoxy developers,
either use the mailing lists or the support trackers.
+If you have to contact a Privoxy developer directly for other reasons, please
+send a real mail and do not bother with SourceForge's messaging system. Answers
+to SourceForge messages are usually bounced by SourceForge's mail server in
+which case the developer wasted time writing a response you don't get. From
+your point of view it will look like your message has been completely ignored,
+so this is frustrating for all parties involved.
+
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
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
+
+ debug 32768 # log all data read from the network
+
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.
+request if they have the same problem or already found a solution. Note that
+due to spam the trackers may not always allow to post without being logged into
+SourceForge. If that's the case, you are still free to create a login that
+isn't directly linked to your name, though.
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
-automatically get a mail when someone responds to your request.
+automatically get a mail when someone responds to your request. Please don't
+bother to add an email address when using the tracker. If you prefer to
+communicate through email, just use one of the mailing lists directly.
The appendix of the Privoxy User Manual also has helpful information on
understanding actions, and action debugging.
-------------------------------------------------------------------------------
-6.4. Other
+6.4. Mailing Lists
-For any other issues, feel free to use the mailing lists. Technically
-interested users and people who wish to contribute to the project are also
-welcome on the developers list! You can find an overview of all Privoxy-related
+If you prefer to communicate through email, instead of using a web interface,
+feel free to use one of the mailing lists. To discuss issues that haven't been
+completely diagnosed yet, please use the Privoxy users list. Technically
+interested users and people who wish to contribute to the project are always
+welcome on the developers list. You can find an overview of all Privoxy-related
mailing lists, including list archives, at: http://sourceforge.net/mail/?
group_id=11118.
projects / privoxy.git / blobdiff