Added no-ping and hide-tor-exit-notation.
[privoxy.git] / INSTALL
diff --git a/INSTALL b/INSTALL
index 9bb9caf..6bb2ae5 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -4,7 +4,7 @@
  *
  * Purpose     :  INSTALL file to help with installing from source.
  *
- * 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
@@ -26,8 +26,9 @@
  *                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
  *
  *********************************************************************/
    
 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:
+When building from a source tarball, first unpack the source:
 
- tar xzvf privoxy-3.1.1-beta-src* [.tgz or .tar.gz]                            
- cd privoxy-3.1.1-beta                                                         
+ tar xzvf privoxy-3.0.5-beta-src* [.tgz or .tar.gz]                            
+ cd privoxy-3.0.5-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:
+For retrieving the current CVS sources, you'll need a CVS client installed.
+Note that sources from CVS are typicially development quality, and may not be
+stable, or well tested. To download CVS source, check the Sourceforge
+documentation, which might give commands like:
 
-  cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login          
-  cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current 
+  cvs -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa login          
+  cvs -z3 -d:pserver:anonymous@ijbswa.cvs.sourceforge.net:/cvsroot/ijbswa co current 
   cd current                                                                         
 
 This will create a directory named current/, which will contain the source
@@ -76,7 +77,7 @@ Then, to build from either unpacked tarball or CVS source:
  autoheader                                                                    
  autoconf                                                                      
  ./configure      # (--help to see options)                                    
- make             # (the make from gnu, gmake for *BSD)                        
+ make             # (the make from GNU, sometimes called gmake)                
  su                                                                            
  make -n install  # (to see where all the files will go)                       
  make -s install  # (to really install, -s to silence output)                  
@@ -88,22 +89,24 @@ you by just typing:
 
 in the freshly downloaded or unpacked source directory.
 
-WARNING: If installing as root, the install will fail unless another user is
-specified. configure accepts --with-user and --with-group options for setting
-user and group ownership of the configuration files (which need to be writable
-by the daemon). The specified user must already exist. Or if there is already a
-privoxy user on the system, and no user was specified during configure, make
-install then will use the privoxy user. When starting Privoxy, it should be run
-as this same user that owns the configuration and log files.
+WARNING: If installing as root, the install will fail unless a non-root user or
+group is specified, or a privoxy user and group already exist on the system. If
+a non-root user is specified, and no group, then the installation will try to
+also use a group of the same name as "user". If a group is specified (and no
+user), then the support files will be installed as writable by that group, and
+owned by the user running the installation.
+
+configure accepts --with-user and --with-group options for setting user and
+group ownership of the configuration files (which need to be writable by the
+daemon). The specified user must already exist. When starting Privoxy, it
+should be run as this same user to insure write access to configuration and log
+files.
 
 Alternately, you can specify user and group on the make command line, but be
 sure both already exist:
 
  make -s install  USER=privoxy GROUP=privoxy                                   
 
-If no group is specified, the install will assume a group exists with the same
-name as the specified user.
-
 The default installation path for make install is /usr/local. This may of
 course be customized with the various ./configure path options. If you are
 doing a root install to anywhere else besides /usr/local, be sure to set the
@@ -131,19 +134,18 @@ user to determine how and where to start Privoxy. The init script should be
 checked for correct paths and values, if anything other than a default install
 is done.
 
-If install finds previous versions of any configuration files, these will not
-be overwritten, and the new ones will be installed with a "new" extension. You
-will then need to manually update the installed configuration files as needed.
-All template files will be overwritten. If you have customized, local
+If install finds previous versions of any local configuration files, these will
+not be overwritten, and the new ones will be installed with a "new" extension.
+default.action, default.filter, and standard.action will be overwritten. You
+will then need to manually update the other installed configuration files as
+needed. All template files will be overwritten. If you have customized, local
 templates, you should save these first. If a previous version of Privoxy is
 already running, you will have to restart it manually.
 
-For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
+For more detailed instructions on how to build Redhat 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.
-
 The simplest command line to start Privoxy is $path/privoxy --user=privoxy
 $path/etc/privoxy/config. See privoxy --usage, or the man page, for other
 options, and configuration.