13980N/A<!DOCTYPE REFENTRY PUBLIC "-//Sun Microsystems//DTD DocBook V3.0-Based SolBook Subset V2.0//EN" [
13980N/A<!-- ARC : LSARC 2008/536 espeak for OpenSolaris-->
13980N/A<!ENTITY cmd "espeak">
13980N/A<!ENTITY % commonents SYSTEM "smancommon.ent">
13980N/A%commonents;
13980N/A<!ENTITY % booktitles SYSTEM "booktitles.ent">
13980N/A%booktitles;
13980N/A<!ENTITY suncopy "Copyright (c) 2008, Sun Microsystems, Inc. All Rights Reserved.">
13980N/A]>
13980N/A<?Pub UDT _bookmark _target>
13980N/A<?Pub Inc>
13980N/A<refentry id="espeak-1">
13980N/A<!-- %Z%%M% %I% %E% SMI; -->
13980N/A<refmeta><refentrytitle>&cmd;</refentrytitle><manvolnum>1</manvolnum>
13980N/A<refmiscinfo class="date">20 Aug 2008</refmiscinfo>
13980N/A<refmiscinfo class="sectdesc">&man1;</refmiscinfo>
13980N/A<refmiscinfo class="software">&release;</refmiscinfo>
13980N/A<refmiscinfo class="arch">generic</refmiscinfo>
13980N/A<refmiscinfo class="copyright">&suncopy;</refmiscinfo>
13980N/A</refmeta>
13980N/A
13980N/A<indexterm><primary>&cmd;</primary></indexterm><indexterm><primary>a compact open source software speech synthesizer</primary></indexterm>
13980N/A
13980N/A<refnamediv id="espeak-1-name"><refname>&cmd;</refname><refpurpose>a compact open source software speech synthesizer</refpurpose></refnamediv>
13980N/A
13980N/A<refsynopsisdiv id="espeak-1-synp"><title>&synp-tt;</title>
13980N/A<cmdsynopsis><command>&cmd;</command>
13980N/A<arg choice="opt"><option role="nodash"><replaceable>option...</replaceable></option></arg>
13981N/A<arg choice="opt"><option role="nodash"><replaceable>words</replaceable></option></arg>
13980N/A</cmdsynopsis>
13980N/A</refsynopsisdiv>
13980N/A
13980N/A<refsect1 id="espeak-1-desc"><title>&desc-tt;</title>
13980N/A<para><command>&cmd;</command> is a compact open source software speech synthesizer.
13981N/AIt can run as a command line program to speak text from a file or from
13981N/A<literal>stdin</literal>.</para>
13980N/A<para>Main features of <command>&cmd;</command>:</para>
13980N/A<para>
13980N/A<screen>
13981N/A * Includes different voices, whose characteristics
13980N/A can be altered.
13980N/A * Can produce speech output as a WAV file.
13980N/A * Supports SSML (Speech Synthesis Markup Language
13980N/A - not complete)
13980N/A * Supports HTML.
13980N/A * Is compact in size.
13980N/A * Can translate text to phoneme codes, so it could
13980N/A be adapted as a front end for another speech
13980N/A synthesis engine.
13980N/A * Is written in C++.
13980N/A</screen>
13980N/A</para>
13980N/A</refsect1>
13980N/A
13980N/A<refsect1 id="espeak-1-opts"><title>&opts-tt;</title>
13980N/A<para>The following options are supported:</para>
13980N/A<variablelist termlength="medium">
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>a <replaceable>integer</replaceable></option></term>
13981N/A<listitem><para>Amplitude as an <replaceable>integer</replaceable> in the
13981N/Arange from 0 to 200, default is 100.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>b</option></term>
13981N/A<listitem><para>Input text is 8-bit encoded.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13981N/A<term><option>f <replaceable>text_file</replaceable></option></term>
13983N/A<listitem><para>Speak text from <replaceable>text_file</replaceable>.
13983N/A</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>g <replaceable>integer</replaceable></option></term>
13981N/A<listitem><para>Specify the word gap, or the pause between words, as an
13981N/A<replaceable>integer</replaceable>. Units of 10mS at the default
13981N/Aspeed.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>k <replaceable>integer</replaceable></option></term>
13981N/A<listitem><para>Indicate how to speak capital letters as an
13981N/A<replaceable>integer</replaceable>. The argument can have the following
13981N/Avalues: 1=sound, 2=the word "capitals", higher values=a pitch increase (try
13981N/A<option>k</option> 20).</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>l <replaceable>integer</replaceable></option></term>
13981N/A<listitem><para>Line length as an <replaceable>integer</replaceable>. If not
13981N/Azero (which is the default), consider lines less than this length as
13981N/Aend-of-clause.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>m</option></term>
13981N/A<listitem><para>Interpret SSML markup, and ignore other &lt; &gt; tags.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>p <replaceable>integer</replaceable></option></term>
13981N/A<listitem><para>Pitch adjustment as an <replaceable>integer</replaceable> in
13981N/Athe range from 0 to 99, default is 50.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>q</option></term>
13981N/A<listitem><para>Quiet, do not produce any speech (may be useful with
13981N/A<option>x</option>).</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>s <replaceable>integer</replaceable></option></term>
13981N/A<listitem><para>Speed as an <replaceable>integer</replaceable> meaning
13981N/Awords per minute. Values can be from 80 to 370, default is 170.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13981N/A<term><option>v <replaceable>voice_file</replaceable></option></term>
13983N/A<listitem><para>Use specified <replaceable>voice_file</replaceable>.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13981N/A<term><option>w <replaceable>filename</replaceable></option></term>
13981N/A<listitem><para>Write output to the specified
13981N/A<replaceable>filename</replaceable>, in WAV format,
13981N/Arather than speaking it directly.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>x</option></term>
13981N/A<listitem><para>Write phoneme mnemonics to <literal>stdout</literal>.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>X</option></term>
13981N/A<listitem><para>Write phonemes mnemonics and translation trace to
13981N/A<literal>stdout</literal>.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>z</option></term>
13981N/A<listitem><para>No final sentence pause at the end of the text.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13981N/A<term><option>-compile=<replaceable>voice_name</replaceable></option></term>
13980N/A<listitem><para>Compile the pronunciation rules and dictionary in the
13981N/Acurrent directory. The <replaceable>voice_name</replaceable> value is optional
13981N/Aand specifies which language to use.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>-punct="<replaceable>characters</replaceable>"</option></term>
13981N/A<listitem><para>Speak the names of punctuation
13981N/A<replaceable>characters</replaceable> while speaking. If the
13981N/A<replaceable>characters</replaceable> value is omitted, all punctuation is
13981N/Aspoken.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13981N/A<term><option>-split=<replaceable>minutes</replaceable></option></term>
13981N/A<listitem><para>Starts a new WAV file every <replaceable>minutes<replaceable>. Used with <option>w</option>.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>-stdin</option></term>
13981N/A<listitem><para>Read text input from <literal>stdin</literal> instead of a
13981N/Afile.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>-stdout</option></term>
13981N/A<listitem><para>Write speech output to <literal>stdout</literal>.</para>
13980N/A</listitem></varlistentry>
13980N/A
13980N/A<varlistentry>
13980N/A<term><option>-voices=<replaceable>language</replaceable></option></term>
13981N/A<listitem><para>List the available voices for the specified
13981N/A<replaceable>language</replaceable>. If <replaceable>language</replaceable> is
13981N/Aomitted, then list all voices.</para>
13980N/A</listitem></varlistentry>
13980N/A</variablelist></refsect1>
13980N/A
13980N/A
13980N/A<refsect1 id="espeak-1-file"><title>&file-tt;</title>
13980N/A<para>The following files are used by &cmd;:</para>
13980N/A<variablelist termlength="wholeline">
13980N/A<varlistentry>
13980N/A<term><filename>/usr/lib/libespeak.so</filename></term>
13980N/A<listitem><para>
13980N/ALibrary for &cmd; speech synthesis
13980N/A</para>
13980N/A</listitem></varlistentry>
13980N/A<varlistentry>
13980N/A<term><filename>/usr/share/espeak-data</filename></term>
13980N/A<listitem><para>
13980N/ADirectory of voice language and data files
13980N/A</para>
13980N/A</listitem></varlistentry>
13980N/A</variablelist>
13980N/A</refsect1>
13980N/A
13980N/A<refsect1 id="espeak-1-attr"><title>&attr-tt;</title>
13980N/A<para>See <olink targetdocent="REFMAN5" localinfo="attributes-5"><citerefentry>
13980N/A<refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry></olink>
13980N/Afor descriptions of the following attributes:</para>
13980N/A<informaltable frame="all">
13980N/A<tgroup cols="2" colsep="1" rowsep="1"><colspec colname="COLSPEC0" colwidth="1*">
13980N/A<colspec colname="COLSPEC1" colwidth="1*">
13980N/A<thead>
13980N/A<row><entry align="center" valign="middle">ATTRIBUTE TYPE</entry><entry align="center"
13980N/Avalign="middle">ATTRIBUTE VALUE</entry></row>
13980N/A</thead>
13980N/A<tbody>
18745N/A<row><entry><para>Availability</para></entry><entry><para>library/speech/espeak</para></entry>
13980N/A</row>
13980N/A<row><entry colname="COLSPEC0"><para>Interface stability</para></entry><entry
13980N/Acolname="COLSPEC1"><para>Volatile</para></entry></row>
13980N/A</tbody>
13980N/A</tgroup>
13980N/A</informaltable>
13980N/A</refsect1>
13980N/A
13980N/A<refsect1 id="espeak-1-note"><title>&note-tt;</title>
13980N/A<para>
13980N/A&cmd; was written by Jonathan Duddington.
13980N/A</para>
13980N/A</refsect1>
13980N/A
13980N/A<refsect1 id="espeak-1-also"><title>&also-tt;</title>
13980N/A<para>
13980N/A<citerefentry><refentrytitle>orca</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
13980N/A<citerefentry><refentrytitle>libespeak</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13981N/A<citerefentry><refentrytitle>libgnomespeech</refentrytitle><manvolnum>3</manvolnum></citerefentry>,
13981N/A<citerefentry><refentrytitle>attributes</refentrytitle><manvolnum>5</manvolnum></citerefentry>
13980N/A</para>
13983N/A<para>
13983N/AAdditional information is available from the following site:
13983N/A</para>
13983N/A<para>
13983N/Ahttp://espeak.sourceforge.net/
13983N/A</para>
13980N/A</refsect1>
13980N/A
13980N/A</refentry>