mirror of
https://github.com/linux-speakup/espeakup.git
synced 2026-08-09 09:19:09 +02:00
generate man page from markdown
Use ronn to convert markdown to a man page This simplifies maintaining the documentation. This fixes #31.
This commit is contained in:
Alexander Epaneshnikov
William Hubbs
parent
0c09fe5449
commit
ca1d6b42e2
4 changed files with 87 additions and 79 deletions
|
|
@ -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 <w.d.hubbs@gmail.com>. This manual page was written
|
|
||||||
by Chris Brannon, and his email address is <cmbrannon79@gmail.com>.
|
|
||||||
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 +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
|
||||||
|
|
|
||||||
|
|
@ -1,2 +1,4 @@
|
||||||
option('systemd', type : 'feature', value : 'auto',
|
option('systemd', type : 'feature', value : 'auto',
|
||||||
description :'enable systemd support')
|
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