source: general/genlib/libgcrypt.xml@ ba4e992

10.0 10.1 11.0 11.1 8.4 9.0 9.1 lazarus qt5new trunk upgradedb xry111/intltool xry111/test-20220226
Last change on this file since ba4e992 was ba4e992, checked in by Bruce Dubbs <bdubbs@…>, 3 years ago

More tags

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@21160 af4574ff-66df-0310-9fd7-8a98e5e911e0

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