Update Debian patches to the state of CVS as of 2007-12-01.
[privoxy.git] / README
diff --git a/README b/README
index 03a57b6..6987f7b 100644 (file)
--- a/README
+++ b/README
@@ -4,7 +4,7 @@
  *
  * Purpose     :  README file to give a short intro.
  *
- * Copyright   :  Written by and Copyright (C) 2001 - 2006  the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001-2007  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.0.5. See
+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 :).
+is "beta", but seems stable to us :).
 
-If there are no significant problems with this release, Privoxy 3.0.6 (stable)
-will soon follow. There are expected to be no new features in the meantime.
-Please report any problems on the respective SourceForge Project Tracker (see
-below).
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
--------------------------------------------------------------------------------
-
-Privoxy is a web proxy with advanced filtering capabilities for protecting
-privacy, modifying web page data, 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
-networks.
+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.
 
 Privoxy is based on Internet Junkbuster (tm).
 
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 1. IMPORTANT CHANGES
 
-BIG NEWS! September 2006, Privoxy 3.0.5 is released. This is a significant
-upgrade with many new and enhanced features, and many bugs fixed. There are
-fifteen new actions available, and several actions have enhanced capabilities.
-Multiple filter files are now supported as well. See the "What's New" section
-and the "Upgrader's Notes" in the User Manual for details and specifics.
+November 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",
+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.
+
+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.
 
 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.
 
-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.
-
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 2. INSTALL
 
 See the INSTALL file in this directory, for installing from raw source, and the
 User Manual, for all other installation types.
 
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 3. RUN
 
-privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
-[.GROUP]] [--chroot] [config_file]
+privoxy [——help] [——version] [——no-daemon] [——pidfile PIDFILE] [——user USER
+[.GROUP]] [——chroot] [config_file]
 
 See the man page or User Manual for an explanation of each option, and other
 configuration and usage issues.
@@ -97,7 +90,7 @@ Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
 
 Or Debian: /etc/init.d/privoxy start
 
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 4. CONFIGURATION
 
@@ -112,9 +105,9 @@ Manual has an explanation of all configuration 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.
@@ -122,7 +115,7 @@ p.p/, as well other options.
 All configuration files are subject to unannounced changes during the
 development process.
 
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 5. DOCUMENTATION
 
@@ -140,7 +133,7 @@ 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,
 or can't find it.
 
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 
@@ -148,29 +141,39 @@ We value your feedback. In fact, we rely on it to improve Privoxy and its
 configuration. However, please note the following hints, so we can provide you
 with the best support:
 
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 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
 list, where the developers also hang around.
 
--------------------------------------------------------------------------------
+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
+or one of its features, your message may be accidentally discarded as spam.
+
+If you aren't subscribed, you should therefore spend a few seconds to come up
+with a proper subject. Additionally you should make it clear that you want to
+get CC'd. Otherwise some responses will be directed to the mailing list only,
+and you won't see them.
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 6.2. Reporting Problems
 
 "Problems" for our purposes, come in two forms:
 
-  * Configuration issues, such as ads that slip through, or sites that don't
+   Configuration issues, such as ads that slip through, or sites that don't
     function properly due to one Privoxy "action" or another being turned "on".
-   
-  * "Bugs" in the programming code that makes up Privoxy, such as that might
+
+   "Bugs" in the programming code that makes up Privoxy, such as that might
     cause a crash.
-   
--------------------------------------------------------------------------------
+
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 6.2.1. Reporting Ads or Other Configuration Problems
 
@@ -183,63 +186,74 @@ New, improved default.action files may 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.2.2. Reporting Bugs
 
-Please report all bugs only through our bug tracker: http://sourceforge.net/
-tracker/?group_id=11118&atid=111118.
+Please report all bugs through our bug tracker: http://sourceforge.net/tracker
+/?group_id=11118&atid=111118.
 
 Before doing so, please make sure that the bug has not already been submitted
 and observe the additional hints at the top of the submit form. If already
 submitted, please feel free to add any info to the original report that might
 help to solve the issue.
 
-Please try to verify that it is a Privoxy bug, and not a browser or site bug
-first. If unsure, try toggling off Privoxy, and see if the problem persists. If
-you are using your own custom configuration, please try the stock configs to
-see if the problem is configuration related.
+Please try to verify that it is a Privoxy bug, and not a browser or site bug or
+documented behaviour that just happens to be different than what you expected.
+If unsure, try toggling off Privoxy, and see if the problem persists.
 
-If not using the latest version, the bug may have been found and 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.
+If you are using your own custom configuration, please try the stock configs to
+see if the problem is configuration related. If you're having problems with a
+feature that is disabled by default, please ask around on the mailing list if
+others can reproduce the problem.
+
+If you aren't using the latest Privoxy version, the bug may have been found and
+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 that
+your bug still exists.
 
 Please be sure to provide the following information:
 
-  * The exact Privoxy version of the proxy software (if you got the source from
-    CVS, please also provide the source code revisions as shown in http://
+  • The exact Privoxy version you are using (if you got the source from CVS,
+    please also provide the source code revisions as shown in http://
     config.privoxy.org/show-version).
-   
-  * The operating system and versions you run Privoxy on, (e.g. Windows XP
-    SP2), if you are using some kind of Unix flavour, sending the output of
-    "uname -a" should do.
-   
-  * The name, platform, and version of the browser you were using (e.g.
+
+   The operating system and versions you run Privoxy on, (e.g. Windows XP
+    SP2), if you are using a Unix flavor, sending the output of "uname -a"
+    should do, in case of GNU/Linux, please also name the distribution.
+
+   The name, platform, and version of the browser you were using (e.g.
     Internet Explorer v5.5 for Mac).
-   
-  * The URL where the problem occurred, or some way for us to duplicate the
+
+   The URL where the problem occurred, or some way for us to duplicate the
     problem (e.g. http://somesite.example.com/?somethingelse=123).
-   
-  * Whether your version of Privoxy is one supplied by the developers of
-    Privoxy via SourceForge, or somewhere else.
-   
-  * Whether you are using Privoxy in tandem with another proxy such as Tor. If
-    so, please try disabling the other proxy.
-   
-  * Whether you are using a personal firewall product. If so, does Privoxy work
+
+  • Whether your version of Privoxy is one supplied by the Privoxy developers
+    via SourceForge, or if you got your copy somewhere else.
+
+   Whether you are using Privoxy in tandem with another proxy such as Tor. If
+    so, please temporary disable the other proxy to see if the symptoms change.
+
+   Whether you are using a personal firewall product. If so, does Privoxy work
     without it?
-   
-  * Any other pertinent information to help identify the problem such as config
+
+   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).
-   
-  * Please provide your SF login, or email address, in case we need to contact
-    you.
-   
+
+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.
+
+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.
+
 The appendix of the Privoxy User Manual also has helpful information on
 understanding actions, and action debugging.
 
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 6.3. Request New Features
 
@@ -247,7 +261,7 @@ You are welcome to submit ideas on new features or other proposals for
 improvement through our feature request tracker at http://sourceforge.net/
 tracker/?atid=361118&group_id=11118.
 
--------------------------------------------------------------------------------
+━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
 
 6.4. Other