glfs/multimedia/libdriv/esound.xml
Randy McMurchy 046ae38885 Added a note to the EsounD instructions to optionally install the package documentation
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@2915 af4574ff-66df-0310-9fd7-8a98e5e911e0
2004-11-10 00:42:57 +00:00

153 lines
4.9 KiB
XML

<!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 esound-download-http "http://ftp.gnome.org/pub/GNOME/sources/esound/0.2/esound-&esound-version;.tar.bz2">
<!ENTITY esound-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/esound/0.2/esound-&esound-version;.tar.bz2">
<!ENTITY esound-md5sum "1566344f80a8909b5e6e4d6b6520c2c1">
<!ENTITY esound-size "376 KB">
<!ENTITY esound-buildsize "3.8 MB">
<!ENTITY esound-time "0.16 SBU">
]>
<sect1 id="esound" xreflabel="EsounD-&esound-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="esound.html"?>
<title>EsounD-&esound-version;</title>
<sect2>
<title>Introduction to <application>EsounD</application></title>
<para>The <application>EsounD</application> package contains the Enlightened
Sound Daemon. This is useful for mixing together several digitized audio
streams for playback by a single device.</para>
<sect3><title>Package information</title>
<itemizedlist spacing='compact'>
<listitem><para>Download (HTTP): <ulink url="&esound-download-http;"/></para></listitem>
<listitem><para>Download (FTP): <ulink url="&esound-download-ftp;"/></para></listitem>
<listitem><para>Download MD5 Sum: &esound-md5sum;</para></listitem>
<listitem><para>Download size: &esound-size;</para></listitem>
<listitem><para>Estimated disk space required: &esound-buildsize;</para></listitem>
<listitem><para>Estimated build time: &esound-time;</para></listitem></itemizedlist>
</sect3>
<sect3><title><application>EsounD</application> dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="audiofile"/></para>
</sect4>
<sect4><title>Optional</title>
<para><xref linkend="alsa"/>,
<xref linkend="tcpwrappers"/> and
<xref linkend="docbook-utils"/></para>
</sect4>
</sect3>
</sect2>
<sect2>
<title>Installation of <application>EsounD</application></title>
<para>Install <application>EsounD</application> by running the following
commands:</para>
<screen><userinput><command>./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>
<para>If you wish to install the package documentation (man pages have been
already installed), copy the <filename>docs/esound.ps</filename> file and
<filename class='directory'>docs/html</filename> directory to a desired
location on your system.</para>
</sect2>
<sect2>
<title>Command explanations</title>
<para><parameter>--sysconfdir=/etc</parameter>: This switch puts configuration
files in <filename class="directory">/etc</filename> instead of
<filename class="directory">/usr/etc</filename>.
</para>
</sect2>
<sect2>
<title>Configuring <application>EsounD</application></title>
<sect3><title>Config files</title>
<para><filename>/etc/esd.conf</filename></para>
</sect3>
<sect3><title>Configuration Information</title>
<para>Instructions and information about the configuration file is
located in the <filename>TIPS</filename> file in the
<application>EsounD</application> source directory.</para>
</sect3>
</sect2>
<sect2>
<title>Contents</title>
<para>The <application>EsounD</application> package contains
<command>esd</command>, <command>esdcat</command>, <command>esdctl</command>,
<command>esdfilt</command>, <command>esdloop</command>,
<command>esdmon</command>, <command>esdplay</command>
<command>esdrec</command>, <command>esdsample</command> and
<filename class="libraryfile">libesd</filename> libraries.</para>
</sect2>
<sect2><title>Description</title>
<sect3><title>esd</title>
<para><command>esd</command> is the Enlightened Sound Daemon.</para></sect3>
<sect3><title>esdcat</title>
<para><command>esdcat</command> plays a <filename>RAW</filename> audio stream
through the daemon.</para></sect3>
<sect3><title>esdctl</title>
<para><command>esdctl</command> controls certain aspects of the sound
daemon.</para></sect3>
<sect3><title>esdfilt</title>
<para><command>esfilt</command> is an <application>EsoundD</application>
filter.</para></sect3>
<sect3><title>esdloop</title>
<para><command>esdloop</command> is test scaffolding for sample cache, loop,
and free.</para></sect3>
<sect3><title>esdmon</title>
<para><command>esdmon</command> outputs the mixed stream from the daemon.</para>
</sect3>
<sect3><title>esdplay</title>
<para><command>esdplay</command> plays the named file on
<application>EsoundD</application>.</para></sect3>
<sect3><title>esdrec</title>
<para><command>esdrec</command> outputs from the sound device's current
input.</para></sect3>
<sect3><title>esdsample</title>
<para><command>esdsample</command> is test scaffolding for sample cache, play
back, and free.</para></sect3>
<sect3><title>esd libraries</title>
<para><filename class="libraryfile">libesd</filename> libraries contain the
functions used by <command>esd</command>.</para></sect3>
</sect2>
</sect1>