2.3 Commands

The basic speechd-el commands are all accessible through a common special prefix key, which is C-e by default (you can change it, see section Customization). If this prefix conflicts with a global Emacs command, the original command is available by double pressing the prefix key. For instance, with the default prefix, the end-of-line command, normally available under the C-e key, can be invoked as C-e C-e.

In the following subsections we use the term reading to indicate any kind of output enabled in speechd-el (such as speaking or Braille output).

2.3.1 Reading Commands

C-e l

Read current line (speechd-speak-read-line). With the prefix argument, read the line only from the current cursor position to the end of line.

C-e b

Read current buffer (speechd-speak-read-buffer).

C-e >

Read current buffer from the cursor to the buffer end (speechd-speak-read-rest-of-buffer).

C-e o

Read buffer of the other window, if any is present (speechd-speak-read-other-window).

C-e r

Read current region (speechd-speak-read-region).

C-e C-r

Read text in the rectangle-region (speechd-speak-read-rectangle).

C-e w

Read the next word after cursor (speechd-speak-read-word).

C-e .

Read current sentence (speechd-speak-read-sentence).

C-e {

Read the next paragraph after cursor (speechd-speak-read-paragraph).

C-e [

Read the next page after cursor (speechd-speak-read-page).

C-e '

Read the next symbolic expression after cursor (speechd-speak-read-sexp).

C-e c

Read the character at the cursor position (speechd-speak-read-char).

C-e C-n

Read the next line (speechd-speak-read-next-line).

C-e C-p

Read the previous line (speechd-speak-read-previous-line).

C-e m

Read last seen Emacs message (speechd-speak-last-message).

C-e RET

Read the mode line (speechd-speak-read-mode-line). Note: This command works only in Emacs 22 or higher.

C-e i

Read last output buffer insertions (speechd-speak-last-insertions). That is the text read in auto-reading buffers, see See section Auto-Reading Buffers.

A few Emacs commands get you stuck in a character reading prompt, a typical example is ispell-word. If you miss what was read before you are prompted for action, you can use the following keystrokes at the prompt to repeat the output texts:

C-e

The same as the C-e m command above (speechd-speak-last-message).

C-a

The same as the C-e i command above (speechd-speak-last-insertions).

If you don't like such character reading prompt behavior, you can disable it using the following variable:

speechd-speak-allow-prompt-commands

If non-nil, allow the speechd-speak commands mentioned above in read-char prompts.

2.3.2 Informatory Commands

C-e C-i b

Read information about current buffer (speechd-speak-buffer-info).

C-e C-i f

Read information about current frame (speechd-speak-frame-info).

C-e C-i h

Read contents of the header line (speechd-speak-header-line-info). Note: This command works only in Emacs 22 or higher.

C-e C-i m

Read information about current major and minor modes (speechd-speak-mode-info).

C-e C-i c

Read information about current coding systems (speechd-speak-coding-info).

C-e C-i i

Read information about current input method (speechd-speak-input-method-info).

C-e C-i p

Read status of the process associated with the current buffer (speechd-speak-process-info).

2.3.3 Control Commands

C-e q

Toggle reading globally (speechd-speak-toggle-speaking). With a prefix argument, toggle it in the current buffer only.

C-e s

Stop reading current message (speechd-stop). Other queued messages will still be read. If the prefix argument is given, stop reading the current message of any client, not just of the current connection.

C-e x

Stop reading all the queued messages of the current connection and of the connections listed in speechd-cancelable-connections. If the universal prefix argument is given, stop reading all the messages of all connections. If a numeric prefix argument is given, stop all the messages of the current Emacs session.

C-e p

Pause reading — just be quiet for now and postpone current reading until the resume command is invoked (speechd-pause). If the prefix argument is given, pause reading of all clients.

C-e SPC

Resume paused reading (speechd-resume). If the prefix argument is given, resume reading of all clients.

C-e 1

C-e 2

C-e 3

C-e 4

C-e 5

C-e 6

C-e 7

C-e 8

C-e 9

Set one of the predefined speech rates (speechd-speak-key-set-predefined-rate). C-e 1 sets the slowest rate, C-e 5 sets the medium rate, and C-e 9 sets the fastest rate.

2.3.4 Parameter Setting Commands

These commands set various properties of the speech output. They all apply on the current Speech Dispatcher connection (for more information about Speech Dispatcher connections, see section Connection Voices), unless there are invoked with a prefix argument. With a numeric prefix argument they apply on all speechd-el connections, with a universal prefix argument they apply on all Speech Dispatcher connections.

Commands affecting basic parameters of the text-to-speech process:

C-e d l

Set default language of the connection. Specify it as an RFC 1766 language code (e.g. en, cs, etc.).

C-e d .

Specify how to handle punctuation, whether to read it or ignore it. all mode reads all punctuation characters, none mode skips them all quietly, and some mode reads a selected subset of punctuation characters specified in the Speech Dispatcher configuration.

C-e d c

Set capital letter indication mode. icon means signal them with a sound icon, spell means spell them using a special spelling table, and none means no indication.

Commands affecting speech output properties:

C-e d v

Set default voice to be used by the synthesizer (speechd-set-voice). You may select one from the voice set offered by your Speech Dispatcher installation.

C-e d C-v

Set default voice to be used by the synthesizer directly by its synthesizer dependent name (speechd-set-synthesizer-voice). You may select one from the voice set offered by the currently selected Speech Dispatcher output module. This works only with Speech Dispatcher 0.6.3 or higher and not all Speech Dispatcher output modules support this function.

C-e d r

Set exact speech rate, ranging from -100 (slowest) to 100 (fastest) (speechd-set-rate). Most often you will probably want to use the speechd-speak-key-set-predefined-rate command bound to C-e number instead, see Control Commands.

C-e d p

Set voice pitch, ranging from -100 (lowest) to 100 (highest) (speechd-set-pitch).

C-e d V

Set voice volume, ranging from -100 (lowest) to 100 (highest) (speechd-set-volume).

Commands affecting the speech synthesizer:

C-e d o

Switch Speech Dispatcher to the given output module (speechd-set-output-module). Give the module name when you are prompted for the argument.

2.3.5 Spelling

There are two ways to use spelling in speechd-el. The first one is the speechd-speak-spell-mode, which is a minor mode that you can enable for a buffer. The mode is useful if you want to spell more of the buffer contents.

The second spelling method is using the following command:

C-e C-l

Cause the following command to spell the text it reads (speechd-speak-spell). For instance, if you want to spell the word after the cursor, you can type C-e C-l C-e w.

2.3.6 Other Commands

In case Emacs gets completely crazy and refuses to run commands including C-x C-c because of a bug in speechd-el or in an alternative output related custom definition, you can try to invoke the following command as the last resort:

C-e C-x

Try to disable all modes, hooks and wrappers installed by speechd-speak (speechd-unspeak).

The following commands are rarely used, mostly for diagnosing purposes:

C-e z

Repeat the last output text (speechd-repeat).

M-x speechd-say-text

Prompt for a text and read it.

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