source: general/genlib/popt.xml@ 9d75494

<?xml version="1.0" encoding="UTF-8"?>
<!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 popt-download-http "http://ftp.rpm.org/popt/releases/popt-1.x/popt-&popt-version;.tar.gz">
  <!ENTITY popt-download-ftp  " ">
  <!ENTITY popt-md5sum        "eaa2135fddb6eb03f2c87ee1823e5a78">
  <!ENTITY popt-size          "584 KB">
  <!ENTITY popt-buildsize     "6.9 MB (includes installing documentation and tests)">
  <!ENTITY popt-time          "less than 0.1 SBU (with tests)">
]>

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


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

    &lfs120_checked;

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

    <bridgehead renderas="sect3">popt Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> (for generating documentation)
    </para>

  </sect2>

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

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

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

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

<screen remap="doc"><userinput>sed -i 's@\./@src/@' Doxyfile &amp;&amp;
doxygen</userinput></screen>

    <para>
      To test the results, issue: <command>make check</command>.
    </para>

    <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"
        remap="doc"><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>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <!-- FIXME Removed due to merged-/usr changes
    <para>
      <command>mv /usr/lib/libpopt.so.* /lib</command> and
      <command>ln -sfv ...</command>: Moves the popt library on the root
      filesystem, so it is available in case
      <systemitem class="filesystem">/usr</systemitem> is offline and
      <xref linkend="efibootmgr"/> is installed and linked to popt.
    </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</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 class="libraryfile">libpopt.so</filename></term>
      <listitem>
        <para>
          is used to parse command-line options
        </para>
        <indexterm zone="popt libpopt">
          <primary sortas="c-libpopt">libpopt.so</primary>
        </indexterm>
      </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>