source: general/genlib/libgcrypt.xml@ ef37a4d4

12.0 12.1 kea ken/TL2024 ken/tuningfonts lazarus lxqt plabs/newcss python3.11 qt5new rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18 xry111/xf86-video-removal
Last change on this file since ef37a4d4 was ef37a4d4, checked in by Bruce Dubbs <bdubbs@…>, 13 months ago

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