source: gnome/add/gnome-speech.xml@ 1039de3

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

  <!ENTITY gnome-speech-download-http "&gnome-download-http;/gnome-speech/0.3/gnome-speech-&gnome-speech-version;.tar.bz2">
  <!ENTITY gnome-speech-download-ftp  "&gnome-download-ftp;/gnome-speech/0.3/gnome-speech-&gnome-speech-version;.tar.bz2">
  <!ENTITY gnome-speech-md5sum        "b477d4e0e01b79374f60ceee597c2c3d">
  <!ENTITY gnome-speech-size          "286 KB">
  <!ENTITY gnome-speech-buildsize     "4.8 MB">
  <!ENTITY gnome-speech-time          "0.1 SBU">
]>

<sect1 id="gnome-speech" xreflabel="GNOME Speech-&gnome-speech-version;">
  <?dbhtml filename="gnome-speech.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">gnome-speech-&gnome-speech-version;.tar</keyword>
      <keyword role="ftpdir">gnome-speech</keyword>
    </keywordset>
  </sect1info>

  <title>GNOME Speech-&gnome-speech-version;</title>

  <indexterm zone="gnome-speech">
    <primary sortas="a-GNOME Speech">GNOME Speech</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to GNOME Speech</title>

    <para>The <application>GNOME Speech</application> package provides a
    simple general API for producing text-to-speech output. Multiple backends
    are supported by the <application>GNOME Speech</application> library, but
    currently only the <application>Festival</application> backend is built
    by default; the other backends require either Java or proprietary
    software.</para>

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

    <!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/gnome-speech-&gnome-speech-version;-freetts_fix-1.patch"/></para>
      </listitem>
    </itemizedlist>
    -->

    <bridgehead renderas="sect3">GNOME Speech Dependencies</bridgehead>

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

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="java-access-bridge"/>,
    <xref linkend="freetts"/>,
    <ulink url="http://www.cstr.ed.ac.uk/projects/festival/">Festival</ulink>,
    <ulink url="http://www.ibm.com/software/voice/viavoice/">ViaVoice</ulink>,
    <ulink url="http://www.scansoft.com/">Eloquence</ulink>,
    <ulink url="http://www.fonix.com/">DECTalk</ulink>, and
    <ulink url="http://www.cepstral.com/">Theta</ulink></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of GNOME Speech</title>

    <note>
      <para>You must install at least one of the backend drivers for
      <application>GNOME Speech</application> to render speech through the
      audio hardware. Testing the installation of the backend driver to
      ensure it produces desired results before installing
      <application>GNOME Speech</application> is recommended.</para>
    </note>

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

<screen><userinput>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` &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 &amp;&amp;
install -v -m644 -D doc/gnome-speech.html \
    `pkg-config --variable=prefix \
    ORBit-2.0`/share/doc/gnome-speech-&gnome-speech-version;/gnome-speech.html</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><option>--with-jab-dir=`pkg-config
    --variable=prefix ORBit-2.0`/share/jar</option>: Use this option if you
    have installed the <application>Java Access Bridge</application> package
    and wish to have <application>GNOME Speech</application> build
    in <application>Java</application> support.</para>

    <para>Note: see the <filename>README</filename> and
    <filename>INSTALL</filename> files in the package source tree for the
    correct parameters to pass to <command>configure</command> to enable the
    desired backends.</para>

  </sect2>

  <sect2 role="testing">
    <title>Testing the Installation</title>

    <para>You can test all the available backend drivers, voices and audio
    hardware using the <command>test-speech</command> command. Invoking
    <command>test-speech</command> produces a menu allowing you to select
    a backend driver and the desired voice, then prompts you (with on-screen
    prompts and text-to-speech audio) for additional information.</para>

    <para>If you are using the <application>FreeTTS</application> backend and
    you do not hear any audio, you may need to use the streaming audio method
    instead of the clip audio method. As the
    <systemitem class="username">root</systemitem> user, modify the
    <command>freetts-synthesis-driver</command> script:</para>

<screen role='root'><userinput>sed -i "s/clip/streaming/" $GNOME_PREFIX/bin/freetts-synthesis-driver</userinput></screen>

  </sect2>

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

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

      <seglistitem>
        <seg>festival-synthesis-driver, freetts-synthesis-driver and
        test-speech</seg>
        <seg>libgnomespeech.[so,a]. Other drivers and libraries are also
        installed if you have enabled additional backends.</seg>
        <seg>The following subdirectories of $GNOME_PREFIX:
        include/gnome-speech-1.0,
        share/[doc/gnome-speech-&gnome-speech-version;,
        gnome-speech,
        idl/gnome-speech-1.0]</seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="test-speech">
        <term><command>test-speech</command></term>
        <listitem>
          <para>is used to test the various backend drivers and voices
          installed on the system.</para>
          <indexterm zone="gnome-speech test-speech">
            <primary sortas="b-test-speech">test-speech</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="libgnomespeech">
        <term><filename class='libraryfile'>libgnomespeech.[so,a]</filename></term>
        <listitem>
          <para>provides the API for programs to convert text into speech.</para>
          <indexterm zone="gnome-speech libgnomespeech">
            <primary sortas="c-libgnomespeech">libgnomespeech.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>