[5ef6186] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 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 |
|
---|
[e27c5c5d] | 7 | <!ENTITY libevent-source "https://github.com/libevent/libevent/releases/download">
|
---|
| 8 |
|
---|
| 9 | <!ENTITY libevent-download-http "&libevent-source;/release-&libevent-version;-stable/libevent-&libevent-version;-stable.tar.gz">
|
---|
[5ef6186] | 10 | <!ENTITY libevent-download-ftp " ">
|
---|
[b2bd6604] | 11 | <!ENTITY libevent-md5sum "b5333f021f880fe76490d8a799cd79f4">
|
---|
[0732d97d] | 12 | <!ENTITY libevent-size "1.0 MB">
|
---|
[3591ad9] | 13 | <!ENTITY libevent-buildsize "20 MB (add 4 MB for tests and 4 MB for API docs)">
|
---|
| 14 | <!ENTITY libevent-time "0.3 SBU (add 11 SBU for tests)">
|
---|
[5ef6186] | 15 | ]>
|
---|
| 16 |
|
---|
| 17 | <sect1 id="libevent" xreflabel="libevent-&libevent-version;">
|
---|
| 18 | <?dbhtml filename="libevent.html"?>
|
---|
| 19 |
|
---|
| 20 | <sect1info>
|
---|
| 21 | <date>$Date$</date>
|
---|
| 22 | </sect1info>
|
---|
| 23 |
|
---|
| 24 | <title>libevent-&libevent-version;</title>
|
---|
| 25 |
|
---|
| 26 | <indexterm zone="libevent">
|
---|
[ea21196] | 27 | <primary sortas="a-libevent">libevent</primary>
|
---|
[5ef6186] | 28 | </indexterm>
|
---|
| 29 |
|
---|
| 30 | <sect2 role="package">
|
---|
[ea21196] | 31 | <title>Introduction to libevent</title>
|
---|
[5ef6186] | 32 |
|
---|
| 33 | <para>
|
---|
[ea21196] | 34 | <application>libevent</application> is an asynchronous event notification
|
---|
| 35 | software library. The <application>libevent</application> API provides a
|
---|
| 36 | mechanism to execute a callback function when a specific event occurs on
|
---|
| 37 | a file descriptor or after a timeout has been reached. Furthermore,
|
---|
| 38 | <application>libevent</application> also supports callbacks due to
|
---|
| 39 | signals or regular timeouts.
|
---|
[5ef6186] | 40 | </para>
|
---|
| 41 |
|
---|
[d9622443] | 42 | &lfs111_checked;
|
---|
[5ef6186] | 43 |
|
---|
| 44 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 45 | <itemizedlist spacing="compact">
|
---|
| 46 | <listitem>
|
---|
| 47 | <para>
|
---|
| 48 | Download (HTTP): <ulink url="&libevent-download-http;"/>
|
---|
| 49 | </para>
|
---|
| 50 | </listitem>
|
---|
| 51 | <listitem>
|
---|
| 52 | <para>
|
---|
| 53 | Download (FTP): <ulink url="&libevent-download-ftp;"/>
|
---|
| 54 | </para>
|
---|
| 55 | </listitem>
|
---|
| 56 | <listitem>
|
---|
| 57 | <para>
|
---|
| 58 | Download MD5 sum: &libevent-md5sum;
|
---|
| 59 | </para>
|
---|
| 60 | </listitem>
|
---|
| 61 | <listitem>
|
---|
| 62 | <para>
|
---|
| 63 | Download size: &libevent-size;
|
---|
| 64 | </para>
|
---|
| 65 | </listitem>
|
---|
| 66 | <listitem>
|
---|
| 67 | <para>
|
---|
| 68 | Estimated disk space required: &libevent-buildsize;
|
---|
| 69 | </para>
|
---|
| 70 | </listitem>
|
---|
| 71 | <listitem>
|
---|
| 72 | <para>
|
---|
| 73 | Estimated build time: &libevent-time;
|
---|
| 74 | </para>
|
---|
| 75 | </listitem>
|
---|
| 76 | </itemizedlist>
|
---|
| 77 |
|
---|
[ea21196] | 78 | <bridgehead renderas="sect3">libevent Dependencies</bridgehead>
|
---|
[b1a45a4b] | 79 | <!-- Python3 ports of the rpcgen_event.py file were produced in 2.1.9 -->
|
---|
[94b42903] | 80 | <!--
|
---|
[5ef6186] | 81 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
[ea21196] | 82 | <para role="recommended">
|
---|
| 83 | <xref linkend="openssl"/>
|
---|
| 84 | </para>
|
---|
[94b42903] | 85 | -->
|
---|
[be00429] | 86 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 87 | <para role="optional">
|
---|
| 88 | <xref linkend="doxygen"/> (for API documentation)
|
---|
| 89 | </para>
|
---|
| 90 |
|
---|
[5ef6186] | 91 | <para condition="html" role="usernotes">
|
---|
| 92 | User Notes: <ulink url="&blfs-wiki;/libevent"/>
|
---|
| 93 | </para>
|
---|
| 94 | </sect2>
|
---|
| 95 |
|
---|
| 96 | <sect2 role="installation">
|
---|
[ea21196] | 97 | <title>Installation of libevent</title>
|
---|
[5ef6186] | 98 |
|
---|
[20e9b21] | 99 | <para>
|
---|
| 100 | First, fix an issue that prevents rpcgen_event.py from working:
|
---|
| 101 | </para>
|
---|
| 102 |
|
---|
| 103 | <screen><userinput remap="pre">sed -i 's/python/&3/' event_rpcgen.py</userinput></screen>
|
---|
| 104 |
|
---|
[5ef6186] | 105 | <para>
|
---|
[ea21196] | 106 | Install <application>libevent</application> by running the following
|
---|
[5ef6186] | 107 | commands:
|
---|
| 108 | </para>
|
---|
| 109 |
|
---|
[0732d97d] | 110 | <screen><userinput>./configure --prefix=/usr --disable-static &&
|
---|
[5ef6186] | 111 | make</userinput></screen>
|
---|
| 112 |
|
---|
[101030d] | 113 | <para>
|
---|
| 114 | If you have <xref linkend="doxygen"/> installed and wish to build API
|
---|
[a42c273] | 115 | documentation, issue :
|
---|
[101030d] | 116 | </para>
|
---|
| 117 |
|
---|
[a42c273] | 118 | <screen remap="doc"><userinput>doxygen Doxyfile</userinput></screen>
|
---|
| 119 |
|
---|
[5ef6186] | 120 | <para>
|
---|
[d9622443] | 121 | To test the results, issue: <command>make verify</command>. Six tests in
|
---|
| 122 | every suite related to <filename>regress_ssl.c</filename> and
|
---|
| 123 | <filename>regress_http.c</filename> are known to fail due to
|
---|
| 124 | incompatibilities with OpenSSL-3.
|
---|
[ea21196] | 125 | </para>
|
---|
[5ef6186] | 126 |
|
---|
| 127 | <para>
|
---|
| 128 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 129 | </para>
|
---|
| 130 |
|
---|
| 131 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
[101030d] | 132 |
|
---|
| 133 | <para>
|
---|
| 134 | If you built the API documentation, install it by issuing the following
|
---|
| 135 | commands as the <systemitem class="username">root</systemitem> user:
|
---|
| 136 | </para>
|
---|
| 137 |
|
---|
[a42c273] | 138 | <screen role="root"
|
---|
| 139 | remap="doc"><userinput>install -v -m755 -d /usr/share/doc/libevent-&libevent-version;/api &&
|
---|
[0732d97d] | 140 | cp -v -R doxygen/html/* \
|
---|
[101030d] | 141 | /usr/share/doc/libevent-&libevent-version;/api</userinput></screen>
|
---|
[5ef6186] | 142 | </sect2>
|
---|
[0732d97d] | 143 |
|
---|
[5ef6186] | 144 | <sect2 role="commands">
|
---|
| 145 | <title>Command Explanations</title>
|
---|
| 146 |
|
---|
| 147 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 148 | href="../../xincludes/static-libraries.xml"/>
|
---|
[ea21196] | 149 |
|
---|
[5ef6186] | 150 | </sect2>
|
---|
[0732d97d] | 151 |
|
---|
[5ef6186] | 152 | <sect2 role="content">
|
---|
| 153 | <title>Contents</title>
|
---|
| 154 |
|
---|
| 155 | <segmentedlist>
|
---|
| 156 | <segtitle>Installed Program</segtitle>
|
---|
| 157 | <segtitle>Installed Libraries</segtitle>
|
---|
| 158 | <segtitle>Installed Directory</segtitle>
|
---|
| 159 |
|
---|
| 160 | <seglistitem>
|
---|
[ea21196] | 161 | <seg>
|
---|
[0732d97d] | 162 | event_rpcgen.py
|
---|
[ea21196] | 163 | </seg>
|
---|
[5ef6186] | 164 | <seg>
|
---|
[0732d97d] | 165 | libevent_core.so,
|
---|
| 166 | libevent_extra.so,
|
---|
| 167 | libevent_openssl.so,
|
---|
| 168 | libevent_pthreads.so and
|
---|
| 169 | libevent.so
|
---|
[5ef6186] | 170 | </seg>
|
---|
[ea21196] | 171 | <seg>
|
---|
[0732d97d] | 172 | /usr/include/event2 and
|
---|
[d591de4] | 173 | /usr/share/doc/libevent-&libevent-version;
|
---|
[ea21196] | 174 | </seg>
|
---|
[5ef6186] | 175 | </seglistitem>
|
---|
| 176 | </segmentedlist>
|
---|
| 177 |
|
---|
| 178 | <!-- Who knows what these things do?
|
---|
| 179 | <variablelist>
|
---|
| 180 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 181 | <?dbfo list-presentation="list"?>
|
---|
| 182 | <?dbhtml list-presentation="table"?>
|
---|
| 183 |
|
---|
[0732d97d] | 184 | <varlistentry id="event_rpcgen.py">
|
---|
| 185 | <term><command>event_rpcgen.py</command></term>
|
---|
[5ef6186] | 186 | <listitem>
|
---|
| 187 | <para>
|
---|
[0732d97d] | 188 | does this .....
|
---|
[5ef6186] | 189 | </para>
|
---|
[0732d97d] | 190 | <indexterm zone="libevent event_rpcgen.py">
|
---|
| 191 | <primary sortas="b-event_rpcgen.py">event_rpcgen.py</primary>
|
---|
[5ef6186] | 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
| 196 | <varlistentry id="libevent_core">
|
---|
| 197 | <term><filename class="libraryfile">libevent_core.so</filename></term>
|
---|
| 198 | <listitem>
|
---|
| 199 | <para>
|
---|
| 200 | contains functions that .....
|
---|
| 201 | </para>
|
---|
| 202 | <indexterm zone="libevent libevent_core">
|
---|
| 203 | <primary sortas="c-libevent_core">libevent_core.so</primary>
|
---|
| 204 | </indexterm>
|
---|
| 205 | </listitem>
|
---|
| 206 | </varlistentry>
|
---|
| 207 | </variablelist>
|
---|
| 208 |
|
---|
| 209 | <varlistentry id="libevent_extra">
|
---|
| 210 | <term><filename class="libraryfile">libevent_extra.so</filename></term>
|
---|
| 211 | <listitem>
|
---|
| 212 | <para>
|
---|
| 213 | contains functions that .....
|
---|
| 214 | </para>
|
---|
| 215 | <indexterm zone="libevent libevent_extra">
|
---|
| 216 | <primary sortas="c-libevent_extra">libevent_extra.so</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
| 219 | </varlistentry>
|
---|
[0732d97d] | 220 | </variablelist>
|
---|
| 221 |
|
---|
| 222 | <varlistentry id="libevent_openssl">
|
---|
| 223 | <term><filename class="libraryfile">libevent_openssl.so</filename></term>
|
---|
| 224 | <listitem>
|
---|
| 225 | <para>
|
---|
| 226 | contains functions that .....
|
---|
| 227 | </para>
|
---|
| 228 | <indexterm zone="libevent libevent_openssl">
|
---|
| 229 | <primary sortas="c-libevent_openssl">libevent_openssl.so</primary>
|
---|
| 230 | </indexterm>
|
---|
| 231 | </listitem>
|
---|
| 232 | </varlistentry>
|
---|
| 233 | </variablelist>
|
---|
| 234 |
|
---|
| 235 | <varlistentry id="libevent_pthreads">
|
---|
| 236 | <term><filename class="libraryfile">libevent_pthreads.so</filename></term>
|
---|
| 237 | <listitem>
|
---|
| 238 | <para>
|
---|
| 239 | contains functions that .....
|
---|
| 240 | </para>
|
---|
| 241 | <indexterm zone="libevent libevent_pthreads">
|
---|
| 242 | <primary sortas="c-libevent_pthreads">libevent_pthreads.so</primary>
|
---|
| 243 | </indexterm>
|
---|
| 244 | </listitem>
|
---|
| 245 | </varlistentry>
|
---|
| 246 | </variablelist>
|
---|
| 247 |
|
---|
| 248 | <varlistentry id="libevent-lib">
|
---|
| 249 | <term><filename class="libraryfile">libevent.so</filename></term>
|
---|
| 250 | <listitem>
|
---|
| 251 | <para>
|
---|
| 252 | contains functions that .....
|
---|
| 253 | </para>
|
---|
| 254 | <indexterm zone="libevent libevent-lib">
|
---|
| 255 | <primary sortas="c-libevent">libevent.so</primary>
|
---|
| 256 | </indexterm>
|
---|
| 257 | </listitem>
|
---|
| 258 | </varlistentry>
|
---|
[ea21196] | 259 |
|
---|
[5ef6186] | 260 | </variablelist> -->
|
---|
[ea21196] | 261 |
|
---|
[5ef6186] | 262 | </sect2>
|
---|
[ea21196] | 263 |
|
---|
[5ef6186] | 264 | </sect1>
|
---|