INSTALL.quagga.txt

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