source: basicnet/netlibs/wvstreams.xml@ 939cf0da

<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
   "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;
 
  <!ENTITY wvstreams-download-http "http://people.nit.ca/~jim/wvstreams-&wvstreams-version;.tar.gz">
  <!ENTITY wvstreams-download-ftp  " ">
  <!ENTITY wvstreams-size          "514 KB">
  <!ENTITY wvstreams-buildsize     "28 MB">
  <!ENTITY wvstreams-time          "0.50 SBU">
]>

<sect1 id="wvstreams" xreflabel="WvStreams-&wvstreams-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="wvstreams.html"?>
<title>WvStreams-&wvstreams-version;</title>

<sect2>
<title>Introduction to <application>WvStreams</application></title>

<para><application>WvStreams</application> is a library suite containing the 
platform-independent C++ networking and utilities libraries for rapid
application development.</para>

<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink url="&wvstreams-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink url="&wvstreams-download-ftp;"/></para></listitem>
<listitem><para>Download size: &wvstreams-size;</para></listitem>
<listitem><para>Estimated disk space required: &wvstreams-buildsize;</para></listitem>
<listitem><para>Estimated build time: &wvstreams-time;</para></listitem></itemizedlist>
</sect3>

<sect3><title>Additional downloads</title>
<itemizedlist spacing="compact">
<listitem><para>Required Patch for Tcl: <ulink
url="&patch-root;/wvstreams-&wvstreams-version;-tcl84-1.patch"/></para></listitem>
</itemizedlist></sect3>

<sect3><title><application>WvStreams</application> dependencies</title>
<sect4><title>Required</title>
<para>
<xref linkend="openssl-package"/>
</para></sect4>
<sect4><title>Optional</title>
<para>
<xref linkend="fam"/>,
<xref linkend="db"/>,
<xref linkend="gdbm"/>,
<xref linkend="libogg"/>,
<xref linkend="Linux_PAM"/>,
<xref linkend="tcl"/>,
<xref linkend="qt"/>,
<xref linkend="speex"/>,
<xref linkend="libvorbis"/>,
<ulink url="http://www.fftw.org/">FFTW-2.<replaceable>X</replaceable></ulink>,
<ulink url="http://www.swig.org">SWIG</ulink>,
<ulink url="http://valgrind.kde.org/">Valgrind</ulink> and
<ulink url="http://xplc.sourceforge.net/">XPLC</ulink>
</para></sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>WvStreams</application></title>

<para>If you have <application>Tcl</application> and SWIG installed and wish to
utilize them apply the following patch:</para>

<screen><userinput><command>patch -Np1 -i ../wvstreams-&wvstreams-version;-tcl84-1.patch</command></userinput></screen>

<para>Install <application>WvStreams</application> by running the following 
commands:</para>

<screen><userinput><command>./configure --prefix=/usr &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<title>Configuring <application>WvStreams</application></title>

<sect3><title>Configuration Information</title>
<xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../../lib-config.xml"/>  
</sect3>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application>WvStreams</application> package contains the
<filename class="libraryfile">libuniconf</filename>,
<filename class="libraryfile">libwvfft</filename>,
<filename class="libraryfile">libwvoggspeex</filename>,
<filename class="libraryfile">libwvoggvorbis</filename>,
<filename class="libraryfile">libwvqt</filename>,
<filename class="libraryfile">libwvstreams</filename> and
<filename class="libraryfile">libwvutils</filename>
libraries.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>libuniconf, libwvstreams, libwvutils</title>
<para>
These libraries contain the base C++ classes for rapid application
development.
</para></sect3>

<sect3><title>libwvfft</title>
<para><filename class="libraryfile">libwvfft</filename>
enables <application>WvStreams</application> programs to easily handle
Fast-Fourier transforms, instead of forcing the programmer to use the
much harder to use <filename class="libraryfile">libfftw</filename>
interface.
</para></sect3>

<sect3><title>libwvoggspeex</title>
<para><filename class="libraryfile">libwvoggspeex</filename>
enables quick and painless creation of audio streams using the Speex
Voice over <acronym>IP</acronym> <acronym>CODEC</acronym>.
</para></sect3>

<sect3><title>libwvoggvorbis</title>
<para><filename class="libraryfile">libwvoggvorbis</filename>
enables quick and painless creation of audio streams using the OggVorbis
<acronym>CODEC</acronym>.
</para></sect3>

<sect3><title>libwvqt</title>
<para><filename class="libraryfile">libwvqt</filename>
enables <application>WvStreams</application> to act as the I/O and
configuration back end for <application>Qt</application> and
<application><acronym>KDE</acronym></application>.
</para></sect3>

</sect2>

</sect1>