projects / privoxy.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Just polishing the chrome a little...
[privoxy.git] / README
diff --git a/README b/README
index 0b8ac1e..b5015b8 100644 (file)
--- a/README
+++ b/README
@@ -1,11 +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 the SourceForge
+ * Copyright   :  Written by and Copyright (C) 2001 - 2004  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
@@ -31,15 +30,16 @@
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
  *********************************************************************/
  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
  *
  *********************************************************************/
-   
 
 
-This README is included with the development version of Privoxy 2.9.14, which
-will eventually become Privoxy v3.0 (and soon we hope!). See http://
-www.privoxy.org/ for more information. The current code level is beta, and
-seems stable to us :).
+This README is included with Privoxy 3.0.4-beta. The current code maturity
+level is "beta". Various changes and improvements are underway, and
+preparations are being made for an update of Privoxy. Please report any
+problems to the developers.
+
+-------------------------------------------------------------------------------
 
 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 content, 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
@@ -47,9 +47,23 @@ networks.
 
 Privoxy is based on Internet Junkbuster (tm).
 
 
 Privoxy is based on Internet Junkbuster (tm).
 
+-------------------------------------------------------------------------------
+
+1. IMPORTANT CHANGES
+
+MORE 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.
+
+NEWS! March 2003, Privoxy 3.0.2 is released. This is the first maintenance
+release of Privoxy. There are no significant new features in this release. Some
+bugs are fixed, and some existing features have been enhanced. See ChangeLog
+for details. Upgrading from 3.0.0 is recommended.
 
 
- 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! 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! 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.
@@ -61,161 +75,123 @@ 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.
 
 port is now 8118 due to conflicts with port 8000 assignment. You will need to
 change your browser if upgrading!!! And maybe firewall, etc.
 
+-------------------------------------------------------------------------------
 
 
- INSTALL
---------
+2. INSTALL
 
 
-To build Privoxy from source, autoheader, autoconf, GNU make (gmake), and, of
-course, a C compiler are required.
+See the INSTALL file in this directory, for installing from source, and the
+User Manual, for other installation types.
 
 
-When building from a source tarball (either release version or nightly CVS
-tarball), first unpack the source:
+-------------------------------------------------------------------------------
 
 
- tar xzvf privoxy-2.9.14-beta-src* [.tgz or .tar.gz]                           
- cd privoxy-2.9.14-beta                                                        
-                                                                               
+3. RUN
 
 
-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:
+privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
+[.GROUP]] [--chroot] [config_file]
 
 
-  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                                                                         
-                                                                                     
+See the man page or User Manual for an explanation of each option, and other
+configuration and usage issues.
 
 
-This will create a directory named current/, which will contain the source
-tree.
+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.
 
 
-Then, in either case, to build from unpacked tarball or CVS source:
+Or for Red Hat based distributions: /etc/rc.d/init.d/privoxy start
 
 
- 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)                                        
-                                                                               
+Or for SuSE: /etc/rc.d/privoxy start
 
 
-If you have gnu make, you can have the first four steps automatically done for
-you by just typing
+Or Debian: /etc/init.d/privoxy start
 
 
-  make                                                                         
-                                                                               
+-------------------------------------------------------------------------------
 
 
-in the freshly downloaded or unpacked source directory.
+4. CONFIGURATION
 
 
-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.
+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/.
 
 
-For binary RPM installation, and other platforms, see the user-manual as well.
+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.
 
 
+The actions list can be configured via the web interface accessed via http://
+p.p/, as well other options.
 
 
- RUN
----- 
+-------------------------------------------------------------------------------
 
 
-privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
-[.GROUP]] [config_file]
+5. DOCUMENTATION
 
 
-See the man page or user-manual for a brief explanation of each option.
+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.
 
 
-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.
+The source and configuration files are all well commented. The main
+configuration files are: 'config', 'default.action', and 'default.filter'.
 
 
-Or for Red Hat: /etc/rc.d/init.d/privoxy start
+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.
 
 
-Or for SuSE: /etc/rc.d/privoxy start
+-------------------------------------------------------------------------------
 
 
+6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
 
 
- CONFIGURATION
--------------- 
+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:
 
 
-See: 'config', 'default.action', 'standard.action', 'user.action', and
-'default.filter'. 'user.action' is for personal configuration. These are all
-well commented. Most of the magic is in '*.action' files. 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 a run down of 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.
+6.1. Get Support
 
 
-The actions list can be configured via the web interface accessed via http://
-p.p/, as well other options.
+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.
+
+-------------------------------------------------------------------------------
+
+6.2. Report 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
+and observe the additional hints at the top of the submit form.
+
+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.
+
+-------------------------------------------------------------------------------
+
+6.3. Request New Features
+
+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.5. Other
 
 
-All configuration files are subject to unannounced changes during the
-development process.
-
-
- 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.
-
-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.
-
-Included documentation may vary according to platform and packager.
-
-
- CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
---------------------------------------------------------------
-
-We value your feedback. However, to provide you with the best support, please
-note:
-
-  * Use the Sourceforge Support Forum to get help:
-       
-        http://sourceforge.net/tracker/?group_id=11118&atid=211118
-       
-   
-  * Submit bugs only through our Sourceforge Bug Forum:
-     
-        http://sourceforge.net/tracker/?group_id=11118&atid=111118. 
-        
-   
-    Make sure that the bug has not already been submitted. Please try to verify
-    that it is a Privoxy bug, and not a browser or site bug first. If you are
-    using your own custom configuration, please try the stock configs to see if
-    the problem is a configuration related bug. And if not using the latest
-    development snapshot, please try the latest one. Or even better, CVS
-    sources. Please be sure to include the Privoxy/Junkbuster version,
-    platform, browser, any pertinent log data, any other relevant details
-    (please be specific) and, if possible, some way to reproduce the bug.
-   
-  * Submit feature requests only through our Sourceforge feature request forum:
-     
-        http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
-       
-   
-  * You can also send feedback on websites that Privoxy has problems with. Please bookmark
-    the following link: "Privoxy - Submit Filter Feedback"
-    . Once you surf to a page with problems, use the
-    bookmark to send us feedback. We will look into the issue as soon as possible.
-       
-   
-  * For any other issues, feel free to use the mailing lists:
-     
-        http://sourceforge.net/mail/?group_id=11118.
-     
-   
-    Anyone interested in actively participating in development and related
-    discussions can also join the appropriate mailing list. Archives are
-    available, too.
-   
- -------------------------------------------------------------------------
- ijbswa-developers@lists.sourceforge.net
- 
-
-$Id: readme.sgml,v 1.9 2002/04/24 04:04:12 hal9 Exp $
+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
+mailing lists, including list archives, at: http://sourceforge.net/mail/?
+group_id=11118.
 
 
The official Privoxy git repository