Merge remote branch 'grml-scripts-split/split/grml-scripts'
[grml-scripts.git] / doc / swspeak-setup.8.txt
1 swspeak-setup(8)
2 ================
3 Michael Prokop <mika@grml.org>
4
5 NAME
6 ----
7 swspeak-setup - script for activating software speak(up) features
8
9 SYNOPSIS
10 --------
11
12 *swspeak-setup* [-a] [-e|-s] [-f] [-h]
13
14 DESCRIPTION
15 -----------
16
17 *swspeak-setup* is a wrapper arround setting up the speakup kernel module
18 and its according userspace software (espeakup by default if available, otherwise
19 falling back to speechd-up). The script is used inside the swspeak zsh function
20 of grml's zshrc.
21
22 OPTIONS
23 -------
24
25 *-h*::
26 Show summary of options.
27
28 *-e*::
29 Use espeakup (default, if available).
30
31 *-s*::
32 Use speechd-up (fallback, if available).
33
34 *-a*::
35 Do not execute aumix for setting mixer levels.
36
37 *-f*::
38 Disable flite sound output.
39
40 EXAMPLES
41 --------
42
43 *swspeak-setup* '-a'::
44
45     Set up speakup kernel modules and start espeakup (if available) without executing aumix for setting mixer levels.
46
47 AUTHOR
48 ------
49 swspeak-setup and this manpage were written by Michael Prokop <mika@grml.org>.