Changeset View
Changeset View
Standalone View
Standalone View
usr.bin/vtspeakd/vtspeakd.1
- This file was added.
| .\" $FreeBSD$ | |||||||||||
| .\" | |||||||||||
gbe: I think that this could be dropped and replaced by an SPDX identifier. | |||||||||||
| .\" SPDX-License-Identifier: BSD-2-Clause-FreeBSD | |||||||||||
| .\" | |||||||||||
| .\" Copyright (c) 2022 Hans Petter Selasky | |||||||||||
| .\" | |||||||||||
| .\" Redistribution and use in source and binary forms, with or without | |||||||||||
| .\" modification, are permitted provided that the following conditions | |||||||||||
| .\" are met: | |||||||||||
| .\" 1. Redistributions of source code must retain the above copyright | |||||||||||
| .\" notice, this list of conditions and the following disclaimer. | |||||||||||
| .\" 2. Redistributions in binary form must reproduce the above copyright | |||||||||||
| .\" notice, this list of conditions and the following disclaimer in the | |||||||||||
| .\" documentation and/or other materials provided with the distribution. | |||||||||||
| .\" | |||||||||||
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | |||||||||||
| .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | |||||||||||
| .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | |||||||||||
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | |||||||||||
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |||||||||||
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |||||||||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |||||||||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | |||||||||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | |||||||||||
| .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | |||||||||||
| .\" SUCH DAMAGE. | |||||||||||
| .\" | |||||||||||
| .Dd October 5, 2022 | |||||||||||
| .Dt VTSPEAKD 1 | |||||||||||
| .Os | |||||||||||
| .Sh NAME | |||||||||||
| .Nm vtspeakd | |||||||||||
| .Nd daemon to speak the console | |||||||||||
| .Sh SYNOPSIS | |||||||||||
| .Nm | |||||||||||
| .Op Fl c | |||||||||||
| .Op Fl k | |||||||||||
| .Op Fl l Ar language | |||||||||||
| .Op Fl S Ar program_name | |||||||||||
| .Op Fl B | |||||||||||
| .Op Fl v | |||||||||||
| .Op Fl h | |||||||||||
| .Sh DESCRIPTION | |||||||||||
| The | |||||||||||
| .Nm | |||||||||||
| daemon is used to feed the contents of the current | |||||||||||
| .Xr vt 4 | |||||||||||
| console to an external program, for example espeak. | |||||||||||
| The | |||||||||||
| .Nm | |||||||||||
| program responds to Control-L and Control-B by either redrawing the | |||||||||||
| screen or terminating the currently spoken text, respectivly. | |||||||||||
pauamma_gundo.comUnsubmitted Not Done Inline Actions
pauamma_gundo.com: | |||||||||||
| .Pp | |||||||||||
| The options are as follows: | |||||||||||
| .Bl -tag -width "xxxxx" | |||||||||||
| .It Fl c | |||||||||||
| Be chatty when speaking the console. | |||||||||||
| .It Fl k | |||||||||||
| Don't allow kernel to hangup speak program on bell. | |||||||||||
| .It Fl l | |||||||||||
| Select language to use. | |||||||||||
| .It Fl S | |||||||||||
| Select speak program to use. | |||||||||||
| Default is bin/espeak in the local base directory. | |||||||||||
| .It Fl B | |||||||||||
| Run program in the backround. | |||||||||||
| .It Fl v | |||||||||||
| Print text strings for the speak program to standard output. | |||||||||||
| .It Fl h | |||||||||||
| Show usage and exit. | |||||||||||
| .El | |||||||||||
| .Sh EXAMPLES | |||||||||||
| Start | |||||||||||
| .Nm : | |||||||||||
| .Pp | |||||||||||
| .Dl vtspeakd -B | |||||||||||
| .Sh SEE ALSO | |||||||||||
| .Xr espeak 1 | |||||||||||
I think that this could be dropped and replaced by an SPDX identifier.