glfs/kde/core/arts.xml
Randy McMurchy 6732c09460 Updated all the XML files (and the one stylesheet) to use the 4.5 version of DocBook XML DTD
git-svn-id: svn://svn.linuxfromscratch.org/BLFS/trunk/BOOK@6716 af4574ff-66df-0310-9fd7-8a98e5e911e0
2007-04-04 19:42:53 +00:00

261 lines
9.0 KiB
XML

<?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 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 "e986393a5827499bbad04a00b797add0">
<!ENTITY arts-size "952 KB">
<!ENTITY arts-buildsize "29.7 MB">
<!ENTITY arts-time "1.2 SBU">
]>
<sect1 id="aRts" xreflabel="aRts-&arts-version;">
<?dbhtml filename="aRts.html"?>
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<title>aRts-&arts-version;</title>
<indexterm zone='aRts'>
<primary sortas='a-ARts'>aRts</primary>
</indexterm>
<sect2 role="package">
<title>Introduction to aRts</title>
<para>The Analog Real-time Synthesizer (<application>aRts</application>)
provides sound support for <application>KDE</application> and necessary
libraries for <application>kdelibs</application>.</para>
<bridgehead renderas="sect3">Package Information</bridgehead>
<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>
<bridgehead renderas="sect3">aRts Dependencies</bridgehead>
<bridgehead renderas="sect4">Required</bridgehead>
<para role="required"><xref linkend="qt"/> and
<xref linkend="glib2"/></para>
<bridgehead renderas="sect4">Recommended</bridgehead>
<para role="recommended"><xref linkend="libjpeg"/></para>
<bridgehead renderas="sect4">Optional</bridgehead>
<para role="optional"><xref linkend="libvorbis"/>,
<xref linkend="alsa"/>,
<xref linkend="audiofile"/>,
<xref linkend="libmad"/>,
<xref linkend="esound"/>,
<xref linkend="nas"/>,
<ulink url="http://www.mediaapplicationserver.net/">MAS</ulink>, and
<ulink url="http://jackit.sourceforge.net/">JACK</ulink></para>
<para condition="html" role="usernotes">User Notes:
<ulink url="&blfs-wiki;/arts"/></para>
</sect2>
<sect2 role="installation">
<title>Installation of aRts</title>
<para>Install <application>aRts</application> by running
the following commands:</para>
<screen><userinput>./configure --prefix=&kde-dir; --disable-debug \
--disable-dependency-tracking &amp;&amp;
make</userinput></screen>
<para>This package does not come with a test suite that works with
<application>GCC</application>-&gcc-version;.</para>
<para>Now, as the <systemitem class="username">root</systemitem> user:</para>
<screen role='root'><userinput>make install</userinput></screen>
</sect2>
<sect2 role="commands">
<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>aRts</application> is installed here as it's required
before installing <application>KDE</application>.</para>
<para><parameter>--disable-debug</parameter>: This option causes the
package to be compiled without debugging code.</para>
<para><parameter>--disable-dependency-tracking</parameter>: This option
speeds up one time builds.</para>
</sect2>
<sect2 role="content">
<title>Contents</title>
<segmentedlist>
<segtitle>Installed Programs</segtitle>
<segtitle>Installed Libraries</segtitle>
<segtitle>Installed Directories</segtitle>
<seglistitem>
<seg>artsd, artswrapper, artsshell, artsplay, artsdsp, artscat, arts-control,
artsc-config, and mcopidl</seg>
<seg>aRts libraries</seg>
<seg>The following subdirectories of &kde-dir;/: bin, include/arts,
include/artsc, and lib/mcop</seg>
</seglistitem>
</segmentedlist>
<variablelist>
<bridgehead renderas="sect3">Short Descriptions</bridgehead>
<?dbfo list-presentation="list"?>
<?dbhtml list-presentation="table"?>
<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 which simply sets real-time priority
(running as <systemitem class="username">root</systemitem>)
and then executes <command>artsd</command> 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
<application>aRts</application> 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 <application>aRts</application>.</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 <application>aRts</application>
programs.</para>
<indexterm zone="aRts libaRts">
<primary sortas="c-libaRts">aRts Libraries</primary>
</indexterm>
</listitem>
</varlistentry>
</variablelist>
<para>To find out information about <application>aRts</application> and the
various programs included in the package, see <ulink
url="http://docs.kde.org/development/en/kdemultimedia/artsbuilder/">The
<application>aRts</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>aRts</application>
documentation in your language.</para>
</sect2>
</sect1>