From 878b4ea59210be523349053feb49f5e1f1ab16a3 Mon Sep 17 00:00:00 2001 From: Alexander Epaneshnikov Date: Thu, 17 Jun 2021 19:03:52 +0300 Subject: [PATCH] use ronn instead of pandoc --- doc/espeakup.8.md | 88 --------------------------------------------- doc/espeakup.8.ronn | 77 +++++++++++++++++++++++++++++++++++++++ doc/meson.build | 15 ++++---- meson_options.txt | 2 ++ 4 files changed, 85 insertions(+), 97 deletions(-) delete mode 100644 doc/espeakup.8.md create mode 100644 doc/espeakup.8.ronn diff --git a/doc/espeakup.8.md b/doc/espeakup.8.md deleted file mode 100644 index 2e03618..0000000 --- a/doc/espeakup.8.md +++ /dev/null @@ -1,88 +0,0 @@ ---- -title: ESPEAKUP -section: 8 -date: 14 Jun 2021 ---- - - -## NAME - -espeakup --- connect Speakup to the espeak-ng TTS engine - -## SYNOPSIS - -**espeakup** \[**\--pid-path=path**\] \[**\--alsa-volume**\] -\[**\--default-voice=voicename**\] \[**\--debug**\] \[**\--help**\] -\[**\--version**\] - -## OPTIONS - -**-P path, \--pid-path=path** - -: Set the full path for the pid file espeakup uses when in daemon mode. - -**\--alsa-volume** - -: Drive the ALSA volume. useful for live environments where volume - adjustments maybe impossible. - -**-V voicename, \--default-voice=voicename** - -: Set the espeak-ng voice to be used by default. - -**-d, \--debug** - -: run in the foreground, rather than becoming a daemon process. - -**-h, \--help** - -: display a brief help message and exit. - -**-v, \--version** - -: output version information and exit. - -## DESCRIPTION - -espeakup bridges the gap between two tools: the Speakup screen review -system and the espeak-ng text-to-speech engine. Each of these tools -performs a well-defined task. Speakup is a kernel-based screen reader -for the Linux console. It extracts and processes the text that is -displayed on the foreground virtual console. It supports several -hardware based speech synthesizers directly. However, since it is in -kernel space, it cannot support a software speech synthesizer directly -since these are in user space. espeak-ng is a popular software speech -synthesizer. It is small, light weight, very responsive, and supports -multiple languages. espeakup is a connector which will read text sent to -it by speakup and forward it to espeak-ng. This allows Speakup to use -espeak-ng as its speech synthesizer. - -espeakup is a daemon. Typically, it is started at boot time, and it -terminates when the system is halted or rebooted. It should be started -by the system's init scripts. This process varies among Linux -distributions, but the details are usually managed by the person who -packaged espeakup for your distribution. From the perspective of an -average user, espeakup's operation is invisible. - -## BUGS - -If you find a bug, please create an -[github issue](https://github.com/linux-speakup/espeakup/issues) -You might also consider mentioning it on the mailing list for the Speakup screenreader. Visit -[list page](https://linux-speakup.org/cgi-bin/mailman/listinfo/speakup) -to learn more about the mailing list. - -## SEE ALSO - -For more information about Speakup, visit its -[homepage](https://linux-speakup.org). - -espeak-ng located at [github](https://github.com/espeak-ng/espeak-ng) - -## AUTHOR - -William Hubbs is the author of espeakup. -This manual page was written by Chris Brannon . - -current authors and maintainers can be found at -[github](https://github.com/linux-speakup/espeakup/graphs/contributors) diff --git a/doc/espeakup.8.ronn b/doc/espeakup.8.ronn new file mode 100644 index 0000000..40b9d9c --- /dev/null +++ b/doc/espeakup.8.ronn @@ -0,0 +1,77 @@ + + +# espeakup(8) --- connect Speakup to the espeak-ng TTS engine + +## SYNOPSIS + +`espeakup` [`--pid-path=`] [`--alsa-volume`] +[`--default-voice=`[]] [`--debug`] [`--help`] [`--version`] + +## OPTIONS + + * `-P` , `--pid-path=`: + Set the full path for the pid file espeakup uses when in daemon mode. + + * `--alsa-volume`: + Drive the ALSA volume. useful for live environments where volume + adjustments maybe impossible. + + * `-V` , `--default-voice=`: + Set the espeak-ng voice to be used by default. + + * `-d`, `--debug`: + run in the foreground, rather than becoming a daemon process. + + * `-h`, `--help`: + display a brief help message and exit. + + * `-v`, `--version`: + output version information and exit. + +## DESCRIPTION + +espeakup bridges the gap between two tools: the Speakup screen review system and +the espeak-ng text-to-speech engine. Each of these tools performs a +well-defined task. + +Speakup is a kernel-based screen reader for the Linux console. It extracts and +processes the text that is displayed on the foreground virtual console. It +supports several hardware based speech synthesizers directly. However, since it +is in kernel space, it cannot support a software speech synthesizer directly +since these are in user space. + +espeak-ng is a popular software speech synthesizer. It is small, light weight, +very responsive, and supports multiple languages. espeakup is a connector which +will read text sent to it by speakup and forward it to espeak-ng. This allows +Speakup to use espeak-ng as its speech synthesizer. + +espeakup is a daemon. Typically, it is started at boot time, and it terminates +when the system is halted or rebooted. It should be started by the system's init +scripts. This process varies among Linux distributions, but the details are +usually managed by the person who packaged espeakup for your distribution. From +the perspective of an average user, espeakup's operation is invisible. + +## BUGS + +If you find a bug, please create a +[github issue](https://github.com/linux-speakup/espeakup/issues) +You might also consider mentioning it on the mailing list for the Speakup +screenreader. Visit +[list page](https://linux-speakup.org/cgi-bin/mailman/listinfo/speakup) +to learn more about the mailing list. + +## SEE ALSO + +For more information about Speakup, visit its +[homepage](https://linux-speakup.org). + +espeak-ng can be found at [github](https://github.com/espeak-ng/espeak-ng) + +## AUTHOR + +William Hubbs is the author of espeakup. + +This manual page was written by Chris Brannon . + +current authors and maintainers can be found at +[github](https://github.com/linux-speakup/espeakup/graphs/contributors) diff --git a/doc/meson.build b/doc/meson.build index 51f7d6b..9645649 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -1,11 +1,8 @@ -pandoc = find_program('pandoc', required: false) +ronn = find_program('ronn', required: get_option('man')) -if pandoc.found() - custom_target('espeakup-man', input:files('espeakup.8.md'), output:'espeakup.8', - command:[pandoc, '--standalone', '--from', 'markdown', '--to', 'man', - '--shift-heading-level-by=-1', '--output', '@OUTPUT@', - '@INPUT@'], - install: true, install_dir: join_paths(get_option('mandir'),'man8')) -else - warning('Program "pandoc" not found! Cannot generate man pages') +if ronn.found() + custom_target('man', input:files('espeakup.8.ronn'), + output:'espeakup.8', + command:[ronn, '--output-dir', '@OUTDIR@', '--roff', '@INPUT@'], + install: true, install_dir: join_paths(get_option('mandir'),'man8')) endif diff --git a/meson_options.txt b/meson_options.txt index 45e3a33..c7e35d9 100644 --- a/meson_options.txt +++ b/meson_options.txt @@ -1,2 +1,4 @@ option('systemd', type : 'feature', value : 'auto', description :'enable systemd support') +option('man', type : 'feature', value : 'auto', + description : 'build manpage with ronn')