source: multimedia/libdriv/esound.xml@ 3de6059

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY esound-download-http "&gnome-download-http;/esound/0.2/esound-&esound-version;.tar.bz2">
  <!ENTITY esound-download-ftp  "&gnome-download-ftp;/esound/0.2/esound-&esound-version;.tar.bz2">
  <!ENTITY esound-md5sum        "99cc68770176c8940cf346f60208420e">
  <!ENTITY esound-size          "383 KB">
  <!ENTITY esound-buildsize     "5 MB">
  <!ENTITY esound-time          "0.2 SBU">
]>

<sect1 id="esound" xreflabel="EsounD-&esound-version;">
  <?dbhtml filename="esound.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>EsounD-&esound-version;</title>

  <indexterm zone="esound">
    <primary sortas="a-EsounD">EsounD</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to EsounD</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>

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <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>

    <bridgehead renderas="sect3">EsounD Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="audiofile"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="alsa"/>,
    <xref linkend="arts"/>,
    <xref linkend="tcpwrappers"/>, and
    <xref linkend="docbook-utils"/></para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/esound"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of EsounD</title>

    <para>Install <application>EsounD</application> by running the following
    commands:</para>

<screen><userinput>sed -i 's@doc/esound@&amp;-&esound-version;@' configure &amp;&amp;
./configure --prefix=/usr --sysconfdir=/etc &amp;&amp;
make</userinput></screen>

    <para>This package does not come with a test suite.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>sed -i '...'</command>: This appends the version string to
    the documentation installation directory.</para>

    <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 role="configuration">
    <title>Configuring EsounD</title>

    <sect3 id="esound-config">
      <title>Config Files</title>

      <para><filename>/etc/esd.conf</filename></para>

      <indexterm zone="esound esound-config">
        <primary sortas="e-etc-esd.conf">/etc/esd.conf</primary>
      </indexterm>

    </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 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directory</segtitle>

      <seglistitem>
        <seg>esd, esdcat, esdctl, esd-config, esddsp, esdfilt, esdloop, esdmon,
        esdplay, esdrec, and esdsample</seg>
        <seg>libesd.{so,a} and libesddsp.{so,a}</seg>
        <seg>/usr/share/doc/esound-&esound-version;</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="esd">
        <term><command>esd</command></term>
        <listitem>
          <para>is the Enlightened Sound Daemon.</para>
          <indexterm zone="esound esd">
            <primary sortas="b-esd">esd</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esd-config">
        <term><command>esd-config</command></term>
        <listitem>
          <para>is used by <command>configure</command> to determine the
          compiler and linker flags that should be used to compile and link programs
          that use <application>EsounD</application>.</para>
          <indexterm zone="esound esd-config">
            <primary sortas="b-esd-config">esd-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esdcat">
        <term><command>esdcat</command></term>
        <listitem>
          <para>plays a RAW audio stream through the daemon.</para>
          <indexterm zone="esound esdcat">
            <primary sortas="b-esdcat">esdcat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esdctl">
        <term><command>esdctl</command></term>
        <listitem>
          <para> controls certain aspects of the sound daemon.</para>
          <indexterm zone="esound esdctl">
            <primary sortas="b-esdctl">esdctl</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esdfilt">
        <term><command>esdfilt</command></term>
        <listitem>
          <para>is an <application>EsoundD</application> filter.</para>
          <indexterm zone="esound esdfilt">
            <primary sortas="b-esdfilt">esdfilt</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esdloop">
        <term><command>esdloop</command></term>
        <listitem>
          <para>is test scaffolding for sample cache, loop and free.</para>
          <indexterm zone="esound esdloop">
            <primary sortas="b-esdloop">esdloop</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esdmon">
        <term><command>esdmon</command></term>
        <listitem>
          <para>outputs the mixed stream from the daemon.</para>
          <indexterm zone="esound esdmon">
            <primary sortas="b-esdmon">esdmon</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esdplay">
        <term><command>esdplay</command></term>
        <listitem>
          <para>plays the named file on
          <application>EsoundD</application>.</para>
          <indexterm zone="esound esdplay">
            <primary sortas="b-esdplay">esdplay</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esdrec">
        <term><command>esdrec</command></term>
        <listitem>
          <para>outputs from the sound device's current input.</para>
          <indexterm zone="esound esdrec">
            <primary sortas="b-esdrec">esdrec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="esdsample">
        <term><command>esdsample</command></term>
        <listitem>
          <para>is test scaffolding for sample cache, playback, and free.</para>
          <indexterm zone="esound esdsample">
            <primary sortas="b-esdsample">esdsample</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libesd">
        <term><filename class='libraryfile'>libesd.{so,a}</filename></term>
        <listitem>
          <para>contains functions used by the <application>EsounD</application>
          programs as well as other programs to read, write and play various sound
          format files.</para>
          <indexterm zone="esound libesd">
            <primary sortas="c-libesd">libesd.{so,a}</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>