*
* 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-2008 the SourceForge
* Privoxy team. http://www.privoxy.org/
*
* Based on the Internet Junkbuster originally written
*
*********************************************************************/
-This README is included with Privoxy 3.0.7. 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.11. See
+http://www.privoxy.org/ for more information. The current code maturity level
+is "UNRELEASED", but seems stable to us :).
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
Privoxy is a non-caching web proxy with advanced filtering capabilities for
enhancing privacy, modifying web page data, managing HTTP cookies, controlling
Privoxy is based on Internet Junkbuster (tm).
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
1. IMPORTANT CHANGES
-December 2007, Privoxy 3.0.7 stable 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.
+Privoxy development is between releases. The current sources are development
+quality. If you find problems please report them to the developers.
-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.
+August 2008, Privoxy 3.0.10 is released! There are not any major new features,
+but many improvements and refinements. 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.
-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.
+June 2008, Privoxy 3.0.9 beta is released. There are no major new features, but
+many improvements and refinements.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+NEWS! January 2008, Privoxy 3.0.8 stable is released. This is a significant
+upgrade with many new and enhanced features, and many bugs fixed. All Privoxy
+users are encouraged to upgrade. 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.
+
+December 2007, Privoxy 3.0.7 is released. This is a beta release in preparation
+for the forthcoming 3.0.8 release.
+
+-------------------------------------------------------------------------------
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] [--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.
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
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
4. CONFIGURATION
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,
or can't find it.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
configuration. However, please note the following hints, so we can provide you
with the best support:
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
6.1. Get Support
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
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
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 be sure to provide the following information:
- • The exact Privoxy version you are using (if you got the source from CVS,
+ * 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
+ * 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.
+ * 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 Privoxy developers
+ * 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
+ * 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
+ * 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).
The appendix of the Privoxy User Manual also has helpful information on
understanding actions, and action debugging.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
6.3. Request New Features
improvement through our feature request tracker at http://sourceforge.net/
tracker/?atid=361118&group_id=11118.
-━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━
+-------------------------------------------------------------------------------
6.4. Other
projects / privoxy.git / blobdiff