From 063f4dbe40faef5acce771557fdab61edbe76162 Mon Sep 17 00:00:00 2001 From: "Reece H. Dunn" Date: Tue, 29 Dec 2015 11:47:50 +0000 Subject: [PATCH] Add documentation for speak-ng. --- .gitignore | 1 + Makefile.am | 7 ++- src/speak-ng.1.ronn | 149 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 156 insertions(+), 1 deletion(-) create mode 100644 src/speak-ng.1.ronn diff --git a/.gitignore b/.gitignore index 978896f4..e371448d 100644 --- a/.gitignore +++ b/.gitignore @@ -47,6 +47,7 @@ libespeak-ng.so* *.exe src/espeak-ng.1 +src/speak-ng.1 src/espeak-ng src/espeakedit diff --git a/Makefile.am b/Makefile.am index 7dd9f9a8..675c58fb 100644 --- a/Makefile.am +++ b/Makefile.am @@ -66,6 +66,9 @@ SUFFIXES=.html .md .ronn src/espeak-ng.1: src/espeak-ng.1.ronn ronn --roff $< +src/speak-ng.1: src/speak-ng.1.ronn + ronn --roff $< + docs: docs/index.html \ docs/add_language.html \ docs/dictionary.html \ @@ -75,8 +78,10 @@ docs: docs/index.html \ docs/phontab.html \ docs/voices.html \ src/espeak-ng.1.html \ + src/speak-ng.1.html \ README.html \ - src/espeak-ng.1 + src/espeak-ng.1 \ + src/speak-ng.1 ##### build targets: diff --git a/src/speak-ng.1.ronn b/src/speak-ng.1.ronn new file mode 100644 index 00000000..a5aafb60 --- /dev/null +++ b/src/speak-ng.1.ronn @@ -0,0 +1,149 @@ +# speak-ng - A multi-lingual software speech synthesizer. + +## SYNOPSIS + +__speak-ng__ [] [<<words>>] + +## DESCRIPTION + +__speak-ng__ is a software speech synthesizer for English, and some other +languages. + +## OPTIONS + + * `-h`, `--help`: + Show summary of options. + + * `--version`: + Prints the espeak library version and the location of the espeak voice + data. + + * `-f `: + Text file to speak. + + * `--stdin`: + Read text input from stdin instead of a file. + +If neither -f nor --stdin are provided, <words> are spoken, or if no +words are provided then text is spoken from stdin a line at a time. + + * `-q`: + Quiet, don't produce any speech (may be useful with -x). + + * `-a `: + Amplitude, 0 to 200, default is 100. + + * `-g `: + Word gap. Pause between words, units of 10ms at the default speed. + + * `-k `: + Indicate capital letters with: 1=sound, 2=the word "capitals", higher + values = a pitch increase (try -k20). + + * `-l `: + Line length. If not zero (which is the default), consider lines less than + this length as end-of-clause. + + * `-p `: + Pitch adjustment, 0 to 99, default is 50. + + * `-s `: + Speed in words per minute, default is 160. + + * `-v `: + Use voice file of this name from espeak-data/voices. A variant can be + specified using +, such as af+m3. + + * `-w `: + Write output to this WAV file, rather than speaking it directly. + + * `--split=`: + Used with `-w` to split the audio output into <minutes> recorded + chunks. + + * `-b`: + Input text encoding, 1=UTF8, 2=8 bit, 4=16 bit. + + * `-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. + + * `-x`: + Write phoneme mnemonics to stdout. + + * `-X`: + Write phonemes mnemonics and translation trace to stdout. If rules files + have been built with --compile=debug, line numbers will also be displayed. + + * `-z`: + No final sentence pause at the end of the text. + + * `--stdout`: + Write speech output to stdout. + + * `--compile=voicename`: + Compile the pronunciation rules and dictionary in the current directory. + =<voicename< is optional and specifies which language is compiled. + + * `--compile-debug=voicename`: + Compile the pronunciation rules and dictionary in the current directory as + above, but include line numbers, that get shown when -X is used. + + * `--ipa`: + Write phonemes to stdout using International Phonetic Alphabet. --ipa=1 Use + ties, --ipa=2 Use ZWJ, --ipa=3 Separate with _. + + * `--tie=`: + The character to use to join multi-letter phonemes in -x and --ipa output. + + * `--path=`: + Specifies the directory containing the espeak-data directory. + + * `--pho`: + Write mbrola phoneme data (.pho) to stdout or to the file in --phonout. + + * `--phonout=`: + Write output from -x -X commands and mbrola phoneme data to this file. + + * `--punct=""`: + Speak the names of punctuation characters during speaking. If + =<characters> is omitted, all punctuation is spoken. + + * `--sep=`: + The character to separate phonemes from the -x and --ipa output. + + * `--voices[=]`: + Lists the available voices. If =<language code> is present then only + those voices which are suitable for that language are listed. + + * `--voices=`: + Lists the voices in the specified subdirectory. + +## EXAMPLES + + * `speak-ng "This is a test"`: + Speak the sentence "This is a test" using the default English voice. + + * `speak-ng -f hello.txt`: + Speak the contents of hello.txt using the default English voice. + + * `cat hello.txt | speak-ng`: + Speak the contents of hello.txt using the default English voice. + + * `speak-ng -x hello`: + Speak the word "hello" using the default English voice, and print the + phonemes that were spoken. + + * `speak-ng -ven-us "[[h@'loU]]"`: + Speak the phonemes "h@'loU" using the American English voice. + +## AUTHOR + +eSpeak NG is maintained by Reece H. Dunn . It is based on +eSpeak by Jonathan Duddington . + +This manual page is based on the eSpeak page written by Luke Yelavich + for the Ubuntu project.