source: general/genutils/gperf.xml@ b37f8d03

<?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;

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY gperf-download-http "http://ftp.gnu.org/gnu/gperf/gperf-&gperf-version;.tar.gz">
  <!ENTITY gperf-download-ftp "ftp://ftp.gnu.org/gnu/gperf/gperf-&gperf-version;.tar.gz">
  <!ENTITY gperf-md5sum "cc20e58975a38075440423c8fb85fd00">
  <!ENTITY gperf-size "866 KB">
  <!ENTITY gperf-buildsize "4 MB">
  <!ENTITY gperf-time "less than 0.1 SBU">
]>

<sect1 id="gperf" xreflabel="gperf-&gperf-version;">
  <?dbhtml filename="gperf.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Gperf-&gperf-version;</title>

  <indexterm zone="gperf">
    <primary sortas="a-Gperf">Gperf</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Gperf</title>

    <para><application>Gperf</application> generates a perfect hash function from a key set.</para>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&gperf-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&gperf-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &gperf-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &gperf-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &gperf-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &gperf-time;</para>
      </listitem>
    </itemizedlist>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/gperf"/></para>

  </sect2>

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

    <para>Install <application>gperf</application> by running the following commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
makeinfo -o doc/gperf.txt --plaintext doc/gperf.texi &amp;&amp;
install -v -m755 -d /usr/share/doc/gperf-&gperf-version; &amp;&amp;
install -m644 -v doc/gperf.{dvi,ps,pdf,txt} /usr/share/doc/gperf-&gperf-version;</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>gperf</seg>
        <seg>None</seg>
        <seg>/usr/share/doc/gperf-&gperf-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gperf-prog">
        <term><command>gperf</command></term>
        <listitem>
          <para> generates a perfect hash function from a key set.</para>
          <indexterm zone="gperf gperf-prog">
            <primary sortas="g-gperf">bc</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>