Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
[privoxy.git] / INSTALL
1 /*********************************************************************
2  *
3  * File        :  $Source: /cvsroot/ijbswa/current/INSTALL,v $
4  *
5  * Purpose     :  INSTALL file to help with installing from source.
6  *
7  * Copyright   :  Written by and Copyright (C) 2001,2002 the SourceForge
8  *                Privoxy team. http://www.privoxy.org/
9  *
10  *                Based on the Internet Junkbuster originally written
11  *                by and Copyright (C) 1997 Anonymous Coders and 
12  *                Junkbusters Corporation.  http://www.junkbusters.com
13  *
14  *                This program is free software; you can redistribute it 
15  *                and/or modify it under the terms of the GNU General
16  *                Public License as published by the Free Software
17  *                Foundation; either version 2 of the License, or (at
18  *                your option) any later version.
19  *
20  *                This program is distributed in the hope that it will
21  *                be useful, but WITHOUT ANY WARRANTY; without even the
22  *                implied warranty of MERCHANTABILITY or FITNESS FOR A
23  *                PARTICULAR PURPOSE.  See the GNU General Public
24  *                License for more details.
25  *
26  *                The GNU General Public License should be included with
27  *                this file.  If not, you can view it at
28  *                http://www.gnu.org/copyleft/gpl.html
29  *                or write to the Free Software Foundation, Inc., 59
30  *                Temple Place - Suite 330, Boston, MA  02111-1307, USA.
31  *
32  *********************************************************************/
33    
34
35 -------------------------------------------------------------------------------
36
37 To build Privoxy from source, autoconf, GNU make (gmake), and, of course, a C
38 compiler like gcc are required.
39
40 When building from a source tarball (either release version or nightly CVS
41 tarball), first unpack the source:
42
43  tar xzvf privoxy-3.0.3-src* [.tgz or .tar.gz]
44  cd privoxy-3.0.3
45
46
47 For retrieving the current CVS sources, you'll need CVS installed. Note that
48 sources from CVS are development quality, and may not be stable, or well
49 tested. To download CVS source:
50
51   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
52   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
53   cd current
54
55
56 This will create a directory named current/, which will contain the source
57 tree.
58
59 Then, in either case, to build from unpacked tarball or CVS source:
60
61  autoheader
62  autoconf
63  ./configure      # (--help to see options)
64  make             # (the make from gnu, gmake for *BSD)
65  su
66  make -n install  # (to see where all the files will go)
67  make install     # (to really install)
68
69
70 If you have gnu make, you can have the first four steps automatically done for
71 you by just typing:
72
73   make
74
75
76 in the freshly downloaded or unpacked source directory.
77
78 For more detailed instructions on how to build Redhat and SuSE RPMs, Windows
79 self-extracting installers, building on platforms with special requirements
80 etc, please consult the developer manual.
81
82 For binary RPM installation, and other platforms, see the user-manual as well.
83