[ripd] bug #278: remove gratuitous use of mid-function declaration
[jleu-quagga.git] / INSTALL.quagga.txt
blobb1bab82fbc86100680d8f242f108221204ed85d0
1 # $Id: INSTALL.quagga.txt,v 1.11 2005/08/10 15:07:02 gdt Exp $
3 --------------------------------------------------------------------------
4 Building and Installing Quagga from releases or snapshots:
6 The 'INSTALL' file contains generic instructions on how to use 'configure'
7 scripts.
9 Quagga requires a C compiler supporting the C99 standard.
11 Quagga requires a reasonable make.  It is considered a bug if quagga
12 does not compile with the system make on recent FreeBSD, NetBSD or
13 OpenBSD, and a very serious bug if it does not compile with GNU make.
15 Quagga expects a POSIX.2 compliant system, more or less.  Clean
16 workarounds for POSIX non-compliance are welcome.
18 It is considered a bug if Quagga fails to build and run on any of the
19 following systems (where .x indicates the most recent release), or
20 such systems "-current" versions.  (Note that considering it a bug is
21 not a guarantee of support, merely "we agree that it is broken".)
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
33 For further Quagga specific information on 'configure' and build-time
34 configuration of the software, please read the Quagga info
35 documentation, (doc/quagga.info).  To read the info page included with
36 the Quagga sources without first installing Quagga:
38   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")'
44 The Quagga website (http://www.quagga.net) currently has the info
45 files available in various formats.
47 --------------------------------------------------------------------------
48 Building Quagga from CVS checkouts:
50 In order to build from CVS, you will need recent versions of several GNU
51 tools, particularly autoconf, automake, libtool, GNU awk and texinfo.  Note
52 that the CVS snapshots on the Quagga website should not require these tools;
53 everything is already setup ready to run 'configure'.  If you have trouble
54 building from CVS checkout it is recommended that you try a CVS snapshot
55 instead.
57 If you are building from plain CVS checkouts, the versions which
58 should work at least with:
60         automake:       1.8.5
61         autoconf:       2.59
62         libtool:        1.5.6
63         texinfo:        4.7
64         GNU AWK:        3.1 [XXX is GNU version really needed?  BSD?]
65         texinfo         4.7
67 Becuase some systems provide texinfo 4.6 (4.7 is new), quagga.info is
68 checked in so that texinfo will generally not be invoked.  When
69 texinfo 4.7 is widespread, quagga.info will be removed from CVS and
70 texinfo will become required again.  (4.7 has figure support, needed
71 for the route server docs, which is why 4.6 doesn't work.)
73 In order to create PostScript or PDF versions of the Texinfo documentation,
74 you will need the convert utility, from the ImageMagick toolset installed,
75 and epstopdf from the TeTeX suite.
77 To create the required autotools files (Makefile.in, configure, etc.),
78 run either the 'update-autotools' script provided, or else the
79 'autoreconf -i' command supplied with your autoconf package.  After this
80 you may run configure.
82 Please refer to "Building and Installing Quagga" above for further
83 instructions.
85 --------------------------------------------------------------------------
86 Notes on required versions:
88 The general goal is to use a modern baseline of tools, while not
89 imposing pain on those tracking stable distributions.  The notes below
90 explain what versions are present in various environments.
92 NetBSD 1.6.2 and 2.0 provide texinfo 4.6.
93 NetBSD 2.99.15 provides texinfo 4.7 (so NetBSD 3 will as well).
94 NetBSD pkgsrc provides automake 1.9.1 autoconf 2.59 libtool 1.5.6
95 NetBSD pgksrc provides texinfo 4.7 (devel/gtexinfo)
97 OpenBSD 3.6 provides texinfo 4.2.
98 OpenBSD [3.6] ports provides automake 1.4-p6 autoconf 2.5.9 libtool 1.5.8
100 --------------------------------------------------------------------------