[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 " ">
|
---|
[c4938ccc] | 10 | <!ENTITY gpgme-md5sum "4d3c7699e1cdd4095d103f7a6833ae3a">
|
---|
[0a18d81] | 11 | <!ENTITY gpgme-size "1.7 MB">
|
---|
[c4938ccc] | 12 | <!ENTITY gpgme-buildsize "262 MB">
|
---|
| 13 | <!ENTITY gpgme-time "0.6 SBU (with all bindings, add 0.9 SBU for tests; all with parallelism=4)">
|
---|
[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 |
|
---|
[de22bfa] | 42 | &lfs111_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 |
|
---|
[32089e1] | 107 | <para>
|
---|
[22c07de] | 108 | First, fix an issue building the package with Glibc-2.34 or later:
|
---|
[32089e1] | 109 | </para>
|
---|
| 110 |
|
---|
[22c07de] | 111 | <screen><userinput remap="pre">sed 's/defined(__sun.*$/1/' -i src/posix-io.c</userinput></screen>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | Next, fix an issue building with Python 3.10 installed:
|
---|
| 115 | </para>
|
---|
| 116 |
|
---|
[a171a54] | 117 | <screen><userinput remap="pre">sed -e 's/3\.9/3.10/' \
|
---|
| 118 | -e 's/:3/:4/' \
|
---|
[0a18d81] | 119 | -e '23653 s/distutils"/setuptools"/' \
|
---|
[22c07de] | 120 | -i configure</userinput></screen>
|
---|
[32089e1] | 121 |
|
---|
[d6da5da] | 122 | <para>
|
---|
| 123 | Install <application>GPGME</application> by running the following
|
---|
| 124 | commands:
|
---|
| 125 | </para>
|
---|
[b358845] | 126 |
|
---|
[14f0ab29] | 127 | <screen><userinput>./configure --prefix=/usr --disable-gpg-test &&
|
---|
[b358845] | 128 | make</userinput></screen>
|
---|
[150992ab] | 129 |
|
---|
[d6da5da] | 130 | <para>
|
---|
[14f0ab29] | 131 | To test the results, you should have <xref linkend="gnupg2"/> installed
|
---|
| 132 | and remove the <command>--disable-gpg-test</command> above. Issue:
|
---|
[0b5fa18] | 133 | <command>make -k check</command>.
|
---|
[d6da5da] | 134 | </para>
|
---|
[b358845] | 135 |
|
---|
[d6da5da] | 136 | <para>
|
---|
| 137 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 138 | </para>
|
---|
[b358845] | 139 |
|
---|
| 140 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 141 |
|
---|
| 142 | </sect2>
|
---|
[f7ac7b2] | 143 |
|
---|
[14f0ab29] | 144 | <sect2 role="commands">
|
---|
| 145 | <title>Command Explanations</title>
|
---|
| 146 |
|
---|
| 147 | <para>
|
---|
| 148 | <parameter>--disable-gpg-test</parameter>: if this parameter is not
|
---|
| 149 | passed to configure, the test programs are built during
|
---|
| 150 | <command>make</command> stage, which requires <xref linkend="gnupg2"/>.
|
---|
| 151 | This parameter is not needed if <xref linkend="gnupg2"/> is installed.
|
---|
| 152 | </para>
|
---|
| 153 |
|
---|
| 154 | </sect2>
|
---|
| 155 |
|
---|
[b358845] | 156 | <sect2 role="content">
|
---|
| 157 | <title>Contents</title>
|
---|
| 158 |
|
---|
| 159 | <segmentedlist>
|
---|
| 160 | <segtitle>Installed Program</segtitle>
|
---|
| 161 | <segtitle>Installed Libraries</segtitle>
|
---|
| 162 | <segtitle>Installed Directory</segtitle>
|
---|
| 163 |
|
---|
| 164 | <seglistitem>
|
---|
[d6da5da] | 165 | <seg>
|
---|
[cd074c2] | 166 | gpgme-config, gpgme-json, and gpgme-tool
|
---|
[d6da5da] | 167 | </seg>
|
---|
| 168 | <seg>
|
---|
[cd074c2] | 169 | libgpgme, libgpgmepp.so, and libqgpgme.so
|
---|
[d6da5da] | 170 | </seg>
|
---|
| 171 | <seg>
|
---|
[cd074c2] | 172 | /usr/include/{gpgme++,qgpgme,QGpgME},
|
---|
| 173 | /usr/lib/cmake/{Gpgmepp,QGpgme}.
|
---|
[90691c23] | 174 | /usr/lib/python{2.7,3.9}/site-packages/gpg, and
|
---|
[d6da5da] | 175 | /usr/share/common-lisp/source/gpgme
|
---|
| 176 | </seg>
|
---|
[b358845] | 177 | </seglistitem>
|
---|
| 178 | </segmentedlist>
|
---|
| 179 |
|
---|
| 180 | <variablelist>
|
---|
| 181 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 182 | <?dbfo list-presentation="list"?>
|
---|
| 183 | <?dbhtml list-presentation="table"?>
|
---|
| 184 |
|
---|
[385b822] | 185 | <varlistentry id="gpgme-config">
|
---|
| 186 | <term><command>gpgme-config</command></term>
|
---|
| 187 | <listitem>
|
---|
| 188 | <para>
|
---|
| 189 | is used to obtain <application>GPGME</application> compilation and
|
---|
[4c24eb0a] | 190 | linking information
|
---|
[385b822] | 191 | </para>
|
---|
| 192 | <indexterm zone="gpgme gpgme-config">
|
---|
| 193 | <primary sortas="b-gpgme-config">gpgme-config</primary>
|
---|
| 194 | </indexterm>
|
---|
| 195 | </listitem>
|
---|
| 196 | </varlistentry>
|
---|
| 197 |
|
---|
[cd074c2] | 198 | <varlistentry id="gpgme-json">
|
---|
| 199 | <term><command>gpgme-json</command></term>
|
---|
| 200 | <listitem>
|
---|
| 201 | <para>
|
---|
[4c24eb0a] | 202 | outputs <application>GPGME</application> commands in JSON format
|
---|
[cd074c2] | 203 | </para>
|
---|
| 204 | <indexterm zone="gpgme gpgme-json">
|
---|
| 205 | <primary sortas="b-gpgme-json">gpgme-json</primary>
|
---|
| 206 | </indexterm>
|
---|
| 207 | </listitem>
|
---|
| 208 | </varlistentry>
|
---|
| 209 |
|
---|
[150992ab] | 210 | <varlistentry id="gpgme-tool">
|
---|
| 211 | <term><command>gpgme-tool</command></term>
|
---|
| 212 | <listitem>
|
---|
| 213 | <para>
|
---|
[d5f6e8e] | 214 | is an assuan server exposing <application>GPGME</application>
|
---|
| 215 | operations, such as printing fingerprints and keyids with
|
---|
[4c24eb0a] | 216 | keyservers
|
---|
[150992ab] | 217 | </para>
|
---|
| 218 | <indexterm zone="gpgme gpgme-tool">
|
---|
| 219 | <primary sortas="b-gpgme-tool">gpgme-tool</primary>
|
---|
| 220 | </indexterm>
|
---|
| 221 | </listitem>
|
---|
| 222 | </varlistentry>
|
---|
| 223 |
|
---|
[cd074c2] | 224 | <!-- As of 1.13.1, this library isn't present anymore.
|
---|
[b358845] | 225 | <varlistentry id="libgpgme-pthread">
|
---|
[d6da5da] | 226 | <term><filename class="libraryfile">libgpgme-pthread.so</filename></term>
|
---|
[b358845] | 227 | <listitem>
|
---|
[d6da5da] | 228 | <para>
|
---|
| 229 | contains the <application>GPGME</application> API functions for
|
---|
| 230 | applications using pthread.
|
---|
| 231 | </para>
|
---|
[b358845] | 232 | <indexterm zone="gpgme libgpgme-pthread">
|
---|
[d6da5da] | 233 | <primary sortas="c-libgpgme-pthread">libgpgme-pthread.so</primary>
|
---|
[b358845] | 234 | </indexterm>
|
---|
| 235 | </listitem>
|
---|
| 236 | </varlistentry>
|
---|
[cd074c2] | 237 | -->
|
---|
[b358845] | 238 |
|
---|
| 239 | <varlistentry id="libgpgme">
|
---|
[d6da5da] | 240 | <term><filename class="libraryfile">libgpgme.so</filename></term>
|
---|
[b358845] | 241 | <listitem>
|
---|
[d6da5da] | 242 | <para>
|
---|
[4c24eb0a] | 243 | contains the <application>GPGME</application> API functions
|
---|
[d6da5da] | 244 | </para>
|
---|
[b358845] | 245 | <indexterm zone="gpgme libgpgme">
|
---|
[d6da5da] | 246 | <primary sortas="c-libgpgme">libgpgme.so</primary>
|
---|
[b358845] | 247 | </indexterm>
|
---|
| 248 | </listitem>
|
---|
| 249 | </varlistentry>
|
---|
| 250 |
|
---|
[48ad7d9] | 251 | <varlistentry id="libgpgmepp">
|
---|
| 252 | <term><filename class="libraryfile">libgpgmepp.so</filename></term>
|
---|
| 253 | <listitem>
|
---|
| 254 | <para>
|
---|
[4c24eb0a] | 255 | contains the C++ <application>GPGME</application> API functions
|
---|
[48ad7d9] | 256 | </para>
|
---|
| 257 | <indexterm zone="gpgme libgpgmepp">
|
---|
| 258 | <primary sortas="c-libgpgmepp">libgpgmepp.so</primary>
|
---|
| 259 | </indexterm>
|
---|
| 260 | </listitem>
|
---|
| 261 | </varlistentry>
|
---|
| 262 |
|
---|
[cd074c2] | 263 | <varlistentry id="libqgpgme">
|
---|
| 264 | <term><filename class="libraryfile">libqgpgme.so</filename></term>
|
---|
| 265 | <listitem>
|
---|
| 266 | <para>
|
---|
| 267 | contains API functions for handling GPG operations in
|
---|
[4c24eb0a] | 268 | <application>Qt</application> applications
|
---|
[cd074c2] | 269 | </para>
|
---|
| 270 | <indexterm zone="gpgme libqgpgme">
|
---|
| 271 | <primary sortas="c-libqgpgme">libqgpgme.so</primary>
|
---|
| 272 | </indexterm>
|
---|
| 273 | </listitem>
|
---|
| 274 | </varlistentry>
|
---|
| 275 |
|
---|
[b358845] | 276 | </variablelist>
|
---|
| 277 |
|
---|
| 278 | </sect2>
|
---|
| 279 |
|
---|
| 280 | </sect1>
|
---|