"Fossies" - the Fresh Open Source Software Archive 
Member "espeak-ng-1.51.1/src/espeak-ng.1.ronn" (21 Jun 2022, 5382 Bytes) of package /linux/privat/espeak-ng-1.51.1.tar.gz:
As a special service "Fossies" has tried to format the requested text file into HTML format (style:
standard) with prefixed line numbers.
Alternatively you can here
view or
download the uninterpreted source code file.
See also the last
Fossies "Diffs" side-by-side code changes report for "espeak-ng.1.ronn":
1.50_vs_1.51.
1 # espeak-ng - A multi-lingual software speech synthesizer.
2
3 ## SYNOPSIS
4
5 __espeak-ng__ [<options>] [<words>]
6
7 ## DESCRIPTION
8
9 __espeak-ng__ is a software speech synthesizer for English, and some other
10 languages.
11
12 ## OPTIONS
13
14 * `-h`, `--help`:
15 Show summary of options.
16
17 * `--version`:
18 Prints the espeak library version and the location of the espeak voice
19 data.
20
21 * `-f <text file>`:
22 Text file to speak.
23
24 * `--stdin`:
25 Read text input from stdin till to the end of a stream at once.
26
27 If neither -f nor --stdin are provided, then <words> from parameter are spoken,
28 or text is spoken from stdin, read separately one line by line at a time.
29
30 * `-d <device>`:
31 Use the specified device to speak the audio on. If not specified, the
32 default audio device is used.
33
34 * `-q`:
35 Quiet, don't produce any speech (may be useful with -x).
36
37 * `-a <integer>`:
38 Amplitude, 0 to 200, default is 100.
39
40 * `-g <integer>`:
41 Word gap. Pause between words, units of 10ms at the default speed.
42
43 * `-k <integer>`:
44 Indicate capital letters with: 1=sound, 2=the word "capitals", higher
45 values = a pitch increase (try -k20).
46
47 * `-l <integer>`:
48 Line length. If not zero (which is the default), consider lines less than
49 this length as end-of-clause.
50
51 * `-p <integer>`:
52 Pitch adjustment, 0 to 99, default is 50.
53
54 * `-s <integer>`:
55 Speed in words per minute, default is 175.
56
57 * `-v <voice name>`:
58 Use voice file of this name from espeak-ng-data/voices. A variant can be
59 specified using <voice>+<variant>, such as af+m3.
60
61 * `-w <wave file name>`:
62 Write output to this WAV file, rather than speaking it directly.
63
64 * `--split=<minutes>`:
65 Used with `-w` to split the audio output into <minutes> recorded
66 chunks.
67
68 * `-b`:
69 Input text encoding, 1=UTF8, 2=8 bit, 4=16 bit.
70
71 * `-m`:
72 Indicates that the text contains SSML (Speech Synthesis Markup Language)
73 tags or other XML tags. Those SSML tags which are supported are
74 interpreted. Other tags, including HTML, are ignored, except that some HTML
75 tags such as <hr> <h2> and <li> ensure a break in the
76 speech.
77
78 * `-x`:
79 Write phoneme mnemonics to stdout.
80
81 * `-X`:
82 Write phonemes mnemonics and translation trace to stdout. If rules files
83 have been built with --compile=debug, line numbers will also be displayed.
84
85 * `-z`:
86 No final sentence pause at the end of the text.
87
88 * `--stdout`:
89 Write speech output to stdout.
90
91 * `--compile=voicename`:
92 Compile the pronunciation rules and dictionary in the current directory.
93 =<voicename< is optional and specifies which language is compiled.
94
95 * `--compile-debug=voicename`:
96 Compile the pronunciation rules and dictionary in the current directory as
97 above, but include line numbers, that get shown when -X is used.
98
99 * `--ipa`:
100 Write phonemes to stdout using International Phonetic Alphabet. --ipa=1 Use
101 ties, --ipa=2 Use ZWJ, --ipa=3 Separate with _.
102
103 * `--tie=<character>`:
104 The character to use to join multi-letter phonemes in -x and --ipa output.
105
106 * `--path=<path>`:
107 Specifies the directory containing the espeak-ng-data directory.
108
109 * `--pho`:
110 Write mbrola phoneme data (.pho) to stdout or to the file in --phonout.
111
112 * `--phonout=<filename>`:
113 Write output from -x -X commands and mbrola phoneme data to this file.
114
115 * `--punct="<characters>"`:
116 Speak the names of punctuation characters during speaking. If
117 =<characters> is omitted, all punctuation is spoken.
118
119 * `--sep=<character>`:
120 The character to separate phonemes from the -x and --ipa output.
121
122 * `--voices[=<language code>]`:
123 Lists the available voices. If =<language code> is present then only
124 those voices which are suitable for that language are listed.
125 If `xx-yy` language code is passed, then voices with `yy` of `xx` language variants
126 are shown with higher priority than just `xx`.
127 If `variant` is passed, then all voice variants are shown.
128 If `mb` or `mbrola` is passed, then all voices using the MBROLA voice synthesizer
129 are shown.
130 If `all` is passed, then all eSpeak NG voices, voice variants and MBROLA
131 voices are shown.
132
133 * `--voices=<directory>`:
134 Lists the voices in the specified subdirectory.
135
136 ## EXAMPLES
137
138 * `espeak-ng "This is a test"`:
139 Speak the sentence "This is a test" using the default English voice.
140
141 * `espeak-ng -f hello.txt`:
142 Speak the contents of hello.txt using the default English voice.
143
144 * `cat hello.txt | espeak-ng`:
145 Speak the contents of hello.txt using the default English voice.
146
147 * `espeak-ng -x hello`:
148 Speak the word "hello" using the default English voice, and print the
149 phonemes that were spoken.
150
151 * `espeak-ng -ven-us "[[h@'loU]]"`:
152 Speak the phonemes "h@'loU" using the American English voice.
153
154 * `espeak-ng --voices`:
155 List all voices supported by eSpeak.
156
157 * `espeak-ng --voices=en`:
158 List all voices that speak English (`en`).
159
160 * `espeak-ng --voices=mb`:
161 List all voices using the MBROLA voice synthesizer.
162
163 ## AUTHOR
164
165 eSpeak NG is maintained by Reece H. Dunn <msclrhd@gmail.com>. It is based on
166 eSpeak by Jonathan Duddington <jonsd@jsd.clara.co.uk>.
167
168 This manual page is based on the eSpeak page written by Luke Yelavich
169 <themuso@ubuntu.com> for the Ubuntu project.