source: postlfs/security/gpgme.xml@ f7774787

<?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 gpgme-download-http " ">
  <!ENTITY gpgme-download-ftp  "ftp://ftp.gnupg.org/gcrypt/gpgme/gpgme-&gpgme-version;.tar.bz2">
  <!ENTITY gpgme-md5sum        "90afa8436ce2b2683c001c824bd22601">
  <!ENTITY gpgme-size          "828 KB">
  <!ENTITY gpgme-buildsize     "22 MB">
  <!ENTITY gpgme-time          "0.3 SBU">
]>

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

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

  <title>GPGME-&gpgme-version;</title>

  <indexterm zone="gpgme">
    <primary sortas="a-GPGME">GPGME</primary>
  </indexterm>

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

    <para>The <application>GPGME</application> package is a C language library
    that allows to add support for cryptography to a program. It is designed to
    make access to public key crypto engines like
    <application>GnuPG</application> or GpgSM easier for applications.
    <application>GPGME</application> provides a high-level crypto API for
    encryption, decryption, signing, signature verification and key
    management.</para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libassuan"/> and
    <xref linkend="libgpg-error"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gnupg"/>,
      <xref linkend="gnupg2"/>, and
      <xref linkend="pth"/>
      </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr         \
            --libexecdir=/usr/lib \
            --without-g13         &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</userinput></screen>

  </sect2>

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

    <para><parameter>--libexecdir=/usr/lib</parameter>: This parameter stops the
    creation of an empty /usr/libexec directory.</para>

    <para><option>--without-g13</option>: This option merely prevents a warning
    about about an un-released development library during
    <command>configure</command>.</para>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>gpgme-config</seg>
        <seg>libgpgme-pthread.so, libgpgme-pth.so, and libgpgme.so</seg>
        <seg>/usr/share/common-lisp/source/gpgme</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libgpgme-pthread">
        <term><filename class='libraryfile'>libgpgme-pthread.{so,a}</filename></term>
        <listitem>
          <para>contains the gpgme API functions for applications using
          pthread.</para>
          <indexterm zone="gpgme libgpgme-pthread">
            <primary sortas="c-libgpgme-pthread">libgpgme-pthread.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgpgme-pth">
        <term><filename class='libraryfile'>libgpgme-pth.{so,a}</filename></term>
        <listitem>
          <para>contains the gpgme API functions for applications using GNU
          Pth.</para>
          <indexterm zone="gpgme libgpgme-pth">
            <primary sortas="c-libgpgme-pth">libgpgme-pth.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

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

    </variablelist>

  </sect2>

</sect1>