source: kde/core/arts.xml@ 4aea8a0

<?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 "&trinity-repo-http;/arts-&trinity-version;.tar.gz">
  <!ENTITY arts-download-ftp  "&trinity-repo-ftp;/arts-&trinity-version;.tar.gz">
  <!ENTITY arts-md5sum        "109124dabb1aaa9d44eb32e43b549142">
  <!ENTITY arts-size          "920 KB">
  <!ENTITY arts-buildsize     "36 MB">
  <!ENTITY arts-time          "0.6 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>aRts-&trinity-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>Trinity</application> programs 
    and libraries.</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="alsa"/>,
      <xref linkend="audiofile"/>,
      <xref linkend="cmake"/>,
      <xref linkend="glib2"/>
      <xref linkend="libmad"/>,
      <xref linkend="libvorbis"/>, and
      <xref linkend="qt"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/arts"/></para>

  </sect2>

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

    <note><para>When extracted, the <application>aRts</application> tar 
    file expands into the directory 
    <filename class='directory'>dependencies/arts</filename>.</para></note>

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

<screen><userinput>BUILD=/tmp/buildarts &amp;&amp;
ARTS=`pwd`           &amp;&amp;
rm -rf   $BUILD      &amp;&amp;
mkdir -p $BUILD      &amp;&amp;
cd       $BUILD      &amp;&amp;

cmake $ARTS                              \
  -DCMAKE_INSTALL_PREFIX=$TRINITY_PREFIX \
  -DCMAKE_VERBOSE_MAKEFILE=ON &amp;&amp;

unset ARTS BUILD     &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="commands">
    <title>Command Explanations</title>

    <para><userinput>ARTS=`pwd`</userinput>: This command saves the 
    location of the <application>aRts</application> source code.</para>

    <para><userinput>rm -rf /tmp/buildarts; mkdir -p /tmp/buildarts; cd
    /tmp/buildarts</userinput>:  The developers strongly recommend building
    Trinity components in a directory separate from the source code.  These
    commands ensure a clean starting location for the build process.</para>

    <para><option>-DCMAKE_INSTALL_PREFIX=$TRINITY_PREFIX</option>: This option
    is the equivalent of the ./configure <option>--prefix</option>
    option.</para>

    <para><option>-DCMAKE_VERBOSE_MAKEFILE=ON</option>: This option
    provides verrbose messages when <userinput>make</userinput> is
    run.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>artsc-config, artscat, artsd, artsdsp, artsplay, artsrec, 
        artsshell, artswrapper, and mcopidl </seg>

        <seg>aRts libraries</seg>
        
        <seg>The following subdirectories of $TRINITY_PREFIX: 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="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="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="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="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="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>

      <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="artsrec">
        <term><command>artsrec</command></term>
        <listitem>
          <para>is a simple utility to record audio input.</para>
          <indexterm zone="aRts artsrec">
            <primary sortas="b-artsrec">artsrec</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="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="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>

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