[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[6eb166fa] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[c92ba3b] | 7 | <!ENTITY libuv-download-http "https://dist.libuv.org/dist/v&libuv-version;/libuv-v&libuv-version;.tar.gz">
|
---|
[6eb166fa] | 8 | <!ENTITY libuv-download-ftp " ">
|
---|
[d7cd28a8] | 9 | <!ENTITY libuv-md5sum "add970d60a6f5942b948267a94353826">
|
---|
[450e20d] | 10 | <!ENTITY libuv-size "1.3 MB">
|
---|
[7a589152] | 11 | <!ENTITY libuv-buildsize "30 MB (with tests and man page)">
|
---|
[d7cd28a8] | 12 | <!ENTITY libuv-time "0.7 SBU (with tests and man page)">
|
---|
[6eb166fa] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libuv" xreflabel="libuv-&libuv-version;">
|
---|
| 16 | <?dbhtml filename="libuv.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>libuv-&libuv-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libuv">
|
---|
| 22 | <primary sortas="a-libuv">libuv</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to libuv</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
[8558044] | 29 | The <application>libuv</application> package is a
|
---|
[ac4d403] | 30 | multi-platform support library with a focus on asynchronous I/O.
|
---|
[6eb166fa] | 31 | </para>
|
---|
| 32 |
|
---|
[e375445] | 33 | &lfs122_checked;
|
---|
[6eb166fa] | 34 |
|
---|
| 35 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 36 | <itemizedlist spacing="compact">
|
---|
| 37 | <listitem>
|
---|
| 38 | <para>
|
---|
| 39 | Download (HTTP): <ulink url="&libuv-download-http;"/>
|
---|
| 40 | </para>
|
---|
| 41 | </listitem>
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (FTP): <ulink url="&libuv-download-ftp;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download MD5 sum: &libuv-md5sum;
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download size: &libuv-size;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Estimated disk space required: &libuv-buildsize;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated build time: &libuv-time;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | </itemizedlist>
|
---|
| 68 |
|
---|
[91a72fe] | 69 | <bridgehead renderas="sect3">libuv Dependencies</bridgehead>
|
---|
| 70 | <!--
|
---|
[6eb166fa] | 71 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 72 | <para role="required">
|
---|
[8558044] | 73 | <xref linkend="???"/>
|
---|
[6eb166fa] | 74 | </para>
|
---|
[91a72fe] | 75 | -->
|
---|
[6eb166fa] | 76 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 77 | <para role="optional">
|
---|
[91a72fe] | 78 | <xref linkend="sphinx"/>
|
---|
[6eb166fa] | 79 | </para>
|
---|
[91a72fe] | 80 |
|
---|
[6eb166fa] | 81 | </sect2>
|
---|
| 82 |
|
---|
| 83 | <sect2 role="installation">
|
---|
| 84 | <title>Installation of libuv</title>
|
---|
| 85 |
|
---|
| 86 | <para>
|
---|
| 87 | Install <application>libuv</application> by running the following
|
---|
| 88 | commands:
|
---|
| 89 | </para>
|
---|
[e05831c9] | 90 |
|
---|
| 91 | <caution>
|
---|
| 92 | <para>
|
---|
| 93 | The <command>sh autogen.sh</command> command below fails if the ACLOCAL
|
---|
| 94 | environment variable is set as specified in <xref linkend="xorg7"/>.
|
---|
| 95 | If it is used, ACLOCAL needs to be unset for this package and then
|
---|
| 96 | reset for other packages.
|
---|
| 97 | </para>
|
---|
| 98 | </caution>
|
---|
| 99 |
|
---|
[a1b1e9d4] | 100 | <!--
|
---|
| 101 | Don't use cmake here to avoid circular dependency
|
---|
[6eb166fa] | 102 |
|
---|
[fe80e96] | 103 | <screen><userinput>sed -i "/TARGETS uv_a ARCHIVE/d" CMakeLists.txt &&
|
---|
| 104 |
|
---|
| 105 | mkdir build &&
|
---|
| 106 | cd build &&
|
---|
| 107 |
|
---|
[cbfa153] | 108 | cmake -D CMAKE_INSTALL_PREFIX=/usr .. &&
|
---|
[a1b1e9d4] | 109 | make </userinput></screen>
|
---|
| 110 | -->
|
---|
| 111 |
|
---|
| 112 | <screen><userinput>sh autogen.sh &&
|
---|
| 113 | ./configure --prefix=/usr --disable-static &&
|
---|
[fe80e96] | 114 | make </userinput></screen>
|
---|
[91a72fe] | 115 |
|
---|
[6eb166fa] | 116 | <para>
|
---|
[91a72fe] | 117 | If you installed the optional <xref linkend="sphinx"/> python module,
|
---|
| 118 | create the man page:
|
---|
[6eb166fa] | 119 | </para>
|
---|
[91a72fe] | 120 |
|
---|
[d1d8cc44] | 121 | <screen remap="doc"><userinput>make man -C docs</userinput></screen>
|
---|
[91a72fe] | 122 |
|
---|
[e3885b4] | 123 | <para>
|
---|
[9c7363e] | 124 | If you want to run the tests, run: <command>make check</command> as
|
---|
| 125 | a non-root user. <!-- the test suite refuses to run as root -->
|
---|
[e3885b4] | 126 | </para>
|
---|
[91a72fe] | 127 |
|
---|
[6eb166fa] | 128 | <para>
|
---|
[91a72fe] | 129 | Now, as the &root; user:
|
---|
[6eb166fa] | 130 | </para>
|
---|
| 131 |
|
---|
| 132 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[91a72fe] | 133 |
|
---|
| 134 | <para>
|
---|
| 135 | If you built the man page, install it as the &root; user:
|
---|
| 136 | </para>
|
---|
| 137 |
|
---|
[d1d8cc44] | 138 | <screen role="root" remap="doc"><userinput>install -Dm644 docs/build/man/libuv.1 /usr/share/man/man1</userinput></screen>
|
---|
[6eb166fa] | 139 |
|
---|
| 140 | </sect2>
|
---|
| 141 |
|
---|
[a1b1e9d4] | 142 | <!--
|
---|
[6eb166fa] | 143 | <sect2 role="commands">
|
---|
| 144 | <title>Command Explanations</title>
|
---|
| 145 |
|
---|
[fe80e96] | 146 | <para>
|
---|
| 147 | <command>sed ...</command>: This command disables installation
|
---|
| 148 | of the static library.
|
---|
| 149 | </para>
|
---|
[8558044] | 150 |
|
---|
[6eb166fa] | 151 | </sect2>
|
---|
[a1b1e9d4] | 152 | -->
|
---|
[6eb166fa] | 153 | <sect2 role="content">
|
---|
| 154 | <title>Contents</title>
|
---|
| 155 |
|
---|
| 156 | <segmentedlist>
|
---|
| 157 | <segtitle>Installed Programs</segtitle>
|
---|
| 158 | <segtitle>Installed Library</segtitle>
|
---|
[5a66d6ac] | 159 | <segtitle>Installed Directory</segtitle>
|
---|
[6eb166fa] | 160 |
|
---|
| 161 | <seglistitem>
|
---|
| 162 | <seg>
|
---|
| 163 | None
|
---|
| 164 | </seg>
|
---|
| 165 | <seg>
|
---|
| 166 | libuv.so
|
---|
| 167 | </seg>
|
---|
| 168 | <seg>
|
---|
[5a66d6ac] | 169 | /usr/include/uv
|
---|
[6eb166fa] | 170 | </seg>
|
---|
| 171 | </seglistitem>
|
---|
| 172 | </segmentedlist>
|
---|
[5a66d6ac] | 173 |
|
---|
[6eb166fa] | 174 | <variablelist>
|
---|
| 175 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 176 | <?dbfo list-presentation="list"?>
|
---|
| 177 | <?dbhtml list-presentation="table"?>
|
---|
| 178 |
|
---|
| 179 | <varlistentry id="libuv.so">
|
---|
| 180 | <term><filename class="libraryfile">libuv.so</filename></term>
|
---|
| 181 | <listitem>
|
---|
| 182 | <para>
|
---|
[5a66d6ac] | 183 | contains API functions for asynchronous I/O operations
|
---|
[6eb166fa] | 184 | </para>
|
---|
| 185 | <indexterm zone="libuv libuv.so">
|
---|
| 186 | <primary sortas="c-libuv.so">libuv.so</primary>
|
---|
| 187 | </indexterm>
|
---|
| 188 | </listitem>
|
---|
| 189 | </varlistentry>
|
---|
| 190 |
|
---|
| 191 | </variablelist>
|
---|
[5a66d6ac] | 192 |
|
---|
[6eb166fa] | 193 | </sect2>
|
---|
| 194 |
|
---|
| 195 | </sect1>
|
---|