source: basicnet/netlibs/wvstreams.xml@ 9f12e36

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 9f12e36 was 9f12e36, checked in by Randy McMurchy <randy@…>, 15 years ago

Removed 'keywordset' blocks and extra spaces from the XML files (note this was by accident as I meant to do just in the gnome directory but I was in the root of BOOK when I ran the script, but this was going to happen anyway so I don't think it is a big deal)

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

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