[a2d8572] | 1 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
|
---|
| 2 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
| 3 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 4 | %general-entities;
|
---|
[7e5804f] | 5 |
|
---|
| 6 | <!ENTITY wvstreams-download-http "http://open.nit.ca/download/wvstreams-&wvstreams-version;.tar.gz">
|
---|
[08802956] | 7 | <!ENTITY wvstreams-download-ftp " ">
|
---|
[7e5804f] | 8 | <!ENTITY wvstreams-md5sum "89cdc4f979d1f6d745e173bc7485f325">
|
---|
| 9 | <!ENTITY wvstreams-size "1.0 MB">
|
---|
| 10 | <!ENTITY wvstreams-buildsize "57 MB (additional 43 MB to install documentation)">
|
---|
| 11 | <!ENTITY wvstreams-time "0.77 SBU (additional 0.45 SBU to build documentation)">
|
---|
[a2d8572] | 12 | ]>
|
---|
| 13 |
|
---|
[377584f] | 14 | <sect1 id="wvstreams" xreflabel="WvStreams-&wvstreams-version;">
|
---|
[a0f03b0] | 15 | <sect1info>
|
---|
[5cd0959d] | 16 | <othername>$LastChangedBy$</othername>
|
---|
| 17 | <date>$Date$</date>
|
---|
[a0f03b0] | 18 | </sect1info>
|
---|
[00bb024c] | 19 | <?dbhtml filename="wvstreams.html"?>
|
---|
[377584f] | 20 | <title>WvStreams-&wvstreams-version;</title>
|
---|
[7e5804f] | 21 | <indexterm zone="wvstreams">
|
---|
| 22 | <primary sortas="a-WvStreams">WvStreams</primary></indexterm>
|
---|
[f45b1953] | 23 |
|
---|
[a2d8572] | 24 | <sect2>
|
---|
| 25 | <title>Introduction to <application>WvStreams</application></title>
|
---|
| 26 |
|
---|
[7e5804f] | 27 | <para><application>WvStreams</application> is a library suite containing
|
---|
[08802956] | 28 | platform-independent C++ networking and utilities libraries for rapid
|
---|
| 29 | application development.</para>
|
---|
[a2d8572] | 30 |
|
---|
| 31 | <sect3><title>Package information</title>
|
---|
| 32 | <itemizedlist spacing='compact'>
|
---|
[7e5804f] | 33 | <listitem><para>Download (HTTP):
|
---|
| 34 | <ulink url="&wvstreams-download-http;"/></para></listitem>
|
---|
| 35 | <listitem><para>Download (FTP):
|
---|
| 36 | <ulink url="&wvstreams-download-ftp;"/></para></listitem>
|
---|
| 37 | <listitem><para>Download MD5 sum: &wvstreams-md5sum;</para></listitem>
|
---|
[a2d8572] | 38 | <listitem><para>Download size: &wvstreams-size;</para></listitem>
|
---|
[7e5804f] | 39 | <listitem><para>Estimated disk space required:
|
---|
| 40 | &wvstreams-buildsize;</para></listitem>
|
---|
| 41 | <listitem><para>Estimated build time:
|
---|
| 42 | &wvstreams-time;</para></listitem></itemizedlist>
|
---|
[a2d8572] | 43 | </sect3>
|
---|
| 44 |
|
---|
| 45 | <sect3><title>Additional downloads</title>
|
---|
[08802956] | 46 | <itemizedlist spacing="compact">
|
---|
[7e5804f] | 47 | <listitem><para>Required Patch for Tcl: <ulink
|
---|
| 48 | url="&patch-root;/wvstreams-&wvstreams-version;-tcl84-1.patch"/></para>
|
---|
| 49 | </listitem>
|
---|
[a2d8572] | 50 | </itemizedlist></sect3>
|
---|
| 51 |
|
---|
| 52 | <sect3><title><application>WvStreams</application> dependencies</title>
|
---|
[df7efe5] | 53 | <sect4><title>Required</title>
|
---|
[7e5804f] | 54 | <para><xref linkend="openssl"/></para>
|
---|
| 55 | </sect4>
|
---|
| 56 |
|
---|
[08802956] | 57 | <sect4><title>Optional</title>
|
---|
[7e5804f] | 58 | <para><xref linkend="pkgconfig"/>,
|
---|
| 59 | <xref linkend="fam"/>,
|
---|
| 60 | <xref linkend="db"/>,
|
---|
| 61 | <xref linkend="Linux_PAM"/>,
|
---|
| 62 | <xref linkend="tcl"/>,
|
---|
| 63 | <xref linkend="qt"/>,
|
---|
| 64 | <xref linkend="speex"/>,
|
---|
| 65 | <xref linkend="libvorbis"/>,
|
---|
| 66 | <xref linkend="doxygen"/>,
|
---|
| 67 | <ulink url="http://www.fftw.org/">FFTW-2.<replaceable>X</replaceable></ulink>,
|
---|
| 68 | <ulink url="http://www.swig.org">SWIG</ulink>,
|
---|
| 69 | <ulink url="http://qdbm.sourceforge.net/">QDBM</ulink>,
|
---|
| 70 | <ulink url="http://www.openslp.org/">OpenSLP</ulink>,
|
---|
| 71 | <ulink url="http://xplc.sourceforge.net/">XPLC</ulink>,
|
---|
| 72 | <ulink url="http://valgrind.kde.org/">Valgrind</ulink> and
|
---|
| 73 | <ulink url="http://perens.com/FreeSoftware/">Electric Fence</ulink></para>
|
---|
| 74 | </sect4>
|
---|
[a2d8572] | 75 | </sect3>
|
---|
| 76 |
|
---|
| 77 | </sect2>
|
---|
| 78 |
|
---|
| 79 | <sect2>
|
---|
| 80 | <title>Installation of <application>WvStreams</application></title>
|
---|
| 81 |
|
---|
[7e5804f] | 82 | <para>If you have <application>Tcl</application> and
|
---|
| 83 | <application>SWIG</application> installed and wish to utilize them, apply the
|
---|
| 84 | following patch and run the <command>autoreconf</command> program:</para>
|
---|
[a2d8572] | 85 |
|
---|
[7e5804f] | 86 | <screen><userinput><command>patch -Np1 -i ../wvstreams-&wvstreams-version;-tcl84-1.patch &&
|
---|
| 87 | autoreconf -f</command></userinput></screen>
|
---|
[a2d8572] | 88 |
|
---|
[08802956] | 89 | <para>Install <application>WvStreams</application> by running the following
|
---|
| 90 | commands:</para>
|
---|
[a2d8572] | 91 |
|
---|
[7e5804f] | 92 | <screen><userinput><command>./configure --prefix=/usr \
|
---|
| 93 | --sysconfdir=/etc --localstatedir=/var &&
|
---|
| 94 | make</command></userinput></screen>
|
---|
| 95 |
|
---|
| 96 | <para>If <application>Doxygen</application> is installed and you wish to build
|
---|
| 97 | the <acronym>API</acronym> documentation, issue the following command:</para>
|
---|
| 98 |
|
---|
| 99 | <screen><userinput><command>make doxygen</command></userinput></screen>
|
---|
| 100 |
|
---|
| 101 | <para>Now, as the root user:</para>
|
---|
| 102 |
|
---|
| 103 | <screen><userinput role='root'><command>make install</command></userinput></screen>
|
---|
| 104 |
|
---|
| 105 | <para>If you built the <acronym>API</acronym> documentation, install it using
|
---|
| 106 | the following commands:</para>
|
---|
| 107 |
|
---|
| 108 | <screen><userinput role='root'><command>install -v -d -m755 /usr/share/doc/wvstreams-&wvstreams-version;/doxy-html &&
|
---|
| 109 | install -v -m644 Docs/doxy-html/* \
|
---|
| 110 | /usr/share/doc/wvstreams-&wvstreams-version;/doxy-html</command></userinput></screen>
|
---|
| 111 |
|
---|
| 112 | </sect2>
|
---|
| 113 |
|
---|
| 114 | <sect2>
|
---|
| 115 | <title>Command explanations</title>
|
---|
| 116 |
|
---|
| 117 | <para><parameter>--sysconfdir=/etc</parameter>: This parameter places
|
---|
| 118 | configuration files in <filename class='directory'>/etc</filename> instead of
|
---|
| 119 | <filename class='directory'>/usr/etc</filename>.</para>
|
---|
| 120 |
|
---|
| 121 | <para><parameter>--localstatedir=/var</parameter>: This parameter places
|
---|
| 122 | <command>uniconfd</command> run-time files in
|
---|
| 123 | <filename class='directory'>/var/lib</filename> instead of
|
---|
| 124 | <filename class='directory'>/usr/var/lib</filename>.</para>
|
---|
[a2d8572] | 125 |
|
---|
| 126 | </sect2>
|
---|
| 127 |
|
---|
| 128 | <sect2>
|
---|
| 129 | <title>Configuring <application>WvStreams</application></title>
|
---|
| 130 |
|
---|
[7e5804f] | 131 | <sect3 id="wvstreams-config"><title>Config files</title>
|
---|
| 132 | <para><filename>/etc/uniconf.conf</filename></para>
|
---|
| 133 | <indexterm zone="wvstreams wvstreams-config">
|
---|
| 134 | <primary sortas="e-etc-uniconf.conf">/etc/uniconf.conf</primary></indexterm>
|
---|
| 135 | </sect3>
|
---|
| 136 |
|
---|
| 137 | <sect3><title>Configuration information</title>
|
---|
[a2d8572] | 138 | <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="../../lib-config.xml"/>
|
---|
| 139 | </sect3>
|
---|
| 140 |
|
---|
| 141 | </sect2>
|
---|
| 142 |
|
---|
| 143 | <sect2>
|
---|
| 144 | <title>Contents</title>
|
---|
| 145 |
|
---|
[7e5804f] | 146 | <segmentedlist>
|
---|
| 147 | <segtitle>Installed Programs</segtitle>
|
---|
| 148 | <segtitle>Installed Libraries</segtitle>
|
---|
| 149 | <segtitle>Installed Directories</segtitle>
|
---|
[a2d8572] | 150 |
|
---|
[7e5804f] | 151 | <seglistitem>
|
---|
| 152 | <seg>uni and uniconfd</seg>
|
---|
| 153 | <seg>libuniconf.[so,a], libwvbase.[so,a], libwvfft.[so,a],
|
---|
| 154 | libwvoggspeex.[so,a], libwvoggvorbis.[so,a], libwvqt.[so,a],
|
---|
| 155 | libwvstreams.[so,a], libwvtelephony.[so,a], libwvutils.[so,a] and
|
---|
| 156 | libxplc-cxx.a</seg>
|
---|
| 157 | <seg>/usr/include/wvstreams, /usr/share/doc/wvstreams-&wvstreams-version; and
|
---|
| 158 | /var/lib/uniconf</seg>
|
---|
| 159 | </seglistitem>
|
---|
| 160 | </segmentedlist>
|
---|
| 161 |
|
---|
| 162 | <variablelist>
|
---|
| 163 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 164 | <?dbfo list-presentation="list"?>
|
---|
| 165 |
|
---|
| 166 | <varlistentry id="uni">
|
---|
| 167 | <term><command>uni</command></term>
|
---|
| 168 | <listitem><para>is a program to interface with the UniConf configuration
|
---|
| 169 | system.</para>
|
---|
| 170 | <indexterm zone="wvstreams uni">
|
---|
| 171 | <primary sortas="b-uni">uni</primary>
|
---|
| 172 | </indexterm></listitem>
|
---|
| 173 | </varlistentry>
|
---|
| 174 |
|
---|
| 175 | <varlistentry id="uniconfd">
|
---|
| 176 | <term><command>uniconfd</command></term>
|
---|
| 177 | <listitem><para>is a daemon program for the UniConf configuration
|
---|
| 178 | system.</para>
|
---|
| 179 | <indexterm zone="wvstreams uniconfd">
|
---|
| 180 | <primary sortas="b-uniconfd">uniconfd</primary>
|
---|
| 181 | </indexterm></listitem>
|
---|
| 182 | </varlistentry>
|
---|
| 183 |
|
---|
| 184 | <varlistentry id="libuniconf">
|
---|
| 185 | <term><filename class='libraryfile'>libuniconf.[so,a]</filename></term>
|
---|
| 186 | <listitem><para>contains functions that define a hierarchical registry
|
---|
| 187 | abstraction in the UniConf configuration system.</para>
|
---|
| 188 | <indexterm zone="wvstreams libuniconf">
|
---|
| 189 | <primary sortas="c-libuniconf">libuniconf.[so,a]</primary>
|
---|
| 190 | </indexterm></listitem>
|
---|
| 191 | </varlistentry>
|
---|
| 192 |
|
---|
| 193 | <varlistentry id="libwvbase">
|
---|
| 194 | <term><filename class='libraryfile'>libwvbase.[so,a]</filename></term>
|
---|
| 195 | <listitem><para>contains the Base64 encoder and decoder implementations
|
---|
| 196 | functions.</para>
|
---|
| 197 | <indexterm zone="wvstreams libwvbase">
|
---|
| 198 | <primary sortas="c-libwvbase">libwvbase.[so,a]</primary>
|
---|
| 199 | </indexterm></listitem>
|
---|
| 200 | </varlistentry>
|
---|
| 201 |
|
---|
| 202 | <varlistentry id="libwvfft">
|
---|
| 203 | <term><filename class='libraryfile'>libwvfft.[so,a]</filename></term>
|
---|
| 204 | <listitem><para>enables <application>WvStreams</application> programs to
|
---|
| 205 | easily handle Fast-Fourier transforms, instead of forcing the programmer to
|
---|
| 206 | use the much harder to use <filename class="libraryfile">libfftw</filename>
|
---|
| 207 | interface.</para>
|
---|
| 208 | <indexterm zone="wvstreams libwvfft">
|
---|
| 209 | <primary sortas="c-libwvfft">libwvfft.[so,a]</primary>
|
---|
| 210 | </indexterm></listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="libwvoggspeex">
|
---|
| 214 | <term><filename class='libraryfile'>libwvoggspeex.[so,a]</filename></term>
|
---|
| 215 | <listitem><para>enables quick and painless creation of audio streams using
|
---|
| 216 | the <application>Speex</application> Voice over
|
---|
| 217 | <acronym>IP</acronym> <acronym>CODEC</acronym>.</para>
|
---|
| 218 | <indexterm zone="wvstreams libwvoggspeex">
|
---|
| 219 | <primary sortas="c-libwvoggspeex">libwvoggspeex.[so,a]</primary>
|
---|
| 220 | </indexterm></listitem>
|
---|
| 221 | </varlistentry>
|
---|
| 222 |
|
---|
| 223 | <varlistentry id="libwvoggvorbis">
|
---|
| 224 | <term><filename class='libraryfile'>libwvoggvorbis.[so,a]</filename></term>
|
---|
| 225 | <listitem><para>enables quick and painless creation of audio streams using
|
---|
| 226 | the OggVorbis <acronym>CODEC</acronym>.</para>
|
---|
| 227 | <indexterm zone="wvstreams libwvoggvorbis">
|
---|
| 228 | <primary sortas="c-libwvoggvorbis">libwvoggvorbis.[so,a]</primary>
|
---|
| 229 | </indexterm></listitem>
|
---|
| 230 | </varlistentry>
|
---|
| 231 |
|
---|
| 232 | <varlistentry id="libwvqt">
|
---|
| 233 | <term><filename class='libraryfile'>libwvqt.[so,a]</filename></term>
|
---|
| 234 | <listitem><para>enables <application>WvStreams</application> to act as the
|
---|
| 235 | I/O and configuration back end for <application>Qt</application> and
|
---|
| 236 | <application><acronym>KDE</acronym></application>.</para>
|
---|
| 237 | <indexterm zone="wvstreams libwvqt">
|
---|
| 238 | <primary sortas="c-libwvqt">libwvqt.[so,a]</primary>
|
---|
| 239 | </indexterm></listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
| 242 | <varlistentry id="libwvstreams">
|
---|
| 243 | <term><filename class='libraryfile'>libwvstreams.[so,a]</filename></term>
|
---|
| 244 | <listitem><para>provides functions for basic streaming I/O support.</para>
|
---|
| 245 | <indexterm zone="wvstreams libwvstreams">
|
---|
| 246 | <primary sortas="c-libwvstreams">libwvstreams.[so,a]</primary>
|
---|
| 247 | </indexterm></listitem>
|
---|
| 248 | </varlistentry>
|
---|
| 249 |
|
---|
| 250 | <varlistentry id="libtelephony">
|
---|
| 251 | <term><filename class='libraryfile'>libtelephony.[so,a]</filename></term>
|
---|
| 252 | <listitem><para>contains telephony function routines such as echo
|
---|
| 253 | cancellation, dc offset removal, automatic gain control, etc.</para>
|
---|
| 254 | <indexterm zone="wvstreams libtelephony">
|
---|
| 255 | <primary sortas="c-libtelephony">libtelephony.[so,a]</primary>
|
---|
| 256 | </indexterm></listitem>
|
---|
| 257 | </varlistentry>
|
---|
| 258 |
|
---|
| 259 | <varlistentry id="libwvutils">
|
---|
| 260 | <term><filename class='libraryfile'>libwvutils.[so,a]</filename></term>
|
---|
| 261 | <listitem><para>contains functions required by the
|
---|
| 262 | <application>WvStreams</application> libraries and utility programs.</para>
|
---|
| 263 | <indexterm zone="wvstreams libwvutils">
|
---|
| 264 | <primary sortas="c-libwvutils">libwvutils.[so,a]</primary>
|
---|
| 265 | </indexterm></listitem>
|
---|
| 266 | </varlistentry>
|
---|
[a2d8572] | 267 |
|
---|
[7e5804f] | 268 | <varlistentry id="libxplc-cxx">
|
---|
| 269 | <term><filename class='libraryfile'>libxplc-cxx.a</filename></term>
|
---|
| 270 | <listitem><para>contains helper functions for the C++
|
---|
| 271 | <application>WvStreams</application> bindings.</para>
|
---|
| 272 | <indexterm zone="wvstreams libxplc-cxx">
|
---|
| 273 | <primary sortas="c-libxplc-cxx">libxplc-cxx.a</primary>
|
---|
| 274 | </indexterm></listitem>
|
---|
| 275 | </varlistentry>
|
---|
| 276 | </variablelist>
|
---|
[a2d8572] | 277 |
|
---|
| 278 | </sect2>
|
---|
[f45b1953] | 279 |
|
---|
| 280 | </sect1>
|
---|