Import the Ubuntu man page for espeak in the ronn format.

.gitignore

@@ -46,6 +46,8 @@ libespeak-ng.so*
 *.html
 *.exe
 
+src/espeak-ng.1
+
 src/espeak-ng
 src/espeakedit
 src/speak-ng

Makefile.am

@@ -53,10 +53,19 @@ distclean-local:
 ##### documentation:
 
 %.html: %.md _layouts/webpage.html
-	cat $< | sed -e 's/\.md)/.html)/g' | kramdown --template _layouts/webpage.html > $@
+	cat $< | sed -e 's/\.md)/.html)/g' -e 's/\.ronn/.html/g' | \
+		kramdown --template _layouts/webpage.html > $@
+
+%.html: %.ronn
+	ronn --html $<
+
+src/espeak-ng.1: src/espeak-ng.1.ronn
+	ronn --roff $<
 
 docs:	docs/index.html \
-	README.html
+	src/espeak-ng.1.html \
+	README.html \
+	src/espeak-ng.1
 
 docs/speak_lib.h: src/include/espeak-ng/speak_lib.h
 	cp $< $@

README.md

@@ -43,6 +43,7 @@ Optionally, you need:
 To build the documentation, you need:
 
 1.  the `kramdown` markdown processor.
+2.  the `ronn` man-page markdown processor.
 
 ### Debian
 
@@ -66,6 +67,7 @@ Documentation dependencies:
 | Dependency    | Install                              |
 |---------------|--------------------------------------|
 | kramdown      | `sudo apt-get install ruby-kramdown` |
+| ronn          | `sudo apt-get install ruby-ronn`     |
 
 Cross-compiling for windows:
 
@@ -187,6 +189,9 @@ already have an espeak-ng install by running:
 The [main documentation](docs/index.md) for eSpeak NG provides more information
 on using and creating voices/languages for for eSpeak NG.
 
+The [espeak-ng](src/espeak-ng.1.ronn) command-line documentation provides a
+reference of the different command-line options available, with example usage.
+
 ## Building Voices
 
 If you are modifying a language's phoneme, voice or dictionary files, you

src/espeak-ng.1.ronn

@@ -0,0 +1,120 @@
+# espeak - A multi-lingual software speech synthesizer.
+
+## SYNOPSIS
+
+__espeak__ [<options>] [<&lt;words&gt;>]
+
+## DESCRIPTION
+
+__espeak__ is a software speech synthesizer for English, and some other
+languages.
+
+## OPTIONS
+
+  * `-h`:
+    Show summary of options.
+
+  * `--version`:
+    Prints the espeak library version and the location of the espeak voice
+    data.
+
+  * `-f <text file>`:
+    Text file to speak
+
+  * `--stdin`:
+    Read text input from stdin instead of a file
+
+If neither -f nor --stdin, &lt;words&gt; are spoken, or if none then text is
+spoken from stdin, each line separately.
+
+  * `-q`:
+    Quiet, don't produce any speech (may be useful with -x)
+
+  * `-a <integer>`:
+    Amplitude, 0 to 200, default is 100
+
+  * `-g <integer>`:
+    Word gap. Pause between words, units of 10mS at the default speed
+
+  * `-k <integer>`:
+    Indicate capital letters with: 1=sound, 2=the word "capitals", higher
+    values = a pitch increase (try -k20).
+
+  * `-l <integer>`:
+    Line length. If not zero (which is the default), consider lines less than
+    this length as and-of-clause
+
+  * `-p <integer>`:
+    Pitch adjustment, 0 to 99, default is 50
+
+  * `-s <integer>`:
+    Speed in words per minute, default is 160
+
+  * `-v <voice name>`:
+    Use voice file of this name from espeak-data/voices
+
+  * `-w <wave file name>`:
+    Write output to this WAV file, rather than speaking it directly
+
+  * `-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 &lt;hr&gt; &lt;h2&gt; and &lt;li&gt; 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.
+    =&lt;voice name&lt; is optional and specifies which language
+
+  * `--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.
+
+  * `--ipa`:
+    Write phonemes to stdout using International Phonetic Alphabet. --ipa=1 Use
+    ties, --ipa=2 Use ZWJ, --ipa=3 Separate with _
+
+  * `--path=<path>`:
+    Specifies the directory containing the espeak-data directory
+
+  * `--pho`:
+    Write mbrola phoneme data (.pho) to stdout or to the file in --phonout
+
+  * `--phonout=<filename>`:
+    Write output from -x -X commands and mbrola phoneme data to this file
+
+  * `--punct="<characters>"`:
+    Speak the names of punctuation characters during speaking. If
+    =&lt;characters&gt; is omitted, all punctuation is spoken.
+
+  * `--voices[=<language code>]`:
+    Lists the available voices. If =&lt;language code&gt; is present then only
+    those voices which are suitable for that language are listed.
+
+  * `--voices=<directory>`:
+    lists the voices in the specified subdirectory.
+
+## AUTHOR
+
+eSpeak was written by Jonathan Duddington <[email protected]>. The webpage
+for this package can be found at http://espeak.sourceforge.net/.
+
+This manual page was written by Luke Yelavich <[email protected]>, for the
+Ubuntu project (but may be used by others).