source: multimedia/audioutils/xmms.xml@ f15e274

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 XMMS-download-http "http://www.xmms.org/files/1.2.x/xmms-&XMMS-version;.tar.bz2">
  <!ENTITY XMMS-download-ftp  "ftp://ftp.fu-berlin.de/unix/linux/mirrors/gentoo/distfiles/xmms-&XMMS-version;.tar.bz2">
  <!ENTITY XMMS-md5sum        "03a85cfc5e1877a2e1f7be4fa1d3f63c">
  <!ENTITY XMMS-size          "2.4 MB">
  <!ENTITY XMMS-buildsize     "55 MB">
  <!ENTITY XMMS-time          "0.84 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">xmms-&XMMS-version;.tar</keyword>
      <keyword role="ftpdir">xmms</keyword>
    </keywordset>
  </sect1info>

  <title>XMMS-&XMMS-version;</title>

  <indexterm zone="xmms">
    <primary sortas="a-XMMS">XMMS</primary>
  </indexterm>

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

    <para><application>XMMS</application> is an audio player
    for the <application>X Window System</application>.</para>

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

    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/xmms-&XMMS-version;-gcc4-1.patch"/></para>
      </listitem>
    </itemizedlist>

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="GTK"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="alsa"/>,
    <xref linkend="esound"/>,
    <xref linkend="libvorbis"/> and
    <xref linkend="libmikmod"/></para>

  </sect2>

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

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

<screen><userinput>patch -Np1 -i ../xmms-&XMMS-version;-gcc4-1.patch &amp;&amp;
./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 -m755 -d /usr/share/doc/xmms-&XMMS-version; &amp;&amp;
install -v -m644 FAQ README /usr/share/doc/xmms-&XMMS-version;</userinput></screen>

  </sect2>

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

    <sect3 id="xmms-config-config">
      <title>Config Files</title>

      <para><filename>~/.xmms/config</filename></para>

      <indexterm zone="xmms xmms-config-config">
        <primary sortas="e-AA.xmms-config">~/.xmms/config</primary>
      </indexterm>

    </sect3>

    <sect3>
      <title>Configuration Information</title>

      <para>When you start <command>xmms</command> for the first time, you can
      configure it with <keycap>CTRL+P</keycap>. Note that you can extend
      <application>XMMS</application>' functionality with plugins and skins.
      You can find these at <ulink url="http://xmms.org"/>.</para>

    </sect3>

  </sect2>

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

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

      <seglistitem>
        <seg>xmms, xmms-config, and wmxmms</seg>
        <seg>libxmms.[so,a] and numerous input, output, effects, and general
        plugins</seg>
        <seg>/usr/include/xmms, /usr/lib/xmms, /usr/share/xmms and
        /usr/share/doc/xmms-&XMMS-version;</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="xmms-prog">
        <term><command>xmms</command></term>
        <listitem>
          <para> (an acronym for X MultiMedia System) is a program comparable
          in function with <application>WinAMP</application>. Its main function
          is playing audio files like WAV and MP3. It can be extended with
          plugins to play a number of other audio or video formats. Its look
          can be customized with <application>WinAMP</application> style
          skins.</para>
          <indexterm zone="xmms xmms-prog">
            <primary sortas="b-xmms">xmms</primary></indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="xmms-config">
        <term><command>xmms-config</command></term>
        <listitem>
          <para>is used by other programs which need to link with
          <command>xmms</command> to retrieve the library and include
          paths.</para>
          <indexterm zone="xmms xmms-config">
            <primary sortas="b-xmms-config">xmms-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="wmxmms">
        <term><command>wmxmms</command></term>
        <listitem>
          <para>is a dock applet for the <application>Window Maker</application>
          window manager. From the applet you can start and control
          <command>xmms</command>.</para>
          <indexterm zone="xmms wmxmms">
            <primary sortas="b-wmxmms">wmxmms</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libxmms">
        <term><filename class='libraryfile'>libxmms.[so,a]</filename></term>
        <listitem>
          <para>contains graphics and playback functions used by
          <command>xmms</command>. These functions can also be utilized by other
          packages.</para>
          <indexterm zone="xmms libxmms">
            <primary sortas="c-libxmms">libxmms.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>