glfs/general/genutils/gperf.xml

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

  <!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        "c1f1db32fb6598d6a93e6e88796a8632">
  <!ENTITY gperf-size          "961 KB">
  <!ENTITY gperf-buildsize     "5 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>

    &lfs65_checked;

    <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 --docdir=/usr/share/doc/gperf-&gperf-version; &amp;&amp;
make</userinput></screen>

    <para>If desired, create a text version of the documentation by issuing
    the following command:</para>

<screen><userinput>makeinfo -o doc/gperf.txt --plaintext doc/gperf.texi</userinput></screen>

    <para>To test the results, issue <command>make check</command>. There
    should be no output from the <command>diff</command> commands.</para>

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

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

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>install -m644 -v doc/gperf.{dvi,ps,pdf,txt} ...</command>:
    This command installs documentation. Modify the command (remove ',txt') if
    you did not build the text version.</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</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="b-gperf">gperf</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>