source: archive/gnome/liboauth.xml@ 48b59802

<?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 liboauth-download-http "&sourceforge-repo;/liboauth/liboauth-&liboauth-version;.tar.gz">
  <!ENTITY liboauth-download-ftp  " ">
  <!ENTITY liboauth-md5sum        "46881d24bc7107dc0c66ef250f03d95e">
  <!ENTITY liboauth-size          "492 KB">
  <!ENTITY liboauth-buildsize     "3.5 MB">
  <!ENTITY liboauth-time          "less than 0.1 SBU">
]>

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

  <sect1info>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
      <application>liboauth</application> is a collection of POSIX-C functions
      implementing the OAuth Core RFC 5849 standard. Liboauth provides functions
      to escape and encode parameters according to OAuth specification and
      offers high-level functionality to sign requests or verify OAuth signatures
      as well as perform HTTP requests.
    </para>

    &lfs73_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="curl"/> and
      <xref linkend="openssl"/> or
      <xref linkend="nss"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="doxygen"/> (to build documentation).
    </para>

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

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

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

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

    <para>
      If you have <xref linkend="doxygen"/>, issue <command>make dox</command>
      to build documentation.
    </para>

    <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>

    <para>
      If you have built documentation previously, install it with following
      commands as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>mkdir -pv /usr/share/doc/liboauth-&liboauth-version; &amp;&amp;
cp -rv doc/html/* /usr/share/doc/liboauth-&liboauth-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/static-libraries.xml"/>

    <para>
      <option>--enable-nss</option>: Use this switch if you want to
      use Mozilla NSS instead of <application>OpenSSL</application>.
    </para>

  </sect2>

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

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          liboauth.so
        </seg>
        <seg>
          /usr/share/doc/liboauth-&liboauth-version;
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="liboauth-lib">
        <term><filename class="libraryfile">liboauth.so</filename></term>
        <listitem>
          <para>
            provides functions to escape and encode stings according to
            OAuth specifications and offers high-level functionality built
            on top to sign requests or verify signatures using either NSS or
            OpenSSL for calculating the hash/signatures.
          </para>
          <indexterm zone="liboauth liboauth-lib">
            <primary sortas="c-liboauth">liboauth.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>