Updated to WvStreams-4.0.1

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@3424 af4574ff-66df-0310-9fd7-8a98e5e911e0
This commit is contained in:
Randy McMurchy 2005-02-10 04:20:33 +00:00
parent 050a53c692
commit 7e5804fb40
3 changed files with 215 additions and 78 deletions

View File

@ -2,12 +2,13 @@
"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-http "http://open.nit.ca/download/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">
<!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;">
@ -17,50 +18,60 @@
</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 the
<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 (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>
<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>
<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>
<para><xref linkend="openssl"/></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>
<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>
@ -68,24 +79,62 @@ url="&patch-root;/wvstreams-&wvstreams-version;-tcl84-1.patch"/></para></listite
<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>
<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</command></userinput></screen>
<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 &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>
<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><title>Configuration Information</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>
@ -94,52 +143,137 @@ make install</command></userinput></screen>
<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>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
</sect2>
<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>
<sect2><title>Description</title>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<sect3><title>libuniconf, libwvstreams, libwvutils</title>
<para>
These libraries contain the base C++ classes for rapid application
development.
</para></sect3>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>
<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>

View File

@ -1,4 +1,4 @@
<!ENTITY day "09">
<!ENTITY day "10">
<!ENTITY month "02">
<!ENTITY year "2005">
<!ENTITY version "svn-&year;&month;&day;">
@ -197,7 +197,7 @@
<!-- Chapter 16 -->
<!ENTITY curl-version "7.13.0">
<!ENTITY wvstreams-version "3.75.0">
<!ENTITY wvstreams-version "4.0.1">
<!ENTITY gnet-version "2.0.5">
<!ENTITY libsoup-version "2.2.1">

View File

@ -22,6 +22,9 @@ who wrote what.</para>
<itemizedlist>
<listitem><para>February 10th, 2005 [randy]: Updated to
WvStreams-4.0.1</para></listitem>
<listitem><para>February 9th, 2005 [larry]: Updated MIT krb5 to krb-1.4,
incorporated offical patches for autofs and moved cracklib to required in
Linux_PAM.</para></listitem>