Back

## 2.1 INSTALLATION

(This section only applies to Linux and other Posix systems).
There are two versions of the command line program. They both have the same command parameters (see below).

1. espeak uses speech engine in the libespeak shared library. The libespeak library must first be installed.

2. speak is a stand-alone version which includes its own copy of the speech engine.

Place the espeak or speak executable file in the command path, eg in /usr/local/bin

Place the "espeak-data" directory in /usr/share as /usr/share/espeak-data.
Alternatively if it is placed in the user's home directory (i.e. /home/<user>/espeak-data) then that will be used instead.

#### Dependencies

espeak uses the PortAudio sound library (version 18), so you will need to have the libportaudio0 library package installed. It may be already, since it's used by other software, such as OpenOffice.org and the Audacity sound editor.

Some Linux distrubitions (eg. SuSe 10) have version 19 of PortAudio which has a slightly different API. The speak program can be compiled to use version 19 of PortAudio by copying the file portaudio19.h to portaudio.h before compiling.

The speak program may be compiled without using PortAudio, by removing the line

       #define USE_PORTAUDIO

in the file speech.h.

## 2.2 COMMAND OPTIONS

### 2.2.1 Examples

To use at the command line, type:
espeak "This is a test"
or
espeak -f <text file>

Or just type
espeak
followed by text on subsequent lines. Each line is spoken when RETURN is pressed.
Use espeak -x to see the corresponding phoneme codes.

### 2.2.2 Use with KDE Text-to-Speech (KTTS)

To add to KDE-Text-to-Speech Manager (KTTSMgr), use it as a "Command" talker with "command for speaking texts" set to:
cat %f | espeak --stdin -w %w

Note:

- When used by the KTTS system, I noticed a slight background hiss with the speech, which is not present when I use espeak directly from the command line. This was because KDE sound default was set to "8 bits" rather than 16 bits.
- KTTSMgr breaks the text into sentences to pass to the speech engine, but it mistakenly assumes sentence breaks when dots follow abbreviations and therefore pauses after the dots in "eg. Mr. John B. Smith etc." Speaking a text file directly with espeak gives better results in this respect.
- Speaking text from a web page using KTTS often causes headings and image captions to be run together with the following text as a single sentence. Speaking the HTML directly with the -m option set (i.e. using espeak -m -f text.html), may help if this is a problem.

### 2.2.3 The Command Line Options

espeak [options] ["words"]
  Text input can be taken either from a file, from a string in the command, or from stdin.

-f <text file>
  Speaks a text file.

--stdin
  Takes the text input from stdin.

If neither -f nor --stdin is given, then the text input is taken from "words" (a text string within double quotes).
If that is not present then text is taken from stdin, but each line is treated as a separate sentence.

-a <integer>
  Sets amplitude (volume) in a range of 0 to 200. The default is 100.

-p <integer>
  Adjusts the pitch in a range of 0 to 99. The default is 50.

-s <integer>
  Sets the speed in words-per-minute (approximate values for the default voice, others may differ slightly). The default value is 170. I generally use a faster speed of 185. Range 80 to 370.

-b
  Indicates that the input text is in the 8-bit character set which corresponds to the language (eg. Latin-2 for Polish). Without this option, eSpeak assumes text is UTF8, but will automatically switch to the 8-bit character set if it finds an illegal UTF8 sequence. That may give wrong results if some 8-bit character sequences look like valid UFT8 multibyte characters.

-l <integer>
  Line-break length, default value 0. If set, then lines which are shorter than this are treated as separate clauses and spoken separately with a break between them. This can be useful for some text files, but bad for others.

-m
  Indicates that the text contains SSML (Speech Synthesis Markup Language) tags or other XML tags. Those SSML tags which are supported are interpreted. Other tags, including HTML, are ignored, except that some HTML tags such as <hr> <h2> and <li> ensure a break in the speech.

-v <voice filename>[+<variant>]
  Sets a Voice for the speech, usually to select a language. eg:

         espeak -vaf

  To use the Afrikaans voice. A modifier after the voice name can be used to vary the tone of the voice, eg:

         espeak -vaf+3

  The variants are `+1 +2 +3 +4 +5` for male voices and `+11 +12 +13 +14` which simulate female voices by using higher pitches.

  <voice filename> is a file within the `espeak-data/voices` directory.
  Voice files can specify a language, different pitches, tonal qualities, and prosody for the voice. See the voices.html file.

  Voice names which start with mb- are for use with Mbrola diphone voices, see mbrola.html

  Some languages may need additional dictionary data, see languages.html

-w <wave file>
  Writes the speech output to a file in WAV format, rather than speaking it.

-x
  The phoneme mnemonics, into which the input text is translated, are shown on stdout.

-X
  As -x, but in addition, details are shown of the pronunciation rule and dictionary list lookup. This can be useful to see why a certain pronunciation is being produced. Each matching pronunciation rule is listed, together with its score, the highest scoring rule being used in the translation. "Found:" indicates the word was found in the dictionary lookup list, and "Flags:" means the word was found with only properties and not a pronunciation. You can see when a word has been retranslated after removing a prefix or suffix.

-q
  Quiet. No sound is generated. This may be useful with the -x option.

-z
  The option removes the end-of-sentence pause which normally occurs at the end of the text.

--stdout
  Writes the speech output to stdout as it is produced, rather than speaking it. The data starts with a WAV file header which indicates the sample rate and format of the data. The length fields are set to zero because the length of the data is unknown when the header is produced.

--compile[=<voice name>]
  Compile the pronunciation rule and dictionary lookup data from their source files in the current directory. The Voice determines which language's files are compiled. For example, if it's an English voice, then en_rules, en_list, and en_extra (if present), are compiled to replace en_dict in the speak-data directory. If no Voice is specified then the default Voice is used.

--punct[="<characters>"]
  Speaks the names of punctuation characters when they are encountered in the text. If <characters> are given, then only those listed punctuation characters are spoken, eg. `--punct=".,;?"`

--voices[=<language code>]
  Lists the available voices.
  If =<language code> is present then only those voices which are suitable for that language are listed.

### 2.2.4 The Input Text

HTML Input
  If the -m option is used to indicate marked-up text, then HTML can be spoken directly.

Phoneme Input
  As well as plain text, phoneme mnemonics can be used in the text input to espeak. They are enclosed within double square brackets. Spaces are used to separate words and all stressed syllables must be marked explicitly.
  eg: `[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]]`