X-Git-Url: http://www.privoxy.org/gitweb/?p=privoxy.git;a=blobdiff_plain;f=README;h=5062f2b9f6379dda88d3bbd7ab38659aea60db78;hp=6987f7b530db4219dc8f409cc8316fd5ceda9a36;hb=2aa2632e43fb79c2a927c1d4acbdaa6b19e28a4e;hpb=af54618c059fd116d88387645cf6c689c658a56e diff --git a/README b/README index 6987f7b5..5062f2b9 100644 --- a/README +++ b/README @@ -4,7 +4,7 @@ * * 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 @@ -32,11 +32,10 @@ * *********************************************************************/ -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 :). +This README is included with Privoxy 3.0.8. 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 @@ -47,15 +46,19 @@ multi-user networks. Privoxy is based on Internet Junkbuster (tm). -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +------------------------------------------------------------------------------- 1. IMPORTANT CHANGES -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! 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. 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. @@ -65,19 +68,19 @@ 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. -━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━ +------------------------------------------------------------------------------- 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. @@ -90,7 +93,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,28 +115,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, 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. +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. -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. +The source and configuration files are all well commented. The main +configuration files are: 'config', 'default.action', and 'default.filter'. 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 @@ -141,7 +138,7 @@ 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 @@ -161,19 +158,19 @@ 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 @@ -186,7 +183,7 @@ 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 @@ -214,30 +211,30 @@ your bug still exists. 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). @@ -253,7 +250,7 @@ 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 @@ -261,7 +258,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