source: multimedia/audioutils/audacious.xml@ 89488b4

<?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;.tar.bz2">
  <!--<!ENTITY audacious-download-ftp "&gentoo-ftp-repo;/audacious-&audacious-version;.tbz2">-->
  <!ENTITY audacious-download-ftp         " ">
  <!ENTITY audacious-md5sum               "5ecdff54f4c32c6ae958095d23c57308">
  <!ENTITY audacious-size                 "775 KB">
  <!ENTITY audacious-buildsize            "63 MB (typical)">
  <!ENTITY audacious-time                 "1.1 SBU">
  <!ENTITY audacious-plugins-download "http://distfiles.atheme.org/audacious-plugins-&audacious-plugins-version;.tar.bz2">
  <!ENTITY audacious-plugins-md5sum       "af35af836bf67fec4f762f7ddca104f2">
  <!ENTITY audacious-plugins-size         "2.1 MB">

]>

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

    &lfs70_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</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>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="gtk3"/> or <xref linkend="gtk2"/> (if
    both are installed it defaults to using <xref linkend="gtk3"/>) and
    <xref linkend="libmowgli"/></para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="optional"><xref linkend="dbus"/></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),
    <ulink url="http://www.atheme.org/project/libguess">libguess</ulink> and
    <xref linkend="doxygen"/></para>


    <bridgehead renderas="sect4">Optional (for Plugins)</bridgehead>
    <para role="optional"><xref linkend="alsa"/>,
    <xref linkend="curl"/>,
    <xref linkend="neon"/> (for online mpg3 and ogg radio),
    <xref linkend="lame"/>,
    <xref linkend="flac"/>,
    <xref linkend="libvorbis"/>,
    <xref linkend="faad2"/>,
    <xref linkend="ffmpeg"/>,
    <xref linkend="sdl"/>,
    <xref linkend="mpg123"/>,
    <xref linkend="libnotify"/>,
    <ulink url="http://adplug.sourceforge.net/">AdPlug</ulink>,
    <ulink url="http://www.gnu.org/software/libcdio/">libcdio</ulink>,
    <ulink url="http://sourceforge.net/projects/libmms">libmms</ulink>,
    <ulink url="http://www.mega-nerd.com/libsndfile/">libsndfile</ulink>,
    <ulink url="http://jackit.sourceforge.net/">JACK</ulink>,
    <ulink url="http://pulseaudio.org/">PulseAudio</ulink>,
    <ulink url="http://roaraudio.keep-cool.org/">libroar</ulink>,
    <ulink url="http://sourceforge.net/apps/trac/fluidsynth/">FluidSynth</ulink>,
    <ulink url="http://libmtp.sourceforge.net/">libmtp</ulink>,
    <ulink url="http://sourceforge.net/projects/libcue/">libcue</ulink>,
    <ulink url="http://sourceforge.net/projects/bs2b/">The Bauer
    stereophonic-to-binaural DSP (bs2b) library</ulink>,
    <ulink url="http://sourceforge.net/projects/libbinio/">libbinio</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:</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 &amp;&amp;
install -v -m644 -D README /usr/share/doc/audacious-&audacious-version;/README</userinput></screen>

  </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're
    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><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 output from
    <command>./configure --help</command> for information.</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>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>

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


  </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>libaudacious.so, libaudclient.so, libaudgui.so and numerous
        Container, Effect, General, Input, Output, Transport and Visualization
        plugin modules (exactly what gets installed depends on the dependencies
        you installed first)</seg>
        <seg>/usr/include/audacious, /usr/include/libaudcore,
        /usr/include/libaudgui, /usr/lib/audacious and
        /usr/share/audacious
        <!--/usr/share/doc/audacious-&audacious-version;,-->
        </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="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>

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

<!-- Who knows what they do?
      <varlistentry id="libaudclient">
        <term><filename class='libraryfile'>libaudclient.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="audacious libaudclient">
            <primary sortas="c-libaudclient">libaudclient.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libaudgui">
        <term><filename class='libraryfile'>libaudgui.so</filename></term>
        <listitem>
          <para>contains functions that .....</para>
          <indexterm zone="audacious libaudgui">
            <primary sortas="c-libaudgui">libaudgui.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
-->

    </variablelist>

  </sect2>

</sect1>