source: multimedia/audioutils/audacious.xml@ 92ada82

<?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.audacious-media-player.org/audacious-&audacious-version;.tar.bz2">
  <!ENTITY audacious-download-ftp         " ">
  <!ENTITY audacious-md5sum               "093208db6d22e9fa225cb8d83b981907">
  <!ENTITY audacious-size                 "560 KB">
  <!ENTITY audacious-buildsize            "47 MB (with Gtk and Qt5 user interfaces)">
  <!ENTITY audacious-time                 "0.5 SBU (with Gtk and Qt5 user interfaces)">

  <!ENTITY audacious-plugins-download
           "http://distfiles.audacious-media-player.org/audacious-plugins-&audacious-plugins-version;.tar.bz2">
  <!ENTITY audacious-plugins-md5sum       "1cbf90fa8a3a9f30f8e68333399f68c2">
  <!ENTITY audacious-plugins-size         "1.8 MB">
  <!ENTITY audacious-plugins-buildsize    "139 MB (with Gtk and Qt5 user interfaces)">
  <!ENTITY audacious-plugins-time         "1.5 SBU (with Gtk and Qt5 user interfaces)">
]>

<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 an audio player.
    </para>

    &lfs78_checked;

    <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 Plugins</title>
      <listitem>
        <para>
          Download (HTTP): <ulink url="&audacious-plugins-download;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &audacious-plugins-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &audacious-plugins-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &audacious-plugins-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &audacious-plugins-time;
        </para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk2"/> or
      <xref linkend="qt5"/> (or both),
      <xref linkend="libxml2"/> (plugins),
      <xref linkend="xorg-env"/> (plugins), and
      <xref linkend="x-window-system"/> (runtime)
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="optional">
      <xref linkend="alsa"/> and
      <xref linkend="dbus"/><!--, also
FIXME - REMOVE COMMENT WHEN GNOME-ICON-THEME is put back into the book
      <xref linkend="gnome-icon-theme"/> (runtime)
-->
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="pcre"/> or
      <ulink url="https://github.com/kkos/oniguruma">Oniguruma</ulink>, and
      <xref linkend="valgrind"/>
<!--      <ulink url="http://atheme.org/projects/libguess.html">libguess</ulink>-->
    </para>

    <bridgehead renderas="sect4">Optional (for Plugins)</bridgehead>
    <para role="optional">
      <xref linkend="curl"/>,
      <xref linkend="faad2"/>,
      <xref linkend="ffmpeg"/>,
      <xref linkend="flac"/>,
      <xref linkend="lame"/>,
      <xref linkend="libcdio"/> (to identify and play CDs),
      <xref linkend="libnotify"/>,
      <xref linkend="libsamplerate"/>,
      <xref linkend="libsndfile"/>,
      <xref linkend="libvorbis"/>,
      <xref linkend="mpg123"/>,
      <xref linkend="neon"/> (for online mpg3 and ogg radio),
      <xref linkend="pulseaudio"/>,
      <xref linkend="sdl"/>,
      <ulink url="http://sourceforge.net/projects/bs2b/">The Bauer
        stereophonic-to-binaural DSP (bs2b) library</ulink>,
      <ulink url="http://sourceforge.net/apps/trac/fluidsynth/">FluidSynth</ulink>,
      <ulink url="http://jackit.sourceforge.net/">JACK</ulink>
        (requires <xref linkend="libsamplerate"/>),
<!--  <ulink url="http://sourceforge.net/projects/libbinio/">libbinio</ulink>
        (to build the AdPlug plugin),-->
      <ulink url="http://sourceforge.net/projects/libcue/">libcue</ulink>,
      <ulink url="http://sourceforge.net/projects/modplug-xmms/">libmodplug</ulink>,
      <ulink url="http://sourceforge.net/projects/libmms">libmms</ulink>,
      <ulink url="http://www.lirc.org/">LIRC</ulink>, and
      <ulink url="http://www.wavpack.com/">WavPack</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 (you may wish to change the stamp to another string):
    </para>

<screen><userinput>TPUT=/bin/true ./configure --prefix=/usr \
                           --with-buildstamp="BLFS" &amp;&amp;
make</userinput></screen>
<!--
    <para>
      If you have <xref linkend="doxygen"/> installed and wish to build the
      API documentation, issue <command>doxygen</command>.
    </para>-->

    <para>
      This package does not come with a test suite, but you can run, before
      installing, test <command>src/balsa</command>. You will see a lot of
      debugging messages scrolling in the console. This is actually useful
      because they can be used to track down a bug.
    </para>

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

<screen role="root"><userinput>make install</userinput></screen>
<!--
    <para>
      If you built the API documentation, install it as the
      <systemitem class="username">root</systemitem> user by issuing:
    </para>

<screen role="root"><userinput>install -v -m755 -d /usr/share/doc/audacious-&audacious-version;/api &amp;&amp;
install -v -m644    doc/html/* \
                    /usr/share/doc/audacious-&audacious-version;/api</userinput></screen>-->
  </sect2>

  <sect2 role="installation">
    <title>Installation of Audacious Plugins</title>
<!--
    <note>
      <para>
        If <application>Xorg</application> is not installed in
        <filename class="directory">/usr</filename>, tell the linker
        where to find it:
      </para>

<screen><userinput>export LIBRARY_PATH=$XORG_PREFIX/lib</userinput></screen>

    </note>-->

    <para>
      Install the required plugins package by unpacking the tarball, changing
      into the newly created directory, and issuing the following
      commands:
    </para>

<screen><userinput>TPUT=/bin/true ./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>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/update-icons-and-desktop.xml"/>
  </sect2>

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

    <para>
      <parameter>TPUT=/bin/true</parameter>: the default is for
      <command>make</command> to output text in color. This is fine if you are
      building in a terminal, but if you script the build process and pipe the
      output from <command>make</command> to a log file then the control
      characters used to color the text can make the logfile unreadable. This
      option stops it coloring the text.
    </para>

    <para><parameter>--with-buildstamp</parameter>: This switch appends
    the given text to the version string.</para>

    <para><option>--disable-gtk</option>: Use this to disable GTK+ support.</para>

    <para><option>--disable-mp3</option>: Use this for the plugins if you have
    not installed mpg123 and do not wish to play mp3 files.</para>

    <para><option>--enable-qt</option>: Use this to enable Qt support.</para>

    <para><option>--enable-valgrind</option>: Allow better Valgrind leak checks.</para>

  </sect2>

  <sect2 role="configuration">
    <title>Configuring Audacious</title>

    <para>
      If you prefer the old, smaller Winamp/XMMS interface, click on View&gt;
      Interface&gt; Winamp Classic Interface.
    </para>

    <para>
      If you built with both Gtk and Qt user interfaces, the Qt version
      can be executed from a terminal, issuing <command>audacious
      --qt</command>. If you wish a desktop menu entry to execute this Qt
      version, issue the following commands as the <systemitem
      class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>cp -v /usr/share/applications/audacious{,-qt}.desktop &amp;&amp;

sed -e '/^Name/ s/$/ Qt/' \
    -e '/Exec=/ s/audacious/&amp; --qt/' \
    -i /usr/share/applications/audacious-qt.desktop</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>
          audacious and audtool
        </seg>
        <seg>
          libaudcore.so, libaudgui.so, libaudqt.so, libaudtag.so, and several
          plugin libraries under /usr/lib/audacious/ sub-directories
        </seg>
        <seg>
          /usr/include/{audacious,libaudcore,libaudgui,libaudqt},
          /usr/lib/audacious and
          /usr/share/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 GTK+2 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="audtool">
        <term><command>audtool</command></term>
        <listitem>
          <para>
            is a small tool to modify the behavior of a running
            <command>audacious</command> instance.
          </para>
          <indexterm zone="audacious audtool">
            <primary sortas="b-audtool">audtool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>