projects / privoxy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
- Remove filter_client_header() and filter_client_header(),
[privoxy.git] / README
diff --git a/README b/README
index e7a9536..a7e64f1 100644 (file)
--- a/README
+++ b/README
@@ -1,10 +1,10 @@
 /*********************************************************************
  *
 /*********************************************************************
  *
- * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $
+ * File        :  $Source: /cvsroot/ijbswa/current/README,v $
  *
  * Purpose     :  README file to give a short intro.
  *
  *
  * Purpose     :  README file to give a short intro.
  *
- * Copyright   :  Written by and Copyright (C) 2001,2002 the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001 - 2006  the SourceForge
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
  *                Privoxy team. http://www.privoxy.org/
  *
  *                Based on the Internet Junkbuster originally written
@@ -26,20 +26,23 @@
  *                The GNU General Public License should be included with
  *                this file.  If not, you can view it at
  *                http://www.gnu.org/copyleft/gpl.html
  *                The GNU General Public License should be included with
  *                this file.  If not, you can view it at
  *                http://www.gnu.org/copyleft/gpl.html
- *                or write to the Free Software Foundation, Inc., 59
- *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
+ *                or write to the Free Software Foundation, Inc., 
+ *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 
+ *                USA
  *
  *********************************************************************/
 
  *
  *********************************************************************/
 
-This README is included with the development version of Privoxy 3.1.1, which
-will someday become Privoxy v3.2. See http://www.privoxy.org/ for more
-information. The current code level is technically alpha, but is not yet
-significantly different from the 3.0.0 stable branch at this time..
+This README is included with Privoxy > 3.0.6 -> 3.0.7. 
+See http://www.privoxy.org/ for more information. The current code maturity
+level is "unknown". Development work is in progress. There may be new 
+features, bugs, partially working aspects, etc, all of which may not be 
+documented. Use 3.0.6 for production systems and where stability is necessary.
+Please report any problems.
 
 -------------------------------------------------------------------------------
 
 Privoxy is a web proxy with advanced filtering capabilities for protecting
 
 -------------------------------------------------------------------------------
 
 Privoxy is a web proxy with advanced filtering capabilities for protecting
-privacy, filtering web page content, managing cookies, controlling access, and
+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
 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
@@ -51,81 +54,40 @@ Privoxy is based on Internet Junkbuster (tm).
 
 1. IMPORTANT CHANGES
 
 
 1. IMPORTANT CHANGES
 
-REALLY BIG NEWS! August 2002: The long-awaited, oft-delayed stable version of
-Privoxy 3.0 is finally released! This is way behind schedule, but better late
-than never. The developers all hope the wait was worth it.
+NEWS! November 2006, Privoxy 3.0.6 is released. This is a significant upgrade
+with many new and enhanced features, and many bugs fixed. It is also the first
+stable release in quite some time. There are fifteen new actions available, and
+several actions have enhanced capabilities. Multiple filter files are now
+supported as well. There are many improvements and refinements. See the "What's
+New" section and the "Upgrader's Notes" in the User Manual for details and
+specifics. Preliminary work on 3.0.7 is already underway.
 
 
-NEWS! As of 03/24/02, the name of this project has been changed from ijbswa/
-Junkbuster to Privoxy. This is reflected in many of the included files.
+NEWS! September 2006, Privoxy 3.0.5 BETA is released. This is a significant
+upgrade with many new and enhanced features, and many bugs fixed.
 
 
-WARNING! If upgrading from earlier versions of this project via RPM packages,
-the new package will delete any previously installed 'Junkbuster' packages.
+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.
 
 
-IMPORTANT! READ! Configuration Change as of 17 Mar 2002: The default listening
-port is now 8118 due to conflicts with port 8000 assignment. You will need to
-change your browser if upgrading!!! And maybe firewall, etc.
+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
 
 
 -------------------------------------------------------------------------------
 
 2. INSTALL
 
-To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
-compiler like gcc are required.
-
-When building from a source tarball (either release version or nightly CVS
-tarball), first unpack the source:
-
- tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz]                            
- cd privoxy-3.1.1-beta                                                         
-
-For retrieving the current CVS sources, you'll need CVS installed. Note that
-sources from CVS are development quality, and may not be stable, or well
-tested. To download CVS source:
-
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current 
-  cd current                                                                         
-
-This will create a directory named current/, which will contain the source
-tree.
-
-Then, in either case, to build from unpacked tarball or CVS source:
-
- autoheader                                                                    
- autoconf                                                                      
- ./configure      # (--help to see options)                                    
- make             # (the make from gnu, gmake for *BSD)                        
- su                                                                            
- make -n install  # (to see where all the files will go)                       
- make install     # (to really install)                                        
-
-+-----------------------------------------------------------------------------+
-|                                   Warning                                   |
-|-----------------------------------------------------------------------------|
-|The "make install" target is temporary quite broken! It is recommended to use|
-|a binary package, or do a source build, and manually install the components. |
-|Sorry.                                                                       |
-+-----------------------------------------------------------------------------+
-
-If you have gnu make, you can have the first four steps automatically done for
-you by just typing:
-
-  make                                                                         
-
-in the freshly downloaded or unpacked source directory.
-
-For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
-self-extracting installers, building on platforms with special requirements
-etc, please consult the developer manual.
-
-For binary RPM installation, and other platforms, see the user-manual as well.
+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
 
 -------------------------------------------------------------------------------
 
 3. RUN
 
 privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
-[.GROUP]] [config_file]
+[.GROUP]] [--chroot] [config_file]
 
 See the man page or User Manual for an explanation of each option, and other
 configuration and usage issues.
 
 See the man page or User Manual for an explanation of each option, and other
 configuration and usage issues.
@@ -134,9 +96,7 @@ If no config_file is specified on the command line, Privoxy will look for a
 file named 'config' in the current directory (except Win32 which will look for
 'config.txt'). If no config_file is found, Privoxy will fail to start.
 
 file named 'config' in the current directory (except Win32 which will look for
 'config.txt'). If no config_file is found, Privoxy will fail to start.
 
-Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
-
-Or for SuSE: /etc/rc.d/privoxy start
+Or for Red Hat and Fedora based distributions: /etc/rc.d/init.d/privoxy start
 
 Or Debian: /etc/init.d/privoxy start
 
 
 Or Debian: /etc/init.d/privoxy start
 
@@ -144,14 +104,15 @@ Or Debian: /etc/init.d/privoxy start
 
 4. CONFIGURATION
 
 
 4. CONFIGURATION
 
-See: 'config', 'default.action', 'user.action', and 'default.filter'.
-'user.action' is for personal and local configuration preferences. These are
-all well commented. Most of the magic is in '*.action' files. 'user.action'
-should be used for any actions customizations. On Unix-like systems, these
-files are installed in /etc/privoxy. On Windows, then wherever the executable
-itself is installed. There are many significant changes and advances since
-Junkbuster v2.0.x. The User Manual has an explanation of all configuration
-options, and examples: http://www.privoxy.org/user-manual/.
+See: 'config', 'default.action', 'user.action', 'default.filter', and
+'user.filter'. 'user.action' and 'user.filter' are for personal and local
+configuration preferences. These are all well commented. Most of the magic is
+in '*.action' files. 'user.action' should be used for any actions
+customizations. On Unix-like systems, these files are typically installed in /
+etc/privoxy. On Windows, then wherever the executable itself is installed.
+There are many significant changes and advances from earlier versions. The User
+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:
 
 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:
@@ -161,22 +122,16 @@ 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.
 
 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
 
 -------------------------------------------------------------------------------
 
 5. DOCUMENTATION
 
-There should be documentation in the 'doc' subdirectory, but it is not
-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 toplevel 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,
 
 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,
@@ -202,24 +157,84 @@ list, where the developers also hang around.
 
 -------------------------------------------------------------------------------
 
 
 -------------------------------------------------------------------------------
 
-6.2. Report Bugs
+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
+    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
+    cause a crash.
+   
+-------------------------------------------------------------------------------
+
+6.2.1. Reporting Ads or Other Configuration Problems
+
+Please send feedback on ads that slipped through, innocent images that were
+blocked, sites that don't work properly, and other configuration related
+problem of default.action file, to http://sourceforge.net/tracker/?group_id=
+11118&atid=460288, the Actions File Tracker.
+
+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.
 
 Before doing so, please make sure that the bug has not already been submitted
 
 Please report all bugs only 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.
+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
 
 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.
-The appendix of the user manual also has helpful information on action
-debugging. If you are using your own custom configuration, please try the stock
-configs to see if the problem is configuration related.
-
-If not using the latest version, chances are that the bug has 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, but this is not required for reporting.
+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.
+
+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.
+
+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://
+    config.privoxy.org/show-version).
+   
+  * 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.
+   
+  * 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
+    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
+    without it?
+   
+  * 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.
+   
+The appendix of the Privoxy User Manual also has helpful information on
+understanding actions, and action debugging.
 
 -------------------------------------------------------------------------------
 
 
 -------------------------------------------------------------------------------
 
@@ -231,21 +246,7 @@ tracker/?atid=361118&group_id=11118.
 
 -------------------------------------------------------------------------------
 
 
 -------------------------------------------------------------------------------
 
-6.4. Report Ads or Other Actions-Related Problems
-
-Please send feedback on ads that slipped through, innocent images that were
-blocked, and any other problems relating to the default.action file through our
-actions feedback mechanism located at http://www.privoxy.org/actions/. On this
-page, you will also find a bookmark which will take you back there from any
-troubled site and even pre-fill the form!
-
-New, improved default.action files will 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.5. Other
+6.4. Other
 
 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
 
 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
The official Privoxy git repository