source: kde/core/arts.xml@ 86af98a

<?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.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

<!ENTITY arts-download-http "&kde-download-http;/arts-&arts-version;.tar.bz2">
<!ENTITY arts-download-ftp  "&kde-download-ftp;/arts-&arts-version;.tar.bz2">
<!ENTITY arts-md5sum        "a3d22f7cc5c641204a28d3f77e441a84">
<!ENTITY arts-size          "968 KB">
<!ENTITY arts-buildsize     "31.3 MB">
<!ENTITY arts-time          "2.00 SBU">
]>

<sect1 id="aRts" xreflabel="aRts-&arts-version;">
<sect1info>
  <othername>$LastChangedBy$</othername>
  <date>$Date$</date>
</sect1info>
<?dbhtml filename="arts.html"?>
<title><application><acronym>aRts</acronym></application>-&arts-version;</title>

<sect2><title>Introduction to <application><acronym>aRts</acronym></application></title>
<indexterm zone='aRts'>
  <primary sortas='a-ARts'>aRts</primary>
</indexterm>

<para>The Analog Real-time Synthesizer 
(<application><acronym>aRts</acronym></application>) provides 
sound support for <acronym>KDE</acronym> and necessary libraries for 
<application>kdelibs</application>.</para>

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

<sect3><title><application><acronym>aRts</acronym></application> 
dependencies</title>

<sect4><title>Required</title>
<para><xref linkend="qt"/> and 
<xref linkend="glib2"/></para>
</sect4>

<sect4><title>Recommended</title>
<para><xref linkend="libjpeg"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="libogg"/>, 
<xref linkend="libvorbis"/>, 
<xref linkend="alsa"/>, 
<xref linkend="audiofile"/>, 
<xref linkend="libmad"/>, 
<xref linkend="esound"/>, 
<ulink url="http://www.mediaapplicationserver.net/">MAS</ulink> and 
<ulink url="http://jackit.sourceforge.net/">JACK</ulink></para>
</sect4>
</sect3>

</sect2>

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

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

<screen><userinput><command>./configure --prefix=&kde-dir; --disable-debug \
    --disable-dependency-tracking &amp;&amp;
make</command></userinput></screen>

<para>Now, as the root user:</para>
 
<screen><userinput role='root'><command>make install</command></userinput></screen>

</sect2>

<sect2><title>Command explanations</title>

<para><parameter>--prefix=&kde-dir;</parameter>: This option tells the 
process to install the package in 
<filename class="directory">&kde-dir;</filename>. 
<application><acronym>aRts</acronym></application> is installed here as 
it's required before installing <acronym>KDE</acronym>.</para>

<para><option>--disable-debug</option>: This option causes the
package to be compiled without debugging code.</para>

<para><option>--disable-dependency-tracking</option>: This option
speeds up one time builds.</para>

</sect2>

<sect2><title>Contents</title>
<segmentedlist>
  <segtitle>Installed Programs</segtitle>
  <segtitle>Installed Libraries</segtitle>
 
  <seglistitem>
    <seg>artsd, artswrapper, artsshell, artsplay, artsdsp, artscat, arts-control, 
        artsc-config, mcopidl</seg>
    <seg>aRts libraries</seg>
  </seglistitem>
</segmentedlist>
 
<variablelist>
  <bridgehead renderas="sect3">Short Descriptions</bridgehead>
  <?dbfo list-presentation="list"?>
 
<varlistentry id="artsd">
  <term><command>artsd</command></term>
  <listitem>
    <para>is a daemon that provides access to the sound hardware resources.</para>
    <indexterm zone="aRts artsd">
      <primary sortas="b-artsd">artsd</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="artswrapper">
  <term><command>artswrapper</command></term>
  <listitem>
    <para>is a small wrapper program artswrapper which simply sets real-time priority (running as root) 
          and then executes artsd as a non-root user.</para>
    <indexterm zone="aRts artswrapper">
      <primary sortas="b-artswrapper">artswrapper</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="artsshell">
  <term><command>artsshell</command></term>
  <listitem>
    <para>is intended as a utility to perform miscellaneous functions related to the sound server.</para>
    <indexterm zone="aRts artsshell">
      <primary sortas="b-artsshell">artsshell</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="artsplay">
  <term><command>artsplay</command></term>
  <listitem>
    <para>is a simple utility to play a sound file.</para>
    <indexterm zone="aRts artsplay">
      <primary sortas="b-artsplay">artsplay</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="artsdsp">
  <term><command>artsdsp</command></term>
  <listitem>
    <para>provides an interim solution that allows most of legacy sound applications to run unchanged.</para>
    <indexterm zone="aRts artsdsp">
      <primary sortas="b-artsdsp">artsdsp</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="artscat">
  <term><command>artscat</command></term>
  <listitem>
    <para>is a simple utility to send raw audio data to the sound server.</para>
    <indexterm zone="aRts artscat">
      <primary sortas="b-artscat">artscat</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="artscontrol">
  <term><command>artscontrol</command></term>
  <listitem>
    <para>is a graphical utility for performing a number of tasks related to the sound server.</para>
    <indexterm zone="aRts  artscontrol">
      <primary sortas="b-artscontrol">artscontrol</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="artsc-config">
  <term><command>artsc-config</command></term>
  <listitem>
    <para>is a utility to assist developers using the aRts C API.</para>
    <indexterm zone="aRts  artsc-config">
      <primary sortas="b-artsc-config">artsc-config</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="mcopidl">
  <term><command>mcopidl</command></term>
  <listitem>
    <para>is the Interface Definition Language (IDL) file compiler for MCOP, 
          the Multimedia Communication Protocol used by aRts.</para>
    <indexterm zone="aRts  mcopidl">
      <primary sortas="b-mcopidl">mcopidl</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
<varlistentry id="libaRts">
  <term><filename class='libraryfile'>aRts Libraries</filename></term>
  <listitem>
    <para>contains functions that support aRts programs.</para>
    <indexterm zone="aRts libaRts">
      <primary sortas="c-libaRts">aRts Libraries</primary>
    </indexterm>
  </listitem>
</varlistentry>
 
</variablelist>

<para>To find out information about
<application><acronym>aRts</acronym></application> and the various programs
included in the package, see
<ulink url="http://docs.kde.org/en/3.3/kdemultimedia/artsbuilder/">The
<application><acronym>aRts</acronym></application> Handbook</ulink>. For
information in languages other then English, see the
<ulink url="http://docs.kde.org/">KDE Documentation</ulink> and navigate to
the <application><acronym>aRts</acronym></application> documentation in your
language.</para>

</sect2>

</sect1>