source: general/genlib/libgcrypt.xml@ d284bee

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libgcrypt-download-http "&sources-anduin-http;/l/libgcrypt-&libgcrypt-version;.tar.bz2">
  <!ENTITY libgcrypt-download-ftp  "ftp://ftp.gnupg.org/gcrypt/libgcrypt/libgcrypt-&libgcrypt-version;.tar.bz2">
  <!ENTITY libgcrypt-md5sum        "34105aa927e23c217741966496b97e67">
  <!ENTITY libgcrypt-size          "1.1 MB">
  <!ENTITY libgcrypt-buildsize     "23 MB">
  <!ENTITY libgcrypt-time          "0.4 SBU (additional 0.8 SBU to run the test suite)">
]>

<sect1 id="libgcrypt" xreflabel="Libgcrypt-&libgcrypt-version;">
  <?dbhtml filename="libgcrypt.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Libgcrypt-&libgcrypt-version;</title>

  <indexterm zone="libgcrypt">
    <primary sortas="a-Libgcrypt">Libgcrypt</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Libgcrypt</title>

    <para>The <application>Libgcrypt</application> package contains a general
    purpose crypto library based on the code used in
    <application>GnuPG</application>. The library provides a high level
    interface to cryptographic building blocks using an extendable and flexible
    API.</para>

    &lfs65_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&libgcrypt-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&libgcrypt-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &libgcrypt-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &libgcrypt-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &libgcrypt-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &libgcrypt-time;</para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Libgcrypt Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libgpg-error"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><ulink url="http://www.kernel.org/pub/linux/libs/security/linux-privs/libcap2/">
    Linux Capabilities (libcap)</ulink></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/libgcrypt"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Libgcrypt</title>

    <para>Install <application>Libgcrypt</application> by running the
    following commands:</para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>Only <command>info</command> documentation is shipped in the package
    tarball. If you wish to build alternate formats of the documentation, you
    must have <xref linkend="tetex"/> installed (to build the PDF, PostScript
    and chunked HTML docs), then issue the following commands:</para>

<screen><userinput>make -C doc pdf ps html &amp;&amp;
makeinfo --html --no-split -o doc/gcrypt_nochunks.html doc/gcrypt.texi &amp;&amp;
makeinfo --plaintext       -o doc/gcrypt.txt           doc/gcrypt.texi</userinput></screen>

    <para>To test the results, issue: <command>make check</command>.</para>

    <para>Now, as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m644 -D README /usr/share/doc/libgcrypt-&libgcrypt-version;/README</userinput></screen>

    <para>If you built the additional documentation, install it by issuing the
    following commands as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/libgcrypt-&libgcrypt-version;/html &amp;&amp;
install -v -m644 doc/gcrypt.html/* \
                    /usr/share/doc/libgcrypt-&libgcrypt-version;/html &amp;&amp;
install -v -m644 doc/gcrypt_nochunks.html \
                    /usr/share/doc/libgcrypt-&libgcrypt-version; &amp;&amp;
install -v -m644 doc/gcrypt.{pdf,ps,dvi,txt,texi} \
                    /usr/share/doc/libgcrypt-&libgcrypt-version;</userinput></screen>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>dumpsexp, hmac256 and libgcrypt-config</seg>
        <seg>libgcrypt.{so,a}</seg>
        <seg>/usr/share/doc/libgcrypt-&libgcrypt-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libgcrypt-config">
        <term><command>libgcrypt-config</command></term>
        <listitem>
          <para>is a utility used to configure and build applications based on
          the libgcrypt(3) library. It can be used to query the C compiler and
          linker flags which are required to correctly compile and link the
          application against the libgcrypt(3) library.</para>
          <indexterm zone="libgcrypt libgcrypt-config">
            <primary sortas="b-libgcrypt-config">libgcrypt-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgcrypt-lib">
        <term><filename class='libraryfile'>libgcrypt.{so,a}</filename></term>
        <listitem>
          <para>contains the cryptographic API functions.</para>
          <indexterm zone="libgcrypt libgcrypt-lib">
            <primary sortas="c-libgcrypt">libgcrypt.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>