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