main/multimedia/sound/espeak/files/espeak.1

.\"                                      Hey, EMACS: -*- nroff -*-
.\" First parameter, NAME, should be all caps
.\" Second parameter, SECTION, should be 1-8, maybe w/ subsection
.\" other parameters are allowed: see man(7), man(1)
.TH ESPEAK 1 "July 25, 2007"
.\" Please adjust this date whenever revising the manpage.
.\"
.\" Some roff macros, for reference:
.\" .nh        disable hyphenation
.\" .hy        enable hyphenation
.\" .ad l      left justify
.\" .ad b      justify to both left and right margins
.\" .nf        disable filling
.\" .fi        enable filling
.\" .br        insert line break
.\" .sp <n>    insert n+1 empty lines
.\" for manpage-specific macros, see man(7)
.SH NAME
espeak \- A multi-lingual software speech synthesizer.
.SH SYNOPSIS
.B espeak
.RI [ options ]\ [ "<words>" ]
.SH DESCRIPTION
.B espeak
is a software speech synthesizer for English, and some other languages.
.SH OPTIONS
.TP
.B \-h
Show summary of options.
.TP
.B \-f <text file>
Text file to speak
.TP
.B \-\-stdin
Read text input from stdin instead of a file
.TP
If neither -f nor --stdin, <words> are spoken, or if none then text is spoken from stdin, each line separately.
.TP
.B \-q
Quiet, don't produce any speech (may be useful with -x)
.TP
.B \-a <integer>
Amplitude, 0 to 20, default is 10
.TP
.B \-l <integer>
Line length. If not zero (which is the default), consider
lines less than this length as and-of-clause
.TP
.B \-p <integer>
Pitch adjustment, 0 to 99, default is 50
.TP
.B -s <integer>
Speed in words per minute, default is 160
.TP
.B \-v <voice name>
Use voice file of this name from espeak-data/voices
.TP
.B -b
Input text is 8-bit encoding
.TP
.B -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.
.TP
.B \-w <wave file name>
Write output to this WAV file, rather than speaking it directly
.TP
.B \-x
Write phoneme mnemonics to stdout
.TP
.B \-X
Write phonemes mnemonics and translation trace to stdout. If rules files have been built with --compile=debug, line numbers will also be displayed.
.TP
.B \-\-stdout
Write speech output to stdout
.TP
.B \-\-compile=<voice name>
Compile the pronunciation rules and dictionary in the current directory. =<voice name> is optional and specifies which language
.TP
.B \-\-path=<path>
Specifies the directory containing the espeak-data directory
.TP
.B \-\-phonout=<filename>
Write output from -x -X commands and mbrola phoneme data to this file
.TP
.B \-\-punct="<characters>"
Speak the names of punctuation characters during speaking. If =<characters> is omitted, all punctuation is spoken.
.TP
.B \-k <integer>
Indicate capital letters with: 1=sound, 2=the word "capitals", higher values = a pitch increase (try -k20).
.TP
.B \-\-voices[=<language code>]
Lists the available voices. If =<language code> is present then only those voices which are suitable for that language are listed.
.TP
.B \-\-compile=voicename
Compile the pronunciation rules and dictionary in the current directory. =<voice name> is optional and specifies which language
.TP
.B \-\-compile=debug
Compile the pronunciation rules and dictionary in the current directory as above, but include line numbers, that get shown when -X is used.
.SH AUTHOR
eSpeak was written by Jonathan Duddington <jonsd@jsd.clara.co.uk>. The webpage for this package can be found at http://espeak.sourceforge.net/.
.PP
This manual page was written by Luke Yelavich <themuso@ubuntu.com>, for the Ubuntu project (but may be used by others).