This is speechd-el.info, produced by makeinfo version 4.6 from
speechd-el.texi.

This manual is for speechd-el, 0.3.

   Copyright (C) 2003, 2004 Brailcom, o.p.s.

     Permission is granted to copy, distribute and/or modify this
     document under the terms of the GNU Free Documentation License,
     Version 1.2 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with no Front-Cover Texts
     and no Back-Cover Texts.  A copy of the license is included in the
     section entitled "GNU Free Documentation License."
   
INFO-DIR-SECTION Sound
INFO-DIR-SECTION Emacs
START-INFO-DIR-ENTRY
* speechd-el: (speechd-el).	Emacs interface to Speech Dispatcher.
END-INFO-DIR-ENTRY


File: speechd-el.info,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)

speechd-el
**********

This manual is for speechd-el, 0.3.

   Copyright (C) 2003, 2004 Brailcom, o.p.s.

     Permission is granted to copy, distribute and/or modify this
     document under the terms of the GNU Free Documentation License,
     Version 1.2 or any later version published by the Free Software
     Foundation; with no Invariant Sections, with no Front-Cover Texts
     and no Back-Cover Texts.  A copy of the license is included in the
     section entitled "GNU Free Documentation License."
   
* Menu:

* Introduction::                What is speechd-el and this manual about?
* speechd-el User Manual::      Using Emacs speech output.
* speechd-el Elisp Library::    Using speechd-el in Elisp programs.
* Contact Information::         Bug reporting etc.

* Copying This Manual::         GNU Free Documentation License.
* Index::                       Concept, function, variable and key index.


File: speechd-el.info,  Node: Introduction,  Next: speechd-el User Manual,  Prev: Top,  Up: Top

Introduction
************

speechd-el is an Emacs client to Speech Dispatcher.  It provides the
following functionality:

   * An Emacs Lisp library for accessing Speech Dispatcher using its
     socket based communication protocol (SSIP).

   * Emacs speech output support, especially focused on providing
     facilities necessary for Emacs use by the blind and visually
     impaired.

   Key features of speechd-el are:

   * Support for automated speaking, without necessity to customize each
     particular Emacs function to make it speak; most built-in and
     external Emacs packages produce speech output immediately, without
     any special support.

   * Almost no change of standard Emacs behavior, no interference with
     user settings.

   * Full cooperation with Speech Dispatcher.

   * Small code size.

   This manual describes the speech output user interface, how to
customize and extend the interface, and the Emacs Lisp library.  Some
degree of familiarity with Speech Dispatcher on the user level is
recommended, though not absolutely necessary.


File: speechd-el.info,  Node: speechd-el User Manual,  Next: speechd-el Elisp Library,  Prev: Introduction,  Up: Top

speechd-el User Manual
**********************

speechd-el allows you to use Emacs without looking at screen, with
speech output only.  The main usage area is by blind and visually
impaired people, but you generally you can use speech output for many
purposes, according to any your wishes and needs.

   You can download the latest released version of speechd-el from
<http://www.freebsoft.org/pub/projects/speechd-el/>.

   speechd-el uses Speech Dispatcher for the speech output, so working
Speech Dispatcher installation is necessary to produce any speech
output.  Please look at <http://www.freebsoft.org/speechd> for more
information about Speech Dispatcher.

* Menu:

* Installation::                Installing speechd-el.
* Starting Speech Output::      Making it speak.
* Commands::                    Usage.
* Customization::               Basic customization.
* Advanced Customization::      Writing your own command feedbacks.
* Problems::                    Strange behavior.
* Bug Reporting::               speechd-el and Speech Dispatcher bugs.


File: speechd-el.info,  Node: Installation,  Next: Starting Speech Output,  Prev: speechd-el User Manual,  Up: speechd-el User Manual

Installation
============

In order to install speechd-el, you need the Elib library.  You can
download it from <ftp://ftp.debian.org/debian/pool/main/e/elib/>.

   Once you Elib installed, you can install speechd-el in the following
steps:

  1. Copy the `*.el' files contained in the distribution package
     somewhere to your Emacs load path.

  2. If you like, byte compile the `*.el' files.  Byte compilation is
     recommended, because it speeds up speechd-el significantly.  You
     can byte compile using the command

          make compile

     Then install the compiled files to an Emacs load path location as
     well.

  3. Install the `speechd-log-extractor' somewhere to your shell PATH,
     e.g. `/usr/local/bin/'.

  4. Add the following line to your `~/.emacs':

          (autoload 'speechd-speak "speechd-speak" nil t)

   To run speechd-el, Speech Dispatcher must be installed and running.
Speech Dispatcher 0.3 or higher is recommended to get all the
speechd-el features working.


File: speechd-el.info,  Node: Starting Speech Output,  Next: Commands,  Prev: Installation,  Up: speechd-el User Manual

Starting Speech Output
======================

After installation of the `*.el' files and restarting Emacs, you can
set up speechd-speak using the `M-x speechd-speak' command.  If you
want to happen it automatically each time Emacs is started, put the
following line to your `~/.emacs' after the autoload line:

     (speechd-speak)

`M-x speechd-speak'
     Set up Emacs for speech output and start speaking.

     Please don't forget Speech Dispatcher must be running in order to
     get any speech output!

     After the initial setup, the command can be used again to restart
     the speech support when needed.  Especially, you must run it again
     if Speech Dispatcher gets restarted.

     With a prefix argument, all open connections are closed first.
     This is useful when you need to reset parameters of all
     connections, see *Note Connection Voices::.

     After the first invocation, the command is available under the
     `C-e C-s' key.

   Once the setup is done, enabling and disabling the speech output is
controlled by speechd-speak and global-speechd-speak minor modes.
Usually the mode commands are not used directly, you use the
`speechd-speak-toggle-speaking' command (*note Control Commands::), but
if you need them, they are available.

`M-x speechd-speak-mode'
     Enable or disable speaking in the current buffer.  With no
     argument, this command toggles the mode.  Non-null prefix argument
     turns on the mode.  Null prefix argument turns off the mode.

`M-x global-speechd-speak-mode'
     Enable or disable speaking globally.  With no argument, this
     command toggles the mode.  With prefix argument, turn speaking on
     if and only if the argument is positive.


File: speechd-el.info,  Node: Commands,  Next: Customization,  Prev: Starting Speech Output,  Up: speechd-el User Manual

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, *note
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'.

* Menu:

* Reading Commands::            Reading pieces of text.
* Control Commands::            Stopping, setting speech rate, etc.
* Parameter Setting Commands::  Modifying speech output.
* Spelling::                    How to spell a piece of text.
* Other Commands::              Auxiliary commands.


File: speechd-el.info,  Node: Reading Commands,  Next: Control Commands,  Prev: Commands,  Up: Commands

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').


File: speechd-el.info,  Node: Control Commands,  Next: Parameter Setting Commands,  Prev: Reading Commands,  Up: Commands

Control Commands
----------------

`C-e q'
     Toggle speaking globally (`speechd-speak-toggle-speaking').  With
     a prefix argument, toggle it in the current buffer only.

`C-e s'
     Stop speaking current message (`speechd-stop').  Other queued
     messages will still be spoken.  If the prefix argument is given,
     stop speaking the current message of any client, not just of the
     current connection.

`C-e x'
     Stop speaking all the queued messages of the current connection.
     If the universal numeric argument is given, stop speaking 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 speaking -- just be quiet for now and postpone current
     speaking until the resume command is invoked (`speechd-pause').
     If the prefix argument is given, pause speaking of all clients.

`C-e SPC'
     Resume paused speaking (`speechd-resume').  If the prefix argument
     is given, resume speaking 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.


File: speechd-el.info,  Node: Parameter Setting Commands,  Next: Spelling,  Prev: Control Commands,  Up: Commands

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, *note 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.

   You can set a separate connection, having its own connection
parameters, for a buffer using the following command:

`C-e C-c'
     Set a given connection for the current buffer
     (`speechd-speak-new-connection').  The command prompts for a
     connection name, you can give either new name or a name of an
     existent connection.  Normally, you are offered with a newly
     generated connection name, while with a prefix argument, you can
     choose from the names of existent 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 ISO 639
     language code.

`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 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 *Note 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.


File: speechd-el.info,  Node: Spelling,  Next: Other Commands,  Prev: Parameter Setting Commands,  Up: Commands

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'.


File: speechd-el.info,  Node: Other Commands,  Prev: Spelling,  Up: Commands

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 a speech
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 text sent to Speech Dispatcher (`speechd-repeat').

`M-x speechd-say-text'
     Prompt for a text and speak it.


File: speechd-el.info,  Node: Customization,  Next: Advanced Customization,  Prev: Commands,  Up: speechd-el User Manual

Customization
=============

* Menu:

* Host Configuration::          Where to connect to.
* Default Priorities::          Priorities of various kinds of messages.
* Basic Speaking::              Simple options.
* Auto-Speaking Buffers::       Making certain buffers speak automatically.
* Signalling::                  Signalling empty lines, etc.
* Text Properties::             Handling faces and special pieces of text.
* Languages::                   Using multiple languages.
* Voices::                      Defining different voices.
* Connection Voices::           Setting connection parameters.
* Multiple Connections::        Different parameters for some modes & buffers.
* Keys::                        Customizing command keys.
* Modes::                       Minor mode hooks.
* Debugging::                   Make debugger quiet.


File: speechd-el.info,  Node: Host Configuration,  Next: Default Priorities,  Prev: Customization,  Up: Customization

Speech Dispatcher Host Connection Configuration
-----------------------------------------------

Host connection variables allow you connect to Speech Dispatcher
running on a remote host or a non-default port.

`speechd-host'
     Name of the host running Speech Dispatcher to connect to, given as
     a string.  Default is `"localhost"'.

`speechd-port'
     Port number to connect to.  Default is the default Speech
     Dispatcher port.

`speechd-timeout'
     Maximum number of seconds to wait for a Speech Dispatcher answer.
     If it is exceeded, speechd-el closes the connection.  Normally,
     Speech Dispatcher should answer protocol commands immediately, but
     if you talk to a Speech Dispatcher in a strange way through a
     lagging network, you may want to increase the limit.


File: speechd-el.info,  Node: Default Priorities,  Next: Basic Speaking,  Prev: Host Configuration,  Up: Customization

Default Priorities
------------------

If a speechd-el function sends a message to Speech Dispatcher without
an explicitly specified priority, the priorities defined by the
following variables are used.  By changing the values, you can achieve
interesting effects.  For instance, changing the value of
`speechd-default-key-priority' from `notification' to `message' makes
all typed characters to be echoed and makes them to interrupt common
text reading.

   The valid values of all the variables here are: `important',
`message', `text', `notification', `progress'.  They correspond to
Speech Dispatcher priorities, see the Speech Dispatcher manual for more
details.

`speechd-default-text-priority'
     Default priority of most text messages.

`speechd-default-sound-priority'
     Default priority of sound icons.

`speechd-default-char-priority'
     Default priority of spelled characters.

`speechd-default-key-priority'
     Default priority of typed keys.


File: speechd-el.info,  Node: Basic Speaking,  Next: Auto-Speaking Buffers,  Prev: Default Priorities,  Up: Customization

Basic Customization of Speaking
-------------------------------

`speechd-speak-deleted-char'
     Defines which character to read when deleting a character.  If
     non-`nil', speak the deleted character, otherwise speak the
     adjacent character.

`speechd-speak-buffer-name'
     When you switch to another buffer and this variable is non-`nil',
     speak the new buffer name.  If the variable value is the symbol
     `text', speak the text from the cursor position to the end of line
     in the new buffer as well.  If the variable is `nil', speak the
     text without speaking the buffer name.

`speechd-speak-on-minibuffer-exit'
     When this variable is non-`nil', speechd-el reads the text around
     cursor after exiting from minibuffer or its recursive level if
     there is nothing else to speak.

`speechd-speak-read-command-keys'
     This variable defines in which situations command keys should be
     read after their command is performed.  If `t', the command keys
     are always read.  If `nil', they are never read.  If list, it may
     contain one or more of the following symbols describing the
     situations in which the keys should be read:

    `movement'
          Read the command keys if the cursor has moved, no buffer
          modification happened.

    `modification'
          Buffer was modified, the cursor hasn't moved.

    `movement-modification'
          Buffer was modified and the cursor was moved.

     If the variable value is `t', the command keys are read before the
     command is performed.  Otherwise, their speaking is delayed after
     the command is executed, since the buffer changes and cursor
     movement must be detected first.

`speechd-speak-ignore-command-keys'
     List of commands that should never echo their command keys.

`speechd-speak-read-command-name'
     If non-`nil', read in the situations defined by the variable
     `speechd-speak-read-command-keys' command name instead of command
     keys.


File: speechd-el.info,  Node: Auto-Speaking Buffers,  Next: Signalling,  Prev: Basic Speaking,  Up: Customization

Auto-Speaking Buffers
---------------------

It sometimes useful to start speaking some buffers without user's
explicit request.  For instance, if a help command is invoked, the user
usually wants to read the help text immediately.  The following
variables contain lists of names of the buffers that may be spoken
automatically if they get changed by the last command and are visible
in some window of the current frame.

`speechd-speak-auto-speak-buffers'
     Content of these buffers is spoken after the command on the above
     conditions if nothing else (e.g. text around a new cursor
     position) is to be spoken.

`speechd-speak-force-auto-speak-buffers'
     Like `speechd-speak-auto-speak-buffers' except that the buffer
     content is spoken forcibly, even when something else could be
     spoken.

   The following variables define how to handle texts inserted during
performing user commands.  Only newly inserted text is read, the
options don't affect processing of deleted text.  Also, the options
don't affect insertions within commands processed in a special way by
speechd-el or user definitions, like `self-insert-command'.

`speechd-speak-buffer-insertions'
     Defines whether insertions in the current buffer should be read
     automatically.  The value may be one of the following symbols:

    `nil'
          Don't speak the inserted texts.

    `t'
          Speak all the inserted texts.

    `one-line'
          Speak only the first lines of inserted texts.

    `whole-buffer'
          Speak whole buffer if it was modified in any way.

`speechd-speak-insertions-in-buffers'
     List of names of buffers, in which insertions are automatically
     spoken, whether the buffer is current or not and regardless the
     `speechd-speak-buffer-insertions' variable.

`speechd-speak-priority-insertions-in-buffers'
     List of names of buffers, in which insertions are automatically
     spoken immediately as they appear, not only after a command is
     evaluated as with `speechd-speak-insertions-in-buffers'.  This is
     typically useful in comint buffers.

`speechd-speak-align-buffer-insertions'
     If non-`nil', the insertion text to be spoken is extended to the
     beginning of the first word affected by the insertion.  This is
     particularly useful in completion functions.

   If the last command modified the current buffer and moved its cursor
to a completely different position, the new cursor position is not
indicated in speech output.  You can change it through the following
variable:

`speechd-speak-movement-on-insertions'
     If `t', speak the text around new cursor position even when the
     current buffer was modified.  If `read-only', speak it only in
     read-only buffers.  If `nil', don't speak it.


File: speechd-el.info,  Node: Signalling,  Next: Text Properties,  Prev: Auto-Speaking Buffers,  Up: Customization

Signalling
----------

Certain situations may be signalled by sound icons.  The following
variable enables or disables the predefined indications.  To learn how
to define your own indications, *Note Advanced Customization::.

`speechd-speak-signal-events'
     List of symbols, containing names of events to signal with a sound
     icon.  The following event names are supported:

    `start'
          Start or restart of speechd-el.

    `empty'
          Empty text in various situations.

    `beginning-of-line'
          Reaching beginning of line after the `forward-char' and
          `backward-char' commands.

    `end-of-line'
          Reaching end of line after the `forward-char' and
          `backward-char' commands.

    `minibuffer'
          Entering minibuffer.

    `message'
          Messages in echo area follow.


File: speechd-el.info,  Node: Text Properties,  Next: Languages,  Prev: Signalling,  Up: Customization

Text Properties
---------------

By default, after a movement command speechd-el speaks the current
line.  But if the cursor position is surrounded by a text having text
properties (typically faces, but any text properties count), speechd-el
may read just the piece of the text around the cursor having uniform
properties.

   Also, if font lock mode is enabled, faces may be mapped to different
voices.

`speechd-speak-by-properties-on-movement'
     Method of selection of the piece of text to be spoken on movement.
     The variable may take one of the following values.

    `nil'
          Text properties are not considered at all.

    `t'
          All text properties are considered.

    list of faces
          Only the named faces are considered.

`speechd-speak-by-properties-always'
     List of commands that always consider text properties, even when
     the `speechd-speak-by-properties-on-movement' variable is `nil'.

`speechd-speak-by-properties-never'
     List of commands that never consider text properties, even when the
     `speechd-speak-by-properties-on-movement' variable is non-`nil'.

`speechd-speak-faces'
     This variable allows you to invoke actions when the cursor ends up
     on a certain face after a user command is performed.  The variable
     value is an alist with elements of the form `(FACE . ACTION)'.

     If a movement command leaves the cursor on a FACE and there is no
     explicit speaking bound to the command, ACTION is invoked.  If
     ACTION is a string, that string is spoken.  If ACTION is a
     function, it is invoked, with no arguments.

`speechd-face-voices'
     Mapping of faces to voices.  The variable value is an alist with
     elements of the form `(FACE . VOICE)' where FACE is a face and
     VOICE is a voice identifier defined in `speechd-voices', see *Note
     Voices::.  Each face is spoken in the corresponding voice.  If
     there's no item for a given face in this variable, the face is
     spoken in the current voice.

     Note that the mapping takes the effect only if font lock mode is
     enabled.


File: speechd-el.info,  Node: Languages,  Next: Voices,  Prev: Text Properties,  Up: Customization

Using multiple languages
------------------------

You can use speechd-el with multiple languages.  However, the process
can't be easily automated, since ordinary text does not contain any
information about its language.  So if you want to use speechd-el with
the output being spoken in multiple languages, you must provide
speechd-el some hints.

   The basic means for providing language information to speechd-el is
the variable `speechd-language'.  Each time speechd-el is about to
speak a piece of text, it checks the variable for the language code and
if it is non-`nil', it speaks the text in the corresponding language.
The non-`nil' value must be a string of the RFC 1766 language code.

   Most often you will probably want to set the variable in a particular
file, see *Note File Variables: (emacs)File Variables, or as a buffer
local variable, see *Note Locals: (emacs)Locals, in mode hooks, see
*Note Hooks: (emacs)Hooks.

   If a piece of the text has the `language' property containing the
RFC 1766 language code, it is spoken in the corresponding language,
regardless of other settings.  You can use the `speechd-language'
function to put the property on a string in your Elisp programs.

   Another good way of using multiple languages is to use multiple
connections for separating language dependent buffers or modes, see
*Note Multiple Connections::, and to set the `language' parameter for
each such a connection, see *Note Connection Voices::.


File: speechd-el.info,  Node: Voices,  Next: Connection Voices,  Prev: Languages,  Up: Customization

Defining voices
---------------

You can define special voices in speechd-el that can be used in
different situations, e.g. to speak different faces in different voices
(*note Text Properties::) or to set different punctuation modes for
different kinds of buffers (*note Multiple Connections::).  speechd-el
voices define not only basic voice characteristics, but also speech
characteristics like pitch or rate and special properties like
punctuation reading or capital character signalization.

   Voice definition is contained in the following variable:

`speechd-voices'
     Alist of voice identifiers and their parameters.

     Each element of the list is of the form `(VOICE-ID . PARAMETERS)',
     where VOICE-ID is a symbol under which the voice will be accessed
     and PARAMETERS is an alist of parameter identifiers and parameter
     values.  Valid parameter names are the following symbols:
     `language', `gender', `age', `style', `name', `rate', `pitch',
     `volume', `punctuation-mode', `capital-character-mode',
     `message-priority', `output-module'.

     `name' value is a string identifying Speech Dispatcher voice name.
     If it is not given, the parameters `gender', `age', and `style'
     are considered to select a Speech Dispatcher voice.  `gender'
     value can be one of the symbols `male', `female', `neutral'.
     `age' can be one of the symbols `middle-adult', `child'.
     `neutral'.  `style' can be one of the numbers `1', `2', `3'
     (`style' values are likely to be changed in future).

     The `message-priority' parameter sets priority of amy message of
     the voice.  Its value is any of the message priority symbols.

     See the corresponding `speechd-set-*' functions for valid values
     of other parameters.

     The voice named `nil' is special, it defines a default voice.
     Explicit definition of its parameters is optional.


File: speechd-el.info,  Node: Connection Voices,  Next: Multiple Connections,  Prev: Voices,  Up: Customization

Connection Voices
-----------------

With the help of the following variable you can let set various
connection parameters, like speech rate, language, etc., automatically.
speechd-el can open multiple connections according to various criteria
(*note Multiple Connections::), you can set different parameters to
different connections, based on their names.

`speechd-connection-parameters'
     Alist of connection names and corresponding voices.  Each list
     element is of the form `(CONNECTION-NAME . VOICE)', where
     CONNECTION-NAME is a connection name given as a string and VOICE
     is a voice identifier defined in the variable `speechd-voices'.

     The default voice (named `nil') is used for connections that are
     not present in this variable.

   So that changing the value of the variable could take the full
effect, the open connections must be reopened.  Unless you use the
customization interface, you must invoke the `C-u M-x speechd-speak'
command to ensure this.

   There is a command to help you with setting connection voice and its
parameters:

`C-e C-a'
     Store the current connection parameters to a specified voice in the
     `speechd-voices' variable and set that voice for the current
     connection in the `speechd-connection-voices' variable.

     Please note you are still responsible to save the variables if you
     want to use them in future sessions.


File: speechd-el.info,  Node: Multiple Connections,  Next: Keys,  Prev: Connection Voices,  Up: Customization

Multiple Connections
--------------------

You can arrange speechd-el to use separate connections to Speech
Dispatcher for certain buffers or major modes.  This is basically
useful to allow independent parameter setting for those buffers and
major modes, both by hand and through the configuration (*note
Connection Voices::).

   Each Speech Dispatcher connection has its unique name.  By default,
speechd-el uses a connection named `"default"'.  All you need to create
a separate connection is to let speechd-el choose a different
connection name in certain situations.  The process of connection name
selection is driven by the `speechd-speak-connections' variable.

`speechd-speak-connections'
     Alist mapping major modes and buffers to Speech Dispatcher
     connections.  Each element of the alist is of the form
     `(MODE-OR-BUFFER . CONNECTION-NAME)'.

     When speechd-el wants to send a message, it tests the current
     environment against the MODE-OR-BUFFER entries.  MODE-OR-BUFFER
     may be one of the following objects, in the order of priority from
     the highest to the lowest:

        * a list, representing a function call that should return a
          non-`nil' value if and only if the element should be applied

        * buffer name

        * the symbol `:minibuffer', representing minibuffers

        * major mode symbol

        * `nil', representing non-buffer areas, e.g. echo area

        * `t', representing the default value if nothing else matches

     If more entries match in some situation, the entry with the highest
     priority is used.

     CONNECTION-NAME is an arbitrary non-empty string naming the
     corresponding connection.  If no connection with such a name is
     open in the running speechd-el, it is automatically created when
     there's something to send to it.


File: speechd-el.info,  Node: Keys,  Next: Modes,  Prev: Multiple Connections,  Up: Customization

Keys
----

The command keys of speechd-el are defined by the
`speechd-speak-prefix' variable and the `speechd-speak-mode-map' key
map.

`speechd-speak-prefix'
     This variable defines the prefix key of the speechd-el commands,
     which is `C-e' by default.  If you change the variable value after
     speaking has already been started through the `speechd-speak'
     command and you do not set it through the customization interface,
     you must rerun the `speechd-speak' so that the change took any
     effect.

`speechd-speak-mode-map'
     This key map holds the mapping of the keys following the prefix
     key.  You can set keys here in the usual way, e.g.

          (define-key speechd-speak-mode-map "t" 'speechd-say-text)

     to get the `'speechd-say-text' command bound to the `C-e t' key
     (assuming `C-e' is the prefix key).


File: speechd-el.info,  Node: Modes,  Next: Debugging,  Prev: Keys,  Up: Customization

Minor mode hooks
----------------

speechd-el provides a minor mode that enables and disables the
speaking, *Note Starting Speech Output::.  You can let perform custom
actions on entering it through the following hook.

`speechd-speak-mode-hook'
     Hook run when speechd-speak minor mode is enabled.


File: speechd-el.info,  Node: Debugging,  Prev: Modes,  Up: Customization

Debugging speechd-el
--------------------

When you try to debug speechd-speak functions, you can experience the
problem of recursive speaking in the Elisp debugger.  To avoid it, you
can instruct speechd-el to be quiet in Elisp debuggers:

`speechd-speak-in-debugger'
     If `nil', speechd-speak functions won't speak in Elisp debuggers.


File: speechd-el.info,  Node: Advanced Customization,  Next: Problems,  Prev: Customization,  Up: speechd-el User Manual

Defining Your Own Command Feedbacks
===================================

Writing your own feedback definitions generally requires knowledge of
Elisp programming.  But don't be afraid, you can set basic things
without it, just following instructions here.

   speechd-el allows you to say a text, play a sound icon, or call any
Elisp expression before or after a command or a function is invoked.
There are two macros that allow you to do it, while ensuring everything
is set up properly:

`speechd-speak-command-feedback COMMAND POSITION FEEDBACK'
     Install feedback invocation on COMMAND.  `command' is a name of an
     interactive function (use `C-h C-c' to get a name of the command
     bound to a given key).

     POSITION may be one of the symbols `before' and `after' to call
     the feedback before or after the command is invoked.

     `feedback' may be a string or any Elisp expression.  If it is a
     string (a text enclosed in double quotes), it defines a text to be
     spoken or a sound icon to be played.  If the string starts with an
     asterisk (`*'), it names a sound icon (the asterisk is not a part
     of the name), otherwise it is a normal text.

     Example:

          (speechd-speak-command-feedback suspend-emacs before "Suspending Emacs!")

     You can put this line of Elisp code to your `~/.emacs' to ensure
     you are informed when you invoke the `suspend-emacs' command
     (usually bound to `C-z').

`speechd-speak-function-feedback FUNCTION POSITION FEEDBACK'
     This is the same as `speechd-speak-command-feedback', except it is
     called anytime the given function is invoked, whether interactively
     or not.  Also, FUNCTION may be any function, not only an
     interactive command.

   _Please note:_

   * Due to Emacs deficiency, the feedback mechanism may not work on
     built-in functions.

   * Be careful if you want to install function feedbacks without help
     of the macros above.  The macros install code ensuring nothing is
     spoken if `speechd-speak-mode' is disabled and other similar
     precautions.  If you do not use them, you should make those
     precautions yourself.


File: speechd-el.info,  Node: Problems,  Next: Bug Reporting,  Prev: Advanced Customization,  Up: speechd-el User Manual

Problems You May Encounter
==========================

   * _In some situations, when a modified text is read after performing
     a command, the text is read in separate pieces and some of the
     pieces are repeated._

     Buffer modifications can be performed by many different ways in
     Elisp programs.  speechd-el is unable to track them always
     satisfactory.  If you have a reasonable idea how to improve buffer
     modification reading, please tell us.

     As a workaround, if you encounter this problem when performing some
     often used commands, you might want to define your own speaking
     feedbacks of those commands.  *Note Advanced Customization::, for
     more details.

   * _There are sometimes small delays (about 1 second) before
     something is spoken after a command._

     Maybe Emacs is garbage collecting in the meantime.  Try to increase
     the value of the `gc-cons-threshold' variable, e.g. to 4000000.
     It may increase or reduce the performance, depending on your
     environment and particular requirements.

     If you are an experienced Elisp hacker and you can find out why
     speechd-el produces significant amount of data increasing the
     frequency of garbage collection and how to make the things better,
     your help is welcome!

   * _During holding down the `C-n' key, the screen gets frozen and the
     cursor doesn't move for a while._

     Emacs redisplay routines are generally not invoked when Emacs is
     busy.  speechd-el combined with your autorepeat may achieve such a
     state quite easily.  If that's a real problem to you, you can
     reduce your autorepeat rate or buy a faster computer.

     Certainly, any tips increasing speechd-el performance are welcome.


File: speechd-el.info,  Node: Bug Reporting,  Prev: Problems,  Up: speechd-el User Manual

How to Report speechd-el or Speech Dispatcher Bugs
==================================================

When you encounter a speechd-el bug, you can report it to us using the
following command.  Before doing it, please read the whole text of this
section to allow handling your bug report in a more efficient way.

`M-x speechd-bug'
     Report a speechd-el or Speech Dispatcher bug.  The command asks you
     for some information and then asks you whether you can reproduce
     the bug.  If you can, answer `y' and start reproducing the bug
     immediately.  As soon as the bug is reproduced, type `C-e .'.
     Then you can (and should) further edit the generated mail and send
     it in the usual way.

`M-x speechd-bug-reproduce'
     Start reproducing a speechd-el or Speech Dispatcher bug.  All user
     and speechd actions are watched from this moment.

     Bug reproduction is finished by pressing the `C-e C-f' keys.
     After the bug reproduction is finished, information about it is
     inserted into the buffer where the `speechd-bug-reproduce' command
     was invoked.

     This command is useful when you want to provide information about a
     bug without generating new bug report.

   When reporting the bugs, please always remember the following
instructions:

   * Write as much information about the problem as possible.  Describe
     what doesn't work, what's the expected behavior, what actions have
     triggered the bug, what's special about your Emacs environment or
     Speech Dispatcher configuration, etc.  Don't try to analyze too
     much which information is important and which is not -- everything
     may be important to the developers, so try not to forget to
     mention anything that might be important, better more than less.
     Missing information may cause the developers won't be able to
     handle the bug at all.

   * Be as much precise as possible.  Don't expect the developers to
     know the context or to know the way you typically use Emacs and
     speechd-el.  Write in exact terms -- instead of just writing "when
     I invoke foo" write better "when I press the keys `M-x foo RET',
     thus invoking the `foo' command"; or instead of writing "doesn't
     speak what I expect" write like "speaks `blah blah' instead of
     `bleh bleh bleh' what is I expect, since `bleh bleh bleh' is the
     text of the whole line".

   * When reproducing the bug, try to have the Speech Dispatcher logging
     enabled to the highest level -- set the `LogLevel' option to `5'
     in your `speechd.conf' configuration file.

   * When reproducing the bug, don't do any extra actions and invoke
     `C-e .' as soon as the bug is reproduce.  Thus you avoid losing
     the relevant information of the automatically extracted log files
     in an unnecessary garbage.

   * You can also look at the Speech Dispatcher bug reporting
     instructions, see *Note Reporting Bugs: (speechd)Reporting Bugs.


File: speechd-el.info,  Node: speechd-el Elisp Library,  Next: Contact Information,  Prev: speechd-el User Manual,  Up: Top

speechd-el Emacs Lisp Library
*****************************

Right now, there's no real programmer's manual to the library.  Please
read docstrings of available variables, functions and macros.

   Nevertheless, here are some instructions you can and should follow:

   * Don't use any functions, variables or other Lisp objects, names of
     which start with the `speechd--' or `speechd-speak--' prefixes.
     These objects are considered private and may change incompatibly
     or disappear at any time without notice.

   * If you want to select or create a particular connection, do so by
     binding the `speechd-client-name' variable:

          (let ((speechd-client-name "something"))
            ... the code using the connection "something" ... )

     Please note it's usually bad idea to open two concurrent Speech
     Dispatcher connections sharing the same client name.

   * If you write a code invoking speech output, that is intended to be
     called asynchronously, such as in a process filter function or a
     timer, always wrap it by the `speechd-protect' macro.

   * Otherwise there should be no special pitfalls and you should be
     safe to do anything what makes sense.

   You can also look at *Note Advanced Customization::.


File: speechd-el.info,  Node: Contact Information,  Next: Copying This Manual,  Prev: speechd-el Elisp Library,  Up: Top

Contact Information
*******************

If you want to report a bug on speechd-el, send complete information
regarding the bug to the bug tracking address
<speechd-el@bugs.freebsoft.org>.  If you have a patch to speechd-el,
you can send it to the same address.

   _Please_, before sending us any bug report, read the bug reporting
instructions, see *Note Bug Reporting::.  Thus you allow us to process
your bug report more efficiently, resulting in a better response to the
report and faster resolving of the issue.

   If you have any questions, suggestions, or anything else to tell us,
feel free to contact us at the e-mail address <speechd@freebsoft.org>.


File: speechd-el.info,  Node: Copying This Manual,  Next: Index,  Prev: Contact Information,  Up: Top

GNU Free Documentation License
******************************

                      Version 1.2, November 2002

     Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
     59 Temple Place, Suite 330, Boston, MA  02111-1307, USA
     
     Everyone is permitted to copy and distribute verbatim copies
     of this license document, but changing it is not allowed.

  0. PREAMBLE

     The purpose of this License is to make a manual, textbook, or other
     functional and useful document "free" in the sense of freedom: to
     assure everyone the effective freedom to copy and redistribute it,
     with or without modifying it, either commercially or
     noncommercially.  Secondarily, this License preserves for the
     author and publisher a way to get credit for their work, while not
     being considered responsible for modifications made by others.

     This License is a kind of "copyleft", which means that derivative
     works of the document must themselves be free in the same sense.
     It complements the GNU General Public License, which is a copyleft
     license designed for free software.

     We have designed this License in order to use it for manuals for
     free software, because free software needs free documentation: a
     free program should come with manuals providing the same freedoms
     that the software does.  But this License is not limited to
     software manuals; it can be used for any textual work, regardless
     of subject matter or whether it is published as a printed book.
     We recommend this License principally for works whose purpose is
     instruction or reference.

  1. APPLICABILITY AND DEFINITIONS

     This License applies to any manual or other work, in any medium,
     that contains a notice placed by the copyright holder saying it
     can be distributed under the terms of this License.  Such a notice
     grants a world-wide, royalty-free license, unlimited in duration,
     to use that work under the conditions stated herein.  The
     "Document", below, refers to any such manual or work.  Any member
     of the public is a licensee, and is addressed as "you".  You
     accept the license if you copy, modify or distribute the work in a
     way requiring permission under copyright law.

     A "Modified Version" of the Document means any work containing the
     Document or a portion of it, either copied verbatim, or with
     modifications and/or translated into another language.

     A "Secondary Section" is a named appendix or a front-matter section
     of the Document that deals exclusively with the relationship of the
     publishers or authors of the Document to the Document's overall
     subject (or to related matters) and contains nothing that could
     fall directly within that overall subject.  (Thus, if the Document
     is in part a textbook of mathematics, a Secondary Section may not
     explain any mathematics.)  The relationship could be a matter of
     historical connection with the subject or with related matters, or
     of legal, commercial, philosophical, ethical or political position
     regarding them.

     The "Invariant Sections" are certain Secondary Sections whose
     titles are designated, as being those of Invariant Sections, in
     the notice that says that the Document is released under this
     License.  If a section does not fit the above definition of
     Secondary then it is not allowed to be designated as Invariant.
     The Document may contain zero Invariant Sections.  If the Document
     does not identify any Invariant Sections then there are none.

     The "Cover Texts" are certain short passages of text that are
     listed, as Front-Cover Texts or Back-Cover Texts, in the notice
     that says that the Document is released under this License.  A
     Front-Cover Text may be at most 5 words, and a Back-Cover Text may
     be at most 25 words.

     A "Transparent" copy of the Document means a machine-readable copy,
     represented in a format whose specification is available to the
     general public, that is suitable for revising the document
     straightforwardly with generic text editors or (for images
     composed of pixels) generic paint programs or (for drawings) some
     widely available drawing editor, and that is suitable for input to
     text formatters or for automatic translation to a variety of
     formats suitable for input to text formatters.  A copy made in an
     otherwise Transparent file format whose markup, or absence of
     markup, has been arranged to thwart or discourage subsequent
     modification by readers is not Transparent.  An image format is
     not Transparent if used for any substantial amount of text.  A
     copy that is not "Transparent" is called "Opaque".

     Examples of suitable formats for Transparent copies include plain
     ASCII without markup, Texinfo input format, LaTeX input format,
     SGML or XML using a publicly available DTD, and
     standard-conforming simple HTML, PostScript or PDF designed for
     human modification.  Examples of transparent image formats include
     PNG, XCF and JPG.  Opaque formats include proprietary formats that
     can be read and edited only by proprietary word processors, SGML or
     XML for which the DTD and/or processing tools are not generally
     available, and the machine-generated HTML, PostScript or PDF
     produced by some word processors for output purposes only.

     The "Title Page" means, for a printed book, the title page itself,
     plus such following pages as are needed to hold, legibly, the
     material this License requires to appear in the title page.  For
     works in formats which do not have any title page as such, "Title
     Page" means the text near the most prominent appearance of the
     work's title, preceding the beginning of the body of the text.

     A section "Entitled XYZ" means a named subunit of the Document
     whose title either is precisely XYZ or contains XYZ in parentheses
     following text that translates XYZ in another language.  (Here XYZ
     stands for a specific section name mentioned below, such as
     "Acknowledgements", "Dedications", "Endorsements", or "History".)
     To "Preserve the Title" of such a section when you modify the
     Document means that it remains a section "Entitled XYZ" according
     to this definition.

     The Document may include Warranty Disclaimers next to the notice
     which states that this License applies to the Document.  These
     Warranty Disclaimers are considered to be included by reference in
     this License, but only as regards disclaiming warranties: any other
     implication that these Warranty Disclaimers may have is void and
     has no effect on the meaning of this License.

  2. VERBATIM COPYING

     You may copy and distribute the Document in any medium, either
     commercially or noncommercially, provided that this License, the
     copyright notices, and the license notice saying this License
     applies to the Document are reproduced in all copies, and that you
     add no other conditions whatsoever to those of this License.  You
     may not use technical measures to obstruct or control the reading
     or further copying of the copies you make or distribute.  However,
     you may accept compensation in exchange for copies.  If you
     distribute a large enough number of copies you must also follow
     the conditions in section 3.

     You may also lend copies, under the same conditions stated above,
     and you may publicly display copies.

  3. COPYING IN QUANTITY

     If you publish printed copies (or copies in media that commonly
     have printed covers) of the Document, numbering more than 100, and
     the Document's license notice requires Cover Texts, you must
     enclose the copies in covers that carry, clearly and legibly, all
     these Cover Texts: Front-Cover Texts on the front cover, and
     Back-Cover Texts on the back cover.  Both covers must also clearly
     and legibly identify you as the publisher of these copies.  The
     front cover must present the full title with all words of the
     title equally prominent and visible.  You may add other material
     on the covers in addition.  Copying with changes limited to the
     covers, as long as they preserve the title of the Document and
     satisfy these conditions, can be treated as verbatim copying in
     other respects.

     If the required texts for either cover are too voluminous to fit
     legibly, you should put the first ones listed (as many as fit
     reasonably) on the actual cover, and continue the rest onto
     adjacent pages.

     If you publish or distribute Opaque copies of the Document
     numbering more than 100, you must either include a
     machine-readable Transparent copy along with each Opaque copy, or
     state in or with each Opaque copy a computer-network location from
     which the general network-using public has access to download
     using public-standard network protocols a complete Transparent
     copy of the Document, free of added material.  If you use the
     latter option, you must take reasonably prudent steps, when you
     begin distribution of Opaque copies in quantity, to ensure that
     this Transparent copy will remain thus accessible at the stated
     location until at least one year after the last time you
     distribute an Opaque copy (directly or through your agents or
     retailers) of that edition to the public.

     It is requested, but not required, that you contact the authors of
     the Document well before redistributing any large number of
     copies, to give them a chance to provide you with an updated
     version of the Document.

  4. MODIFICATIONS

     You may copy and distribute a Modified Version of the Document
     under the conditions of sections 2 and 3 above, provided that you
     release the Modified Version under precisely this License, with
     the Modified Version filling the role of the Document, thus
     licensing distribution and modification of the Modified Version to
     whoever possesses a copy of it.  In addition, you must do these
     things in the Modified Version:

       A. Use in the Title Page (and on the covers, if any) a title
          distinct from that of the Document, and from those of
          previous versions (which should, if there were any, be listed
          in the History section of the Document).  You may use the
          same title as a previous version if the original publisher of
          that version gives permission.

       B. List on the Title Page, as authors, one or more persons or
          entities responsible for authorship of the modifications in
          the Modified Version, together with at least five of the
          principal authors of the Document (all of its principal
          authors, if it has fewer than five), unless they release you
          from this requirement.

       C. State on the Title page the name of the publisher of the
          Modified Version, as the publisher.

       D. Preserve all the copyright notices of the Document.

       E. Add an appropriate copyright notice for your modifications
          adjacent to the other copyright notices.

       F. Include, immediately after the copyright notices, a license
          notice giving the public permission to use the Modified
          Version under the terms of this License, in the form shown in
          the Addendum below.

       G. Preserve in that license notice the full lists of Invariant
          Sections and required Cover Texts given in the Document's
          license notice.

       H. Include an unaltered copy of this License.

       I. Preserve the section Entitled "History", Preserve its Title,
          and add to it an item stating at least the title, year, new
          authors, and publisher of the Modified Version as given on
          the Title Page.  If there is no section Entitled "History" in
          the Document, create one stating the title, year, authors,
          and publisher of the Document as given on its Title Page,
          then add an item describing the Modified Version as stated in
          the previous sentence.

       J. Preserve the network location, if any, given in the Document
          for public access to a Transparent copy of the Document, and
          likewise the network locations given in the Document for
          previous versions it was based on.  These may be placed in
          the "History" section.  You may omit a network location for a
          work that was published at least four years before the
          Document itself, or if the original publisher of the version
          it refers to gives permission.

       K. For any section Entitled "Acknowledgements" or "Dedications",
          Preserve the Title of the section, and preserve in the
          section all the substance and tone of each of the contributor
          acknowledgements and/or dedications given therein.

       L. Preserve all the Invariant Sections of the Document,
          unaltered in their text and in their titles.  Section numbers
          or the equivalent are not considered part of the section
          titles.

       M. Delete any section Entitled "Endorsements".  Such a section
          may not be included in the Modified Version.

       N. Do not retitle any existing section to be Entitled
          "Endorsements" or to conflict in title with any Invariant
          Section.

       O. Preserve any Warranty Disclaimers.

     If the Modified Version includes new front-matter sections or
     appendices that qualify as Secondary Sections and contain no
     material copied from the Document, you may at your option
     designate some or all of these sections as invariant.  To do this,
     add their titles to the list of Invariant Sections in the Modified
     Version's license notice.  These titles must be distinct from any
     other section titles.

     You may add a section Entitled "Endorsements", provided it contains
     nothing but endorsements of your Modified Version by various
     parties--for example, statements of peer review or that the text
     has been approved by an organization as the authoritative
     definition of a standard.

     You may add a passage of up to five words as a Front-Cover Text,
     and a passage of up to 25 words as a Back-Cover Text, to the end
     of the list of Cover Texts in the Modified Version.  Only one
     passage of Front-Cover Text and one of Back-Cover Text may be
     added by (or through arrangements made by) any one entity.  If the
     Document already includes a cover text for the same cover,
     previously added by you or by arrangement made by the same entity
     you are acting on behalf of, you may not add another; but you may
     replace the old one, on explicit permission from the previous
     publisher that added the old one.

     The author(s) and publisher(s) of the Document do not by this
     License give permission to use their names for publicity for or to
     assert or imply endorsement of any Modified Version.

  5. COMBINING DOCUMENTS

     You may combine the Document with other documents released under
     this License, under the terms defined in section 4 above for
     modified versions, provided that you include in the combination
     all of the Invariant Sections of all of the original documents,
     unmodified, and list them all as Invariant Sections of your
     combined work in its license notice, and that you preserve all
     their Warranty Disclaimers.

     The combined work need only contain one copy of this License, and
     multiple identical Invariant Sections may be replaced with a single
     copy.  If there are multiple Invariant Sections with the same name
     but different contents, make the title of each such section unique
     by adding at the end of it, in parentheses, the name of the
     original author or publisher of that section if known, or else a
     unique number.  Make the same adjustment to the section titles in
     the list of Invariant Sections in the license notice of the
     combined work.

     In the combination, you must combine any sections Entitled
     "History" in the various original documents, forming one section
     Entitled "History"; likewise combine any sections Entitled
     "Acknowledgements", and any sections Entitled "Dedications".  You
     must delete all sections Entitled "Endorsements."

  6. COLLECTIONS OF DOCUMENTS

     You may make a collection consisting of the Document and other
     documents released under this License, and replace the individual
     copies of this License in the various documents with a single copy
     that is included in the collection, provided that you follow the
     rules of this License for verbatim copying of each of the
     documents in all other respects.

     You may extract a single document from such a collection, and
     distribute it individually under this License, provided you insert
     a copy of this License into the extracted document, and follow
     this License in all other respects regarding verbatim copying of
     that document.

  7. AGGREGATION WITH INDEPENDENT WORKS

     A compilation of the Document or its derivatives with other
     separate and independent documents or works, in or on a volume of
     a storage or distribution medium, is called an "aggregate" if the
     copyright resulting from the compilation is not used to limit the
     legal rights of the compilation's users beyond what the individual
     works permit.  When the Document is included in an aggregate, this
     License does not apply to the other works in the aggregate which
     are not themselves derivative works of the Document.

     If the Cover Text requirement of section 3 is applicable to these
     copies of the Document, then if the Document is less than one half
     of the entire aggregate, the Document's Cover Texts may be placed
     on covers that bracket the Document within the aggregate, or the
     electronic equivalent of covers if the Document is in electronic
     form.  Otherwise they must appear on printed covers that bracket
     the whole aggregate.

  8. TRANSLATION

     Translation is considered a kind of modification, so you may
     distribute translations of the Document under the terms of section
     4.  Replacing Invariant Sections with translations requires special
     permission from their copyright holders, but you may include
     translations of some or all Invariant Sections in addition to the
     original versions of these Invariant Sections.  You may include a
     translation of this License, and all the license notices in the
     Document, and any Warranty Disclaimers, provided that you also
     include the original English version of this License and the
     original versions of those notices and disclaimers.  In case of a
     disagreement between the translation and the original version of
     this License or a notice or disclaimer, the original version will
     prevail.

     If a section in the Document is Entitled "Acknowledgements",
     "Dedications", or "History", the requirement (section 4) to
     Preserve its Title (section 1) will typically require changing the
     actual title.

  9. TERMINATION

     You may not copy, modify, sublicense, or distribute the Document
     except as expressly provided for under this License.  Any other
     attempt to copy, modify, sublicense or distribute the Document is
     void, and will automatically terminate your rights under this
     License.  However, parties who have received copies, or rights,
     from you under this License will not have their licenses
     terminated so long as such parties remain in full compliance.

 10. FUTURE REVISIONS OF THIS LICENSE

     The Free Software Foundation may publish new, revised versions of
     the GNU Free Documentation License from time to time.  Such new
     versions will be similar in spirit to the present version, but may
     differ in detail to address new problems or concerns.  See
     `http://www.gnu.org/copyleft/'.

     Each version of the License is given a distinguishing version
     number.  If the Document specifies that a particular numbered
     version of this License "or any later version" applies to it, you
     have the option of following the terms and conditions either of
     that specified version or of any later version that has been
     published (not as a draft) by the Free Software Foundation.  If
     the Document does not specify a version number of this License,
     you may choose any version ever published (not as a draft) by the
     Free Software Foundation.

ADDENDUM: How to use this License for your documents
----------------------------------------------------

To use this License in a document you have written, include a copy of
the License in the document and put the following copyright and license
notices just after the title page:

       Copyright (C)  YEAR  YOUR NAME.
       Permission is granted to copy, distribute and/or modify this document
       under the terms of the GNU Free Documentation License, Version 1.2
       or any later version published by the Free Software Foundation;
       with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
       A copy of the license is included in the section entitled ``GNU
       Free Documentation License''.

   If you have Invariant Sections, Front-Cover Texts and Back-Cover
Texts, replace the "with...Texts." line with this:

         with the Invariant Sections being LIST THEIR TITLES, with
         the Front-Cover Texts being LIST, and with the Back-Cover Texts
         being LIST.

   If you have Invariant Sections without Cover Texts, or some other
combination of the three, merge those two alternatives to suit the
situation.

   If your document contains nontrivial examples of program code, we
recommend releasing these examples in parallel under your choice of
free software license, such as the GNU General Public License, to
permit their use in free software.


File: speechd-el.info,  Node: Index,  Prev: Copying This Manual,  Up: Top

Index
*****

* Menu:

* authors:                               Contact Information.
* beginning of line:                     Signalling.
* buffer names:                          Basic Speaking.
* buffers:                               Auto-Speaking Buffers.
* bug reporting:                         Bug Reporting.
* bugs:                                  Contact Information.
* C-e ':                                 Reading Commands.
* C-e .:                                 Reading Commands.
* C-e 1:                                 Control Commands.
* C-e 2:                                 Control Commands.
* C-e 3:                                 Control Commands.
* C-e 4:                                 Control Commands.
* C-e 5:                                 Control Commands.
* C-e 6:                                 Control Commands.
* C-e 7:                                 Control Commands.
* C-e 8:                                 Control Commands.
* C-e 9:                                 Control Commands.
* C-e >:                                 Reading Commands.
* C-e [:                                 Reading Commands.
* C-e b:                                 Reading Commands.
* C-e c:                                 Reading Commands.
* C-e C-a:                               Connection Voices.
* C-e C-c:                               Parameter Setting Commands.
* C-e C-f:                               Bug Reporting.
* C-e C-l:                               Spelling.
* C-e C-n:                               Reading Commands.
* C-e C-p:                               Reading Commands.
* C-e C-r:                               Reading Commands.
* C-e C-s:                               Starting Speech Output.
* C-e C-x:                               Other Commands.
* C-e d .:                               Parameter Setting Commands.
* C-e d c:                               Parameter Setting Commands.
* C-e d l:                               Parameter Setting Commands.
* C-e d o:                               Parameter Setting Commands.
* C-e d p:                               Parameter Setting Commands.
* C-e d r:                               Parameter Setting Commands.
* C-e d V:                               Parameter Setting Commands.
* C-e d v:                               Parameter Setting Commands.
* C-e l:                                 Reading Commands.
* C-e m:                                 Reading Commands.
* C-e o:                                 Reading Commands.
* C-e p:                                 Control Commands.
* C-e q:                                 Control Commands.
* C-e r:                                 Reading Commands.
* C-e s:                                 Control Commands.
* C-e SPC:                               Control Commands.
* C-e w:                                 Reading Commands.
* C-e x:                                 Control Commands.
* C-e z:                                 Other Commands.
* C-e {:                                 Reading Commands.
* C-x C-c:                               Other Commands.
* capital character mode:                Parameter Setting Commands.
* command keys:                          Basic Speaking.
* command name:                          Basic Speaking.
* connection:                            Parameter Setting Commands.
* connections:                           Multiple Connections.
* contact:                               Contact Information.
* cursor:                                Text Properties.
* debugging:                             Debugging.
* delays:                                Problems.
* deletions:                             Basic Speaking.
* empty text:                            Signalling.
* end of line:                           Signalling.
* extensions:                            Advanced Customization.
* faces:                                 Text Properties.
* FDL, GNU Free Documentation License:   Copying This Manual.
* features:                              Introduction.
* garbage collection:                    Problems.
* gc-cons-threshold:                     Problems.
* global-speechd-speak-mode:             Starting Speech Output.
* hooks:                                 Modes.
* host:                                  Host Configuration.
* inserted text:                         Auto-Speaking Buffers.
* key map:                               Keys.
* keys <1>:                              Keys.
* keys:                                  Basic Speaking.
* language:                              Parameter Setting Commands.
* language text property:                Languages.
* languages:                             Languages.
* line:                                  Signalling.
* M-x speechd-bug:                       Bug Reporting.
* M-x speechd-bug-reproduce:             Bug Reporting.
* minibuffer:                            Basic Speaking.
* minor modes <1>:                       Modes.
* minor modes:                           Starting Speech Output.
* movement:                              Text Properties.
* output module:                         Parameter Setting Commands.
* parameters <1>:                        Voices.
* parameters:                            Parameter Setting Commands.
* pause:                                 Control Commands.
* pitch:                                 Parameter Setting Commands.
* port:                                  Host Configuration.
* prefix key:                            Keys.
* priorities:                            Default Priorities.
* problems:                              Problems.
* punctuation mode:                      Parameter Setting Commands.
* rate <1>:                              Parameter Setting Commands.
* rate:                                  Control Commands.
* recovery:                              Other Commands.
* repeated reading:                      Problems.
* resume:                                Control Commands.
* RFC 1766:                              Languages.
* shutting up:                           Control Commands.
* Speech Dispatcher:                     Introduction.
* speechd-add-connection-settings:       Connection Voices.
* speechd-bug:                           Bug Reporting.
* speechd-bug-reproduce:                 Bug Reporting.
* speechd-cancel:                        Control Commands.
* speechd-client-name:                   speechd-el Elisp Library.
* speechd-connection-parameters:         Connection Voices.
* speechd-default-char-priority:         Default Priorities.
* speechd-default-key-priority:          Default Priorities.
* speechd-default-sound-priority:        Default Priorities.
* speechd-default-text-priority:         Default Priorities.
* speechd-face-voices:                   Text Properties.
* speechd-host:                          Host Configuration.
* speechd-language:                      Languages.
* speechd-pause:                         Control Commands.
* speechd-port:                          Host Configuration.
* speechd-protect:                       speechd-el Elisp Library.
* speechd-repeat:                        Other Commands.
* speechd-resume:                        Control Commands.
* speechd-say-text:                      Other Commands.
* speechd-set-capital-character-mode:    Parameter Setting Commands.
* speechd-set-language:                  Parameter Setting Commands.
* speechd-set-output-module:             Parameter Setting Commands.
* speechd-set-pitch:                     Parameter Setting Commands.
* speechd-set-punctuation-mode:          Parameter Setting Commands.
* speechd-set-rate:                      Parameter Setting Commands.
* speechd-set-voice:                     Parameter Setting Commands.
* speechd-set-volume:                    Parameter Setting Commands.
* speechd-speak:                         Starting Speech Output.
* speechd-speak-align-buffer-insertions: Auto-Speaking Buffers.
* speechd-speak-auto-speak-buffers:      Auto-Speaking Buffers.
* speechd-speak-buffer-insertions:       Auto-Speaking Buffers.
* speechd-speak-buffer-name:             Basic Speaking.
* speechd-speak-by-properties-always:    Text Properties.
* speechd-speak-by-properties-never:     Text Properties.
* speechd-speak-by-properties-on-movement: Text Properties.
* speechd-speak-command-feedback COMMAND POSITION FEEDBACK: Advanced Customization.
* speechd-speak-connections:             Multiple Connections.
* speechd-speak-deleted-char:            Basic Speaking.
* speechd-speak-faces:                   Text Properties.
* speechd-speak-force-auto-speak-buffers: Auto-Speaking Buffers.
* speechd-speak-function-feedback FUNCTION POSITION FEEDBACK: Advanced Customization.
* speechd-speak-ignore-command-keys:     Basic Speaking.
* speechd-speak-in-debugger:             Debugging.
* speechd-speak-insertions-in-buffers:   Auto-Speaking Buffers.
* speechd-speak-key-set-predefined-rate: Control Commands.
* speechd-speak-last-message:            Reading Commands.
* speechd-speak-mode:                    Starting Speech Output.
* speechd-speak-mode-hook:               Modes.
* speechd-speak-mode-map:                Keys.
* speechd-speak-movement-on-insertions:  Auto-Speaking Buffers.
* speechd-speak-new-connection:          Parameter Setting Commands.
* speechd-speak-on-minibuffer-exit:      Basic Speaking.
* speechd-speak-prefix:                  Keys.
* speechd-speak-priority-insertions-in-buffers: Auto-Speaking Buffers.
* speechd-speak-read-buffer:             Reading Commands.
* speechd-speak-read-char:               Reading Commands.
* speechd-speak-read-command-keys:       Basic Speaking.
* speechd-speak-read-command-name:       Basic Speaking.
* speechd-speak-read-line:               Reading Commands.
* speechd-speak-read-next-line:          Reading Commands.
* speechd-speak-read-other-window:       Reading Commands.
* speechd-speak-read-page:               Reading Commands.
* speechd-speak-read-paragraph:          Reading Commands.
* speechd-speak-read-previous-line:      Reading Commands.
* speechd-speak-read-rectangle:          Reading Commands.
* speechd-speak-read-region:             Reading Commands.
* speechd-speak-read-rest-of-buffer:     Reading Commands.
* speechd-speak-read-sentence:           Reading Commands.
* speechd-speak-read-sexp:               Reading Commands.
* speechd-speak-read-word:               Reading Commands.
* speechd-speak-signal-events:           Signalling.
* speechd-speak-spell:                   Spelling.
* speechd-speak-spell-mode:              Spelling.
* speechd-speak-toggle-speaking:         Control Commands.
* speechd-stop:                          Control Commands.
* speechd-timeout:                       Host Configuration.
* speechd-unspeak:                       Other Commands.
* speechd-voices:                        Voices.
* spelling:                              Spelling.
* SSIP:                                  Introduction.
* stop:                                  Control Commands.
* suspend-emacs:                         Advanced Customization.
* text properties:                       Text Properties.
* timeout:                               Host Configuration.
* voice:                                 Parameter Setting Commands.
* voices <1>:                            Connection Voices.
* voices:                                Voices.
* volume:                                Parameter Setting Commands.



Tag Table:
Node: Top724
Node: Introduction1723
Node: speechd-el User Manual2897
Node: Installation4077
Node: Starting Speech Output5222
Node: Commands7063
Node: Reading Commands7928
Node: Control Commands9388
Node: Parameter Setting Commands10827
Node: Spelling13523
Node: Other Commands14146
Node: Customization14820
Node: Host Configuration15789
Node: Default Priorities16708
Node: Basic Speaking17796
Node: Auto-Speaking Buffers19911
Node: Signalling22802
Node: Text Properties23760
Node: Languages25961
Node: Voices27529
Node: Connection Voices29530
Node: Multiple Connections31050
Node: Keys32999
Node: Modes33953
Node: Debugging34346
Node: Advanced Customization34764
Node: Problems37048
Node: Bug Reporting38929
Node: speechd-el Elisp Library41984
Node: Contact Information43373
Node: Copying This Manual44160
Node: Index66572

End Tag Table
