From c7bd2ca17db147ebcb114c8683b86e906f802316 Mon Sep 17 00:00:00 2001 From: Packit Service Date: Dec 09 2020 13:05:54 +0000 Subject: Apply patch 0001-Use-kramdown-in-man-pages.patch patch_name: 0001-Use-kramdown-in-man-pages.patch present_in_specfile: true location_in_specfile: 1 --- diff --git a/Makefile.am b/Makefile.am index 0ae0c32..cf1d833 100644 --- a/Makefile.am +++ b/Makefile.am @@ -76,14 +76,14 @@ distclean-local: ##### custom rules: -SUFFIXES=.html .md .ronn +SUFFIXES=.html .md .md.html: _layouts/webpage.html - cat $< | sed -e 's/\.md)/.html)/g' -e 's/\.ronn/.html/g' | \ + cat $< | sed -e 's/\.md)/.html)/g' | \ kramdown --template _layouts/webpage.html > $@ -.ronn.html: - ronn --html $< +.md.html: + kramdown --template _layouts/webpage.html -i kramdown -o html $< > $@ ##### vim: @@ -101,11 +101,11 @@ EXTRA_DIST += $(vim_addons_syntax_DATA) ##### documentation: -src/espeak-ng.1: src/espeak-ng.1.ronn - ronn --roff $< +src/espeak-ng.1: src/espeak-ng.1.md + kramdown -i kramdown -o man $< > $@ -src/speak-ng.1: src/speak-ng.1.ronn - ronn --roff $< +src/speak-ng.1: src/speak-ng.1.md + kramdown -i kramdown -o man $< > $@ docs: docs/index.html \ docs/add_language.html \ @@ -195,9 +195,7 @@ endif bin_PROGRAMS += src/speak-ng -if HAVE_RONN man1_MANS += src/speak-ng.1 -endif src_speak_ng_LDADD = src/libespeak-ng.la src_speak_ng_LDFLAGS = -static -lm ${PCAUDIOLIB_LIBS} @@ -206,9 +204,7 @@ src_speak_ng_SOURCES = src/speak-ng.c bin_PROGRAMS += src/espeak-ng -if HAVE_RONN man1_MANS += src/espeak-ng.1 -endif src_espeak_ng_LDADD = src/libespeak-ng.la ${PCAUDIOLIB_LIBS} src_espeak_ng_SOURCES = src/espeak-ng.c diff --git a/README.md b/README.md index dac80c2..935fe97 100644 --- a/README.md +++ b/README.md @@ -108,7 +108,6 @@ Optionally, you need: to enable audio output; 3. the [sonic](https://github.com/espeak-ng/sonic) development library to enable sonic audio speed up support; -4. the `ronn` man-page markdown processor to build the man pages. To build the documentation, you need: @@ -122,7 +121,6 @@ be installed using the following commands: | autotools | `sudo apt-get install make autoconf automake libtool pkg-config` | | c99 compiler | `sudo apt-get install gcc` | | sonic | `sudo apt-get install libsonic-dev` | -| ronn | `sudo apt-get install ruby-ronn` | | kramdown | `sudo apt-get install ruby-kramdown` | ### Building @@ -326,7 +324,7 @@ To enable eSpeak, you need to: The [main documentation](docs/index.md) for eSpeak NG provides more information on using and creating voices/languages for eSpeak NG. -The [espeak-ng](src/espeak-ng.1.ronn) and [speak-ng](src/speak-ng.1.ronn) +The [espeak-ng](src/espeak-ng.1.md) and [speak-ng](src/speak-ng.1.md) command-line documentation provide a reference of the different command-line options available to these commands with example usage. diff --git a/configure.ac b/configure.ac index 33960c2..302f88f 100644 --- a/configure.ac +++ b/configure.ac @@ -224,14 +224,6 @@ AM_CONDITIONAL(OPT_MBROLA, [test x"$have_mbrola" = xyes]) AM_CONDITIONAL(OPT_ASYNC, [test x"$have_async" = xyes]) dnl ================================================================ -dnl ronn checks. -dnl ================================================================ - -AC_CHECK_PROG(RONN, ronn, ronn, no) - -AM_CONDITIONAL(HAVE_RONN, [test ! x"$RONN" = xno]) - -dnl ================================================================ dnl Extended dictionary checks. dnl ================================================================ diff --git a/src/espeak-ng.1.md b/src/espeak-ng.1.md new file mode 100644 index 0000000..89fa2c0 --- /dev/null +++ b/src/espeak-ng.1.md @@ -0,0 +1,163 @@ +# espeak-ng(1) - A multi-lingual software speech synthesizer. +{: data-date="July 2018"} + +## SYNOPSIS + +__espeak-ng__ \[*options*\] \[*words*\] + +## DESCRIPTION + +__espeak-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, `` are spoken, or if no +words are provided then text is spoken from stdin a line at a time. + +`-d ` +: Use the specified device to speak the audio on. If not specified, the + default audio device is used. + +`-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-ng-data/voices. A variant can be + specified using _voice_+_variant_, 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 \ 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 \ \ and \ 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. + =\ 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-ng-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 + =\ is omitted, all punctuation is spoken. + +`--sep=` +: The character to separate phonemes from the `-x` and `--ipa` output. + +`--voices[=]` +: Lists the available voices. If =\ is present then only + those voices which are suitable for that language are listed. + +`--voices=` +: Lists the voices in the specified subdirectory. + +## EXAMPLES + +`espeak-ng "This is a test"` +: Speak the sentence \"This is a test\" using the default English voice. + +`espeak-ng -f hello.txt` +: Speak the contents of hello.txt using the default English voice. + +`cat hello.txt | espeak-ng` +: Speak the contents of hello.txt using the default English voice. + +`espeak-ng -x hello` +: Speak the word \"hello\" using the default English voice, and print the + phonemes that were spoken. + +`espeak-ng -ven-us "[[h@'loU]]"` +: Speak the phonemes \"h@'loU\" using the American English voice. + +`espeak-ng --voices` +: List all voices supported by eSpeak. + +`espeak-ng --voices=en` +: List all voices that speak English (`en`). + +`espeak-ng --voices=mb` +: List all voices using the MBROLA voice synthesizer. + +## 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. diff --git a/src/espeak-ng.1.ronn b/src/espeak-ng.1.ronn deleted file mode 100644 index 4fcd5e8..0000000 --- a/src/espeak-ng.1.ronn +++ /dev/null @@ -1,162 +0,0 @@ -# espeak-ng - A multi-lingual software speech synthesizer. - -## SYNOPSIS - -__espeak-ng__ [] [] - -## DESCRIPTION - -__espeak-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. - - * `-d `: - Use the specified device to speak the audio on. If not specified, the - default audio device is used. - - * `-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-ng-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-ng-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 - - * `espeak-ng "This is a test"`: - Speak the sentence "This is a test" using the default English voice. - - * `espeak-ng -f hello.txt`: - Speak the contents of hello.txt using the default English voice. - - * `cat hello.txt | espeak-ng`: - Speak the contents of hello.txt using the default English voice. - - * `espeak-ng -x hello`: - Speak the word "hello" using the default English voice, and print the - phonemes that were spoken. - - * `espeak-ng -ven-us "[[h@'loU]]"`: - Speak the phonemes "h@'loU" using the American English voice. - - * `espeak-ng --voices`: - List all voices supported by eSpeak. - - * `espeak-ng --voices=en`: - List all voices that speak English (`en`). - - * `espeak-ng --voices=mb`: - List all voices using the MBROLA voice synthesizer. - -## 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. diff --git a/src/speak-ng.1.md b/src/speak-ng.1.md new file mode 100644 index 0000000..b05b9ad --- /dev/null +++ b/src/speak-ng.1.md @@ -0,0 +1,159 @@ +# speak-ng(1) - A multi-lingual software speech synthesizer. +{: data-date="July 2018"} + +## SYNOPSIS + +__speak-ng__ \[*options*\] \[*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, `` 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-ng-data/voices. A variant can be + specified using _voice_+_variant_, 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 \ 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 \ \ and \ 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. + =\ 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-ng-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 + =\ is omitted, all punctuation is spoken. + +`--sep=` +: The character to separate phonemes from the `-x` and `--ipa` output. + +`--voices[=]` +: Lists the available voices. If =\ 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. + +`speak-ng --voices` +: List all voices supported by eSpeak. + +`speak-ng --voices=en` +: List all voices that speak English (`en`). + +`speak-ng --voices=mb` +: List all voices using the MBROLA voice synthesizer. + +## 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. diff --git a/src/speak-ng.1.ronn b/src/speak-ng.1.ronn deleted file mode 100644 index 25c607f..0000000 --- a/src/speak-ng.1.ronn +++ /dev/null @@ -1,158 +0,0 @@ -# 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-ng-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-ng-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. - - * `speak-ng --voices`: - List all voices supported by eSpeak. - - * `speak-ng --voices=en`: - List all voices that speak English (`en`). - - * `speak-ng --voices=mb`: - List all voices using the MBROLA voice synthesizer. - -## 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.