diff --git a/doc/espeakup.8 b/doc/espeakup.8 deleted file mode 100644 index 092c776..0000000 --- a/doc/espeakup.8 +++ /dev/null @@ -1,78 +0,0 @@ -.\" Hey, Emacs! This is an -*- nroff -*- source file. -.\" Espeakup is Copyright 2008 by William Hubbs. -.\" This is free software; see the GNU General Public Licence version 3 -.\" or later for copying conditions. There is NO warranty. -.TH ESPEAKUP 8 "5 Nov 2008" "0.60" -.nh -.SH NAME -espeakup \(em connect Speakup to the ESpeak TTS engine -.SH SYNOPSIS -.B espeakup -[ -.B \-\^\-pid-path=path -] -[ -.B \-\^\-default-voice=voicename -] -[ -.B \-\^\-debug -] -[ -.B \-\^\-help -] -[ -.B \-\^\-version -] -.SH OPTIONS -.TP -.B \-P path, \-\^\-pid-path=path -Set the full path for the pid file espeakup uses when in daemon mode. -.TP -.B \-V voicename, \-\^\-default-voice=voicename -Set the espeak voice to be used by default. -.TP -.B \-d, \-\^\-debug -run in the foreground, rather than becoming a daemon process. -.TP -.B \-h, \-\^\-help -display a brief help message and exit. -.TP -.B \-v, \-\^\-version -output version information and exit. -.SH DESCRIPTION -Espeakup bridges the gap between two tools: the Speakup screen review -system and the ESppeak 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 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. This allows Speakup to use ESpeak as its speech -synthesizer. -.PP -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. -.SH BUGS -.PP -Espeakup is still classified as alpha software. Bugs are periodically found -and fixed. If you find a bug, please do report it to the author. You -might also consider mentioning it on the mailing list for the Speakup -screenreader. Visit http://speech.braille.uwo.ca/mailman/listinfo/speakup -to learn more about the mailing list. -.SH SEE ALSO -.PP -For more information about Speakup, visit its homepage: http://linux-speakup.org. -ESpeak's home page is http://espeak.sourceforge.net. -.SH AUTHOR -.PP -William Hubbs is the author and maintainer of Espeakup. He may be reached -via the email address . This manual page was written -by Chris Brannon, and his email address is . 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 7726ab6..9645649 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -1 +1,8 @@ -install_man('espeakup.8') +ronn = find_program('ronn', required: get_option('man')) + +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')