mirror of
https://github.com/linux-speakup/espeakup.git
synced 2026-08-22 15:44:17 +02:00
use ronn instead of pandoc
This commit is contained in:
Alexander Epaneshnikov
parent
d669e886d7
commit
878b4ea592
4 changed files with 85 additions and 97 deletions
|
|
@ -1,88 +0,0 @@
|
|||
---
|
||||
title: ESPEAKUP
|
||||
section: 8
|
||||
date: 14 Jun 2021
|
||||
---
|
||||
<!-- markdownlint-disable MD036 -->
|
||||
|
||||
## 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 <w.d.hubbs@gmail.com> is the author of espeakup.
|
||||
This manual page was written by Chris Brannon <cmbrannon79@gmail.com>.
|
||||
|
||||
current authors and maintainers can be found at
|
||||
[github](https://github.com/linux-speakup/espeakup/graphs/contributors)
|
||||
77
doc/espeakup.8.ronn
Normal file
77
doc/espeakup.8.ronn
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
<!-- markdownlint-disable MD036 -->
|
||||
|
||||
# espeakup(8) --- 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 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 <w.d.hubbs@gmail.com> is the author of espeakup.
|
||||
|
||||
This manual page was written by Chris Brannon <cmbrannon79@gmail.com>.
|
||||
|
||||
current authors and maintainers can be found at
|
||||
[github](https://github.com/linux-speakup/espeakup/graphs/contributors)
|
||||
|
|
@ -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
|
||||
|
|
|
|||
|
|
@ -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')
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue