Detail fixes
[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.2 2002/04/06 05:07:28 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  If you make changes to this file, please verify the finished 
21  docs all display as intended.
22
23  This file is included into:
24
25   user-manual
26   README
27
28 -->
29
30 <para>
31  To build <application>Privoxy</application> from source, 
32  autoheader, autoconf,GNU make (gmake), and, of course, a C 
33  compiler are required.
34 </para>
35
36 <para>
37  When building from a source tarball (either release version or
38  nightly CVS tarball), first unpack the source: 
39 </para>
40
41 <para>
42  <screen>
43  tar xzvf privoxy-&p-version;<![%p-not-stable;[-beta]]>-src* [.tgz or .tar.gz]
44  cd privoxy-&p-version;<![%p-not-stable;[-beta]]>
45  </screen>
46 </para>
47
48 <para>
49  For retrieving the current CVS sources, you'll need CVS installed.
50  Note that sources from CVS are development quality, and may not be
51  stable, or well tested. To download CVS source:
52 </para>
53
54 <para>
55  <screen>
56   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
57   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
58   cd current
59  </screen>
60 </para>
61
62 <para>
63  This will create a directory named <filename>current/</filename>, which will 
64  contain the source tree.
65 </para>
66
67 <para>
68  Then, in either case, to build from unpacked tarball or CVS source:
69 </para>
70
71 <para>
72  <screen>
73  autoheader
74  autoconf
75  ./configure      # (--help to see options)
76  make             # (the make from gnu, gmake for *BSD) 
77  su 
78  make -n install  # (to see where all the files will go)
79  make install     # (to really install)
80  </screen>
81 </para>
82
83 <para>
84   If you have gnu make, you can have the first four steps 
85   automatically done for you by just typing
86 </para>
87
88 <para>
89  <screen>
90   make
91  </screen>
92 </para>
93
94 <para>
95   in the freshly downloaded or unpacked source directory.
96 </para>
97
98 <para>
99  Redhat and SuSE src and binary RPMs can be built with 
100  <quote><command>make redhat-dist</command></quote> or
101  <quote><command>make suse-dist</command></quote> from unpacked sources. You
102  will need to run <quote><command>autoconf; autoheader;
103  ./configure</command></quote> beforehand. *BSD will require gmake (from
104  <ulink url="http://www.gnu.org">http://www.gnu.org</ulink>). 
105  <![%p-readme;[See the user-manual for OS/2 build instructions.]]>
106 </para>
107
108  <![%p-readme;[
109  <para>
110   For binary RPM installation, and other platforms, see the user-manual 
111   as well.
112  </para>
113 ]]>