BOOK/chapter06/flex.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-flex" role="wrap">
   9   <?dbhtml filename="flex.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>flex</productname>
  13     <productnumber>&flex-version;</productnumber>
  14     <address>&flex-url;</address>
  15   </sect1info>
  16
  17   <title>Flex-&flex-version;</title>
  18
  19   <indexterm zone="ch-system-flex">
  20     <primary sortas="a-Flex">Flex</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The Flex package contains a utility for generating programs that
  27     recognize patterns in text.</para>
  28
  29     <segmentedlist>
  30       <segtitle>&buildtime;</segtitle>
  31       <segtitle>&diskspace;</segtitle>
  32
  33       <seglistitem>
  34         <seg>&flex-ch6-sbu;</seg>
  35         <seg>&flex-ch6-du;</seg>
  36       </seglistitem>
  37     </segmentedlist>
  38
  39   </sect2>
  40
  41   <sect2 role="installation">
  42     <title>Installation of Flex</title>
  43
  44     <para>First, fix a problem introduced with glibc-2.26:</para>
  45
  46 <screen><userinput remap="pre">sed -i "/math.h/a #include &lt;malloc.h&gt;" src/flexdef.h</userinput></screen>
  47
  48     <para>The build procedure assumes the <application>help2man</application>
  49     program is available to create a man page from the executable --help option.
  50     This is not present, so we use an environment variable to skip this process.
  51     Now, prepare Flex for compilation:</para>
  52
  53 <screen><userinput remap="configure">HELP2MAN=/tools/bin/true \
  54 ./configure --prefix=/usr --docdir=/usr/share/doc/flex-&flex-version;</userinput></screen>
  55
  56     <para>Compile the package:</para>
  57
  58 <screen><userinput remap="make">make</userinput></screen>
  59
  60     <para>To test the results (about 0.5 SBU), issue:</para>
  61
  62 <screen><userinput remap="test">make check</userinput></screen>
  63
  64     <para>Install the package:</para>
  65
  66 <screen><userinput remap="install">make install</userinput></screen>
  67
  68     <para>A few programs do not know about <command>flex</command> yet and
  69     try to run its predecessor, <command>lex</command>. To support those
  70     programs, create a symbolic link named <filename>lex</filename> that
  71     runs <filename>flex</filename> in <command>lex</command> emulation
  72     mode:</para>
  73
  74 <screen><userinput remap="install">ln -sv flex /usr/bin/lex</userinput></screen>
  75
  76   </sect2>
  77
  78   <sect2 id="contents-flex" role="content">
  79     <title>Contents of Flex</title>
  80
  81     <segmentedlist>
  82       <segtitle>Installed programs</segtitle>
  83       <segtitle>Installed libraries</segtitle>
  84       <segtitle>Installed directory</segtitle>
  85
  86       <seglistitem>
  87         <seg>flex, flex++ (link to flex), and lex (link to flex)</seg>
  88         <seg>libfl.so</seg>
  89         <seg>/usr/share/doc/flex-&flex-version;</seg>
  90       </seglistitem>
  91     </segmentedlist>
  92
  93     <variablelist>
  94       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  95       <?dbfo list-presentation="list"?>
  96       <?dbhtml list-presentation="table"?>
  97
  98       <varlistentry id="flex">
  99         <term><command>flex</command></term>
 100         <listitem>
 101           <para>A tool for generating programs that recognize patterns in text;
 102           it allows for the versatility to specify the rules for pattern-finding,
 103           eradicating the need to develop a specialized program</para>
 104           <indexterm zone="ch-system-flex flex">
 105             <primary sortas="b-flex">flex</primary>
 106           </indexterm>
 107         </listitem>
 108       </varlistentry>
 109
 110       <varlistentry id="flexpp">
 111         <term><command>flex++</command></term>
 112         <listitem>
 113           <para>An extension of flex, is used for generating C++ code
 114           and classes. It is a symbolic link to <command>flex</command></para>
 115           <indexterm zone="ch-system-flex flexpp">
 116             <primary sortas="b-flex++">flex++</primary>
 117           </indexterm>
 118         </listitem>
 119       </varlistentry>
 120
 121       <varlistentry id="lex">
 122         <term><command>lex</command></term>
 123         <listitem>
 124           <para>A symbolic link that runs <command>flex</command> in
 125           <command>lex</command> emulation mode</para>
 126           <indexterm zone="ch-system-flex lex">
 127             <primary sortas="b-lex">lex</primary>
 128           </indexterm>
 129         </listitem>
 130       </varlistentry>
 131
 132       <varlistentry id="libfl">
 133         <term><filename class="libraryfile">libfl</filename></term>
 134         <listitem>
 135           <para>The <filename class="libraryfile">flex</filename> library</para>
 136           <indexterm zone="ch-system-flex libfl">
 137             <primary sortas="c-libfl">libfl</primary>
 138           </indexterm>
 139         </listitem>
 140       </varlistentry>
 141
 142     </variablelist>
 143
 144   </sect2>
 145
 146 </sect1>