source: multimedia/audioutils/audacious.xml@ c909857d

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

  <!ENTITY audacious-download-http        "http://distfiles.atheme.org/audacious-&audacious-version;.tgz">
  <!ENTITY audacious-download-ftp         "&gentoo-ftp-repo;/audacious-&audacious-version;.tgz">
  <!ENTITY audacious-md5sum               "b784a30604a2f9d84e9da310069f43f9">
  <!ENTITY audacious-size                 "1.7 MB">
  <!ENTITY audacious-buildsize            "86 MB (includes all plugins and documentation)">
  <!ENTITY audacious-time                 "1.9 SBU">

  <!ENTITY audacious-plugins-version       "1.3.5">
  <!ENTITY audacious-plugins-download      "http://distfiles.atheme.org/audacious-plugins-&audacious-plugins-version;.tgz">
  <!ENTITY audacious-plugins-md5sum        "ff6b5901367337f8149e15c8fb1fdf95">
  <!ENTITY audacious-plugins-size          "2.9 MB">

  <!ENTITY audacious-plugins-ugly-version  "1.3.0">
  <!ENTITY audacious-plugins-ugly-download "http://distfiles.atheme.org/audacious-plugins-ugly-&audacious-plugins-ugly-version;.tgz">
  <!ENTITY audacious-plugins-ugly-md5sum   "3c6274c334c60e092135202a37c61dc2">
  <!ENTITY audacious-plugins-ugly-size     "438 KB">
]>

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

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

  <title>Audacious-&audacious-version;</title>

  <indexterm zone="audacious">
    <primary sortas="a-Audacious">Audacious</primary>
  </indexterm>

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

    <para><application>Audacious</application> is a Gtk+-2 based audio
    player.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
    <title>Required</title>
      <listitem>
        <para>Plugins: <ulink url="&audacious-plugins-download;"/></para>
      </listitem>
      <listitem>
        <para>Md5 sum: &audacious-plugins-md5sum;</para>
      </listitem>
      <listitem>
        <para>Size: &audacious-plugins-size;</para>
      </listitem>
    </itemizedlist>

    <itemizedlist spacing="compact">
    <title>Optional</title>
      <listitem>
        <para>Ugly Plugins: <ulink url="&audacious-plugins-ugly-download;"/></para>
      </listitem>
      <listitem>
        <para>Md5 sum: &audacious-plugins-ugly-md5sum;</para>
      </listitem>
      <listitem>
        <para>Size: &audacious-plugins-ugly-size;</para>
      </listitem>
    </itemizedlist>

    <para>Additional plugins can be downloaded from <ulink
    url="http://audacious-media-player.org/Plugins"/>. Note that these
    third-party plugins are not supported by the
    <application>Audacious</application> development team.</para>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="libglade"/> and
    <xref linkend="mcs"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="pcre"/> or
    <ulink url="http://www.geocities.jp/kosako3/oniguruma/">Oniguruma</ulink>,
    <ulink url="http://www.mega-nerd.com/libsamplerate/">Secret Rabbit Code</ulink>
      (a.k.a. libsamplerate), and
    <xref linkend="gtk-doc"/></para>


    <bridgehead renderas="sect4">Optional (for Plugins)</bridgehead>
    <para role="optional"><ulink url="http://adplug.sourceforge.net/">AdPlug</ulink>,
    <xref linkend="alsa"/>,
    <xref linkend="arts"/>,
    <xref linkend="curl"/>,
    <xref linkend="esound"/>,
    <ulink url="http://jackit.sourceforge.net/">JACK</ulink>,
    <xref linkend="lame"/>,
    <xref linkend="libmad"/>,
    <ulink url="http://www.musepack.net/">libmpcdec</ulink> (requires
    <ulink url="http://sourceforge.net/projects/libmms">libmms</ulink>,
    <ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink>,
    <xref linkend="libvorbis"/>,
    <ulink url="http://www.lirc.org">LIRC</ulink>,
    <ulink url="http://xmms-projectm.sourceforge.net/">projectM</ulink>,
    <ulink url="http://pulseaudio.org/">PulseAudio</ulink>,
    <ulink url="http://www.hunz.org/">rocklight</ulink> (only for IBM Thinkpads),
    <xref linkend="sdl"/>,
    <ulink url="http://developer.kde.org/~wheeler/taglib/">TagLib</ulink>), and
    <ulink url="http://www.wavpack.com/">WavPack</ulink></para>

    <bridgehead renderas="sect4">Optional (for Ugly Plugins)</bridgehead>
    <para role="optional"><ulink url="http://www.galago-project.org/news/index.php">libnotify</ulink></para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>If you wish to create the SDK documentation, issue the following
    command: <command>make documentation-build</command>.</para>

    <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 README /usr/share/doc/audacious-&audacious-version;/README</userinput></screen>

    <para>If you created the SDK documentation, install it by issuing the
    following commands as the <systemitem class="username">root</systemitem>
    user:</para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/gtk-doc/html/{,lib}audacious &amp;&amp;
install -v -m644    doc/audacious/html/* \
                    /usr/share/gtk-doc/html/audacious &amp;&amp;
install -v -m644    doc/libaudacious/html/* \
                    /usr/share/gtk-doc/html/libaudacious</userinput></screen>

  </sect2>

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

    <para><option>--enable-one-plugin-dir</option> and
    <option>--disable-user-plugin-dir</option>: These options are used to
    determine how the plugins are stored. Review the ouput from
    <command>./configure --help</command> for information.</para>

    <para><option>--enable-chardet</option>: This option is used to enable
    character set detection support.</para>

    <para><option>--enable-samplerate</option>: This option is used to enable
   libsamplerate support.</para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Audacious Plugins</title>

    <para>Install the required plugins package by unpacking the tarball, changing
    into the newly created directory, and issuing 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>

    <para>If desired, repeat this procedure for the optional plugins
    package.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>audacious, audacious-arts-helper and audtool</seg>
        <seg>libaudacious.so and numerous Container, Effect, General, Input,
        Output, Visualization, and amidi-plug plugin modules</seg>
        <seg>/usr/include/audacious, /usr/lib/audacious,
        /usr/share/audacious, /usr/share/doc/audacious-&audacious-version;,
        and /usr/share/gtk-doc/html/audacious</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="audacious-prog">
        <term><command>audacious</command></term>
        <listitem>
          <para>is a Gtk2 port of <application>XMMS</application> based on the
          <application>Beep Media Player</application>.</para>
          <indexterm zone="audacious audacious-prog">
            <primary sortas="b-audacious">audacious</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libaudacious">
        <term><filename class='libraryfile'>libaudacious.so</filename></term>
        <listitem>
          <para>contains functions that are used by
          <command>audacious</command> to render its
          graphical interface.</para>
          <indexterm zone="audacious libaudacious">
            <primary sortas="c-libaudacious">libaudacious.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>