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