source: BOOK/final-system/common/flex.xml@ 1df81fa

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
  "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
]>

<sect1 id="ch-system-flex" role="wrap">
  <?dbhtml filename="flex.html"?>

  <title>Flex-&flex-version;</title>

  <indexterm zone="ch-system-flex">
    <primary sortas="a-Flex">Flex</primary>
  </indexterm>

  <sect2 role="package">
    <title/>

    <para>The Flex package contains a utility for generating programs that
    recognize patterns in text.</para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Flex</title>

    <para os="a">Prepare Flex for compilation:</para>

<screen os="b"><userinput>./configure \
    --prefix=/usr \
    --docdir=/usr/share/doc/flex-&flex-version;</userinput></screen>

    <para os="c">Compile the package:</para>

<screen os="d"><userinput>make</userinput></screen>

    <para os="e">To test the results, issue:</para>

<screen os="e2"><userinput remap="test">make check</userinput></screen>

    <para os="e3">The test suite will report 3 failures for tests that
    use <command>bison</command>, which is not installed yet. For full
    test coverage, you can run Flex's test suite again after Bison
    is installed.</para>

    <para os="f">Install the package:</para>

<screen os="g"><userinput>make install</userinput></screen>

    <para os="h">A few programs do not know about <command>flex</command> yet and
    try to run its predecessor, <command>lex</command>. To support those
    programs, create a wrapper script named <filename>lex</filename> that
    calls <filename>flex</filename> in <command>lex</command> emulation
    mode:</para>

<screen os="i"><userinput>cat &gt; /usr/bin/lex &lt;&lt; "EOF"
<literal>#!/bin/sh
# Begin /usr/bin/lex

exec /usr/bin/flex -l "$@"

# End /usr/bin/lex</literal>
EOF
chmod -v 755 /usr/bin/lex</userinput></screen>

  </sect2>

  <sect2 id="contents-flex" role="content">
    <title>Contents of Flex</title>

    <segmentedlist>
      <segtitle>Installed programs</segtitle>
      <segtitle>Installed libraries</segtitle>
      <segtitle>Installed directory</segtitle>

      <seglistitem>
        <seg>flex, flex++ (link to flex), lex</seg>
        <seg>libfl.[a,so], libfl_pic.[a,so]</seg>
        <seg>/usr/share/doc/flex-&flex-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="flex">
        <term><command>flex</command></term>
        <listitem>
          <para>A tool for generating programs that recognize patterns in text;
          it allows for the versatility to specify the rules for pattern-finding,
          eradicating the need to develop a specialized program</para>
          <indexterm zone="ch-system-flex flex">
            <primary sortas="b-flex">flex</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="flexpp">
        <term><command>flex++</command></term>
        <listitem>
          <para>Link to <command>flex</command> which makes it generate C++
          scanner classes</para>
          <indexterm zone="ch-system-flex flexpp">
            <primary sortas="b-flex++">flex++</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="lex">
        <term><command>lex</command></term>
        <listitem>
          <para>A script that runs <command>flex</command> in
          <command>lex</command> emulation mode</para>
          <indexterm zone="ch-system-flex lex">
            <primary sortas="b-lex">lex</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfl">
        <term><filename class="libraryfile">libfl</filename></term>
        <listitem>
          <para>The <filename class="libraryfile">flex</filename> library</para>
          <indexterm zone="ch-system-flex libfl">
            <primary sortas="c-libfl">libfl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libfl_pic">
        <term><filename class="libraryfile">libfl_pic</filename></term>
        <listitem>
          <para>The <filename class="libraryfile">flex</filename> library</para>
          <indexterm zone="ch-system-flex libfl_pic">
            <primary sortas="c-libfl">libfl_pic</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>