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