source: general/genlib/popt.xml@ 48fe343

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

  <!ENTITY popt-download-http "http://rpm.net.in/mirror/rpm-4.4.x/popt-&popt-version;.tar.gz">
  <!ENTITY popt-download-ftp  "ftp://wraptastic.org/pub/rpm-4.4.x/popt-&popt-version;.tar.gz">
  <!ENTITY popt-md5sum        "dd22a6873b43d00f75e1c1b7dcfd1ff7">
  <!ENTITY popt-size          "1.1 MB">
  <!ENTITY popt-buildsize     "8.3 MB (includes installing documentation)">
  <!ENTITY popt-time          "0.3 SBU">
]>

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

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

  <title>Popt-&popt-version;</title>

  <indexterm zone="popt">
    <primary sortas="a-Popt">Popt</primary>
  </indexterm>

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

    <para>The <application>popt</application> package contains the
    <application>popt</application> libraries which are used by
    some programs to parse command-line options.</para>

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

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

  </sect2>

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

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

<screen><userinput>sed -i -e "/*origOptString ==/c 0)" popt.c &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>If you have <xref linkend="doxygen"/> installed and wish to build
    the API documentation, issue <command>doxygen</command>.</para>

    <para>To test the results, issue:</para>

<screen><userinput>make check</userinput></screen>

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

<screen role="root"><userinput>make install</userinput></screen>

    <para>If you built the API documentation, install it using the following
    commands issued by the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/popt-&popt-version; &amp;&amp;
install -v -m644 doxygen/html/* /usr/share/doc/popt-&popt-version;</userinput></screen>

  </sect2>

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

    <para><command>sed ...</command>:
    This fix taken backported from the development version of <application>popt</application>
    fixes a problem identified by the included testsuite.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>libpopt.{so,a}</seg>
        <seg>/usr/share/doc/popt-&popt-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libpopt">
      <term><filename role='library'>libpopt.{so,a}</filename></term>
      <listitem>
        <para> is used to parse command-line options.</para>
        <indexterm zone="popt libpopt">
          <primary sortas="c-libpopt">libpopt.{so,a}</primary>
        </indexterm>
      </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>