source: multimedia/audioutils/xmms.xml@ 17929f0

<!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  " ">
  <!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;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="xmms.html"?>
<title>XMMS-&XMMS-version;</title>
<indexterm zone="xmms">
<primary sortas="a-XMMS">XMMS</primary></indexterm>

<sect2>
<title>Introduction to 
<application><acronym>XMMS</acronym></application></title>

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

<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application><acronym>XMMS</acronym></application> 
dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="GTK"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="alsa"/>, 
<xref linkend="esound"/>, 
<xref linkend="libogg"/>, 
<xref linkend="libvorbis"/> and 
<xref linkend="libmikmod"/></para>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of 
<application><acronym>XMMS</acronym></application></title>

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

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

<para>This package does not come with a test suite.</para>

<para>Now, as the root user:</para>

<screen><userinput role='root'><command>make install</command></userinput></screen>
</sect2>

<sect2>
<title>Configuring <application><acronym>XMMS</acronym></application></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 <userinput>CTRL+P</userinput>. Note that you can extend XMMS' 
functionality with plugins and skins. You can find these at 
<ulink url="http://xmms.org"/>.</para>
</sect3>

</sect2>

<sect2>
<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 and /usr/share/xmms</seg>
</seglistitem>
</segmentedlist>

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

<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 <filename>WAV</filename> and 
<filename>MP3</filename>. 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>