source: multimedia/libdriv/libmikmod.xml@ 593d644

<!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 libmikmod-download-http "http://mikmod.raphnet.net/files/libmikmod-&libmikmod-version;.tar.gz">
  <!ENTITY libmikmod-download-ftp  "ftp://ftp.raphnet.net/pub/libmikmod/libmikmod-&libmikmod-version;.tar.gz">
  <!ENTITY libmikmod-md5sum        "705106da305e8de191549f1e7393185c">
  <!ENTITY libmikmod-size          "604 KB">
  <!ENTITY libmikmod-buildsize     "9.9 MB">
  <!ENTITY libmikmod-time          "0.3 SBU">
]>

<sect1 id="libmikmod" xreflabel="libmikmod-&libmikmod-version;">
<sect1info>
  <othername>$LastChangedBy$</othername>
  <date>$Date$</date>
</sect1info>

<?dbhtml filename="libmikmod.html"?>
<title>libmikmod-&libmikmod-version;</title>

<indexterm zone="libmikmod">
  <primary sortas="a-libmikmod">libmikmod</primary>
</indexterm>

<sect2>
<title>Introduction to <application>libmikmod</application></title>

<para>
<application>libmikmod</application> is a sound library capable of
playing audio samples as well as tracker modules. Supported module
formats include <acronym>MOD</acronym>, <acronym>S3M</acronym>,
<acronym>XM</acronym>, <acronym>IT</acronym>, <acronym>MED</acronym>,
<acronym>MTM</acronym> and <acronym>669</acronym>.</para>

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

<sect3>
<title><application>libmikmod</application> dependencies</title>

<sect4>
<title>Optional</title>
<para><xref linkend="alsa"/>, 
      <xref linkend="esound"/>, 
      <ulink url="http://www.perex.cz/~perex/ultra/">libGUS</ulink>, 
      <ulink url="http://osalp.sourceforge.net/">AFlib</ulink> and 
      <ulink url="http://www.anime.net/~sam9407/">SAM9407 driver</ulink></para>
</sect4>
</sect3>

<sect3>
<title>Additional downloads</title>

<itemizedlist spacing='compact'>
  <listitem><para>Recommended Patch: <ulink 
     url="http://mikmod.raphnet.net/files/libmikmod-3.1.11-a.diff"/></para>
  </listitem>
</itemizedlist>
</sect3>

</sect2>

<sect2>
<title>Installation of <application>libmikmod</application></title>

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

<screen><userinput><command>patch -Np1 -i ../libmikmod-3.1.11-a.diff &amp;&amp;
sed -i -e "s/VERSION=10/VERSION=11/" \
       -e "s/sys_asoundlib/alsa_asoundlib/" \
       -e "s/snd_cards/snd_card_load/g" \
       -e "s|sys/asoundlib.h|alsa/asoundlib.h|g" \
       -e "s/^LIBOBJS/#LIBOBJS/" \
    configure.in &amp;&amp;
autoconf &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</command></userinput></screen>

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

<screen><userinput role='root'><command>make install &amp;&amp;
chmod 755 /usr/lib/libmikmod.so.2.0.4 &amp;&amp;
install -v -m644 -D docs/mikmod.html \
    /usr/share/doc/libmikmod-3.1.11/mikmod.html</command></userinput></screen>

</sect2>

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

<para><command>sed -i -e ...</command>: This increments the package micro 
version and also modifies the <application>ALSA</application> header search
routine so that the package properly discovers the 
<application>ALSA</application> library.  It also fixes a problem 
which makes <application>autoconf</application> fail.</para>

<para><command>autoconf</command>: This generates a new 
<command>configure</command> script, required because of the changes to
<filename>configure.in</filename>.</para>

</sect2>

<sect2>
<title>Contents</title>

<segmentedlist>
  <segtitle>Installed Program</segtitle>
  <segtitle>Installed Library</segtitle>
  <segtitle>Installed Directory</segtitle>

  <seglistitem>
    <seg>libmikmod-config</seg>
    <seg>libmikmod.[so,a]</seg>
    <seg>/usr/share/doc/libmikmod-&libmikmod-version;</seg>
  </seglistitem>
</segmentedlist>

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

<varlistentry id="libmikmod-config">
  <term><command>libmikmod-config</command></term>
  <listitem>
    <para>provides version information, compiler, and linker flags 
    to programs that utilize <application>libmikmod</application>.</para>
    <indexterm zone="libmikmod libmikmod-config">
      <primary sortas="b-libmikmod-config">libmikmod-config</primary>
    </indexterm>
  </listitem>
</varlistentry>

<varlistentry id="libmikmod-lib">
  <term><filename class='libraryfile'>libmikmod.[so,a]</filename></term>
  <listitem>
    <para>contains functions that are required to play various tracker module 
      files.</para>
    <indexterm zone="libmikmod libmikmod-lib">
      <primary sortas="c-libmikmod">libmikmod.[so,a]</primary>
    </indexterm>
  </listitem>
</varlistentry>

</variablelist>

</sect2>
</sect1>