source: networking/netlibs/serf.xml@ 46491e5

<?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 serf-download-http "https://serf.googlecode.com/files/serf-&serf-version;.tar.bz2">
  <!ENTITY serf-download-ftp  " ">
  <!ENTITY serf-md5sum        "bb0dbf9494495db7e8b34eac99b2dc3a">
  <!ENTITY serf-size          "133 KB">
  <!ENTITY serf-buildsize     "3.0 MB">
  <!ENTITY serf-time          "0.1 SBU">
]>

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

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

  <title>Serf-&serf-version;</title>

  <indexterm zone="serf">
    <primary sortas="a-Serf">Serf</primary>
  </indexterm>

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

    <para>
      The <application>Serf</application> package contains a C-based HTTP client
      library built upon the Apache Portable Runtime (APR) library. It
      multiplexes connections, running the read/write communication asynchronously.
      Memory copies and transformations are kept to a minimum to provide high
      performance operation.
    </para>

    &lfs73_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="apr-util"/>,
      <xref linkend="openssl"/> and
      <xref linkend="scons"/>
    </para>

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

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

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

<screen><userinput>sed -i "/incdir/s:MAJOR':&amp;\n\nenv\['SHLIBVERSION'\]='0.\${MAJOR}.0':" SConstruct &amp;&amp;
sed -i "/Append/s:RPATH=libdir,::" SConstruct &amp;&amp;
sed -i "/Default/s:lib_static,::" SConstruct &amp;&amp;
sed -i "/Alias/s:install_static,::" SConstruct &amp;&amp;
scons PREFIX=/usr</userinput></screen>

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

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>scons PREFIX=/usr install &amp;&amp;
ln -sfv libserf-1.so.0.1.0 /usr/lib/libserf-1.so.0 &amp;&amp;
ln -sfv libserf-1.so.0.1.0 /usr/lib/libserf-1.so</userinput></screen>

  </sect2>

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

    <para>
      <command>sed -i "..."</command>: First sed modifies the build script
      to build shared versioned library, second sed removes runtime path
      from shared library and third and fourth sed disable building and
      installing of the static library.
    </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>
          libserf-1.so
        </seg>
        <seg>
          /usr/include/serf-1
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libserf-1">
        <term><filename class="libraryfile">libserf-1.so</filename></term>
        <listitem>
          <para>
            contains the <application>Serf</application> API functions.
          </para>
          <indexterm zone="serf libserf-1">
            <primary sortas="c-libserf-1">libserf-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>