source: general/genlib/libgcrypt.xml@ bc131697

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 bc131697 was 18aa9339, checked in by Douglas R. Reno <renodr@…>, 16 months ago

Lots of tags for X
  • 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 <!ENTITY libgcrypt-download-ftp "&gnupg-ftp;/libgcrypt/libgcrypt-&libgcrypt-version;.tar.bz2">
9 <!ENTITY libgcrypt-download-ftp " ">
10 <!ENTITY libgcrypt-md5sum "8fadbe1fddafa341dce5ef3869f70e25">
11 <!ENTITY libgcrypt-size "3.6 MB">
12 <!ENTITY libgcrypt-buildsize "130 MB (with tests and pdf documentation)">
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 <para>
108 The above commands build the documentation in html and plaintext
109 formats. If you wish to build alternate formats of the documentation, you
110 need <xref linkend="texlive"/> (or <xref linkend="tl-installer"/>). Issue
111 the following command:
112 </para>
113
114<screen remap="doc"><userinput>make -C doc pdf</userinput></screen>
115
116 <para>
117 To test the results, issue: <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 &amp;&amp;
125install -v -dm755 /usr/share/doc/libgcrypt-&libgcrypt-version; &amp;&amp;
126install -v -m644 README doc/{README.apichanges,fips*,libgcrypt*} \
127 /usr/share/doc/libgcrypt-&libgcrypt-version; &amp;&amp;
128
129install -v -dm755 /usr/share/doc/libgcrypt-&libgcrypt-version;/html &amp;&amp;
130install -v -m644 doc/gcrypt.html/* \
131 /usr/share/doc/libgcrypt-&libgcrypt-version;/html &amp;&amp;
132install -v -m644 doc/gcrypt_nochunks.html \
133 /usr/share/doc/libgcrypt-&libgcrypt-version; &amp;&amp;
134install -v -m644 doc/gcrypt.{txt,texi} \
135 /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>
136
137 <para>
138 If you built alternate formats of the documentation, install them by
139 issuing the following command as the
140 <systemitem class="username">root</systemitem> user:
141 </para>
142
143<screen role="root"
144 remap="doc"><userinput>install -v -m644 doc/gcrypt.{pdf,ps,dvi} \
145 /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>
146
147 </sect2>
148
149 <sect2 role="commands">
150 <title>Command Explanations</title>
151
152 <para>
153 <option>--with-capabilities</option>: This option enables libcap2 support.
154 Note that this breaks <xref linkend="cryptsetup"/>
155 </para>
156
157 </sect2>
158
159 <sect2 role="content">
160 <title>Contents</title>
161
162 <segmentedlist>
163 <segtitle>Installed Programs</segtitle>
164 <segtitle>Installed Library</segtitle>
165 <segtitle>Installed Directory</segtitle>
166
167 <seglistitem>
168 <seg>
169 dumpsexp, hmac256, libgcrypt-config, and mpicalc
170 </seg>
171 <seg>
172 libgcrypt.so
173 </seg>
174 <seg>
175 /usr/share/doc/libgcrypt-&libgcrypt-version;
176 </seg>
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
185 <varlistentry id="dumpsexp">
186 <term><command>dumpsexp</command></term>
187 <listitem>
188 <para>
189 is a debug tool for S-expressions
190 </para>
191 <indexterm zone="libgcrypt dumpsexp">
192 <primary sortas="b-dumpsexp">dumpsexp</primary>
193 </indexterm>
194 </listitem>
195 </varlistentry>
196
197 <varlistentry id="hmac256">
198 <term><command>hmac256</command></term>
199 <listitem>
200 <para>
201 is a standalone HMAC-SHA-256 implementation used to compute
202 an HMAC-SHA-256 authentication code
203 </para>
204 <indexterm zone="libgcrypt hmac256">
205 <primary sortas="b-hmac256">hmac256</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209
210 <varlistentry id="libgcrypt-config">
211 <term><command>libgcrypt-config</command></term>
212 <listitem>
213 <para>
214 determines the compile and linker flags that should be used to
215 compile and link programs that use <filename class="libraryfile">libgcrypt</filename>
216 </para>
217 <indexterm zone="libgcrypt libgcrypt-config">
218 <primary sortas="b-libgcrypt-config">libgcrypt-config</primary>
219 </indexterm>
220 </listitem>
221 </varlistentry>
222
223 <varlistentry id="mpicalc">
224 <term><command>mpicalc</command></term>
225 <listitem>
226 <para>
227 is a RPN (Reverse Polish Notation) calculator
228 </para>
229 <indexterm zone="libgcrypt mpicalc">
230 <primary sortas="b-mpicalc">mpicalc</primary>
231 </indexterm>
232 </listitem>
233 </varlistentry>
234
235 <varlistentry id="libgcrypt-lib">
236 <term><filename class="libraryfile">libgcrypt.so</filename></term>
237 <listitem>
238 <para>
239 contains the cryptographic API functions
240 </para>
241 <indexterm zone="libgcrypt libgcrypt-lib">
242 <primary sortas="c-libgcrypt">libgcrypt.so</primary>
243 </indexterm>
244 </listitem>
245 </varlistentry>
246
247 </variablelist>
248
249 </sect2>
250
251</sect1>
Note: See TracBrowser for help on using the repository browser.