source: general/genlib/apr.xml@ 86b3ae3

<?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 apr-download-http
    "https://archive.apache.org/dist/apr/apr-&apr-version;.tar.bz2">
  <!ENTITY apr-download-ftp  " ">
  <!ENTITY apr-md5sum        "f8a62f3984898ba0ea8b6f26b851cb99">
  <!ENTITY apr-size          "876 KB">
  <!ENTITY apr-buildsize     "11 MB (additional 4 MB for the tests)">
  <!ENTITY apr-time          "0.1 SBU (add 1.4 SBU for tests)">
]>

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


  <title>Apr-&apr-version;</title>

  <indexterm zone="apr">
    <primary sortas="a-apr">Apr</primary>
  </indexterm>

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

    <para>
      The Apache Portable Runtime (APR) is a supporting library for the
      Apache web server. It provides a set of application programming interfaces
      (APIs) that map to the underlying Operating System (OS). Where the OS
      doesn't support a particular function, APR will provide an emulation. Thus
      programmers can use the APR to make a program portable across different
      platforms.
    </para>

    &lfs120_checked;

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

  </sect2>

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

<!--
    <para>
      First, fix a security issue:
    </para>
<!- -
<screen><userinput>sed '/{306/a \
\
    if (xt-&gt;tm_mon &lt; 0 || xt-&gt;tm_mon &gt;= 12) \
        return APR_EBADDATE;' -i time/unix/time.c</userinput></screen>
- ->
<screen><userinput>sed -e "/shift/i \
\    if (xt-&gt;tm_mon &lt; 0 || xt-&gt;tm_mon &gt;= 12) return APR_EBADDATE;" \
    -i time/unix/time.c</userinput></screen>
-->
<!--
    <para>
      Fix an issue checking a location in a script template:
    </para>
<screen><userinput>sed -e '/^case "$0"/s;$0;$(readlink -f $0);' \
    -i apr-config.in</userinput></screen>
-->
    <para>
      Install <application>Apr</application> by running the following commands:
    </para>

<screen><userinput>./configure --prefix=/usr    \
            --disable-static \
            --with-installbuilddir=/usr/share/apr-1/build &amp;&amp;
make</userinput></screen>

    <para>
      To test the results, issue: <command>make test</command>. <!-- teststr is
      known to hang on some systems. - WORKS AS OF 1.6.5 (renodr) -->
    </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>

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

  </sect2>

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

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

      <seglistitem>
        <seg>
          apr-1-config
        </seg>
        <seg>
          libapr-1.so
        </seg>
        <seg>
          /usr/include/apr-1 and
          /usr/share/apr-1
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="apr-1-config">
        <term><command>apr-1-config</command></term>
        <listitem>
          <para>
            is a shell script used to retrieve information about the apr
            library in the system. It is typically used to compile and link
            against the library
          </para>
          <indexterm zone="apr apr-1-config">
            <primary sortas="b-apr-1-config">apr-1-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libapr-1">
        <term><filename class="libraryfile">libapr-1.so</filename></term>
        <listitem>
          <para>
            is the Apache Portable Runtime library
          </para>
          <indexterm zone="apr libapr-1">
            <primary sortas="c-libapr-1">libapr-1.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>

  </sect2>

</sect1>