[b358845] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY gpgme-download-http "&gnupg-http;/gpgme/gpgme-&gpgme-version;.tar.bz2">
|
---|
[d4e8cd93] | 8 | <!ENTITY gpgme-download-ftp "&gnupg-ftp;/gpgme/gpgme-&gpgme-version;.tar.bz2">
|
---|
[14d673a2] | 9 | <!ENTITY gpgme-download-ftp " ">
|
---|
[d5f6e8e] | 10 | <!ENTITY gpgme-md5sum "e086c4575fe4d7840864fb7dfe97f692">
|
---|
[8d97143c] | 11 | <!ENTITY gpgme-size "1.6 MB">
|
---|
[d5f6e8e] | 12 | <!ENTITY gpgme-buildsize "243 MB">
|
---|
| 13 | <!ENTITY gpgme-time "0.8 SBU (with parallelism=4; with all bindings, add 0.6 SBU for tests)">
|
---|
[b358845] | 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="gpgme" xreflabel="GPGME-&gpgme-version;">
|
---|
| 17 | <?dbhtml filename="gpgme.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
| 22 |
|
---|
| 23 | <title>GPGME-&gpgme-version;</title>
|
---|
| 24 |
|
---|
| 25 | <indexterm zone="gpgme">
|
---|
| 26 | <primary sortas="a-GPGME">GPGME</primary>
|
---|
| 27 | </indexterm>
|
---|
| 28 |
|
---|
| 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to GPGME</title>
|
---|
| 31 |
|
---|
[d6da5da] | 32 | <para>
|
---|
[200bab29] | 33 | The <application>GPGME</application> package is a C library
|
---|
[bbacc9a] | 34 | that allows cryptography support to be added to a
|
---|
[d6da5da] | 35 | program. It is designed to make access to public key crypto
|
---|
| 36 | engines like <application>GnuPG</application> or GpgSM easier
|
---|
| 37 | for applications. <application>GPGME</application> provides
|
---|
| 38 | a high-level crypto API for encryption, decryption, signing,
|
---|
| 39 | signature verification and key management.
|
---|
| 40 | </para>
|
---|
[b358845] | 41 |
|
---|
[9029db2] | 42 | &lfs101_checked;
|
---|
[b358845] | 43 |
|
---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
[d6da5da] | 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&gpgme-download-http;"/>
|
---|
| 49 | </para>
|
---|
[b358845] | 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
[d6da5da] | 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&gpgme-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
[b358845] | 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
[d6da5da] | 57 | <para>
|
---|
| 58 | Download MD5 sum: &gpgme-md5sum;
|
---|
| 59 | </para>
|
---|
[b358845] | 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
[d6da5da] | 62 | <para>
|
---|
| 63 | Download size: &gpgme-size;
|
---|
| 64 | </para>
|
---|
[b358845] | 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
[d6da5da] | 67 | <para>
|
---|
| 68 | Estimated disk space required: &gpgme-buildsize;
|
---|
| 69 | </para>
|
---|
[b358845] | 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
[d6da5da] | 72 | <para>
|
---|
| 73 | Estimated build time: &gpgme-time;
|
---|
| 74 | </para>
|
---|
[b358845] | 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
[150992ab] | 77 |
|
---|
[b358845] | 78 | <bridgehead renderas="sect3">GPGME Dependencies</bridgehead>
|
---|
| 79 |
|
---|
| 80 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[d6da5da] | 81 | <para role="required">
|
---|
| 82 | <xref linkend="libassuan"/>
|
---|
| 83 | </para>
|
---|
[b358845] | 84 |
|
---|
| 85 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[289d262f] | 86 | <para role="optional">
|
---|
[33690a1] | 87 | <xref linkend="doxygen"/> and
|
---|
[cd074c2] | 88 | <xref linkend="graphviz"/> (for API documentation),
|
---|
[33690a1] | 89 | <xref linkend="gnupg2"/> (required if Qt or SWIG are installed;
|
---|
[356a7a9] | 90 | used during the testsuite),
|
---|
[33690a1] | 91 | <xref linkend="clisp"/>,<!--
|
---|
| 92 | gpgme can still use python 2.7, but can use python3 as well,
|
---|
| 93 | so do not advertise python2
|
---|
| 94 | <xref linkend="python2"/>,-->
|
---|
[30d6b736] | 95 | <xref linkend="qt5"/>, and/or
|
---|
| 96 | <xref linkend="swig"/> (for language bindings)
|
---|
[d6da5da] | 97 | </para>
|
---|
[b358845] | 98 |
|
---|
| 99 | <para condition="html" role="usernotes">User Notes:
|
---|
[d6da5da] | 100 | <ulink url="&blfs-wiki;/gpgme"/>
|
---|
| 101 | </para>
|
---|
[b358845] | 102 | </sect2>
|
---|
| 103 |
|
---|
| 104 | <sect2 role="installation">
|
---|
| 105 | <title>Installation of GPGME</title>
|
---|
| 106 |
|
---|
[d6da5da] | 107 | <para>
|
---|
| 108 | Install <application>GPGME</application> by running the following
|
---|
| 109 | commands:
|
---|
| 110 | </para>
|
---|
[b358845] | 111 |
|
---|
[14f0ab29] | 112 | <screen><userinput>./configure --prefix=/usr --disable-gpg-test &&
|
---|
[b358845] | 113 | make</userinput></screen>
|
---|
[150992ab] | 114 |
|
---|
[d6da5da] | 115 | <para>
|
---|
[14f0ab29] | 116 | To test the results, you should have <xref linkend="gnupg2"/> installed
|
---|
| 117 | and remove the <command>--disable-gpg-test</command> above. Issue:
|
---|
[0b5fa18] | 118 | <command>make -k check</command>.
|
---|
[d6da5da] | 119 | </para>
|
---|
[b358845] | 120 |
|
---|
[d6da5da] | 121 | <para>
|
---|
| 122 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 123 | </para>
|
---|
[b358845] | 124 |
|
---|
| 125 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 126 |
|
---|
| 127 | </sect2>
|
---|
[f7ac7b2] | 128 |
|
---|
[14f0ab29] | 129 | <sect2 role="commands">
|
---|
| 130 | <title>Command Explanations</title>
|
---|
| 131 |
|
---|
| 132 | <para>
|
---|
| 133 | <parameter>--disable-gpg-test</parameter>: if this parameter is not
|
---|
| 134 | passed to configure, the test programs are built during
|
---|
| 135 | <command>make</command> stage, which requires <xref linkend="gnupg2"/>.
|
---|
| 136 | This parameter is not needed if <xref linkend="gnupg2"/> is installed.
|
---|
| 137 | </para>
|
---|
| 138 |
|
---|
| 139 | </sect2>
|
---|
| 140 |
|
---|
[b358845] | 141 | <sect2 role="content">
|
---|
| 142 | <title>Contents</title>
|
---|
| 143 |
|
---|
| 144 | <segmentedlist>
|
---|
| 145 | <segtitle>Installed Program</segtitle>
|
---|
| 146 | <segtitle>Installed Libraries</segtitle>
|
---|
| 147 | <segtitle>Installed Directory</segtitle>
|
---|
| 148 |
|
---|
| 149 | <seglistitem>
|
---|
[d6da5da] | 150 | <seg>
|
---|
[cd074c2] | 151 | gpgme-config, gpgme-json, and gpgme-tool
|
---|
[d6da5da] | 152 | </seg>
|
---|
| 153 | <seg>
|
---|
[cd074c2] | 154 | libgpgme, libgpgmepp.so, and libqgpgme.so
|
---|
[d6da5da] | 155 | </seg>
|
---|
| 156 | <seg>
|
---|
[cd074c2] | 157 | /usr/include/{gpgme++,qgpgme,QGpgME},
|
---|
| 158 | /usr/lib/cmake/{Gpgmepp,QGpgme}.
|
---|
[90691c23] | 159 | /usr/lib/python{2.7,3.9}/site-packages/gpg, and
|
---|
[d6da5da] | 160 | /usr/share/common-lisp/source/gpgme
|
---|
| 161 | </seg>
|
---|
[b358845] | 162 | </seglistitem>
|
---|
| 163 | </segmentedlist>
|
---|
| 164 |
|
---|
| 165 | <variablelist>
|
---|
| 166 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 167 | <?dbfo list-presentation="list"?>
|
---|
| 168 | <?dbhtml list-presentation="table"?>
|
---|
| 169 |
|
---|
[385b822] | 170 | <varlistentry id="gpgme-config">
|
---|
| 171 | <term><command>gpgme-config</command></term>
|
---|
| 172 | <listitem>
|
---|
| 173 | <para>
|
---|
| 174 | is used to obtain <application>GPGME</application> compilation and
|
---|
[4c24eb0a] | 175 | linking information
|
---|
[385b822] | 176 | </para>
|
---|
| 177 | <indexterm zone="gpgme gpgme-config">
|
---|
| 178 | <primary sortas="b-gpgme-config">gpgme-config</primary>
|
---|
| 179 | </indexterm>
|
---|
| 180 | </listitem>
|
---|
| 181 | </varlistentry>
|
---|
| 182 |
|
---|
[cd074c2] | 183 | <varlistentry id="gpgme-json">
|
---|
| 184 | <term><command>gpgme-json</command></term>
|
---|
| 185 | <listitem>
|
---|
| 186 | <para>
|
---|
[4c24eb0a] | 187 | outputs <application>GPGME</application> commands in JSON format
|
---|
[cd074c2] | 188 | </para>
|
---|
| 189 | <indexterm zone="gpgme gpgme-json">
|
---|
| 190 | <primary sortas="b-gpgme-json">gpgme-json</primary>
|
---|
| 191 | </indexterm>
|
---|
| 192 | </listitem>
|
---|
| 193 | </varlistentry>
|
---|
| 194 |
|
---|
[150992ab] | 195 | <varlistentry id="gpgme-tool">
|
---|
| 196 | <term><command>gpgme-tool</command></term>
|
---|
| 197 | <listitem>
|
---|
| 198 | <para>
|
---|
[d5f6e8e] | 199 | is an assuan server exposing <application>GPGME</application>
|
---|
| 200 | operations, such as printing fingerprints and keyids with
|
---|
[4c24eb0a] | 201 | keyservers
|
---|
[150992ab] | 202 | </para>
|
---|
| 203 | <indexterm zone="gpgme gpgme-tool">
|
---|
| 204 | <primary sortas="b-gpgme-tool">gpgme-tool</primary>
|
---|
| 205 | </indexterm>
|
---|
| 206 | </listitem>
|
---|
| 207 | </varlistentry>
|
---|
| 208 |
|
---|
[cd074c2] | 209 | <!-- As of 1.13.1, this library isn't present anymore.
|
---|
[b358845] | 210 | <varlistentry id="libgpgme-pthread">
|
---|
[d6da5da] | 211 | <term><filename class="libraryfile">libgpgme-pthread.so</filename></term>
|
---|
[b358845] | 212 | <listitem>
|
---|
[d6da5da] | 213 | <para>
|
---|
| 214 | contains the <application>GPGME</application> API functions for
|
---|
| 215 | applications using pthread.
|
---|
| 216 | </para>
|
---|
[b358845] | 217 | <indexterm zone="gpgme libgpgme-pthread">
|
---|
[d6da5da] | 218 | <primary sortas="c-libgpgme-pthread">libgpgme-pthread.so</primary>
|
---|
[b358845] | 219 | </indexterm>
|
---|
| 220 | </listitem>
|
---|
| 221 | </varlistentry>
|
---|
[cd074c2] | 222 | -->
|
---|
[b358845] | 223 |
|
---|
| 224 | <varlistentry id="libgpgme">
|
---|
[d6da5da] | 225 | <term><filename class="libraryfile">libgpgme.so</filename></term>
|
---|
[b358845] | 226 | <listitem>
|
---|
[d6da5da] | 227 | <para>
|
---|
[4c24eb0a] | 228 | contains the <application>GPGME</application> API functions
|
---|
[d6da5da] | 229 | </para>
|
---|
[b358845] | 230 | <indexterm zone="gpgme libgpgme">
|
---|
[d6da5da] | 231 | <primary sortas="c-libgpgme">libgpgme.so</primary>
|
---|
[b358845] | 232 | </indexterm>
|
---|
| 233 | </listitem>
|
---|
| 234 | </varlistentry>
|
---|
| 235 |
|
---|
[48ad7d9] | 236 | <varlistentry id="libgpgmepp">
|
---|
| 237 | <term><filename class="libraryfile">libgpgmepp.so</filename></term>
|
---|
| 238 | <listitem>
|
---|
| 239 | <para>
|
---|
[4c24eb0a] | 240 | contains the C++ <application>GPGME</application> API functions
|
---|
[48ad7d9] | 241 | </para>
|
---|
| 242 | <indexterm zone="gpgme libgpgmepp">
|
---|
| 243 | <primary sortas="c-libgpgmepp">libgpgmepp.so</primary>
|
---|
| 244 | </indexterm>
|
---|
| 245 | </listitem>
|
---|
| 246 | </varlistentry>
|
---|
| 247 |
|
---|
[cd074c2] | 248 | <varlistentry id="libqgpgme">
|
---|
| 249 | <term><filename class="libraryfile">libqgpgme.so</filename></term>
|
---|
| 250 | <listitem>
|
---|
| 251 | <para>
|
---|
| 252 | contains API functions for handling GPG operations in
|
---|
[4c24eb0a] | 253 | <application>Qt</application> applications
|
---|
[cd074c2] | 254 | </para>
|
---|
| 255 | <indexterm zone="gpgme libqgpgme">
|
---|
| 256 | <primary sortas="c-libqgpgme">libqgpgme.so</primary>
|
---|
| 257 | </indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
| 260 |
|
---|
[b358845] | 261 | </variablelist>
|
---|
| 262 |
|
---|
| 263 | </sect2>
|
---|
| 264 |
|
---|
| 265 | </sect1>
|
---|