bc439bacf7a6b37d4e4c765d1c0fc93b02e88ab6
[privoxy.git] / doc / source / buildsource.sgml
1 <!--
2  File        :  $Source: /cvsroot/ijbswa/current/doc/source/buildsource.sgml,v $
3
4  Purpose     :  Entity included in other project documents.
5                 
6  $Id: buildsource.sgml,v 1.0 2002/04/04 01:14:18 hal9 Exp $
7
8  Written by and Copyright (C) 2001 the SourceForge
9  Privoxy team. http://www.privoxy.org/
10
11  Based on the Internet Junkbuster originally written
12  by and Copyright (C) 1997 Anonymous Coders and 
13  Junkbusters Corporation.  http://www.junkbusters.com
14
15
16  ======================================================================
17   This file used for inclusion with other documents only.
18  ======================================================================
19
20 -->
21 <para>
22  There are several ways to install <application>Privoxy</application>.
23 </para>
24
25 <para>
26  To build <application>Privoxy</application> from source, 
27  autoconf and GNU make (gmake) are required. Source is available as gzipped
28  tar archives. For this, first unpack the source: 
29 </para>
30
31 <para>
32  <screen>
33  tar xzvf privoxy-&p-version;<![%p-not-stable;[-beta]]>-src* [.tgz or .tar.gz]
34  cd privoxy-&p-version;<![%p-not-stable;[-beta]]>
35  </screen>
36 </para>
37
38
39 <para>
40  For retrieving the current CVS sources, you'll need the CVS 
41  package installed first. Note CVS source is development quality, 
42  and may not be stable, or well tested. To download CVS source:
43 </para>
44
45 <para>
46  <screen>
47   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
48   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
49   cd current
50  </screen>
51 </para>
52
53 <para>
54  This will create a directory named <filename>current/</filename>, which will 
55  contain the source tree.
56 </para>
57
58 <para>
59  Then, in either case, to build from unpacked tarball or CVS source:
60 </para>
61
62 <para>
63  <screen>
64  autoheader
65  autoconf
66  ./configure      (--help to see options)
67  make             (the make from gnu, gmake for *BSD) 
68  su 
69  make -n install  (to see where all the files will go)
70  make install     (to really install)
71  </screen>
72 </para>
73
74 <para>
75  Redhat and SuSE src and binary RPMs can be built with 
76  <quote><command>make redhat-dist</command></quote> or
77  <quote><command>make suse-dist</command></quote> from unpacked sources. You
78  will need to run <quote><command>autoconf; autoheader;
79  ./configure</command></quote> beforehand. *BSD will require gmake (from
80  <ulink url="http://gnu.org">http://gnu.org</ulink>). 
81  <![%p-readme;[See the user-manual for OS/2 build instructions.]]>
82 </para>
83
84  <![%p-readme;[
85  <para>
86   For binary RPM installation, and other platforms, see the user-manual 
87   as well.
88  </para>
89 ]]>