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.9 2002/05/10 01:48:19 hal9 Exp $
   7
   8  Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
   9  See LICENSE.
  10
  11  ======================================================================
  12   This file used for inclusion with other documents only.
  13  ======================================================================
  14
  15  If you make changes to this file, please verify the finished
  16  docs all display as intended.
  17
  18  This file is included into:
  19
  20   user-manual
  21   README
  22
  23 -->
  24
  25 <para>
  26  To build <application>Privoxy</application> from source,
  27  <ulink url="http://www.gnu.org/software/autoconf/autoconf.html">autoconf</ulink>,
  28  <ulink
  29  url="http://www.gnu.org/software/make/make.html">GNU make
  30  (gmake)</ulink>, and, of course, a C compiler like <ulink
  31  url="http://www.gnu.org/software/gcc/gcc.html">gcc</ulink> are required.
  32 </para>
  33
  34 <para>
  35  When building from a source tarball (either release version or
  36  <ulink
  37  url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz">nightly CVS
  38  tarball</ulink>), 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  For more detailed instructions on how to build Redhat and SuSE RPMs,
 100  Windows self-extracting installers, building on platforms with
 101  special requirements etc, please consult the <ulink
 102  url="../developer-manual/newrelease.html">developer manual</ulink>.
 103 </para>
 104
 105 <!-- print for README only -->
 106  <![%p-readme;[
 107  <para>
 108   For binary RPM installation, and other platforms, see the user-manual
 109   as well.
 110  </para>
 111 ]]>