source: general/genlib/libksba.xml@ 96e0c171

<?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 libksba-download-http "&gnupg-http;/libksba/libksba-&libksba-version;.tar.bz2">
  <!ENTITY libksba-download-ftp  " ">
  <!ENTITY libksba-md5sum        "17a0b93de57cd91c7e3264b107723092">
  <!ENTITY libksba-size          "656 KB">
  <!ENTITY libksba-buildsize     "10 MB (with tests)">
  <!ENTITY libksba-time          "0.1 SBU (with tests)">
]>

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


  <title>libksba-&libksba-version;</title>

  <indexterm zone="libksba">
    <primary sortas="a-libksba">libksba</primary>
  </indexterm>

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

    <para>
      The <application>Libksba</application> package contains a library
      used to make X.509 certificates as well as making the CMS (Cryptographic
      Message Syntax) easily accessible by other applications. Both
      specifications are building blocks of S/MIME and TLS. The library does
      not rely on another cryptographic library but provides hooks for easy
      integration with <application>Libgcrypt</application>.
    </para>

    &lfs120_checked;

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

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="valgrind"/>
    </para>


  </sect2>

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

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

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

makeinfo - -html - -no-split -o doc/ksba_nochunks.html doc/ksba.texi &amp;&amp;
makeinfo - -plaintext       -o doc/ksba.txt           doc/ksba.texi</userinput></screen>

    <para>
      If you wish to build alternate formats of the documentation, you
      must have <xref linkend="texlive"/> installed,
      then issue the following commands:
    </para>

<screen remap="doc"><userinput>make -C doc ps pdf html</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</userinput></screen><!-- &amp;&amp;

install -v -m755 -d /usr/share/doc/libksba-&libksba-version; &amp;&amp;
install -v -m644    README doc/ksba{_nochunks.html,.txt,.texi} \
                    /usr/share/doc/libksba-&libksba-version;</userinput></screen>

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

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

  </sect2>

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

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

      <seglistitem>
        <seg><!--ksba-config not in 1.6.3-->None</seg>
        <seg>libksba.so</seg>
        <seg>None<!--/usr/share/doc/libksba-&libksba-version;--></seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>
      <!--
      <varlistentry id="ksba-config">
        <term><command>ksba-config</command></term>
        <listitem>
          <para>
            is a utility used to configure and build applications based on
            the libksba(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 libksba(3) library
          </para>
          <indexterm zone="libksba ksba-config">
            <primary sortas="b-ksba-config">ksba-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      -->
      <varlistentry id="libksba-lib">
        <term><filename class="libraryfile">libksba.{so,a}</filename></term>
        <listitem>
          <para>
            contains the cryptographic API functions
          </para>
          <indexterm zone="libksba libksba-lib">
            <primary sortas="c-libksba">libksba.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>