glfs/postlfs/security/gpgme.xml
Bruce Dubbs 48bcac91a6 Tag dependencies for kf5
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21997 af4574ff-66df-0310-9fd7-8a98e5e911e0
2019-08-19 01:01:59 +00:00

263 lines
8.0 KiB
XML

<?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 "&gnupg-http;/gpgme/gpgme-&gpgme-version;.tar.bz2">
<!ENTITY gpgme-download-ftp "&gnupg-ftp;/gpgme/gpgme-&gpgme-version;.tar.bz2">
<!ENTITY gpgme-download-ftp " ">
<!ENTITY gpgme-md5sum "198f0a908ec3cd8f0ce9a4f3a4489645">
<!ENTITY gpgme-size "1.7 MB">
<!ENTITY gpgme-buildsize "232 MB (with all bindings)">
<!ENTITY gpgme-time "0.7 SBU (with parallelism=4; with all bindings, add 0.5 SBU for tests)">
]>
<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 library
that allows cryptography support to be added 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>
&lfs90_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"/>
</para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional">
<xref linkend="doxygen"/> and
<xref linkend="graphviz"/> (for API documentation),
<xref linkend="gnupg2"/> (required if Qt or SWIG are installed;
used during the testsuite),
<xref linkend="clisp"/>,
<xref linkend="python2"/>,
<xref linkend="qt5"/>, and/or
<xref linkend="swig"/> (for language bindings)
</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 --disable-gpg-test &amp;&amp;
make</userinput></screen>
<para>
To test the results, you should have <xref linkend="gnupg2"/> installed
and remove the <command>--disable-gpg-test</command> above. 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>--disable-gpg-test</parameter>: if this parameter is not
passed to configure, the test programs are built during
<command>make</command> stage, which requires <xref linkend="gnupg2"/>.
This parameter is not needed if <xref linkend="gnupg2"/> is installed.
</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, gpgme-json, and gpgme-tool
</seg>
<seg>
libgpgme, libgpgmepp.so, and libqgpgme.so
</seg>
<seg>
/usr/include/{gpgme++,qgpgme,QGpgME},
/usr/lib/cmake/{Gpgmepp,QGpgme}.
/usr/lib/python{2.7,3.7}/site-packages/gpg, and
/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="gpgme-config">
<term><command>gpgme-config</command></term>
<listitem>
<para>
is used to obtain <application>GPGME</application> compilation and
linking information.
</para>
<indexterm zone="gpgme gpgme-config">
<primary sortas="b-gpgme-config">gpgme-config</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="gpgme-json">
<term><command>gpgme-json</command></term>
<listitem>
<para>
outputs <application>GPGME</application> commands in JSON format.
</para>
<indexterm zone="gpgme gpgme-json">
<primary sortas="b-gpgme-json">gpgme-json</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="gpgme-tool">
<term><command>gpgme-tool</command></term>
<listitem>
<para>
prints fingerprint and keyid with keyservers.
</para>
<indexterm zone="gpgme gpgme-tool">
<primary sortas="b-gpgme-tool">gpgme-tool</primary>
</indexterm>
</listitem>
</varlistentry>
<!-- As of 1.13.1, this library isn't present anymore.
<varlistentry id="libgpgme-pthread">
<term><filename class="libraryfile">libgpgme-pthread.so</filename></term>
<listitem>
<para>
contains the <application>GPGME</application> API functions for
applications using pthread.
</para>
<indexterm zone="gpgme libgpgme-pthread">
<primary sortas="c-libgpgme-pthread">libgpgme-pthread.so</primary>
</indexterm>
</listitem>
</varlistentry>
-->
<varlistentry id="libgpgme">
<term><filename class="libraryfile">libgpgme.so</filename></term>
<listitem>
<para>
contains the <application>GPGME</application> API functions.
</para>
<indexterm zone="gpgme libgpgme">
<primary sortas="c-libgpgme">libgpgme.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libgpgmepp">
<term><filename class="libraryfile">libgpgmepp.so</filename></term>
<listitem>
<para>
contains the C++ <application>GPGME</application> API functions.
</para>
<indexterm zone="gpgme libgpgmepp">
<primary sortas="c-libgpgmepp">libgpgmepp.so</primary>
</indexterm>
</listitem>
</varlistentry>
<varlistentry id="libqgpgme">
<term><filename class="libraryfile">libqgpgme.so</filename></term>
<listitem>
<para>
contains API functions for handling GPG operations in
<application>Qt</application> applications.
</para>
<indexterm zone="gpgme libqgpgme">
<primary sortas="c-libqgpgme">libqgpgme.so</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
</sect2>
</sect1>