glfs/networking/netlibs/neon.xml

<?xml version="1.0" encoding="UTF-8"?>
<!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-&neon-version;.tar.gz"> -->
  <!ENTITY neon-download-http "https://notroj.github.io/neon/neon-&neon-version;.tar.gz">
  <!ENTITY neon-download-ftp  " ">
  <!ENTITY neon-md5sum        "7976b1cd67b7228cddb7eb4f39640ac5">
  <!ENTITY neon-size          "876 KB">
  <!ENTITY neon-buildsize     "8.6 MB (additional 18 MB for tests)">
  <!ENTITY neon-time          "0.1 SBU (add 0.4 SBU for tests)">
]>

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


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

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

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

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

    &lfs120_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">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gnutls"/>,
      <xref linkend="libxml2"/>,
      <xref linkend="mitkrb"/>,
      <xref linkend="nss"/> (for some tests),
      <xref linkend="xmlto"/> (to regenerate the documentation),
      <ulink url="https://github.com/libproxy/libproxy">libproxy</ulink>, and
      <ulink url="https://www.manyfish.co.uk/pakchois/">PaKChoiS</ulink>
    </para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of neon</title>
<!-- Not needed for 0.32.2
    <para>
      The build mechanism tries to recreate the documentation even
      though its included in the archive. Recreating would require
      <application>xmlto</application> to be installed. Apply the
      following sed to not recreate the docs:
    </para>

<screen><userinput>sed 's/\(install-\(html\|man\):\).*/\1/' -i Makefile.in</userinput></screen>
-->
    <para>
      Install <application>neon</application> by running the following
      commands:
    </para>

<screen><userinput>./configure --prefix=/usr    \
            --with-ssl       \
            --enable-shared  \
            --disable-static &amp;&amp;
make</userinput></screen>

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

    <para>
      If you wish to regenerate the documentation, issue:
    </para>

<screen remap="doc"><userinput>make docs</userinput></screen>

    <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>--with-ssl</parameter>: This switch enables SSL support
      using <application>OpenSSL</application>.
      <application>GnuTLS</application> can be used instead, by passing
      <option>--with-ssl=gnutls</option> and
      <option>--with-ca-bundle=/etc/pki/tls/certs/ca-bundle.crt</option> to the
      <command>configure</command> script.
    </para>

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

<!-- We have Expat in LFS now, so this really isn't applicable anymore.
    <para>
      <option>- -with-libxml2</option>: This switch forces the use of
      <application>libxml2</application> instead of
      <application>Expat</application>.
    </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 and
          /usr/share/doc/neon-&neon-version;
        </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 that provides information about an installed copy
            of the neon 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>