Reorganizing the repository: swapping out what was HEAD (the old 3.1 branch)
[privoxy.git] / doc / source / buildsource.sgml
index bc439ba..963760a 100644 (file)
@@ -3,43 +3,52 @@
 
  Purpose     :  Entity included in other project documents.
                 
- $Id: buildsource.sgml,v 1.0 2002/04/04 01:14:18 hal9 Exp $
-
- Written by and Copyright (C) 2001 the SourceForge
- Privoxy team. http://www.privoxy.org/
-
- Based on the Internet Junkbuster originally written
- by and Copyright (C) 1997 Anonymous Coders and 
- Junkbusters Corporation.  http://www.junkbusters.com
+ $Id: buildsource.sgml,v 1.9.2.3 2003/11/06 13:36:37 oes Exp $
 
+ Copyright (C) 2001, 2002 Privoxy Developers <developers@privoxy.org>
+ See LICENSE.
 
  ======================================================================
   This file used for inclusion with other documents only.
  ======================================================================
 
+ If you make changes to this file, please verify the finished 
+ docs all display as intended.
+
+ This file is included into:
+
+  user-manual
+  README
+
 -->
+
 <para>
- There are several ways to install <application>Privoxy</application>.
+ To build <application>Privoxy</application> from source, 
+ <ulink url="http://www.gnu.org/software/autoconf/autoconf.html">autoconf</ulink>,
+ <ulink
+ url="http://www.gnu.org/software/make/make.html">GNU make
+ (gmake)</ulink>, and, of course, a C compiler like <ulink
+ url="http://www.gnu.org/software/gcc/gcc.html">gcc</ulink> are required.
 </para>
 
 <para>
- To build <application>Privoxy</application> from source, 
- autoconf and GNU make (gmake) are required. Source is available as gzipped
- tar archives. For this, first unpack the source: 
+ When building from a source tarball (either release version or
+ <ulink
+ url="http://cvs.sourceforge.net/cvstarballs/ijbswa-cvsroot.tar.bz2">nightly CVS
+ tarball</ulink>), first unpack the source: 
 </para>
 
 <para>
  <screen>
  tar xzvf privoxy-&p-version;<![%p-not-stable;[-beta]]>-src* [.tgz or .tar.gz]
  cd privoxy-&p-version;<![%p-not-stable;[-beta]]>
- </screen>
+</screen>
 </para>
 
-
 <para>
- For retrieving the current CVS sources, you'll need the CVS 
- package installed first. Note CVS source is development quality, 
and may not be stable, or well tested. To download CVS source:
+ For retrieving the current CVS sources, you'll need CVS installed.
+ Note that sources from CVS are development quality, and may not be
+ stable, or well tested. To download CVS source:
 </para>
 
 <para>
@@ -47,7 +56,7 @@
   cvs -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa login
   cvs -z3 -d:pserver:anonymous@cvs.ijbswa.sourceforge.net:/cvsroot/ijbswa co current
   cd current
- </screen>
+</screen>
 </para>
 
 <para>
  <screen>
  autoheader
  autoconf
- ./configure      (--help to see options)
- make             (the make from gnu, gmake for *BSD) 
+ ./configure      (--help to see options)
+ make             (the make from gnu, gmake for *BSD) 
  su 
- make -n install  (to see where all the files will go)
- make install     (to really install)
- </screen>
+ make -n install  # (to see where all the files will go)
+ make install     # (to really install)
+</screen>
+</para>
+
+<para>
+  If you have gnu make, you can have the first four steps 
+  automatically done for you by just typing:
+</para>
+
+<para>
+ <screen>
+  make
+</screen>
+</para>
+
+<para>
+  in the freshly downloaded or unpacked source directory.
 </para>
 
 <para>
- Redhat and SuSE src and binary RPMs can be built with 
- <quote><command>make redhat-dist</command></quote> or
- <quote><command>make suse-dist</command></quote> from unpacked sources. You
- will need to run <quote><command>autoconf; autoheader;
- ./configure</command></quote> beforehand. *BSD will require gmake (from
- <ulink url="http://gnu.org">http://gnu.org</ulink>). 
- <![%p-readme;[See the user-manual for OS/2 build instructions.]]>
+ For more detailed instructions on how to build Redhat and SuSE RPMs,
+ Windows self-extracting installers, building on platforms with
+ special requirements etc, please consult the <ulink
+ url="../developer-manual/newrelease.html">developer manual</ulink>.
 </para>
 
+<!-- print for README only -->
  <![%p-readme;[
  <para>
   For binary RPM installation, and other platforms, see the user-manual