source: basicnet/netlibs/wvstreams.xml@ 7f76b96

<!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://open.nit.ca/download/wvstreams-&wvstreams-version;.tar.gz">
  <!ENTITY wvstreams-download-ftp  " ">
  <!ENTITY wvstreams-md5sum        "89cdc4f979d1f6d745e173bc7485f325">
  <!ENTITY wvstreams-size          "1.0 MB">
  <!ENTITY wvstreams-buildsize     "57 MB (additional 43 MB to install documentation)">
  <!ENTITY wvstreams-time          "0.77 SBU (additional 0.45 SBU to build documentation)">
]>

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

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

<para><application>WvStreams</application> is a library suite containing 
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 MD5 sum: &wvstreams-md5sum;</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"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="pkgconfig"/>, 
<xref linkend="fam"/>, 
<xref linkend="db"/>, 
<xref linkend="Linux_PAM"/>, 
<xref linkend="tcl"/>, 
<xref linkend="qt"/>, 
<xref linkend="speex"/>, 
<xref linkend="libvorbis"/>, 
<xref linkend="doxygen"/>, 
<ulink url="http://www.fftw.org/">FFTW-2.<replaceable>X</replaceable></ulink>, 
<ulink url="http://www.swig.org">SWIG</ulink>, 
<ulink url="http://qdbm.sourceforge.net/">QDBM</ulink>, 
<ulink url="http://www.openslp.org/">OpenSLP</ulink>, 
<ulink url="http://xplc.sourceforge.net/">XPLC</ulink>, 
<ulink url="http://valgrind.kde.org/">Valgrind</ulink> and 
<ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>
</sect4>
</sect3>

</sect2>

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

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

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

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

<screen><userinput><command>./configure --prefix=/usr \
    --sysconfdir=/etc --localstatedir=/var &amp;&amp;
make</command></userinput></screen>

<para>If <application>Doxygen</application> is installed and you wish to build 
the <acronym>API</acronym> documentation, issue the following command:</para>

<screen><userinput><command>make doxygen</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

<para>If you built the <acronym>API</acronym> documentation, install it using 
the following commands:</para>

<screen><userinput role='root'><command>install -v -d -m755 /usr/share/doc/wvstreams-&wvstreams-version;/doxy-html &amp;&amp; 
install -v -m644 Docs/doxy-html/* \
    /usr/share/doc/wvstreams-&wvstreams-version;/doxy-html</command></userinput></screen>

</sect2>

<sect2>
<title>Command explanations</title>

<para><parameter>--sysconfdir=/etc</parameter>: This parameter places 
configuration files in <filename class='directory'>/etc</filename> instead of 
<filename class='directory'>/usr/etc</filename>.</para>

<para><parameter>--localstatedir=/var</parameter>: This parameter places 
<command>uniconfd</command> run-time files in 
<filename class='directory'>/var/lib</filename> instead of 
<filename class='directory'>/usr/var/lib</filename>.</para>

</sect2>

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

<sect3 id="wvstreams-config"><title>Config files</title>
<para><filename>/etc/uniconf.conf</filename></para>
<indexterm zone="wvstreams wvstreams-config">
<primary sortas="e-etc-uniconf.conf">/etc/uniconf.conf</primary></indexterm>
</sect3>

<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>

<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>

<seglistitem>
<seg>uni and uniconfd</seg>
<seg>libuniconf.[so,a], libwvbase.[so,a], libwvfft.[so,a], 
libwvoggspeex.[so,a], libwvoggvorbis.[so,a], libwvqt.[so,a], 
libwvstreams.[so,a], libwvtelephony.[so,a], libwvutils.[so,a] and 
libxplc-cxx.a</seg>
<seg>/usr/include/wvstreams, /usr/share/doc/wvstreams-&wvstreams-version; and 
/var/lib/uniconf</seg>
</seglistitem>
</segmentedlist>

<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>

<varlistentry id="uni">
<term><command>uni</command></term>
<listitem><para>is a program to interface with the UniConf configuration 
system.</para>
<indexterm zone="wvstreams uni">
<primary sortas="b-uni">uni</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="uniconfd">
<term><command>uniconfd</command></term>
<listitem><para>is a daemon program for the UniConf configuration 
system.</para>
<indexterm zone="wvstreams uniconfd">
<primary sortas="b-uniconfd">uniconfd</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libuniconf">
<term><filename class='libraryfile'>libuniconf.[so,a]</filename></term>
<listitem><para>contains functions that define a hierarchical registry 
abstraction in the UniConf configuration system.</para>
<indexterm zone="wvstreams libuniconf">
<primary sortas="c-libuniconf">libuniconf.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libwvbase">
<term><filename class='libraryfile'>libwvbase.[so,a]</filename></term>
<listitem><para>contains the Base64 encoder and decoder implementations 
functions.</para>
<indexterm zone="wvstreams libwvbase">
<primary sortas="c-libwvbase">libwvbase.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libwvfft">
<term><filename class='libraryfile'>libwvfft.[so,a]</filename></term>
<listitem><para>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>
<indexterm zone="wvstreams libwvfft">
<primary sortas="c-libwvfft">libwvfft.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libwvoggspeex">
<term><filename class='libraryfile'>libwvoggspeex.[so,a]</filename></term>
<listitem><para>enables quick and painless creation of audio streams using 
the <application>Speex</application> Voice over 
<acronym>IP</acronym> <acronym>CODEC</acronym>.</para>
<indexterm zone="wvstreams libwvoggspeex">
<primary sortas="c-libwvoggspeex">libwvoggspeex.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libwvoggvorbis">
<term><filename class='libraryfile'>libwvoggvorbis.[so,a]</filename></term>
<listitem><para>enables quick and painless creation of audio streams using 
the OggVorbis <acronym>CODEC</acronym>.</para>
<indexterm zone="wvstreams libwvoggvorbis">
<primary sortas="c-libwvoggvorbis">libwvoggvorbis.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libwvqt">
<term><filename class='libraryfile'>libwvqt.[so,a]</filename></term>
<listitem><para>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>
<indexterm zone="wvstreams libwvqt">
<primary sortas="c-libwvqt">libwvqt.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libwvstreams">
<term><filename class='libraryfile'>libwvstreams.[so,a]</filename></term>
<listitem><para>provides functions for basic streaming I/O support.</para>
<indexterm zone="wvstreams libwvstreams">
<primary sortas="c-libwvstreams">libwvstreams.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libtelephony">
<term><filename class='libraryfile'>libtelephony.[so,a]</filename></term>
<listitem><para>contains telephony function routines such as echo 
cancellation, dc offset removal, automatic gain control, etc.</para>
<indexterm zone="wvstreams libtelephony">
<primary sortas="c-libtelephony">libtelephony.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libwvutils">
<term><filename class='libraryfile'>libwvutils.[so,a]</filename></term>
<listitem><para>contains functions required by the 
<application>WvStreams</application> libraries and utility programs.</para>
<indexterm zone="wvstreams libwvutils">
<primary sortas="c-libwvutils">libwvutils.[so,a]</primary>
</indexterm></listitem>
</varlistentry>

<varlistentry id="libxplc-cxx">
<term><filename class='libraryfile'>libxplc-cxx.a</filename></term>
<listitem><para>contains helper functions for the C++ 
<application>WvStreams</application> bindings.</para>
<indexterm zone="wvstreams libxplc-cxx">
<primary sortas="c-libxplc-cxx">libxplc-cxx.a</primary>
</indexterm></listitem>
</varlistentry>
</variablelist>

</sect2>

</sect1>