source: general/genlib/libgcrypt.xml@ 45ab6c7

11.0 lazarus qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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