source: basicnet/netlibs/wvstreams.xml@ ebabf24

10.0 10.1 11.0 6.2 6.2.0 6.2.0-rc1 6.2.0-rc2 6.3 6.3-rc1 6.3-rc2 6.3-rc3 7.10 7.4 7.5 7.6 7.6-blfs 7.6-systemd 7.7 7.8 7.9 8.0 8.1 8.2 8.3 8.4 9.0 9.1 basic bdubbs/svn elogind gnome kde5-13430 kde5-14269 kde5-14686 ken/refactor-virt krejzi/svn lazarus nosym perl-modules qt5new systemd-11177 systemd-13485 trunk xry111/git-date xry111/git-date-for-trunk xry111/git-date-test
Last change on this file since ebabf24 was ebabf24, checked in by Randy McMurchy <randy@…>, 15 years ago

Moved the last two xinclude files in the root of the book's sources to the global xinclude directory

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

  • Property mode set to 100644
File size: 11.7 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4 <!ENTITY % general-entities SYSTEM "../../general.ent">
5 %general-entities;
6
7 <!ENTITY wvstreams-download-http "http://open.nit.ca/download/wvstreams-&wvstreams-version;.tar.gz">
8 <!ENTITY wvstreams-download-ftp " ">
9 <!ENTITY wvstreams-md5sum "103230cb9926cb8f3f4d8dc8584f3b9c">
10 <!ENTITY wvstreams-size "1.2 MB">
11 <!ENTITY wvstreams-buildsize "46 MB (additional 44 MB to install documentation)">
12 <!ENTITY wvstreams-time "0.8 SBU (additional 1.9 SBU to build documentation)">
13]>
14
15<sect1 id="wvstreams" xreflabel="WvStreams-&wvstreams-version;">
16 <?dbhtml filename="wvstreams.html"?>
17
18 <sect1info>
19 <othername>$LastChangedBy$</othername>
20 <date>$Date$</date>
21 </sect1info>
22
23 <title>WvStreams-&wvstreams-version;</title>
24
25 <indexterm zone="wvstreams">
26 <primary sortas="a-WvStreams">WvStreams</primary>
27 </indexterm>
28
29 <sect2 role="package">
30 <title>Introduction to WvStreams</title>
31
32 <para><application>WvStreams</application> is a library suite containing
33 platform-independent C++ networking and utilities libraries for rapid
34 application development.</para>
35
36 <bridgehead renderas="sect3">Package Information</bridgehead>
37 <itemizedlist spacing='compact'>
38 <listitem>
39 <para>Download (HTTP): <ulink url="&wvstreams-download-http;"/></para>
40 </listitem>
41 <listitem>
42 <para>Download (FTP): <ulink url="&wvstreams-download-ftp;"/></para>
43 </listitem>
44 <listitem>
45 <para>Download MD5 sum: &wvstreams-md5sum;</para>
46 </listitem>
47 <listitem>
48 <para>Download size: &wvstreams-size;</para>
49 </listitem>
50 <listitem>
51 <para>Estimated disk space required: &wvstreams-buildsize;</para>
52 </listitem>
53 <listitem>
54 <para>Estimated build time: &wvstreams-time;</para>
55 </listitem>
56 </itemizedlist>
57
58 <bridgehead renderas="sect3">WvStreams Dependencies</bridgehead>
59
60 <bridgehead renderas="sect4">Required</bridgehead>
61 <para role="required"><xref linkend="openssl"/></para>
62
63 <bridgehead renderas="sect4">Optional</bridgehead>
64 <para role="optional"><xref linkend="pkgconfig"/>,
65 <xref linkend="gamin"/>,
66 <!-- <xref linkend="db"/>, -->
67 <xref linkend="linux-pam"/>,
68 <xref linkend="tcl"/>,
69 <xref linkend="qt"/>,
70 <xref linkend="speex"/>,
71 <xref linkend="libvorbis"/>,
72 <xref linkend="doxygen"/>,
73 <ulink url="http://www.fftw.org/">FFTW-2.<replaceable>&lt;X&gt;</replaceable></ulink>,
74 <ulink url="http://www.swig.org">SWIG</ulink>,
75 <ulink url="http://qdbm.sourceforge.net/">QDBM</ulink>,
76 <ulink url="http://www.openslp.org/">OpenSLP</ulink>,
77 <ulink url="http://xplc.sourceforge.net/">XPLC</ulink>,
78 <ulink url="http://valgrind.kde.org/">Valgrind</ulink>, and
79 <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>
80
81 <para condition="html" role="usernotes">User Notes:
82 <ulink url="&blfs-wiki;/wvstreams"/></para>
83
84 </sect2>
85
86 <sect2 role="installation">
87 <title>Installation of WvStreams</title>
88
89 <para>If you have <application>Tcl</application> and
90 <application>SWIG</application> installed and wish to utilize them, run the
91 following:</para>
92
93<screen><userinput>sed -i -e "s/8_3/8_4/" -e "s/8\.3/8.4/" \
94 configure{,.ac} include/wvautoconf.h.in bindings/rules.mk \
95 gnulib/config.h</userinput></screen>
96
97 <para>Install <application>WvStreams</application> by running the following
98 commands:</para>
99
100<screen><userinput>./configure --prefix=/usr \
101 --sysconfdir=/etc --localstatedir=/var &amp;&amp;
102make</userinput></screen>
103
104 <para>If <application>Doxygen</application> is installed and you wish to build
105 the API documentation, issue the following command:</para>
106
107<screen><userinput>make doxygen</userinput></screen>
108
109 <para>To test the results, issue: <command>make test</command>.</para>
110
111 <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
112
113<screen role='root'><userinput>make install</userinput></screen>
114
115 <para>If you built the API documentation, install it using the following commands:</para>
116
117<screen role='root'><userinput>install -v -d -m755 /usr/share/doc/wvstreams-&wvstreams-version;/doxy-html &amp;&amp;
118install -v -m644 Docs/doxy-html/* \
119 /usr/share/doc/wvstreams-&wvstreams-version;/doxy-html</userinput></screen>
120
121 </sect2>
122
123 <sect2 role="commands">
124 <title>Command Explanations</title>
125
126 <para><command>sed -i ...</command>: Change to tcl8.4 from tcl8.3.</para>
127
128 <para><parameter>--sysconfdir=/etc</parameter>: This parameter places
129 configuration files in <filename class='directory'>/etc</filename> instead of
130 <filename class='directory'>/usr/etc</filename>.</para>
131
132 <para><parameter>--localstatedir=/var</parameter>: This parameter places
133 <command>uniconfd</command> run-time files in
134 <filename class='directory'>/var/lib</filename> instead of
135 <filename class='directory'>/usr/var/lib</filename>.</para>
136
137 </sect2>
138
139 <sect2 role="configuration">
140 <title>Configuring WvStreams</title>
141
142 <sect3 id="wvstreams-config">
143 <title>Config Files</title>
144
145 <para><filename>/etc/uniconf.conf</filename></para>
146
147 <indexterm zone="wvstreams wvstreams-config">
148 <primary sortas="e-etc-uniconf.conf">/etc/uniconf.conf</primary>
149 </indexterm>
150
151 </sect3>
152
153 <sect3>
154 <title>Configuration Information</title>
155
156 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
157 href="../../xincludes/lib-config.xml"/>
158
159 </sect3>
160
161 </sect2>
162
163 <sect2 role="content">
164 <title>Contents</title>
165
166 <segmentedlist>
167 <segtitle>Installed Programs</segtitle>
168 <segtitle>Installed Libraries</segtitle>
169 <segtitle>Installed Directories</segtitle>
170
171 <seglistitem>
172 <seg>uni and uniconfd</seg>
173 <seg>libuniconf.{so,a}, libwvbase.{so,a}, libwvfft.{so,a},
174 libwvoggspeex.{so,a}, libwvoggvorbis.{so,a}, libwvqt.{so,a},
175 libwvstreams.{so,a}, libwvtelephony.{so,a}, libwvutils.{so,a} and
176 libxplc-cxx.a</seg>
177 <seg>/usr/include/wvstreams, /usr/share/doc/wvstreams-&wvstreams-version; and
178 /var/lib/uniconf</seg>
179 </seglistitem>
180 </segmentedlist>
181
182 <variablelist>
183 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
184 <?dbfo list-presentation="list"?>
185 <?dbhtml list-presentation="table"?>
186
187 <varlistentry id="uni">
188 <term><command>uni</command></term>
189 <listitem>
190 <para>is a program to interface with the UniConf configuration system.</para>
191 <indexterm zone="wvstreams uni">
192 <primary sortas="b-uni">uni</primary>
193 </indexterm>
194 </listitem>
195 </varlistentry>
196
197 <varlistentry id="uniconfd">
198 <term><command>uniconfd</command></term>
199 <listitem>
200 <para>is a daemon program for the UniConf configuration system.</para>
201 <indexterm zone="wvstreams uniconfd">
202 <primary sortas="b-uniconfd">uniconfd</primary>
203 </indexterm>
204 </listitem>
205 </varlistentry>
206
207 <varlistentry id="libuniconf">
208 <term><filename class='libraryfile'>libuniconf.{so,a}</filename></term>
209 <listitem>
210 <para>contains functions that define a hierarchical registry
211 abstraction in the UniConf configuration system.</para>
212 <indexterm zone="wvstreams libuniconf">
213 <primary sortas="c-libuniconf">libuniconf.{so,a}</primary>
214 </indexterm>
215 </listitem>
216 </varlistentry>
217
218 <varlistentry id="libwvbase">
219 <term><filename class='libraryfile'>libwvbase.{so,a}</filename></term>
220 <listitem>
221 <para>contains the Base64 encoder and decoder implementations functions.</para>
222 <indexterm zone="wvstreams libwvbase">
223 <primary sortas="c-libwvbase">libwvbase.{so,a}</primary>
224 </indexterm>
225 </listitem>
226 </varlistentry>
227
228 <varlistentry id="libwvfft">
229 <term><filename class='libraryfile'>libwvfft.{so,a}</filename></term>
230 <listitem>
231 <para>enables <application>WvStreams</application> programs to
232 easily handle Fast-Fourier transforms, instead of forcing the programmer to
233 use the much harder to use <filename class="libraryfile">libfftw</filename>
234 interface.</para>
235 <indexterm zone="wvstreams libwvfft">
236 <primary sortas="c-libwvfft">libwvfft.{so,a}</primary>
237 </indexterm>
238 </listitem>
239 </varlistentry>
240
241 <varlistentry id="libwvoggspeex">
242 <term><filename class='libraryfile'>libwvoggspeex.{so,a}</filename></term>
243 <listitem>
244 <para>enables quick and painless creation of audio streams using
245 the <application>Speex</application> Voice over
246 IP CODEC.</para>
247 <indexterm zone="wvstreams libwvoggspeex">
248 <primary sortas="c-libwvoggspeex">libwvoggspeex.{so,a}</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="libwvoggvorbis">
254 <term><filename class='libraryfile'>libwvoggvorbis.{so,a}</filename></term>
255 <listitem>
256 <para>enables quick and painless creation of audio streams using
257 the OggVorbis CODEC.</para>
258 <indexterm zone="wvstreams libwvoggvorbis">
259 <primary sortas="c-libwvoggvorbis">libwvoggvorbis.{so,a}</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="libwvqt">
265 <term><filename class='libraryfile'>libwvqt.{so,a}</filename></term>
266 <listitem>
267 <para>enables <application>WvStreams</application> to act as the
268 I/O and configuration back end for <application>Qt</application> and
269 <application>KDE</application>.</para>
270 <indexterm zone="wvstreams libwvqt">
271 <primary sortas="c-libwvqt">libwvqt.{so,a}</primary>
272 </indexterm>
273 </listitem>
274 </varlistentry>
275
276 <varlistentry id="libwvstreams">
277 <term><filename class='libraryfile'>libwvstreams.{so,a}</filename></term>
278 <listitem>
279 <para>provides functions for basic streaming I/O support.</para>
280 <indexterm zone="wvstreams libwvstreams">
281 <primary sortas="c-libwvstreams">libwvstreams.{so,a}</primary>
282 </indexterm>
283 </listitem>
284 </varlistentry>
285
286 <varlistentry id="libtelephony">
287 <term><filename class='libraryfile'>libtelephony.{so,a}</filename></term>
288 <listitem>
289 <para>contains telephony function routines such as echo
290 cancellation, dc offset removal, automatic gain control, etc.</para>
291 <indexterm zone="wvstreams libtelephony">
292 <primary sortas="c-libtelephony">libtelephony.{so,a}</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="libwvutils">
298 <term><filename class='libraryfile'>libwvutils.{so,a}</filename></term>
299 <listitem>
300 <para>contains functions required by the
301 <application>WvStreams</application> libraries and utility programs.</para>
302 <indexterm zone="wvstreams libwvutils">
303 <primary sortas="c-libwvutils">libwvutils.{so,a}</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="libxplc-cxx">
309 <term><filename class='libraryfile'>libxplc-cxx.a</filename></term>
310 <listitem>
311 <para>contains helper functions for the C++
312 <application>WvStreams</application> bindings.</para>
313 <indexterm zone="wvstreams libxplc-cxx">
314 <primary sortas="c-libxplc-cxx">libxplc-cxx.a</primary>
315 </indexterm>
316 </listitem>
317 </varlistentry>
318
319 </variablelist>
320
321 </sect2>
322
323</sect1>
Note: See TracBrowser for help on using the repository browser.