source: general/genlib/libuv.xml@ ed345e7

<?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 libuv-download-http "https://dist.libuv.org/dist/v&libuv-version;/libuv-v&libuv-version;.tar.gz">
  <!ENTITY libuv-download-ftp  " ">
  <!ENTITY libuv-md5sum        "fa56dafe664d21f9568adebc428d2d64">
  <!ENTITY libuv-size          "1.2 MB">
  <!ENTITY libuv-buildsize     "14 MB (add 14 MB for tests)">
  <!ENTITY libuv-time          "less than 0.1 SBU (add 0.5 SBU for tests)">
]>

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


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

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

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

    <para>
      The <application>libuv</application> package is a
      multi-platform support library with a focus on asynchronous I/O.
    </para>

    &lfs120_checked;

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="???"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="???"/>
    </para>
-->
  </sect2>

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

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

    <caution>
      <para>
        The <command>sh autogen.sh</command> command below fails if the ACLOCAL
        environment variable is set as specified in <xref linkend="xorg7"/>.
        If it is used, ACLOCAL needs to be unset for this package and then
        reset for other packages.
      </para>
    </caution>

<!--
Don't use cmake here to avoid circular dependency

<screen><userinput>sed -i "/TARGETS uv_a ARCHIVE/d" CMakeLists.txt &amp;&amp;

mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=/usr .. &amp;&amp;
make </userinput></screen>
-->

<screen><userinput>sh autogen.sh                              &amp;&amp;
./configure --prefix=/usr --disable-static &amp;&amp;
make </userinput></screen>
<!--
    <para>
      If you want to run the tests, add -DBUILD_TESTING=true to
      the cmake line above and after building run:
      <command>make test</command>.
    </para>
-->
    <para>
      If you want to run the tests, run: <command>make check</command> as
      a non-root user. <!-- the test suite refuses to run as root -->
    </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>
      <command>sed ...</command>: This command disables installation
      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>
          libuv.so
        </seg>
        <seg>
          /usr/include/uv
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libuv.so">
        <term><filename class="libraryfile">libuv.so</filename></term>
        <listitem>
          <para>
            contains API functions for asynchronous I/O operations
          </para>
          <indexterm zone="libuv libuv.so">
            <primary sortas="c-libuv.so">libuv.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>