source: multimedia/libdriv/alsa-lib.xml@ f3ebc751

<?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 alsa-lib-download-http "&alsa-download-http;/lib/alsa-lib-&alsa-lib-version;.tar.bz2">
  <!ENTITY alsa-lib-download-ftp  "&alsa-download-ftp;/lib/alsa-lib-&alsa-lib-version;.tar.bz2">
  <!ENTITY alsa-lib-md5sum        "114af3304619920ffe2b147b760700b9">
  <!ENTITY alsa-lib-size          "682 KB">
  <!ENTITY alsa-lib-buildsize     "27.3 MB (additional 14.4 MB to build and install docs)">
  <!ENTITY alsa-lib-time          "0.6 SBU">
]>

<sect1 id="alsa-lib" xreflabel="ALSA Library-&alsa-lib-version;">
  <?dbhtml filename="alsa-lib.html"?>

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

  <title>ALSA Library-&alsa-lib-version;</title>

  <indexterm zone="alsa-lib">
    <primary sortas="a-ALSA-Library">ALSA Library</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to ALSA Library</title>

    <para>The <application>ALSA Library</application> package contains
    the ALSA library.  This is used by programs (including <application>ALSA
    Utilities</application>) requiring access to the ALSA sound interface.</para>

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

    <bridgehead renderas="sect3">ALSA Library Dependencies</bridgehead>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para><xref linkend="doxygen"/></para>

  </sect2>

  <sect2 role="kernel"  id="alsa-lib-kernel">
    <title>Kernel Configuration</title>

    <para>In the <quote>Sound</quote> section of the kernel configuration, edit
    <emphasis role="bold">Advanced Linux Sound Architecture</emphasis>
    options to match your audio hardware and disable deprecated
    <emphasis role="bold">Open Sound System</emphasis>.
    Recompile and install your new kernel.</para>

    <indexterm zone="alsa-lib alsa-lib-kernel">
      <primary sortas="d-ALSA">ALSA</primary>
    </indexterm>

  </sect2>

  <sect2 role="installation">
    <title>Installation of ALSA Library</title>

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

<screen><userinput>./configure --enable-static &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 -D doc/asoundrc.txt \
    /usr/share/doc/alsa-lib-&alsa-lib-version;/asoundrc.txt</userinput></screen>

   <para>If you have <application>Doxygen</application> installed and you wish to
    build the library API documentation, run the following
    commands from the top-level directory of the source tree:</para>

<screen><userinput>make doc</userinput></screen>

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

<screen role="root"><userinput>install -v -d -m755 /usr/share/alsa/doc/html &amp;&amp;
install -v -m644 doc/doxygen/html/* /usr/share/alsa/doc/html</userinput></screen>

  </sect2>

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

    <para><parameter>--enable-static</parameter>: This switch is used to enable
    building the static library as some programs link against it.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring ALSA Library</title>

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

      <para><filename>~/.asoundrc</filename>,
      <filename>/etc/asound.conf</filename>,
      <filename>/usr/share/alsa/alsa.conf</filename>, and
      <filename>/usr/share/alsa/{cards,pcm}/*.conf</filename></para>

      <indexterm zone="alsa-lib alsa-lib-config">
        <primary sortas="e-AA.asoundrc">~/.asoundrc</primary>
      </indexterm>

      <indexterm zone="alsa-lib alsa-lib-config">
        <primary sortas="e-etc-asound.conf">/etc/asound.conf</primary>
      </indexterm>

      <indexterm zone="alsa-lib alsa-lib-config">
        <primary sortas="e-usr-share-alsa-alsa.conf">/usr/share/alsa/alsa.conf</primary>
      </indexterm>

      <indexterm zone="alsa-lib alsa-lib-config">
        <primary sortas="e-usr-share-alsa-alsa1">.../alsa/{cards,pcm}/*.conf</primary>
      </indexterm>

    </sect3>

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

      <para>The default <filename>alsa.conf</filename> is adequate for most
      installations. For extra functionality and/or advanced control of your sound
      device, you may need to create additional configuration files. For
      information on the available configuration parameters, visit <ulink
      url="http://www.alsa-project.org/alsa-doc/doc-php/asoundrc.php"/>.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>alsalisp and aserver</seg>
        <seg>libasound.[so,a]</seg>
        <seg>/usr/include/alsa, /usr/share/alsa and
        /usr/share/doc/alsa-lib-&alsa-lib-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libasound">
        <term><filename class='libraryfile'>libasound.[so,a]</filename></term>
        <listitem>
          <para>provides ALSA functions for application programs.</para>
          <indexterm zone="alsa-lib libasound">
            <primary sortas="c-libasound">libasound.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>