blob: a3f3ce121439c08962ebca60598f657a885091de [file] [log] [blame]
paul3849db22005-04-02 17:13:33 +00001# $Id: INSTALL.quagga.txt,v 1.9 2005/04/02 17:13:33 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
gdt8686fc72004-11-23 17:19:21 +00009Quagga requires a C compiler supporting the C99 standard.
10
gdt3764c0c2004-11-15 17:26:47 +000011Quagga can be compiled with either BSD make or GNU make.
12GNU make 3.80 is known to work.
13The following system makes are known to work
14 NetBSD 1.6.2
15 NetBSD 2.0
16
paul9104f562004-11-12 10:30:21 +000017For further Quagga specific information on 'configure' and build-time
18configuration of the software, please read the Quagga info documentation,
19(doc/quagga.info). To read the info page included with the Quagga sources
20without first installing Quagga:
21
22 cd doc/
23 pinfo -r quagga.info
24
25Assuming you have the user-friendly 'pinfo' info browser installed.
26
27You can also the standard GNU 'info' browser, if you prefer this browser you
28have no doubt already spent a lot of time reading its documentation and dont
29need to be told how to specify an info file by filename. ;)
30
31The Quagga website should also have recent versions of documentation
32available online.
33
34--------------------------------------------------------------------------
35Building Quagga from CVS checkouts:
36
37In order to build from CVS, you will need recent versions of several GNU
gdt3764c0c2004-11-15 17:26:47 +000038tools, particularly autoconf, automake, libtool and texinfo. Note that the
gdt8bed7802004-11-15 15:34:50 +000039CVS snapshots on the Quagga website do not require these tools; everything
gdt3764c0c2004-11-15 17:26:47 +000040is already setup ready to run 'configure'. If you have trouble building
paul9104f562004-11-12 10:30:21 +000041from CVS checkout it is recommended that you try a CVS snapshot instead.
42
gdt3764c0c2004-11-15 17:26:47 +000043If you are building from plain CVS checkouts, the versions which
44should work at least with:
paul9104f562004-11-12 10:30:21 +000045
46 automake: 1.8.5
47 autoconf: 2.59
48 libtool: 1.5.6
gdt3764c0c2004-11-15 17:26:47 +000049 texinfo: 4.7
paul9104f562004-11-12 10:30:21 +000050
gdt38c2cfe2004-11-22 20:14:33 +000051Texinfo is not actually required since quagga.info is checked in.
52When texinfo 4.7 is widespread, it will be removed and texinfo will
53become required again. (4.7 has figure support, needed for the route
54server docs, which is why 4.6 doesn't work.)
55
paul3849db22005-04-02 17:13:33 +000056In order to create PostScript or PDF versions of the Texinfo documentation,
57you will need the convert utility, from the ImageMagick toolset installed,
58and epstopdf from the TeTeX suite.
59
gdt3764c0c2004-11-15 17:26:47 +000060To create the required autotools files (Makefile.in, configure, etc.),
61run either the 'update-autotools' script provided, or else the
ajscbf566e2004-11-15 19:43:16 +000062'autoreconf -i' command supplied with your autoconf package. After this
gdt3764c0c2004-11-15 17:26:47 +000063you may run configure. GNU texinfo is required in order to build
64doc/quagga.info, which is not supplied in CVS, but is supplied in the
65CVS snapshots on the Quagga website. quagga.info is created via
66makeinfo during the build.
paul9104f562004-11-12 10:30:21 +000067
68Please refer to "Building and Installing Quagga" above for further
69instructions.
gdt8bed7802004-11-15 15:34:50 +000070
71--------------------------------------------------------------------------
72Notes on required versions:
73
74The general goal is to use a modern baseline of tools, while not
75imposing pain on those tracking stable distributions. The notes below
76explain what versions are present in various environments.
77
gdt8bed7802004-11-15 15:34:50 +000078NetBSD 1.6.2 and 2.0 provide texinfo 4.6.
gdt38c2cfe2004-11-22 20:14:33 +000079NetBSD pkgsrc provides automake 1.9.1 autoconf 2.59 libtool 1.5.6
80NetBSD pgksrc provides texinfo 4.7 (devel/gtexinfo)
81
gdt9c3f5e62004-11-23 12:21:16 +000082OpenBSD 3.6 provides texinfo 4.2.
83OpenBSD [3.6] ports provides automake 1.4-p6 autoconf 2.5.9 libtool 1.5.8
gdt38c2cfe2004-11-22 20:14:33 +000084
paul9104f562004-11-12 10:30:21 +000085--------------------------------------------------------------------------