Correct Debian specials (installation and startup).

[privoxy.git] / README

diff --git a/README b/README
index d4cd5a6..705c989 100644 (file)
--- a/README
+++ b/README
@@ -1,6 +1,6 @@
 /*********************************************************************
  *
 /*********************************************************************
  *

- * File        :  $Source: /cvsroot/ijbswa/current/README,v $
+ * File        :  $Source: /cvsroot/ijbswa/current/doc/source/readme.sgml,v $

  *
  * Purpose     :  README file to give a short intro.
  *
  *
  * Purpose     :  README file to give a short intro.
  *


@@ -31,150 +31,214 @@
  *
  *********************************************************************/
 
  *
  *********************************************************************/
 

-This README is included with the development version of Privoxy,
-which will eventually become Privoxy v3.0 (and soon we hope!). See
-http://www.privoxy.org/.
+This README is included with the development version of Privoxy 2.9.15, 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 :).

 
 

-Privoxy is a web proxy with advanced filtering capabilities for
-protecting privacy, filtering 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. Internet
-Privoxy has application for both stand-alone systems and multi-user
+-------------------------------------------------------------------------------
+
+Table of Contents
+1. IMPORTANT CHANGES
+2. INSTALL
+3. RUN
+4. CONFIGURATION
+5. DOCUMENTATION
+6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
+   
+    6.1. Get Support
+    6.2. Report bugs
+    6.3. Request new features
+    6.4. Report ads or other filter problems
+    6.5. Other
+   
+Privoxy is a web proxy with advanced filtering capabilities for protecting
+privacy, filtering 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

 networks.
 
 networks.
 

-Privoxy is based on the code of the Internet Junkbuster. Junkbuster
-was originally written by JunkBusters Corporation, and was released as
-free open-source software under the GNU GPL. Stefan Waldherr made many
-improvements, and started the SourceForge project to continue
-development. Several other developers are now contributing.
+Privoxy is based on Internet Junkbuster (tm).
+
+-------------------------------------------------------------------------------
+
+1. IMPORTANT CHANGES
+
+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.
+
+WARNING! If upgrading from earlier versions of this project via RPM packages,
+the new package will delete any previously installed 'Junkbuster' packages.
+
+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.
+
+-------------------------------------------------------------------------------
+
+2. INSTALL

 
 

+To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
+compiler like gcc are required.

 
 

- IMPORTANT CHANGES
-------------------
+When building from a source tarball (either release version or nightly CVS
+tarball), first unpack the source:

 
 

-NEWS! As of 03/24/02, the name of this project has been changed 
-from Junkbuster to Privoxy. This is reflected in many of the 
-included files. 
+ tar xzvf privoxy-2.9.15-beta-src* [.tgz or .tar.gz]                           
+ cd privoxy-2.9.15-beta                                                        

 
 

-WARNING! If upgrading from earlier versions of this project via 
-RPM packages, the new package will delete any previously installed 
-'Junkbuster' packages.
+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:

 
 

-IMPORTANT! READ! Configuration Change as of 3 Apr 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.
+  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.

 
 

- INSTALL
---------
+Then, in either case, to build from unpacked tarball or CVS source:

 
 

-For tarball, first unpack:
+ 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)                                        

 
 

- tar xzvf privoxy-2.9.13-beta-src.tar.gz
- cd privoxy-2.9.13-beta
+If you have gnu make, you can have the first four steps automatically done for
+you by just typing:

 
 

- autoheader
- autoconf
- ./configure   (--help to see options)
- gmake         (the make from gnu) 
- su 
- make -n install       (to see where all the files will go)
- make install          (to really install)
+  make                                                                         

 
 

-Redhat and SuSE src and binary RPMs can be built with 'make
-redhat-dist' or 'make suse-dist' (run ./configure first) from unpacked
-sources. BSD will (probably?) require gmake (from http://gnu.org). See
-the user-manual for OS/2 build instructions.
+in the freshly downloaded or unpacked source directory.

 
 

-Privoxy is also available via anonymous CVS:
+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.

 
 

- cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
- cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
+For binary RPM installation, and other platforms, see the user-manual as well.

 
 

-This will create a directory named 'current'. Then, 'cd current', and
-then build as above.
+-------------------------------------------------------------------------------

 
 

+3. RUN

 
 

- RUN
-----
+privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] [--user USER
+[.GROUP]] [config_file]

 
 

-privoxy [--help] [--version] [--no-daemon] [--pidfile PIDFILE] 
- [--user USER] [config_file]
+See the man page or user-manual for a brief explanation of each option.

 
 

-Or for RedHat: /etc/rc.d/init.d/privoxy start
-Or for SuSE:   /etc/rc.d/privoxy start
+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.

 
 

-See the man page or user-manual for a brief explanation of each.
+Or for Red Hat: /etc/rc.d/init.d/privoxy start

 
 

+Or for SuSE: /etc/rc.d/privoxy start

 
 

- CONFIGURATION
---------------
+-------------------------------------------------------------------------------

 
 

-See: 'config', '*.action', and 'default.filter'. These are all well
-commented. Most of the magic is in '*.action', and there are several 
-of these included with varying degrees of aggressiveness. 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/.
+4. CONFIGURATION

 
 

-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.
+See: 'config', 'default.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. '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 a run down of configuration options, and examples: http://
+www.privoxy.org/user-manual/.

 
 

-The default.action file can be configured via the web interface accessed
-via http://p.p/, as well other options.
+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.

 
 

+The actions list can be configured via the web interface accessed via http://
+p.p/, as well other options.

 
 

- DOCUMENTATION
---------------
+All configuration files are subject to unannounced changes during the
+development process.

 
 

-There is a growing amount of documentation in the 'doc' subdirectory,
-but it is not finished at this point. In particular, see the
-user-manual there, and developers should look at developer-manual.
+-------------------------------------------------------------------------------
+
+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.

 
 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
 
 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, which are all well commented. These are 'config', '*.action', and
-'default.filter' in the toplevel source directory.
-
-Some legacy Junkbuster documentation may also be included only to give an idea
-of what Privoxy can do under doc/obsolete/*. Much has changed since these docs
-were written, so beware.
+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.
 
 
 Included documentation may vary according to platform and packager.
 

+-------------------------------------------------------------------------------

 
 

- CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
---------------------------------------------------------------
+6. CONTACTING THE DEVELOPERS, BUG REPORTING AND FEATURE REQUESTS
+
+We value your feedback. However, to provide you with the best support, please
+note the following sections.
+
+-------------------------------------------------------------------------------
+
+6.1. Get Support
+
+To get support, use the Sourceforge Support Forum:
+
+    http://sourceforge.net/tracker/?group_id=11118&atid=211118
+
+-------------------------------------------------------------------------------
+
+6.2. Report bugs
+
+To submit bugs, use the 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 version, platform, browser, any pertinent log data,
+any other relevant details (please be specific) and, if possible, some way to
+reproduce the bug.
+
+-------------------------------------------------------------------------------
+
+6.3. Request new features
+
+To submit ideas on new features, use the Sourceforge feature request forum:
+
+    http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse.
+
+-------------------------------------------------------------------------------
+
+6.4. Report ads or other filter problems
+
+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.
+
+New, improved default.action files will occasionally be made available based on
+your feedback. These will be announced on the ijbswa-announce list.
+
+-------------------------------------------------------------------------------
+
+6.5. Other

 
 

-We value your feedback. However, to provide you with the best support,
-please note:
-   
- * Use the support forum to get help:
-   http://sourceforge.net/tracker/?group_id=11118&atid=211118
- * Submit bugs only thru our 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.
- * Submit feature requests only thru our feature request forum:
-   http://sourceforge.net/tracker/?atid=361118&group_id=11118&func=browse
-     

 For any other issues, feel free to use the mailing lists:
 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 join the appropriate mailing list here:
-http://sourceforge.net/mail/?group_id=11118. Archives are available
-here too.
+ 
+    http://sourceforge.net/mail/?group_id=11118.

 
 

--------------------------------------------------------------------------
-ijbswa-developers@lists.sourceforge.net
+Anyone interested in actively participating in development and related
+discussions can also join the appropriate mailing list. Archives are available,
+too. See the page on Sourceforge.

 
 

-$Id: README,v 1.20 2002/03/24 19:57:28 hal9 Exp $