blob: ec4e799d2af18f34148f71b8f4c056cef54c4dbe [file] [log] [blame]
paul9104f562004-11-12 10:30:21 +00001--------------------------------------------------------------------------
gdt3764c0c2004-11-15 17:26:47 +00002Building and Installing Quagga from releases or snapshots:
paul9104f562004-11-12 10:30:21 +00003
4The 'INSTALL' file contains generic instructions on how to use 'configure'
5scripts.
6
Greg Troxel301e4fb2006-09-20 14:46:07 +00007Quagga requires a C compiler (and associated header files and
8libraries) supporting the C99 standard.
gdte0170882005-08-10 15:07:02 +00009
10Quagga requires a reasonable make. It is considered a bug if quagga
11does not compile with the system make on recent FreeBSD, NetBSD or
12OpenBSD, and a very serious bug if it does not compile with GNU make.
13
14Quagga expects a POSIX.2 compliant system, more or less. Clean
15workarounds for POSIX non-compliance are welcome.
16
17It is considered a bug if Quagga fails to build and run on any of the
18following systems (where .x indicates the most recent release), or
19such systems "-current" versions. (Note that considering it a bug is
20not a guarantee of support, merely "we agree that it is broken".)
21
Greg Troxel301e4fb2006-09-20 14:46:07 +000022 Dragonfly ?
Greg Troxel9f0a19f2007-02-06 19:56:31 +000023 FreeBSD 4.x [In 2007, this is getting tenous.]
gdte0170882005-08-10 15:07:02 +000024 FreeBSD 5.x
Greg Troxel301e4fb2006-09-20 14:46:07 +000025 FreeBSD 6.x
26 FreeBSD-current
gdte0170882005-08-10 15:07:02 +000027 Linux [kernel/distribution information needed]
Greg Troxel9f0a19f2007-02-06 19:56:31 +000028 NetBSD 2.x [Note texinfo 4.6 in base system]
Greg Troxel301e4fb2006-09-20 14:46:07 +000029 NetBSD 3.x
30 NetBSD 4.x
31 NetBSD-current
gdte0170882005-08-10 15:07:02 +000032 OpenBSD ? [info needed on what should work]
33 Solaris 9
34 Solaris 10
35
gdt3764c0c2004-11-15 17:26:47 +000036
paul9104f562004-11-12 10:30:21 +000037For further Quagga specific information on 'configure' and build-time
gdte0170882005-08-10 15:07:02 +000038configuration of the software, please read the Quagga info
39documentation, (doc/quagga.info). To read the info page included with
40the Quagga sources without first installing Quagga:
paul9104f562004-11-12 10:30:21 +000041
gdte0170882005-08-10 15:07:02 +000042 cd doc
43 # one of the following, depending on your info viewer preferences
44 info quagga.info
45 pinfo -r quagga.info
46 emacs -eval '(info "quagga.info")'
paul9104f562004-11-12 10:30:21 +000047
gdte0170882005-08-10 15:07:02 +000048The Quagga website (http://www.quagga.net) currently has the info
49files available in various formats.
paul9104f562004-11-12 10:30:21 +000050
51--------------------------------------------------------------------------
52Building Quagga from CVS checkouts:
53
54In order to build from CVS, you will need recent versions of several GNU
paul7cad4002005-06-28 00:19:48 +000055tools, particularly autoconf, automake, libtool, GNU awk and texinfo. Note
56that the CVS snapshots on the Quagga website should not require these tools;
57everything is already setup ready to run 'configure'. If you have trouble
58building from CVS checkout it is recommended that you try a CVS snapshot
59instead.
paul9104f562004-11-12 10:30:21 +000060
Greg Troxel9f0a19f2007-02-06 19:56:31 +000061We declare that the following versions should work for building from
62CVS checkouts. Earlier versions may work, but failure to do so is not
63a bug. Required versions can be moved earlier if no problems, or
64later after a judgement that a system without a higher version is
65deficient is made.
paul9104f562004-11-12 10:30:21 +000066
Greg Troxel9f0a19f2007-02-06 19:56:31 +000067 automake: 1.9.6 (released 2005-07-10)
68 autoconf: 2.59 (2.60 on 2006-06-26 is too recent to require)
69 libtool: 1.5.22 (released 2005-12-18)
70 texinfo: 4.7 (released 2004-04-10; 4.8 is not yet common)
71 GNU AWK: 3.1.5 (released 2005-08-12)
paul9104f562004-11-12 10:30:21 +000072
gdte0170882005-08-10 15:07:02 +000073Becuase some systems provide texinfo 4.6 (4.7 is new), quagga.info is
74checked in so that texinfo will generally not be invoked. When
75texinfo 4.7 is widespread, quagga.info will be removed from CVS and
76texinfo will become required again. (4.7 has figure support, needed
77for the route server docs, which is why 4.6 doesn't work.)
gdt38c2cfe2004-11-22 20:14:33 +000078
paul3849db22005-04-02 17:13:33 +000079In order to create PostScript or PDF versions of the Texinfo documentation,
80you will need the convert utility, from the ImageMagick toolset installed,
81and epstopdf from the TeTeX suite.
82
gdt3764c0c2004-11-15 17:26:47 +000083To create the required autotools files (Makefile.in, configure, etc.),
Greg Troxel9f0a19f2007-02-06 19:56:31 +000084run "./bootstrap.sh". After this you may run configure as for a
85snapshot or release.
paul9104f562004-11-12 10:30:21 +000086
87Please refer to "Building and Installing Quagga" above for further
88instructions.
gdt8bed7802004-11-15 15:34:50 +000089
90--------------------------------------------------------------------------
91Notes on required versions:
92
93The general goal is to use a modern baseline of tools, while not
94imposing pain on those tracking stable distributions. The notes below
95explain what versions are present in various environments.
96
Greg Troxel9f0a19f2007-02-06 19:56:31 +000097NetBSD 1.6 and 2 provide texinfo 4.6. This is now considered old.
98NetBSD 3 and 4 provide texinfo 4.7.
99
100Fedora Core ? provides autoconf 2.59.
gdt38c2cfe2004-11-22 20:14:33 +0000101
gdt9c3f5e62004-11-23 12:21:16 +0000102OpenBSD 3.6 provides texinfo 4.2.
103OpenBSD [3.6] ports provides automake 1.4-p6 autoconf 2.5.9 libtool 1.5.8
gdt38c2cfe2004-11-22 20:14:33 +0000104
paul9104f562004-11-12 10:30:21 +0000105--------------------------------------------------------------------------