source: general/genlib/libgpg-error.xml@ 5323a4b

<?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 libgpg-error-download-http "&sources-anduin-http;/l/libgpg-error-&libgpg-error-version;.tar.bz2">
  <!ENTITY libgpg-error-download-ftp  "ftp://ftp.gnupg.org/gcrypt/libgpg-error/libgpg-error-&libgpg-error-version;.tar.bz2">
  <!ENTITY libgpg-error-md5sum        "62c0d09d1e76c5b6da8fff92314c4665">
  <!ENTITY libgpg-error-size          "403 KB">
  <!ENTITY libgpg-error-buildsize     "4.5 MB">
  <!ENTITY libgpg-error-time          "0.1 SBU">
]>

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

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

  <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. Among these are GPG, GPGSM,
    GPGME, GPG-Agent, libgcrypt, Libksba, DirMngr, Pinentry, SmartCard Daemon
    and more.</para>

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

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

  </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 Directory</segtitle>

      <seglistitem>
        <seg>gpg-error and gpg-error-config</seg>
        <seg>libgpg-error.{so,a}</seg>
        <seg>/usr/share/common-lisp 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="gpg-error-config">
        <term><command>gpg-error-config</command></term>
        <listitem>
          <para>is a utility used to configure and build applications based on
          the Libgpg-error library. It can be used to query the C compiler and
          linker flags which are required to correctly compile and link the
          application against the Libgpg-error library.</para>
          <indexterm zone="libgpg-error gpg-error-config">
            <primary sortas="b-gpg-error-config">gpg-error-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="liblibgpg-error">
        <term><filename class='libraryfile'>liblibgpg-error.{so,a}</filename></term>
        <listitem>
          <para>contains the <application>Libgpg-error</application> API
          functions.</para>
          <indexterm zone="libgpg-error liblibgpg-error">
            <primary sortas="c-liblibgpg-error">liblibgpg-error.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>