2. Invoking

Usage: speechd-up [options]

-d or --run-deamon

Run as a deamon in the background.

-s or --run-single

Run as an application on the foreground.

-l or --log-level

Sets the logging level. Accepted values are numbers 1 to 5. Five means the most verbose logging.

-L or --log-file

Specifies the path to the file where logs are stored.

-D or --device

Selects the device where Speakup sends it's output.

-c or --coding

Indicates which character coding your console uses. For possible values, please see `iconv –list'. This option is important if your console is not in iso-8859-1! (It doesn't work with “utf-8” and other multibyte encoding because of kernel related issues with this encoding. You must run your console in a unibyte encoding like for example one of the “iso-8859-*” set, sorry.)

-i or --language

Specifies the language to use. You must provide a 2 character ISO 839 language code (such as “en”, “de”, “fr”, “cs”). This language will be set via Speech Dispatcher and if you have a synthesizer configured for it, Speakup should talk this language. It is currently not possible to switch languages on-fly because of limitations of Speakup.

-t or --dont-init-tables

SpeechD-Up tries to init some Speakups /proc tables on its start. Most important, it changes /proc/characters and /proc/chartab so that punctuation, capital letters recognition and various other language dependent things are handled inside Speech Dispatcher and in the synthesizer. This is crucial for internationalization. You can however disable this if you want to modify the tables manually for some reason and don't like speechd-up overwriting them. (Do not expect Speakup to work for other languages than English in that case, unless you know what you are doing and can do the necessary changes manually.)

-p or --probe

Runs SpeechD-Up in the probe mode. This means that SpeechD-Up will do everything as as ordinary, but won't try to open the SpeakUp device. It just speaks a message and terminates (indicating so in the logfiles). This is meant for testing.

-v or --version

Print version and copyright info.

-h or --help

Print a short help.

Examples:

If the device where Speakup talks to userspace is /dev/sftsyn2 and your console is in iso-8859-2, then you can use:

speechd-up --device="/dev/sftsyn2/" --coding "iso-8859-2"

Please use this for debugging or sending bug-reports

speechd-up -s -l 5 -L "/tmp/speechd-up.log"

This document was generated by Hynek Hanke on March, 26 2009 using texi2html 1.78.