source: gnome/add/gnome-speech.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 gnome-speech-download-http "http://ftp.gnome.org/pub/GNOME/sources/gnome-speech/0.3/gnome-speech-&gnome-speech-version;.tar.bz2">
<!ENTITY gnome-speech-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gnome-speech/0.3/gnome-speech-&gnome-speech-version;.tar.bz2">
<!ENTITY gnome-speech-md5sum "34382d0b33146b1f8fc5239895471369">
<!ENTITY gnome-speech-size "255 KB">
<!ENTITY gnome-speech-buildsize "4.6 MB">
<!ENTITY gnome-speech-time "0.15 SBU">
]>

<sect1 id="gnome-speech" xreflabel="GNOME Speech-&gnome-speech-version;">
<sect1info>
<othername>$LastChangedBy$</othername>
<date>$Date$</date>
</sect1info>
<?dbhtml filename="gnome-speech.html"?>
<title>GNOME Speech-&gnome-speech-version;</title>

<sect2>
<title>Introduction to <application><acronym>GNOME</acronym> 
Speech</application></title>

<para>
The <application><acronym>GNOME</acronym> Speech</application> package 
provides a simple general <acronym>API</acronym> for producing text-to-speech 
output. Multiple backends are supported by the
<application><acronym>GNOME</acronym> 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>

<sect3><title>Package information</title>
<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>
</sect3>

<sect3><title><application><acronym>GNOME</acronym> Speech</application> 
dependencies</title>
<sect4><title>Required</title>
<para><xref linkend="libbonobo"/></para>
</sect4>

<sect4><title>Optional</title>
<para><xref linkend="java-access-bridge"/>, 
<ulink url="http://www.cstr.ed.ac.uk/projects/festival/">Festival</ulink>, 
<ulink url="http://freetts.sourceforge.net/">FreeTTS</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>
</sect4>
</sect3>

</sect2>

<sect2>
<title>Installation of <application><acronym>GNOME</acronym> 
Speech</application></title>

<note><para>You must install at least one of the backend drivers for 
<application><acronym>GNOME</acronym> 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><acronym>GNOME</acronym> Speech</application> is 
recommended.</para></note>

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

<screen><userinput><command>./configure --prefix=`pkg-config --variable=prefix ORBit-2.0` &amp;&amp;
make &amp;&amp;
make install</command></userinput></screen>

</sect2>

<sect2>
<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><acronym>GNOME</acronym> Speech</application> build 
in Java 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>
<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, then prompts you (with on-screen prompts and text-to-speech 
audio) for additional information.</para>

</sect2>

<sect2>
<title>Contents</title>

<para>The <application><acronym>GNOME</acronym> Speech</application>
package contains
<command>festival-synthesis-driver</command>,
<command>test-speech</command> and
<filename class="libraryfile">libgnomespeech</filename>. Other drivers 
and libraries are also installed if you have enabled additional 
backends.</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>test-speech</title>
<para><command>test-speech</command> is used to test the various backend 
drivers and voices installed on the system.</para>
</sect3>

<sect3><title>libgnomespeech</title>
<para><filename class="libraryfile">libgnomespeech</filename> provides 
the <acronym>API</acronym> for programs to convert text into
speech.</para>
</sect3>

</sect2>

</sect1>