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, skip running three regression tests that require Bison:</para>
  45
  46 <screen><userinput remap="pre">sed -i -e '/test-bison/d' tests/Makefile.in</userinput></screen>
  47
  48     <para>Prepare Flex for compilation:</para>
  49
  50 <screen><userinput remap="configure">./configure --prefix=/usr --docdir=/usr/share/doc/flex-&flex-version;</userinput></screen>
  51
  52     <para>Compile the package:</para>
  53
  54 <screen><userinput remap="make">make</userinput></screen>
  55
  56     <para>To test the results (about 0.5 SBU), issue:</para>
  57
  58 <screen><userinput remap="test">make check</userinput></screen>
  59
  60     <para>Install the package:</para>
  61
  62 <screen><userinput remap="install">make install</userinput></screen>
  63 <!--
  64     <para>There are some packages that expect to find the
  65     <filename class="libraryfile">lex</filename> library in <filename
  66     class="directory">/usr/lib</filename>. Create a symlink to account for
  67     this:</para>
  68
  69 <screen><userinput remap="install">ln -sv libfl.a /usr/lib/libl.a</userinput></screen>
  70 -->
  71     <para>A few programs do not know about <command>flex</command> yet and
  72     try to run its predecessor, <command>lex</command>. To support those
  73     programs, create a symbolic link named <filename>lex</filename> that
  74     runs <filename>flex</filename> in <command>lex</command> emulation
  75     mode:</para>
  76
  77 <screen><userinput remap="install">ln -sv flex /usr/bin/lex</userinput></screen>
  78
  79   </sect2>
  80
  81   <sect2 id="contents-flex" role="content">
  82     <title>Contents of Flex</title>
  83
  84     <segmentedlist>
  85       <segtitle>Installed programs</segtitle>
  86       <segtitle>Installed libraries</segtitle>
  87       <segtitle>Installed directory</segtitle>
  88
  89       <seglistitem>
  90         <seg>flex, flex++ (link to flex), and lex (link to flex)</seg>
  91         <seg>libfl.{a,so} and libfl_pic.{a,so}</seg>
  92         <seg>/usr/share/doc/flex-&flex-version;</seg>
  93       </seglistitem>
  94     </segmentedlist>
  95
  96     <variablelist>
  97       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  98       <?dbfo list-presentation="list"?>
  99       <?dbhtml list-presentation="table"?>
 100
 101       <varlistentry id="flex">
 102         <term><command>flex</command></term>
 103         <listitem>
 104           <para>A tool for generating programs that recognize patterns in text;
 105           it allows for the versatility to specify the rules for pattern-finding,
 106           eradicating the need to develop a specialized program</para>
 107           <indexterm zone="ch-system-flex flex">
 108             <primary sortas="b-flex">flex</primary>
 109           </indexterm>
 110         </listitem>
 111       </varlistentry>
 112
 113       <varlistentry id="flexpp">
 114         <term><command>flex++</command></term>
 115         <listitem>
 116           <para>An extension of flex, is used for generating C++ code
 117           and classes. It is a symbolic link to <command>flex</command></para>
 118           <indexterm zone="ch-system-flex flexpp">
 119             <primary sortas="b-flex++">flex++</primary>
 120           </indexterm>
 121         </listitem>
 122       </varlistentry>
 123
 124       <varlistentry id="lex">
 125         <term><command>lex</command></term>
 126         <listitem>
 127           <para>A script that runs <command>flex</command> in
 128           <command>lex</command> emulation mode</para>
 129           <indexterm zone="ch-system-flex lex">
 130             <primary sortas="b-lex">lex</primary>
 131           </indexterm>
 132         </listitem>
 133       </varlistentry>
 134
 135       <varlistentry id="libfl">
 136         <term><filename class="libraryfile">libfl</filename></term>
 137         <listitem>
 138           <para>The <filename class="libraryfile">flex</filename> library</para>
 139           <indexterm zone="ch-system-flex libfl">
 140             <primary sortas="c-libfl">libfl</primary>
 141           </indexterm>
 142         </listitem>
 143       </varlistentry>
 144
 145     </variablelist>
 146
 147   </sect2>
 148
 149 </sect1>