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 libgcrypt-download-http " ">
|
---|
8 | <!ENTITY libgcrypt-download-ftp "ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-&libgcrypt-version;.tar.bz2">
|
---|
9 | <!ENTITY libgcrypt-md5sum "4262c3aadf837500756c2051a5c4ae5e">
|
---|
10 | <!ENTITY libgcrypt-size "2.4 MB">
|
---|
11 | <!ENTITY libgcrypt-buildsize "38 MB (additional 7 MB for docs)">
|
---|
12 | <!ENTITY libgcrypt-time "0.3 SBU (additional 0.1 SBU for docs and
|
---|
13 | 0.3 SBU for tests)">
|
---|
14 | ]>
|
---|
15 |
|
---|
16 | <sect1 id="libgcrypt" xreflabel="libgcrypt-&libgcrypt-version;">
|
---|
17 | <?dbhtml filename="libgcrypt.html"?>
|
---|
18 |
|
---|
19 | <sect1info>
|
---|
20 | <othername>$LastChangedBy$</othername>
|
---|
21 | <date>$Date$</date>
|
---|
22 | </sect1info>
|
---|
23 |
|
---|
24 | <title>libgcrypt-&libgcrypt-version;</title>
|
---|
25 |
|
---|
26 | <indexterm zone="libgcrypt">
|
---|
27 | <primary sortas="a-libgcrypt">libgcrypt</primary>
|
---|
28 | </indexterm>
|
---|
29 |
|
---|
30 | <sect2 role="package">
|
---|
31 | <title>Introduction to libgcrypt</title>
|
---|
32 |
|
---|
33 | <para>
|
---|
34 | The <application>libgcrypt</application> package contains a general
|
---|
35 | purpose crypto library based on the code used in
|
---|
36 | <application>GnuPG</application>. The library provides a high level
|
---|
37 | interface to cryptographic building blocks using an extendable and flexible
|
---|
38 | API.
|
---|
39 | </para>
|
---|
40 |
|
---|
41 | &lfs77_checked; &gcc5_checked;
|
---|
42 |
|
---|
43 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
44 | <itemizedlist spacing="compact">
|
---|
45 | <listitem>
|
---|
46 | <para>
|
---|
47 | Download (HTTP): <ulink url="&libgcrypt-download-http;"/>
|
---|
48 | </para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>
|
---|
52 | Download (FTP): <ulink url="&libgcrypt-download-ftp;"/>
|
---|
53 | </para>
|
---|
54 | </listitem>
|
---|
55 | <listitem>
|
---|
56 | <para>
|
---|
57 | Download MD5 sum: &libgcrypt-md5sum;
|
---|
58 | </para>
|
---|
59 | </listitem>
|
---|
60 | <listitem>
|
---|
61 | <para>
|
---|
62 | Download size: &libgcrypt-size;
|
---|
63 | </para>
|
---|
64 | </listitem>
|
---|
65 | <listitem>
|
---|
66 | <para>
|
---|
67 | Estimated disk space required: &libgcrypt-buildsize;
|
---|
68 | </para>
|
---|
69 | </listitem>
|
---|
70 | <listitem>
|
---|
71 | <para>
|
---|
72 | Estimated build time: &libgcrypt-time;
|
---|
73 | </para>
|
---|
74 | </listitem>
|
---|
75 | </itemizedlist>
|
---|
76 |
|
---|
77 | <bridgehead renderas="sect3">libgcrypt Dependencies</bridgehead>
|
---|
78 |
|
---|
79 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
80 | <para role="required">
|
---|
81 | <xref linkend="libgpg-error"/>
|
---|
82 | </para>
|
---|
83 |
|
---|
84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
85 | <para role="optional">
|
---|
86 | <xref linkend="libcap-pam"/> and
|
---|
87 | <xref linkend="pth"/>,
|
---|
88 | <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>)
|
---|
89 | </para>
|
---|
90 |
|
---|
91 | <para condition="html" role="usernotes">User Notes:
|
---|
92 | <ulink url="&blfs-wiki;/libgcrypt"/>
|
---|
93 | </para>
|
---|
94 | </sect2>
|
---|
95 |
|
---|
96 | <sect2 role="installation">
|
---|
97 | <title>Installation of libgcrypt</title>
|
---|
98 |
|
---|
99 | <para>
|
---|
100 | Install <application>libgcrypt</application> by running the
|
---|
101 | following commands:
|
---|
102 | </para>
|
---|
103 |
|
---|
104 | <screen><userinput>./configure --prefix=/usr &&
|
---|
105 | make</userinput></screen>
|
---|
106 |
|
---|
107 | <para>
|
---|
108 | Only <command>info</command> documentation is shipped in the package
|
---|
109 | tarball. If you wish to build alternate formats of the documentation,
|
---|
110 | (you must have <xref linkend="texlive"/> installed to build the PDF
|
---|
111 | and PostScript documentation), then issue the following commands:
|
---|
112 | </para>
|
---|
113 |
|
---|
114 | <screen><userinput>make -j1 -C doc pdf ps html &&
|
---|
115 | makeinfo --html --no-split -o doc/gcrypt_nochunks.html doc/gcrypt.texi &&
|
---|
116 | makeinfo --plaintext -o doc/gcrypt.txt doc/gcrypt.texi</userinput></screen>
|
---|
117 |
|
---|
118 | <para>
|
---|
119 | To test the results, issue: <command>make check</command>.
|
---|
120 | </para>
|
---|
121 |
|
---|
122 | <para>
|
---|
123 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
124 | </para>
|
---|
125 |
|
---|
126 | <screen role="root"><userinput>make install &&
|
---|
127 | install -v -dm755 /usr/share/doc/libgcrypt-&libgcrypt-version; &&
|
---|
128 | install -v -m644 README doc/{README.apichanges,fips*,libgcrypt*} \
|
---|
129 | /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>
|
---|
130 |
|
---|
131 | <para>
|
---|
132 | If you built the additional documentation, install it by issuing the
|
---|
133 | following commands as the <systemitem class="username">root</systemitem>
|
---|
134 | user:
|
---|
135 | </para>
|
---|
136 |
|
---|
137 | <screen role="root"><userinput>install -v -dm755 /usr/share/doc/libgcrypt-&libgcrypt-version;/html &&
|
---|
138 | install -v -m644 doc/gcrypt.html/* \
|
---|
139 | /usr/share/doc/libgcrypt-&libgcrypt-version;/html &&
|
---|
140 | install -v -m644 doc/gcrypt_nochunks.html \
|
---|
141 | /usr/share/doc/libgcrypt-&libgcrypt-version; &&
|
---|
142 | install -v -m644 doc/gcrypt.{pdf,ps,dvi,txt,texi} \
|
---|
143 | /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>
|
---|
144 |
|
---|
145 | </sect2>
|
---|
146 |
|
---|
147 | <sect2 role="commands">
|
---|
148 | <title>Command Explanations</title>
|
---|
149 |
|
---|
150 | <para>
|
---|
151 | <option>--with-capabilities</option>: This option enables libcap2 support.
|
---|
152 | </para>
|
---|
153 |
|
---|
154 | </sect2>
|
---|
155 |
|
---|
156 | <sect2 role="content">
|
---|
157 | <title>Contents</title>
|
---|
158 |
|
---|
159 | <segmentedlist>
|
---|
160 | <segtitle>Installed Programs</segtitle>
|
---|
161 | <segtitle>Installed Library</segtitle>
|
---|
162 | <segtitle>Installed Directory</segtitle>
|
---|
163 |
|
---|
164 | <seglistitem>
|
---|
165 | <seg>
|
---|
166 | dumpsexp, hmac256, libgcrypt-config, and mpicalc
|
---|
167 | </seg>
|
---|
168 | <seg>
|
---|
169 | libgcrypt.so
|
---|
170 | </seg>
|
---|
171 | <seg>
|
---|
172 | /usr/share/doc/libgcrypt-&libgcrypt-version;
|
---|
173 | </seg>
|
---|
174 | </seglistitem>
|
---|
175 | </segmentedlist>
|
---|
176 |
|
---|
177 | <variablelist>
|
---|
178 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
179 | <?dbfo list-presentation="list"?>
|
---|
180 | <?dbhtml list-presentation="table"?>
|
---|
181 |
|
---|
182 | <varlistentry id="dumpsexp">
|
---|
183 | <term><command>dumpsexp</command></term>
|
---|
184 | <listitem>
|
---|
185 | <para>
|
---|
186 | is a debug tool for S-expressions.
|
---|
187 | </para>
|
---|
188 | <indexterm zone="libgcrypt dumpsexp">
|
---|
189 | <primary sortas="b-dumpsexp">dumpsexp</primary>
|
---|
190 | </indexterm>
|
---|
191 | </listitem>
|
---|
192 | </varlistentry>
|
---|
193 |
|
---|
194 | <varlistentry id="hmac256">
|
---|
195 | <term><command>hmac256</command></term>
|
---|
196 | <listitem>
|
---|
197 | <para>
|
---|
198 | is a standalone HMAC-SHA-256 implementation used to compute
|
---|
199 | an HMAC-SHA-256 authentication code.
|
---|
200 | </para>
|
---|
201 | <indexterm zone="libgcrypt hmac256">
|
---|
202 | <primary sortas="b-hmac256">hmac256</primary>
|
---|
203 | </indexterm>
|
---|
204 | </listitem>
|
---|
205 | </varlistentry>
|
---|
206 |
|
---|
207 | <varlistentry id="libgcrypt-config">
|
---|
208 | <term><command>libgcrypt-config</command></term>
|
---|
209 | <listitem>
|
---|
210 | <para>
|
---|
211 | determines the compile and linker flags that should be used to
|
---|
212 | compile and link programs that use <filename class="libraryfile">libgcrypt</filename>.
|
---|
213 | </para>
|
---|
214 | <indexterm zone="libgcrypt libgcrypt-config">
|
---|
215 | <primary sortas="b-libgcrypt-config">libgcrypt-config</primary>
|
---|
216 | </indexterm>
|
---|
217 | </listitem>
|
---|
218 | </varlistentry>
|
---|
219 |
|
---|
220 | <varlistentry id="mpicalc">
|
---|
221 | <term><command>mpicalc</command></term>
|
---|
222 | <listitem>
|
---|
223 | <para>
|
---|
224 | is a RPN (Reverse Polish Notation) calculator.
|
---|
225 | </para>
|
---|
226 | <indexterm zone="libgcrypt mpicalc">
|
---|
227 | <primary sortas="b-mpicalc">mpicalc</primary>
|
---|
228 | </indexterm>
|
---|
229 | </listitem>
|
---|
230 | </varlistentry>
|
---|
231 |
|
---|
232 | <varlistentry id="libgcrypt-lib">
|
---|
233 | <term><filename class="libraryfile">libgcrypt.so</filename></term>
|
---|
234 | <listitem>
|
---|
235 | <para>
|
---|
236 | contains the cryptographic API functions.
|
---|
237 | </para>
|
---|
238 | <indexterm zone="libgcrypt libgcrypt-lib">
|
---|
239 | <primary sortas="c-libgcrypt">libgcrypt.so</primary>
|
---|
240 | </indexterm>
|
---|
241 | </listitem>
|
---|
242 | </varlistentry>
|
---|
243 |
|
---|
244 | </variablelist>
|
---|
245 |
|
---|
246 | </sect2>
|
---|
247 |
|
---|
248 | </sect1>
|
---|