source: networking/netlibs/libevent.xml@ 5e8edab5

elogind
Last change on this file since 5e8edab5 was 5e8edab5, checked in by DJ Lucas <dj@…>, 2 years ago

Merge to HEAD 21618.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/BOOK-elogind@21619 af4574ff-66df-0310-9fd7-8a98e5e911e0

  • Property mode set to 100644
File size: 7.6 KB
Line 
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
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 "f3eeaed018542963b7d2416ef1135ecc">
12 <!ENTITY libevent-size "1.0 MB">
13 <!ENTITY libevent-buildsize "18 MB (add 1 MB for the tests and 6 MB for the API docs)">
14 <!ENTITY libevent-time "0.3 SBU (add 10 SBU for the tests)">
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">
28 <primary sortas="a-libevent">libevent</primary>
29 </indexterm>
30
31 <sect2 role="package">
32 <title>Introduction to libevent</title>
33
34 <para>
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.
41 </para>
42
43 &lfs84_checked;
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
79 <bridgehead renderas="sect3">libevent Dependencies</bridgehead>
80<!--
81 <bridgehead renderas="sect4">Recommended</bridgehead>
82 <para role="recommended">
83 <xref linkend="openssl"/>
84 </para>
85-->
86 <bridgehead renderas="sect4">Optional</bridgehead>
87 <para role="optional">
88 <xref linkend="doxygen"/> (for API documentation)
89 </para>
90
91 <para condition="html" role="usernotes">
92 User Notes: <ulink url="&blfs-wiki;/libevent"/>
93 </para>
94 </sect2>
95
96 <sect2 role="installation">
97 <title>Installation of libevent</title>
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 &amp;&amp;
105make</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>.
116 </para>
117
118 <para>
119 Now, as the <systemitem class="username">root</systemitem> user:
120 </para>
121
122<screen role="root"><userinput>make install</userinput></screen>
123
124 <para>
125 If you built the API documentation, install it by issuing the following
126 commands as the <systemitem class="username">root</systemitem> user:
127 </para>
128
129<screen role="root"
130 remap="doc"><userinput>install -v -m755 -d /usr/share/doc/libevent-&libevent-version;/api &amp;&amp;
131cp -v -R doxygen/html/* \
132 /usr/share/doc/libevent-&libevent-version;/api</userinput></screen>
133 </sect2>
134
135 <sect2 role="commands">
136 <title>Command Explanations</title>
137
138 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
139 href="../../xincludes/static-libraries.xml"/>
140
141 </sect2>
142
143 <sect2 role="content">
144 <title>Contents</title>
145
146 <segmentedlist>
147 <segtitle>Installed Program</segtitle>
148 <segtitle>Installed Libraries</segtitle>
149 <segtitle>Installed Directory</segtitle>
150
151 <seglistitem>
152 <seg>
153 event_rpcgen.py
154 </seg>
155 <seg>
156 libevent_core.so,
157 libevent_extra.so,
158 libevent_openssl.so,
159 libevent_pthreads.so and
160 libevent.so
161 </seg>
162 <seg>
163 /usr/include/event2 and
164 /usr/share/doc/libevent-&libevent-version;
165 </seg>
166 </seglistitem>
167 </segmentedlist>
168
169 <!-- Who knows what these things do?
170 <variablelist>
171 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
172 <?dbfo list-presentation="list"?>
173 <?dbhtml list-presentation="table"?>
174
175 <varlistentry id="event_rpcgen.py">
176 <term><command>event_rpcgen.py</command></term>
177 <listitem>
178 <para>
179 does this .....
180 </para>
181 <indexterm zone="libevent event_rpcgen.py">
182 <primary sortas="b-event_rpcgen.py">event_rpcgen.py</primary>
183 </indexterm>
184 </listitem>
185 </varlistentry>
186
187 <varlistentry id="libevent_core">
188 <term><filename class="libraryfile">libevent_core.so</filename></term>
189 <listitem>
190 <para>
191 contains functions that .....
192 </para>
193 <indexterm zone="libevent libevent_core">
194 <primary sortas="c-libevent_core">libevent_core.so</primary>
195 </indexterm>
196 </listitem>
197 </varlistentry>
198 </variablelist>
199
200 <varlistentry id="libevent_extra">
201 <term><filename class="libraryfile">libevent_extra.so</filename></term>
202 <listitem>
203 <para>
204 contains functions that .....
205 </para>
206 <indexterm zone="libevent libevent_extra">
207 <primary sortas="c-libevent_extra">libevent_extra.so</primary>
208 </indexterm>
209 </listitem>
210 </varlistentry>
211 </variablelist>
212
213 <varlistentry id="libevent_openssl">
214 <term><filename class="libraryfile">libevent_openssl.so</filename></term>
215 <listitem>
216 <para>
217 contains functions that .....
218 </para>
219 <indexterm zone="libevent libevent_openssl">
220 <primary sortas="c-libevent_openssl">libevent_openssl.so</primary>
221 </indexterm>
222 </listitem>
223 </varlistentry>
224 </variablelist>
225
226 <varlistentry id="libevent_pthreads">
227 <term><filename class="libraryfile">libevent_pthreads.so</filename></term>
228 <listitem>
229 <para>
230 contains functions that .....
231 </para>
232 <indexterm zone="libevent libevent_pthreads">
233 <primary sortas="c-libevent_pthreads">libevent_pthreads.so</primary>
234 </indexterm>
235 </listitem>
236 </varlistentry>
237 </variablelist>
238
239 <varlistentry id="libevent-lib">
240 <term><filename class="libraryfile">libevent.so</filename></term>
241 <listitem>
242 <para>
243 contains functions that .....
244 </para>
245 <indexterm zone="libevent libevent-lib">
246 <primary sortas="c-libevent">libevent.so</primary>
247 </indexterm>
248 </listitem>
249 </varlistentry>
250
251 </variablelist> -->
252
253 </sect2>
254
255</sect1>
Note: See TracBrowser for help on using the repository browser.