source: kde/core/tqtinterface.xml@ d4eee5e0

<?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 tqtinterface-download-http "&trinity-repo-http;/tqtinterface-&trinity-version;.tar.gz">
  <!ENTITY tqtinterface-download-ftp  "&trinity-repo-ftp;/tqtinterface-&trinity-version;.tar.gz">
  <!ENTITY tqtinterface-md5sum        "d54cc9fd0b35555298efd17c32471a2b">
  <!ENTITY tqtinterface-size          "1 MB">
  <!ENTITY tqtinterface-buildsize     "10 MB">
  <!ENTITY tqtinterface-time          "0.6 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy: dj $</othername>
    <date>$Date: 2011-03-07 22:45:56 -0600 (Mon, 07 Mar 2011) $</date>
  </sect1info>

  <title>tqtinterface-&trinity-version;</title>

  <indexterm zone='tqtinterface'>
    <primary sortas='a-tqtinterface'>tqtinterface</primary>
  </indexterm>

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

    <para>The <application>tqtinterface</application> package  includes
    libraries that abstract the underlying Qt system from the actual Trinity
    code, allowing easy, complete upgrades to new versions of Qt.  </para>

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

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

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

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

  </sect2>

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

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

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

<screen><userinput>sed -i -e '/PKG/s@/usr@${EXEC_INSTALL_PREFIX}@' CMakeLists.txt &amp;&amp;
BUILD=/tmp/tqt   &amp;&amp;
TQT=`pwd`        &amp;&amp;
rm -rf   $BUILD  &amp;&amp;
mkdir -p $BUILD  &amp;&amp;
cd       $BUILD  &amp;&amp;

cmake $TQT                               \
  -DCMAKE_INSTALL_PREFIX=$TRINITY_PREFIX \
  -DCMAKE_VERBOSE_MAKEFILE=ON            \
  -DQT_VERSION=3 &amp;&amp;

unset TQT 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>sed ... CMakeLists.txt</userinput>: This command changes
    the location of <filename>tqt.pc</filename> to the $TRINITY_PREFIX
    directory hierarchy.</para>

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

    <para><userinput>rm -rf $BUIL; mkdir -p $BUILD; cd $BUILD</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>-QT_VERSION=3</option>: This option is required for this 
    package.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>convert_qt_tqt1,
        convert_qt_tqt2,
        convert_qt_tqt3,
        dcopidl-tqt,
        dcopidl2cpp-tqt,
        dcopidlng-tqt,
        mcopidl-tqt,
        moc-tqt,
        tmoc,
        tqt-replace,
        tqt-replace-stream,
        uic-tqt
        </seg>

        <seg>libtqassistantclient.so and libtqt.so</seg>
        
        <seg>$TRINITY_PREFIX/include/tqt</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="tqtinterfacec-config">
        <term><command>tqtinterfacec-config</command></term>
        <listitem>
          <para>is a utility to assist developers using the
          <application>aRts</application> C API.</para>
          <indexterm zone="aRts  tqtinterfacec-config">
            <primary sortas="b-tqtinterfacec-config">tqtinterfacec-config</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tqtinterfacecat">
        <term><command>tqtinterfacecat</command></term>
        <listitem>
          <para>is a simple utility to send raw audio data to the sound server.</para>
          <indexterm zone="aRts tqtinterfacecat">
            <primary sortas="b-tqtinterfacecat">tqtinterfacecat</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tqtinterfaced">
        <term><command>tqtinterfaced</command></term>
        <listitem>
          <para>is a daemon that provides access to the sound hardware resources.</para>
          <indexterm zone="aRts tqtinterfaced">
            <primary sortas="b-tqtinterfaced">tqtinterfaced</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tqtinterfacedsp">
        <term><command>tqtinterfacedsp</command></term>
        <listitem>
          <para>provides an interim solution that allows most of legacy
          sound applications to run unchanged.</para>
          <indexterm zone="aRts tqtinterfacedsp">
            <primary sortas="b-tqtinterfacedsp">tqtinterfacedsp</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="tqtinterfaceplay">
        <term><command>tqtinterfaceplay</command></term>
        <listitem>
          <para>is a simple utility to play a sound file.</para>
          <indexterm zone="aRts tqtinterfaceplay">
            <primary sortas="b-tqtinterfaceplay">tqtinterfaceplay</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tqtinterfacerec">
        <term><command>tqtinterfacerec</command></term>
        <listitem>
          <para>is a simple utility to record audio input.</para>
          <indexterm zone="aRts tqtinterfacerec">
            <primary sortas="b-tqtinterfacerec">tqtinterfacerec</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tqtinterfaceshell">
        <term><command>tqtinterfaceshell</command></term>
        <listitem>
          <para>is intended as a utility to perform miscellaneous functions
          related to the sound server.</para>
          <indexterm zone="aRts tqtinterfaceshell">
            <primary sortas="b-tqtinterfaceshell">tqtinterfaceshell</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="tqtinterfacewrapper">
        <term><command>tqtinterfacewrapper</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>tqtinterfaced</command> as a non-root user.</para>
          <indexterm zone="aRts tqtinterfacewrapper">
            <primary sortas="b-tqtinterfacewrapper">tqtinterfacewrapper</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>
    -->
  </sect2>

</sect1>