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