bookmarks cleaned, changed structure of user manual, screen and programlisting cleanu...
[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.6 2002/04/26 05:25:23 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, <ulink
33  url="http://www.gnu.org/software/make/make.html">GNU make
34  (gmake)</ulink>, and, of course, a C compiler are required.
35 </para>
36
37 <para>
38  When building from a source tarball (either release version or
39  nightly CVS tarball), first unpack the source: 
40 </para>
41
42 <para>
43  <screen>
44  tar xzvf privoxy-&p-version;<![%p-not-stable;[-beta]]>-src* [.tgz or .tar.gz]
45  cd privoxy-&p-version;<![%p-not-stable;[-beta]]>
46 </screen>
47 </para>
48
49 <para>
50  For retrieving the current CVS sources, you'll need CVS installed.
51  Note that sources from CVS are development quality, and may not be
52  stable, or well tested. To download CVS source:
53 </para>
54
55 <para>
56  <screen>
57   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
58   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
59   cd current
60 </screen>
61 </para>
62
63 <para>
64  This will create a directory named <filename>current/</filename>, which will 
65  contain the source tree.
66 </para>
67
68 <para>
69  Then, in either case, to build from unpacked tarball or CVS source:
70 </para>
71
72 <para>
73  <screen>
74  autoheader
75  autoconf
76  ./configure      # (--help to see options)
77  make             # (the make from gnu, gmake for *BSD) 
78  su 
79  make -n install  # (to see where all the files will go)
80  make install     # (to really install)
81 </screen>
82 </para>
83
84 <para>
85   If you have gnu make, you can have the first four steps 
86   automatically done for you by just typing:
87 </para>
88
89 <para>
90  <screen>
91   make
92 </screen>
93 </para>
94
95 <para>
96   in the freshly downloaded or unpacked source directory.
97 </para>
98
99 <para>
100  For more detailed instructions on how to build Redhat and SuSE RPMs,
101  Windows self-extracting installers, building on platforms with
102  special requirements etc, please consult the <ulink
103  url="../developer-manual/newrelease.html">developer manual</ulink>.
104 </para>
105
106 <!-- print for README only -->
107  <![%p-readme;[
108  <para>
109   For binary RPM installation, and other platforms, see the user-manual 
110   as well.
111  </para>
112 ]]>