source: networking/netlibs/neon.xml@ 9cf2b10b

<?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 neon-download-http "http://www.webdav.org/neon/neon-0.29.6.tar.gz">
  <!ENTITY neon-download-ftp  " ">
  <!ENTITY neon-md5sum        "591e0c82e6979e7e615211b386b8f6bc">
  <!ENTITY neon-size          "862 KB">
  <!ENTITY neon-buildsize     "26 MB">
  <!ENTITY neon-time          "0.1 SBU">
]>

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

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

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

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

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

    <para>The <application>neon</application> package is an HTTP and WebDAV
    client library, with a C interface.</para>

    &lfs71_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libxml2"/> or
    <xref linkend="expat"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="openssl"/> or
      <xref linkend="gnutls"/>,
      <ulink url="http://code.google.com/p/libproxy/">Libproxy</ulink>
      (requires <xref linkend="pkgconfig"/> to find it),
      <xref linkend="mitkrb"/> and
      <ulink url="http://www.manyfish.co.uk/pakchois/">pakchois</ulink>.
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --enable-shared --disable-static &amp;&amp;
make</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>

  </sect2>

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

    <para><parameter>--enable-shared</parameter>: This parameter is needed to
    build the shared libraries, otherwise only static libraries are built and
    installed.</para>

    <para><parameter>--disable-static</parameter>: This parameter prevents the
    static libraries being installed.</para>

    <para><option>--with-ssl=openssl</option>: This option enables SSL support
    using <application>openssl</application>.</para>

    <para><option>--with-ssl=gnutls</option>: This option enables SSL support
    using <application>gnutls</application>.</para>

    <para><option>--with-libxml2</option>: This option forces the use of
    <application>libxml2</application>.</para>

    <para><option>--with-expat</option>: This option forces the use of
    <application>expat</application>.</para>

    <para>If you wish to use the other optional dependencies, consult the
    output of <command>./configure --help</command>.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>neon-config</seg>
        <seg>libneon.so</seg>
        <seg>/usr/{include/neon,share/doc/neon-0.29.6/html}</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="neon-config">
        <term><command>neon-config</command></term>
        <listitem>
          <para>is a script which provides information about an installed copy
          of the <application>neon</application> library.</para>
          <indexterm zone="neon neon-config">
            <primary sortas="b-neon-config">neon-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libneon">
        <term><filename class='libraryfile'>libneon.so</filename></term>
        <listitem>
          <para>is used as a high-level interface to common HTTP and WebDAV
          methods.</para>
          <indexterm zone="neon libneon">
            <primary sortas="c-libneon">libneon.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>