source: multimedia/libdriv/libao.xml@ 4ec808b

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

  <!ENTITY libao-download-http "http://downloads.xiph.org/releases/ao/libao-&libao-version;.tar.gz">
  <!ENTITY libao-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/libao-&libao-version;.tar.gz">
  <!ENTITY libao-md5sum        "12e136a4c0995068ff134997c84421ed">
  <!ENTITY libao-size          "387 KB">
  <!ENTITY libao-buildsize     "3.8 MB">
  <!ENTITY libao-time          "less than 0.1 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">libao-&libao-version;.tar</keyword>
      <keyword role="ftpdir">libao</keyword>
    </keywordset>
  </sect1info>

  <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) and polypaudio (next generation
    <application>GNOME</application> sound architecture).</para>

    <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">X (<xref linkend="xfree86"/>, <xref linkend="xorg"/>
    or <xref linkend="xorg7"/>),
    <xref linkend="esound"/>,
    <xref linkend="alsa"/>,
    <xref linkend="arts"/>,
    <xref linkend="nas"/> and
    <ulink url="http://0pointer.de/lennart/projects/polypaudio/">polypaudio</ulink></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</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,a] and plugins</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,a]</filename></term>
        <listitem>
          <para>provide functions for programs wishing to output sound over
          supported platforms.</para>
          <indexterm zone="libao libao-lib">
            <primary sortas="c-libao">libao.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>