glfs/multimedia/libdriv/libao.xml

<?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 libao-download-http "https://downloads.xiph.org/releases/ao/libao-&libao-version;.tar.gz">
  <!ENTITY libao-download-ftp  " ">
  <!ENTITY libao-md5sum        "9f5dd20d7e95fd0dd72df5353829f097">
  <!ENTITY libao-size          "456 KB">
  <!ENTITY libao-buildsize     "3.9 MB">
  <!ENTITY libao-time          "less than 0.1 SBU">
]>

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


  <title>Libao-&libao-version;</title>

  <indexterm zone="libao">
    <primary sortas="a-Libao">Libao</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Libao</title>

    <para>
      The <application>libao</application> package contains a
      cross-platform audio library. This is useful to output audio on a wide
      variety of platforms. It currently supports WAV files, OSS (Open Sound
      System), ESD (Enlighten Sound Daemon), ALSA (Advanced Linux Sound
      Architecture), NAS (Network Audio system), aRTS (analog Real-Time
      Synthesizer), and PulseAudio (next generation
      <application>GNOME</application> sound architecture).
    </para>

    &lfs120_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libao-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&libao-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libao-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libao-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libao-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libao-time;
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="x-window-system"/>,
      <xref linkend="alsa"/>, and
      <xref linkend='pulseaudio'/>
    </para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &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 &amp;&amp;
install -v -m644 README /usr/share/doc/libao-&libao-version;</userinput></screen>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Libao</title>

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

    <para>
      <filename>/etc/libao.conf</filename> and
      <filename>~/.libao</filename>
    </para>

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

      <indexterm zone="libao libao-config">
        <primary sortas="e-AA.libao">~/.libao</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>
        Currently, the only configuration option available is setting the
        default output device. Issue <command>man libao.conf</command>
        for details.
      </para>

    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

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

      <seglistitem>
        <seg>None</seg>
        <seg>libao.so and plugins under /usr/lib/ao/plugins-4</seg>
        <seg>/usr/include/ao, /usr/lib/ao and /usr/share/doc/libao-&libao-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libao-lib">
        <term><filename class="libraryfile">libao.so</filename></term>
        <listitem>
          <para>
            provides functions for programs wishing to output sound over
            supported platforms
          </para>
          <indexterm zone="libao libao-lib">
            <primary sortas="c-libao">libao.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>