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