From 1e2b619b2495f8b51bf05819f62589211a8d6a2b Mon Sep 17 00:00:00 2001 From: "Reece H. Dunn" Date: Fri, 11 Dec 2015 19:36:32 +0000 Subject: [PATCH] Update the documentation to use espeak-ng, etc. --- docs/add_language.html | 2 +- docs/commands.html | 28 ++++++++++++++-------------- docs/languages.html | 6 +++--- docs/mbrola.html | 6 +++--- docs/phonemes.html | 2 +- docs/voices.html | 8 ++++---- 6 files changed, 26 insertions(+), 26 deletions(-) diff --git a/docs/add_language.html b/docs/add_language.html index 4cfa5536..ca2dc40f 100644 --- a/docs/add_language.html +++ b/docs/add_language.html @@ -97,7 +97,7 @@ For many languages, the consonant phonemes which are already available in eSpeak Once the language's phonemes have been defined, then pronunciation dictionary data can be produced in order to translate the language's source text into phonemes. This consists of two source files: fr_rules (the spelling to phoneme rules) and fr_list (an exceptions list, and attributes of certain words). The corresponding compiled data file is espeak-data/fr_dict which is produced from fr_rules and fr_list sources by the command:

- espeak --compile=fr. + espeak-ng --compile=fr.

diff --git a/docs/commands.html b/docs/commands.html index 0d739b5e..43e26681 100644 --- a/docs/commands.html +++ b/docs/commands.html @@ -13,18 +13,18 @@

2.1.1 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. espeak-ng uses speech engine in the libespeak-ng shared library. The libespeak-ng library must first be installed.

    -

  3. speak is a stand-alone version which includes its own copy of the speech engine. +
  4. speak-ng 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-ng or speak-ng 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.

+espeak-ng 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. @@ -34,28 +34,28 @@ Some Linux distrubitions (eg. SuSe 10) have version 19 of PortAudio which has a The installer: setup_espeak.exe installs the SAPI5 version of eSpeak. During installation you need to specify which voices you want to appear in SAPI5 voice menus.

-It also installs a command line program espeak in the espeak program directory. +It also installs a command line program espeak-ng in the espeak-ng program directory.

 

2.2 COMMAND OPTIONS

2.2.1 Examples

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

Or just type
-   espeak
+   espeak-ng
followed by text on subsequent lines. Each line is spoken when RETURN is pressed.

-Use espeak -x to see the corresponding phoneme codes. +Use espeak-ng -x to see the corresponding phoneme codes.

 

2.2.2 The Command Line Options

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

@@ -123,9 +123,9 @@ Quiet. No sound is generated. This may be useful with options such as -x and --
-v <voice filename>[+<variant>]
Sets a Voice for the speech, usually to select a language. eg: -
   espeak -vaf
+
   espeak-ng -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
+
   espeak-ng -vaf+3
The variants are +m1 +m2 +m3 +m4 +m5 +m6 +m7 for male voices and +f1 +f2 +f3 +f4 which simulate female voices by using higher pitches. Other variants include +croak and +whisper.

<voice filename> is a file within the espeak-data/voices directory.
@@ -216,8 +216,8 @@ If the -m option is used to indicate marked-up text, then HTML can be spoken dir

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:   espeak -v en "[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]]"

+As well as plain text, phoneme mnemonics can be used in the text input to espeak-ng. They are enclosed within double square brackets. Spaces are used to separate words and all stressed syllables must be marked explicitly.

+   eg:   espeak-ng -v en "[[D,Is Iz sVm f@n'EtIk t'Ekst 'InpUt]]"

This command will speak: "This is some phonetic text input".

diff --git a/docs/languages.html b/docs/languages.html index 21e687df..04e9c6f4 100644 --- a/docs/languages.html +++ b/docs/languages.html @@ -27,7 +27,7 @@ Sample texts in various languages can be found at ISO 639-1 code for the language. If the language does not have an ISO 639-1 code, then the 3 letter ISO 639-3 code can be used.

For details of the voice files see Voices. @@ -69,9 +69,9 @@ To make alternative voices for a language, you can make additional voice files i Alternatively there are some preset voice variants which can be applied to any of the language voices, by appending + and a variant name. Their effects are defined by files in espeak-data/voices/!v.

The variants are +m1 +m2 +m3 +m4 +m5 +m6 +m7 for male voices, +f1 +f2 +f3 +f4 +f5 for female voices, and +croak +whisper for other effects. For example: -

   espeak -ven+m3
+
   espeak-ng -ven+m3
The available voice variants can be listed with:
-
   espeak --voices=variant
+
   espeak-ng --voices=variant

3.4 Other Languages

The eSpeak speech synthesizer does text to speech for the following additional langauges.