source: archive/libmikmod.xml@ 48b59802

<?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;

    <!-- Inserted as a reminder to do this. The mention of a test suite
         is usually right before the root user installation commands. Please
         delete these 12 (including one blank) lines after you are done.-->

    <!-- Use one of the two mentions below about a test suite,
         delete the line that is not applicable. Of course, if the
         test suite uses syntax other than "make check", revise the
         line to reflect the actual syntax to run the test suite -->

    <!-- <para>This package does not come with a test suite.</para> -->
    <!-- <para>To test the results, issue: <command>make check</command>.</para> -->

  <!ENTITY libmikmod-download-http "http://mikmod.raphnet.net/files/libmikmod-&libmikmod-version;.tar.gz">
  <!ENTITY libmikmod-download-ftp  "&gentoo-ftp-repo;/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;">
  <?dbhtml filename="libmikmod.html"?>

  <sect1info>
    <date>$Date$</date>
  </sect1info>

  <title>Libmikmod-&libmikmod-version;</title>

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

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

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

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <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>

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

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><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>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/libmikmod"/></para>

  </sect2>

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

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

<screen><userinput>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</userinput></screen>

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

<screen role="root"><userinput>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</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <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 role="content">
    <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"?>
      <?dbhtml list-presentation="table"?>

      <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>