blob: c50f0c422571b638f5d5a27806d673297444bd8e [file] [log] [blame]
paul7cad4002005-06-28 00:19:48 +00001# $Id: INSTALL.quagga.txt,v 1.10 2005/06/28 00:19:48 paul Exp $
gdt8bed7802004-11-15 15:34:50 +00002
paul9104f562004-11-12 10:30:21 +00003--------------------------------------------------------------------------
gdt3764c0c2004-11-15 17:26:47 +00004Building and Installing Quagga from releases or snapshots:
paul9104f562004-11-12 10:30:21 +00005
6The 'INSTALL' file contains generic instructions on how to use 'configure'
7scripts.
8
paul7cad4002005-06-28 00:19:48 +00009Quagga requires a C compiler supporting the C99 standard and GNU make.
gdt3764c0c2004-11-15 17:26:47 +000010
paul9104f562004-11-12 10:30:21 +000011For further Quagga specific information on 'configure' and build-time
12configuration of the software, please read the Quagga info documentation,
13(doc/quagga.info). To read the info page included with the Quagga sources
14without first installing Quagga:
15
16 cd doc/
17 pinfo -r quagga.info
18
19Assuming you have the user-friendly 'pinfo' info browser installed.
20
21You can also the standard GNU 'info' browser, if you prefer this browser you
22have no doubt already spent a lot of time reading its documentation and dont
23need to be told how to specify an info file by filename. ;)
24
25The Quagga website should also have recent versions of documentation
26available online.
27
28--------------------------------------------------------------------------
29Building Quagga from CVS checkouts:
30
31In order to build from CVS, you will need recent versions of several GNU
paul7cad4002005-06-28 00:19:48 +000032tools, particularly autoconf, automake, libtool, GNU awk and texinfo. Note
33that the CVS snapshots on the Quagga website should not require these tools;
34everything is already setup ready to run 'configure'. If you have trouble
35building from CVS checkout it is recommended that you try a CVS snapshot
36instead.
paul9104f562004-11-12 10:30:21 +000037
gdt3764c0c2004-11-15 17:26:47 +000038If you are building from plain CVS checkouts, the versions which
39should work at least with:
paul9104f562004-11-12 10:30:21 +000040
41 automake: 1.8.5
42 autoconf: 2.59
43 libtool: 1.5.6
gdt3764c0c2004-11-15 17:26:47 +000044 texinfo: 4.7
paul7cad4002005-06-28 00:19:48 +000045 GNU AWK: 3.1
paul9104f562004-11-12 10:30:21 +000046
gdt38c2cfe2004-11-22 20:14:33 +000047Texinfo is not actually required since quagga.info is checked in.
48When texinfo 4.7 is widespread, it will be removed and texinfo will
49become required again. (4.7 has figure support, needed for the route
50server docs, which is why 4.6 doesn't work.)
51
paul3849db22005-04-02 17:13:33 +000052In order to create PostScript or PDF versions of the Texinfo documentation,
53you will need the convert utility, from the ImageMagick toolset installed,
54and epstopdf from the TeTeX suite.
55
gdt3764c0c2004-11-15 17:26:47 +000056To create the required autotools files (Makefile.in, configure, etc.),
57run either the 'update-autotools' script provided, or else the
ajscbf566e2004-11-15 19:43:16 +000058'autoreconf -i' command supplied with your autoconf package. After this
gdt3764c0c2004-11-15 17:26:47 +000059you may run configure. GNU texinfo is required in order to build
60doc/quagga.info, which is not supplied in CVS, but is supplied in the
61CVS snapshots on the Quagga website. quagga.info is created via
62makeinfo during the build.
paul9104f562004-11-12 10:30:21 +000063
64Please refer to "Building and Installing Quagga" above for further
65instructions.
gdt8bed7802004-11-15 15:34:50 +000066
67--------------------------------------------------------------------------
68Notes on required versions:
69
70The general goal is to use a modern baseline of tools, while not
71imposing pain on those tracking stable distributions. The notes below
72explain what versions are present in various environments.
73
gdt8bed7802004-11-15 15:34:50 +000074NetBSD 1.6.2 and 2.0 provide texinfo 4.6.
gdt38c2cfe2004-11-22 20:14:33 +000075NetBSD pkgsrc provides automake 1.9.1 autoconf 2.59 libtool 1.5.6
76NetBSD pgksrc provides texinfo 4.7 (devel/gtexinfo)
77
gdt9c3f5e62004-11-23 12:21:16 +000078OpenBSD 3.6 provides texinfo 4.2.
79OpenBSD [3.6] ports provides automake 1.4-p6 autoconf 2.5.9 libtool 1.5.8
gdt38c2cfe2004-11-22 20:14:33 +000080
paul9104f562004-11-12 10:30:21 +000081--------------------------------------------------------------------------