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

<!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 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        "c677299ed39d069c9a4b6a999e34ffe7">
  <!ENTITY alsa-lib-size          "682 KB">
  <!ENTITY alsa-lib-buildsize     "34.2 MB (additional 11.4 MB to build and install docs)">
  <!ENTITY alsa-lib-time          "0.56 SBU">
]>

<sect1 id="alsa-lib" xreflabel="ALSA Library-&alsa-lib-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="alsa-lib.html"?>
<title>ALSA Library-&alsa-lib-version;</title>
<indexterm zone="alsa-lib">
<primary sortas="a-ALSA-Library">ALSA Library</primary></indexterm>

<sect2>
<title>Introduction to <application><acronym>ALSA</acronym> 
Library</application></title>

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

<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application><acronym>ALSA</acronym> Library</application> 
dependencies</title>
<sect4><title>Optional</title>
<para><ulink url="http://jackit.sourceforge.net/">JACK</ulink> and 
<xref linkend="doxygen"/></para>
</sect4>
</sect3>

</sect2>

<sect2 id="alsa-lib-kernel">
<title>Installation of <application><acronym>ALSA</acronym> 
Library</application>
</title>

<para>In the <quote>Sound</quote> section of the kernel configuration, edit 
<userinput>Advanced Linux Sound Architecture</userinput> options to match your 
audio hardware and disable deprecated <userinput>Open Sound System</userinput>. 
Recompile and install your new kernel.</para>
<indexterm zone="alsa-lib alsa-lib-kernel">
<primary sortas="d-ALSA">ALSA</primary></indexterm>

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

<screen><userinput><command>./configure --enable-static &amp;&amp;
make</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>

<para>If you have <application><acronym>JACK</acronym></application> installed 
and you wish to build the <application><acronym>JACK</acronym></application> 
<acronym>PCM</acronym> plugin library, run the following commands:</para>

<screen><userinput><command>cd src/pcm/ext &amp;&amp;
make jack</command></userinput></screen>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install-jack</command></userinput></screen>

<para>Ensure the unprivileged user's current working directory is the root of 
the source tree:</para>

<screen><userinput><command>cd ../../..</command></userinput></screen>

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

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

<para>Now, as the root user:</para>

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

</sect2>

<sect2>
<title>Command explanations</title>

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

</sect2>

<sect2>
<title>Configuring <application><acronym>ALSA</acronym> 
Library</application></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-cards">/usr/share/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, including setup of the 
<application><acronym>JACK</acronym></application> <acronym>PCM</acronym> 
plugin, visit <ulink 
url="http://www.alsa-project.org/alsa-doc/doc-php/asoundrc.php"/>.</para>
</sect3>

</sect2>

<sect2>
<title>Contents</title>

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

<seglistitem>
<seg>alsalisp and aserver</seg>
<seg>libasound.[so,a] and optionally, libasound_module_pcm_jack.[so,a]</seg>
<seg>/usr/include/alsa, /usr/lib/alsa-lib, /usr/share/alsa</seg>
</seglistitem>
</segmentedlist>

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

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

</sect2>

</sect1>