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