[3c88826] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[ff769b8c] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[a2d8572] | 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
[7e5804f] | 6 |
|
---|
| 7 | <!ENTITY wvstreams-download-http "http://open.nit.ca/download/wvstreams-&wvstreams-version;.tar.gz">
|
---|
[08802956] | 8 | <!ENTITY wvstreams-download-ftp " ">
|
---|
[58147907] | 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)">
|
---|
[a2d8572] | 13 | ]>
|
---|
| 14 |
|
---|
[377584f] | 15 | <sect1 id="wvstreams" xreflabel="WvStreams-&wvstreams-version;">
|
---|
[3c88826] | 16 | <?dbhtml filename="wvstreams.html"?>
|
---|
[dc775a26] | 17 |
|
---|
[3c88826] | 18 | <sect1info>
|
---|
| 19 | <othername>$LastChangedBy$</othername>
|
---|
| 20 | <date>$Date$</date>
|
---|
| 21 | </sect1info>
|
---|
[dc775a26] | 22 |
|
---|
[3c88826] | 23 | <title>WvStreams-&wvstreams-version;</title>
|
---|
[dc775a26] | 24 |
|
---|
[3c88826] | 25 | <indexterm zone="wvstreams">
|
---|
| 26 | <primary sortas="a-WvStreams">WvStreams</primary>
|
---|
| 27 | </indexterm>
|
---|
[dc775a26] | 28 |
|
---|
[3c88826] | 29 | <sect2 role="package">
|
---|
| 30 | <title>Introduction to WvStreams</title>
|
---|
[dc775a26] | 31 |
|
---|
[2ca26748] | 32 | <para><application>WvStreams</application> is a library suite containing
|
---|
[3c88826] | 33 | platform-independent C++ networking and utilities libraries for rapid
|
---|
| 34 | application development.</para>
|
---|
[dc775a26] | 35 |
|
---|
[3c88826] | 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>
|
---|
[dc775a26] | 57 |
|
---|
[3c88826] | 58 | <bridgehead renderas="sect3">WvStreams Dependencies</bridgehead>
|
---|
[dc775a26] | 59 |
|
---|
[3c88826] | 60 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
[4dbbf634] | 61 | <para role="required"><xref linkend="openssl"/></para>
|
---|
[dc775a26] | 62 |
|
---|
[3c88826] | 63 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
[4dbbf634] | 64 | <para role="optional"><xref linkend="pkgconfig"/>,
|
---|
[b7ea972] | 65 | <xref linkend="gamin"/>,
|
---|
[3f87e4a] | 66 | <!-- <xref linkend="db"/>, -->
|
---|
[6603f8b] | 67 | <xref linkend="linux-pam"/>,
|
---|
[2ca26748] | 68 | <xref linkend="tcl"/>,
|
---|
| 69 | <xref linkend="qt"/>,
|
---|
| 70 | <xref linkend="speex"/>,
|
---|
| 71 | <xref linkend="libvorbis"/>,
|
---|
| 72 | <xref linkend="doxygen"/>,
|
---|
[061ec9d] | 73 | <ulink url="http://www.fftw.org/">FFTW-2.<replaceable><X></replaceable></ulink>,
|
---|
[2ca26748] | 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>,
|
---|
[3f87e4a] | 78 | <ulink url="http://valgrind.kde.org/">Valgrind</ulink>, and
|
---|
[3c88826] | 79 | <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>
|
---|
[dc775a26] | 80 |
|
---|
[061ec9d] | 81 | <para condition="html" role="usernotes">User Notes:
|
---|
| 82 | <ulink url="&blfs-wiki;/wvstreams"/></para>
|
---|
| 83 |
|
---|
[3c88826] | 84 | </sect2>
|
---|
[dc775a26] | 85 |
|
---|
[3c88826] | 86 | <sect2 role="installation">
|
---|
| 87 | <title>Installation of WvStreams</title>
|
---|
[dc775a26] | 88 |
|
---|
[2ca26748] | 89 | <para>If you have <application>Tcl</application> and
|
---|
[58147907] | 90 | <application>SWIG</application> installed and wish to utilize them, run the
|
---|
| 91 | following:</para>
|
---|
[dc775a26] | 92 |
|
---|
[58147907] | 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>
|
---|
[dc775a26] | 96 |
|
---|
[2ca26748] | 97 | <para>Install <application>WvStreams</application> by running the following
|
---|
[3c88826] | 98 | commands:</para>
|
---|
[dc775a26] | 99 |
|
---|
[3c88826] | 100 | <screen><userinput>./configure --prefix=/usr \
|
---|
[7e5804f] | 101 | --sysconfdir=/etc --localstatedir=/var &&
|
---|
[3c88826] | 102 | make</userinput></screen>
|
---|
[dc775a26] | 103 |
|
---|
[2ca26748] | 104 | <para>If <application>Doxygen</application> is installed and you wish to build
|
---|
[3c88826] | 105 | the API documentation, issue the following command:</para>
|
---|
[dc775a26] | 106 |
|
---|
[3c88826] | 107 | <screen><userinput>make doxygen</userinput></screen>
|
---|
[dc775a26] | 108 |
|
---|
[ebabf24] | 109 | <para>To test the results, issue: <command>make test</command>.</para>
|
---|
| 110 |
|
---|
[3c88826] | 111 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
[dc775a26] | 112 |
|
---|
[3c88826] | 113 | <screen role='root'><userinput>make install</userinput></screen>
|
---|
[dc775a26] | 114 |
|
---|
[3c88826] | 115 | <para>If you built the API documentation, install it using the following commands:</para>
|
---|
[dc775a26] | 116 |
|
---|
[2ca26748] | 117 | <screen role='root'><userinput>install -v -d -m755 /usr/share/doc/wvstreams-&wvstreams-version;/doxy-html &&
|
---|
[7e5804f] | 118 | install -v -m644 Docs/doxy-html/* \
|
---|
[3c88826] | 119 | /usr/share/doc/wvstreams-&wvstreams-version;/doxy-html</userinput></screen>
|
---|
[dc775a26] | 120 |
|
---|
[3c88826] | 121 | </sect2>
|
---|
[dc775a26] | 122 |
|
---|
[3c88826] | 123 | <sect2 role="commands">
|
---|
| 124 | <title>Command Explanations</title>
|
---|
[dc775a26] | 125 |
|
---|
[9f12e36] | 126 | <para><command>sed -i ...</command>: Change to tcl8.4 from tcl8.3.</para>
|
---|
[58147907] | 127 |
|
---|
[2ca26748] | 128 | <para><parameter>--sysconfdir=/etc</parameter>: This parameter places
|
---|
| 129 | configuration files in <filename class='directory'>/etc</filename> instead of
|
---|
[3c88826] | 130 | <filename class='directory'>/usr/etc</filename>.</para>
|
---|
[dc775a26] | 131 |
|
---|
[2ca26748] | 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
|
---|
[3c88826] | 135 | <filename class='directory'>/usr/var/lib</filename>.</para>
|
---|
[dc775a26] | 136 |
|
---|
[3c88826] | 137 | </sect2>
|
---|
[dc775a26] | 138 |
|
---|
[3c88826] | 139 | <sect2 role="configuration">
|
---|
| 140 | <title>Configuring WvStreams</title>
|
---|
[dc775a26] | 141 |
|
---|
[3c88826] | 142 | <sect3 id="wvstreams-config">
|
---|
| 143 | <title>Config Files</title>
|
---|
[dc775a26] | 144 |
|
---|
[3c88826] | 145 | <para><filename>/etc/uniconf.conf</filename></para>
|
---|
[dc775a26] | 146 |
|
---|
[3c88826] | 147 | <indexterm zone="wvstreams wvstreams-config">
|
---|
| 148 | <primary sortas="e-etc-uniconf.conf">/etc/uniconf.conf</primary>
|
---|
| 149 | </indexterm>
|
---|
[dc775a26] | 150 |
|
---|
[3c88826] | 151 | </sect3>
|
---|
[dc775a26] | 152 |
|
---|
[3c88826] | 153 | <sect3>
|
---|
| 154 | <title>Configuration Information</title>
|
---|
[dc775a26] | 155 |
|
---|
[ebabf24] | 156 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude"
|
---|
| 157 | href="../../xincludes/lib-config.xml"/>
|
---|
[dc775a26] | 158 |
|
---|
[3c88826] | 159 | </sect3>
|
---|
[dc775a26] | 160 |
|
---|
[3c88826] | 161 | </sect2>
|
---|
[dc775a26] | 162 |
|
---|
[3c88826] | 163 | <sect2 role="content">
|
---|
| 164 | <title>Contents</title>
|
---|
[dc775a26] | 165 |
|
---|
[3c88826] | 166 | <segmentedlist>
|
---|
| 167 | <segtitle>Installed Programs</segtitle>
|
---|
| 168 | <segtitle>Installed Libraries</segtitle>
|
---|
| 169 | <segtitle>Installed Directories</segtitle>
|
---|
[dc775a26] | 170 |
|
---|
[3c88826] | 171 | <seglistitem>
|
---|
| 172 | <seg>uni and uniconfd</seg>
|
---|
[061ec9d] | 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
|
---|
[3c88826] | 176 | libxplc-cxx.a</seg>
|
---|
[2ca26748] | 177 | <seg>/usr/include/wvstreams, /usr/share/doc/wvstreams-&wvstreams-version; and
|
---|
[3c88826] | 178 | /var/lib/uniconf</seg>
|
---|
| 179 | </seglistitem>
|
---|
| 180 | </segmentedlist>
|
---|
[dc775a26] | 181 |
|
---|
[3c88826] | 182 | <variablelist>
|
---|
| 183 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 184 | <?dbfo list-presentation="list"?>
|
---|
| 185 | <?dbhtml list-presentation="table"?>
|
---|
[dc775a26] | 186 |
|
---|
[3c88826] | 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>
|
---|
[dc775a26] | 196 |
|
---|
[3c88826] | 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>
|
---|
[dc775a26] | 206 |
|
---|
[3c88826] | 207 | <varlistentry id="libuniconf">
|
---|
[061ec9d] | 208 | <term><filename class='libraryfile'>libuniconf.{so,a}</filename></term>
|
---|
[3c88826] | 209 | <listitem>
|
---|
[2ca26748] | 210 | <para>contains functions that define a hierarchical registry
|
---|
[3c88826] | 211 | abstraction in the UniConf configuration system.</para>
|
---|
| 212 | <indexterm zone="wvstreams libuniconf">
|
---|
[061ec9d] | 213 | <primary sortas="c-libuniconf">libuniconf.{so,a}</primary>
|
---|
[3c88826] | 214 | </indexterm>
|
---|
| 215 | </listitem>
|
---|
| 216 | </varlistentry>
|
---|
[dc775a26] | 217 |
|
---|
[3c88826] | 218 | <varlistentry id="libwvbase">
|
---|
[061ec9d] | 219 | <term><filename class='libraryfile'>libwvbase.{so,a}</filename></term>
|
---|
[3c88826] | 220 | <listitem>
|
---|
| 221 | <para>contains the Base64 encoder and decoder implementations functions.</para>
|
---|
| 222 | <indexterm zone="wvstreams libwvbase">
|
---|
[061ec9d] | 223 | <primary sortas="c-libwvbase">libwvbase.{so,a}</primary>
|
---|
[3c88826] | 224 | </indexterm>
|
---|
| 225 | </listitem>
|
---|
| 226 | </varlistentry>
|
---|
[dc775a26] | 227 |
|
---|
[3c88826] | 228 | <varlistentry id="libwvfft">
|
---|
[061ec9d] | 229 | <term><filename class='libraryfile'>libwvfft.{so,a}</filename></term>
|
---|
[3c88826] | 230 | <listitem>
|
---|
[2ca26748] | 231 | <para>enables <application>WvStreams</application> programs to
|
---|
| 232 | easily handle Fast-Fourier transforms, instead of forcing the programmer to
|
---|
[dc775a26] | 233 | use the much harder to use <filename class="libraryfile">libfftw</filename>
|
---|
[3c88826] | 234 | interface.</para>
|
---|
| 235 | <indexterm zone="wvstreams libwvfft">
|
---|
[061ec9d] | 236 | <primary sortas="c-libwvfft">libwvfft.{so,a}</primary>
|
---|
[3c88826] | 237 | </indexterm>
|
---|
| 238 | </listitem>
|
---|
| 239 | </varlistentry>
|
---|
[dc775a26] | 240 |
|
---|
[3c88826] | 241 | <varlistentry id="libwvoggspeex">
|
---|
[061ec9d] | 242 | <term><filename class='libraryfile'>libwvoggspeex.{so,a}</filename></term>
|
---|
[3c88826] | 243 | <listitem>
|
---|
[2ca26748] | 244 | <para>enables quick and painless creation of audio streams using
|
---|
| 245 | the <application>Speex</application> Voice over
|
---|
[3c88826] | 246 | IP CODEC.</para>
|
---|
| 247 | <indexterm zone="wvstreams libwvoggspeex">
|
---|
[061ec9d] | 248 | <primary sortas="c-libwvoggspeex">libwvoggspeex.{so,a}</primary>
|
---|
[3c88826] | 249 | </indexterm>
|
---|
| 250 | </listitem>
|
---|
| 251 | </varlistentry>
|
---|
[dc775a26] | 252 |
|
---|
[3c88826] | 253 | <varlistentry id="libwvoggvorbis">
|
---|
[061ec9d] | 254 | <term><filename class='libraryfile'>libwvoggvorbis.{so,a}</filename></term>
|
---|
[3c88826] | 255 | <listitem>
|
---|
[2ca26748] | 256 | <para>enables quick and painless creation of audio streams using
|
---|
[3c88826] | 257 | the OggVorbis CODEC.</para>
|
---|
| 258 | <indexterm zone="wvstreams libwvoggvorbis">
|
---|
[061ec9d] | 259 | <primary sortas="c-libwvoggvorbis">libwvoggvorbis.{so,a}</primary>
|
---|
[3c88826] | 260 | </indexterm>
|
---|
| 261 | </listitem>
|
---|
| 262 | </varlistentry>
|
---|
[dc775a26] | 263 |
|
---|
[3c88826] | 264 | <varlistentry id="libwvqt">
|
---|
[061ec9d] | 265 | <term><filename class='libraryfile'>libwvqt.{so,a}</filename></term>
|
---|
[3c88826] | 266 | <listitem>
|
---|
[2ca26748] | 267 | <para>enables <application>WvStreams</application> to act as the
|
---|
| 268 | I/O and configuration back end for <application>Qt</application> and
|
---|
[3c88826] | 269 | <application>KDE</application>.</para>
|
---|
| 270 | <indexterm zone="wvstreams libwvqt">
|
---|
[061ec9d] | 271 | <primary sortas="c-libwvqt">libwvqt.{so,a}</primary>
|
---|
[3c88826] | 272 | </indexterm>
|
---|
| 273 | </listitem>
|
---|
| 274 | </varlistentry>
|
---|
[dc775a26] | 275 |
|
---|
[3c88826] | 276 | <varlistentry id="libwvstreams">
|
---|
[061ec9d] | 277 | <term><filename class='libraryfile'>libwvstreams.{so,a}</filename></term>
|
---|
[3c88826] | 278 | <listitem>
|
---|
| 279 | <para>provides functions for basic streaming I/O support.</para>
|
---|
| 280 | <indexterm zone="wvstreams libwvstreams">
|
---|
[061ec9d] | 281 | <primary sortas="c-libwvstreams">libwvstreams.{so,a}</primary>
|
---|
[3c88826] | 282 | </indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
[dc775a26] | 285 |
|
---|
[3c88826] | 286 | <varlistentry id="libtelephony">
|
---|
[061ec9d] | 287 | <term><filename class='libraryfile'>libtelephony.{so,a}</filename></term>
|
---|
[3c88826] | 288 | <listitem>
|
---|
[2ca26748] | 289 | <para>contains telephony function routines such as echo
|
---|
[3c88826] | 290 | cancellation, dc offset removal, automatic gain control, etc.</para>
|
---|
| 291 | <indexterm zone="wvstreams libtelephony">
|
---|
[061ec9d] | 292 | <primary sortas="c-libtelephony">libtelephony.{so,a}</primary>
|
---|
[3c88826] | 293 | </indexterm>
|
---|
| 294 | </listitem>
|
---|
| 295 | </varlistentry>
|
---|
[dc775a26] | 296 |
|
---|
[3c88826] | 297 | <varlistentry id="libwvutils">
|
---|
[061ec9d] | 298 | <term><filename class='libraryfile'>libwvutils.{so,a}</filename></term>
|
---|
[3c88826] | 299 | <listitem>
|
---|
[2ca26748] | 300 | <para>contains functions required by the
|
---|
[3c88826] | 301 | <application>WvStreams</application> libraries and utility programs.</para>
|
---|
| 302 | <indexterm zone="wvstreams libwvutils">
|
---|
[061ec9d] | 303 | <primary sortas="c-libwvutils">libwvutils.{so,a}</primary>
|
---|
[3c88826] | 304 | </indexterm>
|
---|
| 305 | </listitem>
|
---|
| 306 | </varlistentry>
|
---|
[dc775a26] | 307 |
|
---|
[3c88826] | 308 | <varlistentry id="libxplc-cxx">
|
---|
| 309 | <term><filename class='libraryfile'>libxplc-cxx.a</filename></term>
|
---|
| 310 | <listitem>
|
---|
[2ca26748] | 311 | <para>contains helper functions for the C++
|
---|
[3c88826] | 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>
|
---|
[dc775a26] | 318 |
|
---|
[3c88826] | 319 | </variablelist>
|
---|
[dc775a26] | 320 |
|
---|
[3c88826] | 321 | </sect2>
|
---|
[dc775a26] | 322 |
|
---|
[f45b1953] | 323 | </sect1>
|
---|