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