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