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