README

   1 This package contains the GNU Bison parser generator.
   2
   3 * Installation
   4 ** Build from git
   5 Here are basic installation instructions for a repository checkout:
   6
   7     $ git submodules update --init
   8     $ ./bootstrap
   9
  10 then proceed with the usual 'configure && make' steps.
  11
  12 README-hacking contains more information about building and modifying the
  13 software.
  14
  15 ** Build for tarball
  16 See the file INSTALL for generic compilation and installation instructions.
  17
  18 Bison requires GNU m4 1.4.6 or later.  See:
  19
  20       https://ftp.gnu.org/gnu/m4/m4-1.4.6.tar.gz
  21
  22 ** Relocatability
  23 If you pass '--enable-relocatable' to 'configure', Bison is relocatable.
  24
  25 A relocatable program can be moved or copied to a different location on the
  26 file system.  It can also be used through mount points for network sharing.
  27 It is possible to make symlinks to the installed and moved programs, and
  28 invoke them through the symlink.
  29
  30 See "Enabling Relocatability" in the documentation.
  31
  32 ** Internationalization
  33 Bison supports two catalogs: one for Bison itself (i.e., for the
  34 maintainer-side parser generation), and one for the generated parsers (i.e.,
  35 for the user-side parser execution).  The requirements between both differ:
  36 bison needs ngettext, the generated parsers do not.  To simplify the build
  37 system, neither are installed if ngettext is not supported, even if
  38 generated parsers could have been localized.  See
  39 http://lists.gnu.org/archive/html/bug-bison/2009-08/msg00006.html for more
  40 details.
  41
  42 * Questions
  43 See the section FAQ in the documentation (doc/bison.info) for frequently
  44 asked questions.  The documentation is also available in PDF and HTML,
  45 provided you have a recent version of Texinfo installed: run "make pdf" or
  46 "make html".
  47
  48 If you have questions about using Bison and the documentation does not
  49 answer them, please send mail to <help-bison@gnu.org>.
  50
  51 * Bug reports
  52 Please send bug reports to <bug-bison@gnu.org>.  Be sure to include the
  53 version number from 'bison --version', and a complete, self-contained test
  54 case in each bug report.
  55
  56 * Copyright statements
  57 For any copyright year range specified as YYYY-ZZZZ in this package, note
  58 that the range specifies every single year in that closed interval.
  59
  60 -----
  61
  62 Local Variables:
  63 mode: outline
  64 fill-column: 76
  65 ispell-dictionary: "american"
  66 End:
  67
  68 Copyright (C) 1992, 1998-1999, 2003-2005, 2008-2015, 2018-2019 Free
  69 Software Foundation, Inc.
  70
  71 This file is part of GNU bison, the GNU Compiler Compiler.
  72
  73 This program is free software: you can redistribute it and/or modify
  74 it under the terms of the GNU General Public License as published by
  75 the Free Software Foundation, either version 3 of the License, or
  76 (at your option) any later version.
  77
  78 This program is distributed in the hope that it will be useful,
  79 but WITHOUT ANY WARRANTY; without even the implied warranty of
  80 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  81 GNU General Public License for more details.
  82
  83 You should have received a copy of the GNU General Public License
  84 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  85
  86 # LocalWords:  parsers ngettext Texinfo pdf html YYYY ZZZZ ispell american
  87 # LocalWords:  MERCHANTABILITY