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