privoxy-log-parser: Highlight: "filtering request body from client 127.0.0.1 (size...

[privoxy.git] / INSTALL

diff --git a/INSTALL b/INSTALL
index 34f654a..1e6df14 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -5,13 +5,13 @@
  * Purpose     :  INSTALL file to help with installing from source.
  *
  * Copyright   :  Written by and Copyright (C) 2001-2009 the
  * Purpose     :  INSTALL file to help with installing from source.
  *
  * Copyright   :  Written by and Copyright (C) 2001-2009 the

- *                Privoxy team. http://www.privoxy.org/
+ *                Privoxy team. https://www.privoxy.org/

  *
  *                Based on the Internet Junkbuster originally written
  *
  *                Based on the Internet Junkbuster originally written

- *                by and Copyright (C) 1997 Anonymous Coders and 
+ *                by and Copyright (C) 1997 Anonymous Coders and

  *                Junkbusters Corporation.  http://www.junkbusters.com
  *
  *                Junkbusters Corporation.  http://www.junkbusters.com
  *

- *                This program is free software; you can redistribute it 
+ *                This program is free software; you can redistribute it

  *                and/or modify it under the terms of the GNU General
  *                Public License as published by the Free Software
  *                Foundation; either version 2 of the License, or (at
  *                and/or modify it under the terms of the GNU General
  *                Public License as published by the Free Software
  *                Foundation; either version 2 of the License, or (at


@@ -26,12 +26,11 @@
  *                The GNU General Public License should be included with
  *                this file.  If not, you can view it at
  *                http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
  *                The GNU General Public License should be included with
  *                this file.  If not, you can view it at
  *                http://www.gnu.org/licenses/old-licenses/gpl-2.0.html

- *                or write to the Free Software Foundation, Inc., 
- *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 
+ *                or write to the Free Software Foundation, Inc.,
+ *                51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,

  *                USA
  *
  *********************************************************************/
  *                USA
  *
  *********************************************************************/

-   

 
 -------------------------------------------------------------------------------
 
 
 -------------------------------------------------------------------------------
 


@@ -40,45 +39,37 @@ compiler like gcc are required.
 
 When building from a source tarball, first unpack the source:
 
 
 When building from a source tarball, first unpack the source:
 

- tar xzvf privoxy-3.0.15-beta-src.tar.gz
- cd privoxy-3.0.15-beta
+ tar xzvf privoxy-3.0.30-stable-src.tar.gz
+ cd privoxy-3.0.30-stable

 
 

+To build the development version, you can get the source code by doing:

 
 

-For retrieving the current CVS sources, you'll need a CVS client installed.
-Note that sources from CVS are typically development quality, and may not be
-stable, or well tested. To download CVS source, check the Sourceforge
-documentation, which might give commands like:
+  cd <root-dir>
+  git clone https://www.privoxy.org/git/privoxy.git

 
 

-  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 <root-dir>/privoxy/, which will contain the
+source tree.

 
 

+Note that source code in Git is development quality, and may not be stable or
+well tested.

 
 

-This will create a directory named current/, which will contain the source
-tree.
-
-You can also check out any Privoxy "branch", just exchange the current name
-with the wanted branch name (Example: v_3_0_branch for the 3.0 cvs tree).
-
-It is also strongly recommended to not run Privoxy as root. You should
-configure/install/run Privoxy as an unprivileged user, preferably by creating a
-"privoxy" user and group just for this purpose. See your local documentation
-for the correct command line to do add new users and groups (something like
-adduser, but the command syntax may vary from platform to platform).
+It is strongly recommended to not run Privoxy as root. You should configure/
+install/run Privoxy as an unprivileged user, preferably by creating a "privoxy"
+user and group just for this purpose. See your local documentation for the
+correct command line to do add new users and groups (something like adduser,
+but the command syntax may vary from platform to platform).

 
 /etc/passwd might then look like:
 
   privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell
 
 
 /etc/passwd might then look like:
 
   privoxy:*:7777:7777:privoxy proxy:/no/home:/no/shell
 

-

 And then /etc/group, like:
 
   privoxy:*:7777:
 
 And then /etc/group, like:
 
   privoxy:*:7777:
 

-

 Some binary packages may do this for you.
 
 Some binary packages may do this for you.
 

-Then, to build from either unpacked tarball or CVS source:
+Then, to build from either unpacked tarball or Git checkout:

 
  autoheader
  autoconf
 
  autoheader
  autoconf


@@ -88,13 +79,11 @@ Then, to build from either unpacked tarball or CVS source:
  make -n install  # (to see where all the files will go)
  make -s install  # (to really install, -s to silence output)
 
  make -n install  # (to see where all the files will go)
  make -s install  # (to really install, -s to silence output)
 

-

 Using GNU make, you can have the first four steps automatically done for you by
 just typing:
 
   make
 
 Using 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.
 
 To build an executable with security enhanced features so that users cannot
 in the freshly downloaded or unpacked source directory.
 
 To build an executable with security enhanced features so that users cannot


@@ -103,9 +92,8 @@ configurations, configure like this:
 
  ./configure  --disable-toggle  --disable-editor  --disable-force
 
 
  ./configure  --disable-toggle  --disable-editor  --disable-force
 

-
-Then build as above. In Privoxy 3.0.7 and later, all of these options can also
-be disabled through the configuration file.
+Note that all of these options can also be disabled through the configuration
+file.

 
 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
 
 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


@@ -124,7 +112,6 @@ sure both already exist:
 
  make -s install  USER=privoxy GROUP=privoxy
 
 
  make -s install  USER=privoxy GROUP=privoxy
 

-

 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 an install to anywhere besides /usr/local, be sure to set the appropriate
 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 an install to anywhere besides /usr/local, be sure to set the appropriate