BOOK/chapter06/bison.xml

   1 <?xml version="1.0" encoding="ISO-8859-1"?>
   2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   3   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
   4   <!ENTITY % general-entities SYSTEM "../general.ent">
   5   %general-entities;
   6 ]>
   7
   8 <sect1 id="ch-system-bison" role="wrap">
   9   <?dbhtml filename="bison.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>bison</productname>
  13     <productnumber>&bison-version;</productnumber>
  14     <address>&bison-url;</address>
  15   </sect1info>
  16
  17   <title>Bison-&bison-version;</title>
  18
  19   <indexterm zone="ch-system-bison">
  20     <primary sortas="a-Bison">Bison</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Bison package contains a parser generator.</para>
  27
  28     <segmentedlist>
  29       <segtitle>&buildtime;</segtitle>
  30       <segtitle>&diskspace;</segtitle>
  31
  32       <seglistitem>
  33         <seg>&bison-ch6-sbu;</seg>
  34         <seg>&bison-ch6-du;</seg>
  35       </seglistitem>
  36     </segmentedlist>
  37
  38   </sect2>
  39
  40   <sect2 role="installation">
  41     <title>Installation of Bison</title>
  42
  43     <para>First, fix a build problem with the current version:</para>
  44
  45 <screen><userinput remap="pre">sed -i '9327 s/mv/cp/' Makefile.in</userinput></screen>
  46
  47     <para>Prepare Bison for compilation:</para>
  48
  49 <screen><userinput remap="configure">./configure --prefix=/usr --docdir=/usr/share/doc/bison-&bison-version;</userinput></screen>
  50
  51     <para>Compile the package, but work around a race condition in the
  52     current version:</para>
  53
  54 <screen><userinput remap="make">make -j1</userinput></screen>
  55
  56 <!--
  57     <para>To test the results (about 2.2 SBU), issue:</para>
  58
  59 <screen><userinput remap="test">make check</userinput></screen>
  60 -->
  61
  62     <para>There is a circular dependency between bison and flex with regard to
  63     the checks.  If desired, after installing flex in the next section, the
  64     bison package can be rebuilt and the bison checks can be run with
  65     <command>make check</command>.</para>
  66
  67     <para>Install the package:</para>
  68
  69 <screen><userinput remap="install">make install</userinput></screen>
  70
  71   </sect2>
  72
  73   <sect2 id="contents-bison" role="content">
  74     <title>Contents of Bison</title>
  75
  76     <segmentedlist>
  77       <segtitle>Installed programs</segtitle>
  78       <segtitle>Installed library</segtitle>
  79       <segtitle>Installed directory</segtitle>
  80
  81       <seglistitem>
  82         <seg>bison and yacc</seg>
  83         <seg>liby.a</seg>
  84         <seg>/usr/share/bison</seg>
  85       </seglistitem>
  86     </segmentedlist>
  87
  88     <variablelist>
  89       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  90       <?dbfo list-presentation="list"?>
  91       <?dbhtml list-presentation="table"?>
  92
  93       <varlistentry id="bison">
  94         <term><command>bison</command></term>
  95         <listitem>
  96           <para>Generates, from a series of rules, a program for analyzing the
  97           structure of text files; Bison is a replacement for Yacc (Yet Another
  98           Compiler Compiler)</para>
  99           <indexterm zone="ch-system-bison bison">
 100             <primary sortas="b-bison">bison</primary>
 101           </indexterm>
 102         </listitem>
 103       </varlistentry>
 104
 105       <varlistentry id="yacc">
 106         <term><command>yacc</command></term>
 107         <listitem>
 108           <para>A wrapper for <command>bison</command>, meant for programs that
 109           still call <command>yacc</command> instead of <command>bison</command>;
 110           it calls <command>bison</command> with the <parameter>-y</parameter>
 111           option</para>
 112           <indexterm zone="ch-system-bison yacc">
 113             <primary sortas="b-yacc">yacc</primary>
 114           </indexterm>
 115         </listitem>
 116       </varlistentry>
 117
 118       <varlistentry id="liby">
 119         <term><filename class="libraryfile">liby</filename></term>
 120         <listitem>
 121           <para>The Yacc library containing implementations of Yacc-compatible
 122           <function>yyerror</function> and <function>main</function> functions;
 123           this library is normally not very useful, but POSIX requires it</para>
 124           <indexterm zone="ch-system-bison liby">
 125             <primary sortas="c-liby">liby</primary>
 126           </indexterm>
 127         </listitem>
 128       </varlistentry>
 129
 130     </variablelist>
 131
 132   </sect2>
 133
 134 </sect1>