source: general/genlib/libgpg-error.xml@ 73089ed3

<?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 libgpg-error-download-http "&gnupg-http;/libgpg-error/libgpg-error-&libgpg-error-version;.tar.bz2">
  <!ENTITY libgpg-error-download-ftp  " ">
  <!ENTITY libgpg-error-md5sum        "eb171d62d761f49e110b77b747d8a157">
  <!ENTITY libgpg-error-size          "1.0 MB">
  <!ENTITY libgpg-error-buildsize     "11 MB (with tests)">
  <!ENTITY libgpg-error-time          "0.1 SBU (with tests)">
]>

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


  <title>libgpg-error-&libgpg-error-version;</title>

  <indexterm zone="libgpg-error">
    <primary sortas="a-libgpg-error">libgpg-error</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libgpg-error</title>

    <para>
      The <application>libgpg-error</application> package contains a
      library that defines common error values for all
      <application>GnuPG</application> components.
    </para>

    &lfs121_checked;

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

  </sect2>

  <sect2 role="installation">
    <title>Installation of libgpg-error</title>

    <para>
      Install <application>libgpg-error</application> by running the
      following commands:
    </para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</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 &amp;&amp;
install -v -m644 -D README /usr/share/doc/libgpg-error-&libgpg-error-version;/README</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          gpg-error, gpgrt-config, and yat2m
        </seg>
        <seg>
          libgpg-error.so
        </seg>
        <seg>
          /usr/share/common-lisp/source/gpg-error,
          /usr/share/libgpg-error, and
          /usr/share/doc/libgpg-error-&libgpg-error-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="gpg-error">
        <term><command>gpg-error</command></term>
        <listitem>
          <para>
            is used to determine <application>libgpg-error</application>
            error codes
          </para>
          <indexterm zone="libgpg-error gpg-error">
            <primary sortas="b-gpg-error">gpg-error</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="gpgrt-config">
        <term><command>gpgrt-config</command></term>
        <listitem>
          <para>
            is a <command>pkg-config</command> style tool for querying the
            information about installed version of libgpg-error
          </para>
          <indexterm zone="libgpg-error gpgrt-config">
            <primary sortas="b-gpgrt-config">gpgrt-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="yat2m">
        <term><command>yat2m</command></term>
        <listitem>
          <para>
            extracts man pages from a Texinfo source
          </para>
          <indexterm zone="libgpg-error yat2m">
            <primary sortas="b-yat2m">yat2m</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgpg-error-lib">
        <term><filename class="libraryfile">libgpg-error.so</filename></term>
        <listitem>
          <para>
            contains the <application>libgpg-error</application> API
            functions
          </para>
          <indexterm zone="libgpg-error libgpg-error-lib">
            <primary sortas="c-libgpg-error">libgpg-error.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>