source: general/genlib/libassuan.xml@ f1e103a

<?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 libassuan-download-http " ">
  <!ENTITY libassuan-download-ftp  "ftp://ftp.gnupg.org/gcrypt/libassuan/libassuan-&libassuan-version;.tar.bz2">
  <!ENTITY libassuan-md5sum        "59bc0ae7194c412d7a522029005684b2">
  <!ENTITY libassuan-size          "291 KB">
  <!ENTITY libassuan-buildsize     "4 MB">
  <!ENTITY libassuan-time          "less than 0.1 SBU">
]>

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

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

  <title>Libassuan-&libassuan-version;</title>

  <indexterm zone="libassuan">
    <primary sortas="a-Libassuan">Libassuan</primary>
  </indexterm>

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

    <para>The <application>Libassuan</application> package contains an IPC
    library used by some of the other <application>GnuPG</application> related
    packages. <application>Libassuan</application>'s primary use is to allow a
    client to interact with a non-persistent server.
    <application>Libassuan</application> is not, however, limited to use with
    <application>GnuPG</application> servers and clients. It was designed to be
    flexible enough to meet the demands of many transaction based environments
    with non-persistent servers.</para>

    &lfs65_checked;

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

    <bridgehead renderas="sect3">Libassuan 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="pth"/></para>

    <para>Other packages (such as <application>GnuPG-2</application>) will
    require that the <application>Libassuan</application> library is linked to
    the <application>Pth</application> library. Ensure
    <application>Pth</application> is installed before beginning the build if
    you have any doubts.</para>

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

  </sect2>

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

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

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

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

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

<screen><userinput>make -k -C doc pdf ps 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 &amp;&amp;

install -v -m755 -d /usr/share/doc/libassuan-&libassuan-version; &amp;&amp;
install -v -m644    README doc/{assuan{_nochunks.html,.txt,.texi \
                    /usr/share/doc/libassuan-&libassuan-version;</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 -m644 doc/assuan.html/* \
                 /usr/share/doc/libassuan-&libassuan-version;/html &amp;&amp;
install -v -m644 doc/assuan.{pdf,ps,dvi} \
                 /usr/share/doc/libassuan-&libassuan-version;</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>libassuan-config</seg>
        <seg>libassuan.a and libassuan-pth.a</seg>
        <seg>/usr/share/doc/libassuan-&libassuan-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libassuan-config">
        <term><command>libassuan-config</command></term>
        <listitem>
          <para>is a utility used to configure and build applications based on
          the libassuan(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 libassuan(3) library.</para>
          <indexterm zone="libassuan libassuan-config">
            <primary sortas="b-libassuan-config">libassuan-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libassuan-lib">
        <term><filename class='libraryfile'>libassuan.a</filename></term>
        <listitem>
          <para>is the IPC library.</para>
          <indexterm zone="libassuan libassuan-lib">
            <primary sortas="c-libassuan">libassuan.a</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libassuan-pth">
        <term><filename class='libraryfile'>libassuan-pth.a</filename></term>
        <listitem>
          <para>is the IPC library linked with the GNU Portable Threads
          Library.</para>
          <indexterm zone="libassuan libassuan-pth">
            <primary sortas="c-libassuan-pth">libassuan-pth.a</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>