blob: b1bab82fbc86100680d8f242f108221204ed85d0 [file] [log] [blame]
gdte0170882005-08-10 15:07:02 +00001# $Id: INSTALL.quagga.txt,v 1.11 2005/08/10 15:07:02 gdt 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
gdte0170882005-08-10 15:07:02 +00009Quagga requires a C compiler supporting the C99 standard.
10
11Quagga requires a reasonable make. It is considered a bug if quagga
12does not compile with the system make on recent FreeBSD, NetBSD or
13OpenBSD, and a very serious bug if it does not compile with GNU make.
14
15Quagga expects a POSIX.2 compliant system, more or less. Clean
16workarounds for POSIX non-compliance are welcome.
17
18It is considered a bug if Quagga fails to build and run on any of the
19following systems (where .x indicates the most recent release), or
20such systems "-current" versions. (Note that considering it a bug is
21not a guarantee of support, merely "we agree that it is broken".)
22
23 FreeBSD 4.x
24 FreeBSD 5.x
25 Linux [kernel/distribution information needed]
26 NetBSD 1.6.x
27 NetBSD 2.x
28 OpenBSD ? [info needed on what should work]
29 Solaris 9
30 Solaris 10
31
gdt3764c0c2004-11-15 17:26:47 +000032
paul9104f562004-11-12 10:30:21 +000033For further Quagga specific information on 'configure' and build-time
gdte0170882005-08-10 15:07:02 +000034configuration of the software, please read the Quagga info
35documentation, (doc/quagga.info). To read the info page included with
36the Quagga sources without first installing Quagga:
paul9104f562004-11-12 10:30:21 +000037
gdte0170882005-08-10 15:07:02 +000038 cd doc
39 # one of the following, depending on your info viewer preferences
40 info quagga.info
41 pinfo -r quagga.info
42 emacs -eval '(info "quagga.info")'
paul9104f562004-11-12 10:30:21 +000043
gdte0170882005-08-10 15:07:02 +000044The Quagga website (http://www.quagga.net) currently has the info
45files available in various formats.
paul9104f562004-11-12 10:30:21 +000046
47--------------------------------------------------------------------------
48Building Quagga from CVS checkouts:
49
50In order to build from CVS, you will need recent versions of several GNU
paul7cad4002005-06-28 00:19:48 +000051tools, particularly autoconf, automake, libtool, GNU awk and texinfo. Note
52that the CVS snapshots on the Quagga website should not require these tools;
53everything is already setup ready to run 'configure'. If you have trouble
54building from CVS checkout it is recommended that you try a CVS snapshot
55instead.
paul9104f562004-11-12 10:30:21 +000056
gdt3764c0c2004-11-15 17:26:47 +000057If you are building from plain CVS checkouts, the versions which
58should work at least with:
paul9104f562004-11-12 10:30:21 +000059
60 automake: 1.8.5
61 autoconf: 2.59
62 libtool: 1.5.6
gdt3764c0c2004-11-15 17:26:47 +000063 texinfo: 4.7
gdte0170882005-08-10 15:07:02 +000064 GNU AWK: 3.1 [XXX is GNU version really needed? BSD?]
65 texinfo 4.7
paul9104f562004-11-12 10:30:21 +000066
gdte0170882005-08-10 15:07:02 +000067Becuase some systems provide texinfo 4.6 (4.7 is new), quagga.info is
68checked in so that texinfo will generally not be invoked. When
69texinfo 4.7 is widespread, quagga.info will be removed from CVS and
70texinfo will become required again. (4.7 has figure support, needed
71for the route server docs, which is why 4.6 doesn't work.)
gdt38c2cfe2004-11-22 20:14:33 +000072
paul3849db22005-04-02 17:13:33 +000073In order to create PostScript or PDF versions of the Texinfo documentation,
74you will need the convert utility, from the ImageMagick toolset installed,
75and epstopdf from the TeTeX suite.
76
gdt3764c0c2004-11-15 17:26:47 +000077To create the required autotools files (Makefile.in, configure, etc.),
78run either the 'update-autotools' script provided, or else the
ajscbf566e2004-11-15 19:43:16 +000079'autoreconf -i' command supplied with your autoconf package. After this
gdte0170882005-08-10 15:07:02 +000080you may run configure.
paul9104f562004-11-12 10:30:21 +000081
82Please refer to "Building and Installing Quagga" above for further
83instructions.
gdt8bed7802004-11-15 15:34:50 +000084
85--------------------------------------------------------------------------
86Notes on required versions:
87
88The general goal is to use a modern baseline of tools, while not
89imposing pain on those tracking stable distributions. The notes below
90explain what versions are present in various environments.
91
gdt8bed7802004-11-15 15:34:50 +000092NetBSD 1.6.2 and 2.0 provide texinfo 4.6.
gdte0170882005-08-10 15:07:02 +000093NetBSD 2.99.15 provides texinfo 4.7 (so NetBSD 3 will as well).
gdt38c2cfe2004-11-22 20:14:33 +000094NetBSD pkgsrc provides automake 1.9.1 autoconf 2.59 libtool 1.5.6
95NetBSD pgksrc provides texinfo 4.7 (devel/gtexinfo)
96
gdt9c3f5e62004-11-23 12:21:16 +000097OpenBSD 3.6 provides texinfo 4.2.
98OpenBSD [3.6] ports provides automake 1.4-p6 autoconf 2.5.9 libtool 1.5.8
gdt38c2cfe2004-11-22 20:14:33 +000099
paul9104f562004-11-12 10:30:21 +0000100--------------------------------------------------------------------------