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>Prepare Bison for compilation:</para>
  44
  45 <screen><userinput remap="configure">./configure --prefix=/usr --docdir=/usr/share/doc/bison-&bison-version;</userinput></screen>
  46
  47     <para>Compile the package:</para>
  48
  49 <screen><userinput remap="make">make</userinput></screen>
  50
  51 <!--
  52     <para>To test the results (about 2.2 SBU), issue:</para>
  53
  54 <screen><userinput remap="test">make check</userinput></screen>
  55 -->
  56
  57     <para>There is a circular dependency between bison and flex with regard to
  58     the checks.  If desired, after installing flex in the next section, the
  59     bison package can be rebuilt and the bison checks can be run with
  60     <command>make check</command>.</para>
  61
  62     <para>Install the package:</para>
  63
  64 <screen><userinput remap="install">make install</userinput></screen>
  65
  66   </sect2>
  67
  68   <sect2 id="contents-bison" role="content">
  69     <title>Contents of Bison</title>
  70
  71     <segmentedlist>
  72       <segtitle>Installed programs</segtitle>
  73       <segtitle>Installed library</segtitle>
  74       <segtitle>Installed directory</segtitle>
  75
  76       <seglistitem>
  77         <seg>bison and yacc</seg>
  78         <seg>liby.a</seg>
  79         <seg>/usr/share/bison</seg>
  80       </seglistitem>
  81     </segmentedlist>
  82
  83     <variablelist>
  84       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  85       <?dbfo list-presentation="list"?>
  86       <?dbhtml list-presentation="table"?>
  87
  88       <varlistentry id="bison">
  89         <term><command>bison</command></term>
  90         <listitem>
  91           <para>Generates, from a series of rules, a program for analyzing the
  92           structure of text files; Bison is a replacement for Yacc (Yet Another
  93           Compiler Compiler)</para>
  94           <indexterm zone="ch-system-bison bison">
  95             <primary sortas="b-bison">bison</primary>
  96           </indexterm>
  97         </listitem>
  98       </varlistentry>
  99
 100       <varlistentry id="yacc">
 101         <term><command>yacc</command></term>
 102         <listitem>
 103           <para>A wrapper for <command>bison</command>, meant for programs that
 104           still call <command>yacc</command> instead of <command>bison</command>;
 105           it calls <command>bison</command> with the <parameter>-y</parameter>
 106           option</para>
 107           <indexterm zone="ch-system-bison yacc">
 108             <primary sortas="b-yacc">yacc</primary>
 109           </indexterm>
 110         </listitem>
 111       </varlistentry>
 112
 113       <varlistentry id="liby">
 114         <term><filename class="libraryfile">liby</filename></term>
 115         <listitem>
 116           <para>The Yacc library containing implementations of Yacc-compatible
 117           <function>yyerror</function> and <function>main</function> functions;
 118           this library is normally not very useful, but POSIX requires it</para>
 119           <indexterm zone="ch-system-bison liby">
 120             <primary sortas="c-liby">liby</primary>
 121           </indexterm>
 122         </listitem>
 123       </varlistentry>
 124
 125     </variablelist>
 126
 127   </sect2>
 128
 129 </sect1>