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.2.1 2002/08/25 17:10:55 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   INSTALL
  23
  24 -->
  25
  26 <para>
  27  To build <application>Privoxy</application> from source,
  28  <ulink url="http://www.gnu.org/software/autoconf/autoconf.html">autoconf</ulink>,
  29  <ulink
  30  url="http://www.gnu.org/software/make/make.html">GNU make
  31  (gmake)</ulink>, and, of course, a C compiler like <ulink
  32  url="http://www.gnu.org/software/gcc/gcc.html">gcc</ulink> are required.
  33 </para>
  34
  35 <para>
  36  When building from a source tarball (either release version or
  37  <ulink
  38  url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.gz">nightly CVS
  39  tarball</ulink>), 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 <warning>
  85  <para>
  86   The <quote>make install</quote> target is temporary quite broken! It is
  87   recommended to use a binary package, or do a source build, and manually
  88   install the components. Sorry.
  89  </para>
  90 </warning>
  91
  92 <para>
  93   If you have gnu make, you can have the first four steps
  94   automatically done for you by just typing:
  95 </para>
  96
  97 <para>
  98  <screen>
  99   make
 100 </screen>
 101 </para>
 102
 103 <para>
 104   in the freshly downloaded or unpacked source directory.
 105 </para>
 106
 107 <para>
 108  For more detailed instructions on how to build Redhat and SuSE RPMs,
 109  Windows self-extracting installers, building on platforms with
 110  special requirements etc, please consult the <ulink
 111  url="../developer-manual/newrelease.html">developer manual</ulink>.
 112 </para>
 113
 114 <!-- print for README only -->
 115  <![%p-readme;[
 116  <para>
 117   For binary RPM installation, and other platforms, see the user-manual
 118   as well.
 119  </para>
 120 ]]>