@c $Id$
@node Emacspeak Commands
@chapter Emacspeak Commands

This chapter is generated automatically from the source-level documentation.
Any errors or corrections should be made to the source-level
documentation.
This chapter documents a total of 763 commands.

@menu
* cd-tool::                     
* dtk-speak::                   
* emacspeak-alsaplayer::        
* emacspeak-amphetadesk::       
* emacspeak-arc::               
* emacspeak-aumix::             
* emacspeak-bs::                
* emacspeak-buff-menu::         
* emacspeak-c::                 
* emacspeak-calendar::          
* emacspeak-compile::           
* emacspeak-custom::            
* emacspeak-daisy::             
* emacspeak-dired::             
* emacspeak-dismal::            
* emacspeak-ecb::               
* emacspeak-ediff::             
* emacspeak-enriched::          
* emacspeak-entertain::         
* emacspeak-eperiodic::         
* emacspeak-erc::               
* emacspeak-eterm::             
* emacspeak-filtertext::        
* emacspeak-fix-interactive::   
* emacspeak-forms::             
* emacspeak-gnus::              
* emacspeak-gomoku::            
* emacspeak-gridtext::          
* emacspeak-hide::              
* emacspeak-ibuffer::           
* emacspeak-imenu::             
* emacspeak-info::              
* emacspeak-jabber::            
* emacspeak-keymap::            
* emacspeak-loaddefs::          
* emacspeak-m-player::          
* emacspeak-madplay::           
* emacspeak-man::               
* emacspeak-ocr::               
* emacspeak-outline::           
* emacspeak-pronounce::         
* emacspeak-python::            
* emacspeak-realaudio::         
* emacspeak-redefine::          
* emacspeak-remote::            
* emacspeak-rmail::             
* emacspeak-solitaire::         
* emacspeak-sounds::            
* emacspeak-speak::             
* emacspeak-speedbar::          
* emacspeak-table-ui::          
* emacspeak-tabulate::          
* emacspeak-tapestry::          
* emacspeak-tar::               
* emacspeak-tetris::            
* emacspeak-tnt::               
* emacspeak-url-template::      
* emacspeak-view-process::      
* emacspeak-view::              
* emacspeak-vm::                
* emacspeak-w3::                
* emacspeak-w3m::               
* emacspeak-we::                
* emacspeak-websearch::         
* emacspeak-webutils::          
* emacspeak-widget::            
* emacspeak-wizards::           
* emacspeak-xml-shell::         
* emacspeak-xslt::              
* emacspeak-zinf::              
* emacspeak::                   
* voice-setup::                 
* emacspeak-moz::               
* emacspeak-org::               
* emacspeak-webmarks::          
* URL Templates ::              
@end menu

@node cd-tool
@section cd-tool

Commentary:
Provide an emacs front-end to cdtool.
cdtool can be obtained as an rpm
check using rpmfind
or from its home site at
  sunsite.unc.edu /pub/Linux/apps/sound/cdrom/cli
This module also provides the ability to play or save
clips from a CD if you have cdda2wav installed.
cdda2wav is a cd to wav convertor.

Automatically generated documentation
for commands defined in module  cd-tool.

@deffn {Interactive Command} cd-tool ()
@kbd{ control e DEL }

Front-end to CDTool.
Bind this function to a convenient key-
Emacspeak users automatically have
this bound to <DEL> in the emacspeak keymap.

Key     Action
---     ------

+       Next Track
-       Previous Track
SPC     Pause or Resume
e       Eject
=       Shuffle
i       CD Info
p       Play
s       Stop
t       track
c       clip
cap C   Save clip to disk

@end deffn

@node dtk-speak
@section dtk-speak

Commentary:
Defines the TTS interface.

Automatically generated documentation
for commands defined in module  dtk-speak.

@deffn {Interactive Command} dtk-add-cleanup-pattern (&optional DELETE)
@kbd{ control e d a }

Add this pattern to the list of repeating patterns that
are cleaned up.  Optional interactive prefix arg deletes
this pattern if previously added.  Cleaning up repeated
patterns results in emacspeak speaking the pattern followed
by a repeat count instead of speaking all the characters
making up the pattern.  Thus, by adding the repeating
pattern `.' (this is already added by default) emacspeak
will say ``aw fifteen dot'' when speaking the string
``...............'' instead of ``period period period period
''
@end deffn

@deffn {Interactive Command} dtk-pause (&optional PREFIX)
@kbd{ control e p }

Pause ongoing speech.
The speech can be resumed with command `dtk-resume'
normally bound to C-e SPC.  Pausing speech is useful when one needs to
perform a few actions before continuing to read a large document.  Emacspeak
gives you speech feedback as usual once speech has been paused.  `dtk-resume'
continues the interrupted speech irrespective of the buffer
in which it is executed.
Optional PREFIX arg flushes any previously paused speech.
@end deffn

@deffn {Interactive Command} dtk-reset-state ()
@kbd{ control e d  cap R  }

Restore sanity to the Dectalk.
Typically used after the Dectalk has been power   cycled.
@end deffn

@deffn {Interactive Command} dtk-resume ()
@kbd{ control e SPACE }

Resume paused speech.
This command resumes  speech that has been suspended by executing
command `dtk-pause' bound to C-e p.
If speech has not been paused,
and option `dtk-resume-should-toggle' is set,
 then this command will pause ongoing speech.
@end deffn

@deffn {Interactive Command} dtk-select-server (PROGRAM)
@kbd{ control e d d }

Select a speech server interactively.
Argument PROGRAM specifies the speech server program.
When called  interactively, The selected server is started immediately. 
@end deffn

@deffn {Interactive Command} dtk-set-character-scale (FACTOR &optional PREFIX)
@kbd{ control e d f }

Set scale FACTOR for   speech rate.
Speech rate is scaled by this factor
when speaking characters.
Interactive PREFIX arg means set   the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} dtk-set-chunk-separator-syntax (S)
@kbd{ control e d RETURN }

Interactively set how text is split in chunks.
See the Emacs documentation on syntax tables for details on how characters are
classified into various syntactic classes.
Argument S specifies the syntax class.
@end deffn

@deffn {Interactive Command} dtk-set-language (LANG)
Set language according to the argument lang.
@end deffn

@deffn {Interactive Command} dtk-set-next-language ()
Switch to the next available language
@end deffn

@deffn {Interactive Command} dtk-set-predefined-speech-rate (&optional PREFIX)
@kbd{ control e d 0   control e d 1   control e d 2   control e d 3   control e d 4   control e d 5   control e d 6   control e d 7   control e d 8   control e d 9 }

Set speech rate to one of nine predefined levels.
Interactive PREFIX arg says to set the rate globally.
Formula used is:
rate = dtk-speech-rate-base + dtk-speech-rate-step * level.
@end deffn

@deffn {Interactive Command} dtk-set-preferred-language (ALIAS LANG)
Set the alias of the preferred language:
For example if alias="en" lang="en_GB",
then the following call:
 dtk-set-language("en")
will set "en_GB".

@end deffn

@deffn {Interactive Command} dtk-set-previous-language ()
Switch to the previous available language
@end deffn

@deffn {Interactive Command} dtk-set-punctuations (MODE &optional PREFIX)
@kbd{ control e d p }

Set punctuation mode to MODE.
Possible values are `some', `all', or `none'.
Interactive PREFIX arg means set   the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} dtk-set-punctuations-to-all (&optional PREFIX)
Set punctuation  mode to all.
Interactive PREFIX arg sets punctuation mode globally.
@end deffn

@deffn {Interactive Command} dtk-set-punctuations-to-some (&optional PREFIX)
Set punctuation  mode to some.
Interactive PREFIX arg sets punctuation mode globally.
@end deffn

@deffn {Interactive Command} dtk-set-rate (RATE &optional PREFIX)
@kbd{ control e d r }

Set speaking RATE for the tts.
Interactive PREFIX arg means set   the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} dtk-stop ()
@kbd{ <pause>   control e s }

Stop speech now.
@end deffn

@deffn {Interactive Command} dtk-toggle-allcaps-beep (&optional PREFIX)
@kbd{ control e d  cap C  }

Toggle allcaps-beep.
when set, allcaps words  are  indicated by a
short beep.  Interactive PREFIX arg means toggle the global default
value, and then set the current local value to the result.
Note that allcaps-beep is a very useful thing when programming.
However it is irritating to have it on when reading documents.
@end deffn

@deffn {Interactive Command} dtk-toggle-capitalization (&optional PREFIX)
@kbd{ control e d c }

Toggle capitalization.
when set, capitalization is indicated by a
short beep.  Interactive PREFIX arg means toggle the global default
value, and then set the current local value to the result.
@end deffn

@deffn {Interactive Command} dtk-toggle-debug (&optional PREFIX)
@kbd{ control e d b }

Toggle state of the debug FLAG.
When debugging is on, you can switch to the buffer
*speaker* to examine the output from the process
that talks to the speech device by using command C-e d C-M-b.
Note: *speaker* is a hidden buffer, ie it has a leading space in its name.
@end deffn

@deffn {Interactive Command} dtk-toggle-punctuation-mode (&optional PREFIX)
Toggle punctuation mode between "some" and "all".
Interactive PREFIX arg makes the new setting global.
@end deffn

@deffn {Interactive Command} dtk-toggle-quiet (&optional PREFIX)
@kbd{ control e d q }

Toggles state of  dtk-quiet.
Turning on this switch silences speech.
Optional interactive prefix arg causes this setting to become global.
@end deffn

@deffn {Interactive Command} dtk-toggle-speak-nonprinting-chars (&optional PREFIX)
@kbd{ control e d n }

Toggle speak-nonprinting-chars.
Switches behavior of how characters with the high bit set are handled.
Interactive PREFIX arg means toggle the global default
value, and then set the current local value to the result.
@end deffn

@deffn {Interactive Command} dtk-toggle-split-caps (&optional PREFIX)
@kbd{ control e d s }

Toggle split caps mode.
Split caps mode is useful when reading
Hungarian notation in program source code.  Interactive PREFIX arg
means toggle the global default value, and then set the current local
value to the result.
@end deffn

@deffn {Interactive Command} dtk-toggle-splitting-on-white-space ()
@kbd{ control e d SPACE }

Toggle splitting of speech on white space.
This affects the internal state of emacspeak that decides if we split
text purely by clause boundaries, or also include
whitespace.  By default, emacspeak sends a clause at a time
to the speech device.  This produces fluent speech for
normal use.  However in modes such as `shell-mode' and some
programming language modes, clause markers appear
infrequently, and this can result in large amounts of text
being sent to the speech device at once, making the system
unresponsive when asked to stop talking.  Splitting on white
space makes emacspeak's stop command responsive.  However,
when splitting on white space, the speech sounds choppy
since the synthesizer is getting a word at a time.
@end deffn

@deffn {Interactive Command} dtk-toggle-stop-immediately-while-typing (&optional PREFIX)
@kbd{ control e d  cap I  }

Toggle state of variable `dtk-stop-immediately-while-typing'.
As the name implies, if T then speech flushes immediately as you
type.  Optional argument PREFIX specifies if the setting applies
to all buffers.
@end deffn

@deffn {Interactive Command} dtk-toggle-strip-octals (&optional PREFIX)
@kbd{ control e d o }

Toggle stripping of octals.
Interactive prefix arg means
 toggle the global default value, and then set the current local
value to the result.
@end deffn

@node emacspeak-alsaplayer
@section emacspeak-alsaplayer

Commentary:
Defines a simple derived mode for interacting with
alsaplayer.
alsaplayer navigation commands  work via single keystrokes.

Automatically generated documentation
for commands defined in module  emacspeak-alsaplayer.

@deffn {Interactive Command} emacspeak-alsaplayer-add-to-queue (RESOURCE)
Add specified resource to queue.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-backward-10-seconds ()
Skip backward by  10 seconds.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-backward-minute (MINUTES)
Skip backwards by  minutes.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-backward-ten-minutes (MINUTES)
Skip backwards by  chunks of minutes.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-clear ()
Clear or resume alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-clip (PATH START END)
Invoke mp3splt to clip selected range.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-forward-10-seconds ()
Skip forward by  seconds.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-forward-minute (MINUTES)
Skip forward by  minutes.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-forward-ten-minutes (MINUTES)
Skip forward by  chunks of ten minutes.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-info ()
Speak current path and copy it to kill ring.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-jump (TRACK)
Jump to specified track.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-launch ()
Launch Alsaplayer.
user is placed in a buffer associated with the newly created
Alsaplayer session.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-mark-position ()
Mark currently displayed position.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-mode ()
Major mode for alsaplayer interaction. 

key             binding
---             -------

SPC		emacspeak-alsaplayer-pause
,		emacspeak-alsaplayer-backward-10-seconds
.		emacspeak-alsaplayer-forward-10-seconds
/		emacspeak-alsaplayer-speed
<		emacspeak-alsaplayer-backward-minute
>		emacspeak-alsaplayer-forward-minute
?		emacspeak-alsaplayer-status
A		emacspeak-alsaplayer-replace-queue
S		emacspeak-alsaplayer-stop
[		emacspeak-alsaplayer-backward-ten-minutes
]		emacspeak-alsaplayer-forward-ten-minutes
a		emacspeak-alsaplayer-add-to-queue
c		emacspeak-alsaplayer-clear
g		emacspeak-alsaplayer-seek
i		emacspeak-alsaplayer-info
j		emacspeak-alsaplayer-jump
l		emacspeak-alsaplayer-launch
m		emacspeak-alsaplayer-mark-position
n		emacspeak-alsaplayer-next
p		emacspeak-alsaplayer-previous
q		emacspeak-alsaplayer-quit
r		emacspeak-alsaplayer-relative
s		emacspeak-alsaplayer-start
v		emacspeak-alsaplayer-volume
w		emacspeak-alsaplayer-where
x		emacspeak-alsaplayer-clip

This mode runs the hook `emacspeak-alsaplayer-mode-hook', as the final step
during initialization.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-next ()
Next  alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-pause ()
Pause or resume alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-previous ()
Previous  alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-quit ()
Quit or resume alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-relative (OFFSET)
Relative seek  alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-replace-queue (RESOURCE)
Replace currently playing music.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-seek (OFFSET)
Absolute seek  alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-speed (SETTING)
Set speed in alsaplayer.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-start ()
Start  alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-status ()
Show alsaplayer status
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-stop ()
Stop  alsaplayer
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-volume (SETTING)
Set volume.
@end deffn

@deffn {Interactive Command} emacspeak-alsaplayer-where ()
Speak current position and copy it to kill ring.
@end deffn

@node emacspeak-amphetadesk
@section emacspeak-amphetadesk

Automatically generated documentation
for commands defined in module  emacspeak-amphetadesk.

@deffn {Interactive Command} emacspeak-amphetadesk (&optional USE-OPML)
Open amphetadesk.
Interactive prefix-arg use-opml opens the myChannels.opml file.
@end deffn

@deffn {Interactive Command} emacspeak-amphetadesk-quick-add (URL)
Quick add URL to Amphetadesk by prompting for URL.
@end deffn

@node emacspeak-arc
@section emacspeak-arc

Automatically generated documentation
for commands defined in module  emacspeak-arc.

@deffn {Interactive Command} emacspeak-arc-speak-file-modification-time ()
Speak modification time of the file on current line
@end deffn

@deffn {Interactive Command} emacspeak-arc-speak-file-name ()
Speak the name of the file on current line
@end deffn

@deffn {Interactive Command} emacspeak-arc-speak-file-permissions ()
Speak permissions of file current entry 
@end deffn

@deffn {Interactive Command} emacspeak-arc-speak-file-size ()
Speak the size of the file on current line
@end deffn

@node emacspeak-aumix
@section emacspeak-aumix

Commentary:
Provides an AUI to setting up the auditory display via AUMIX
This module is presently Linux specific

Automatically generated documentation
for commands defined in module  emacspeak-aumix.

@deffn {Interactive Command} emacspeak-aumix ()
@kbd{ control e ( }

Setup output parameters of the auditory display.
 Launch this tool while you have auditory output on
multiple channels playing so you can
adjust the settings to your preference.  Hit q to quit when
you are done.
@end deffn

@deffn {Interactive Command} emacspeak-aumix-edit ()
Edit aumix settings interactively. 
Run command M-x emacspeak-aumix-reset
after saving the settings to have them take effect.
@end deffn

@deffn {Interactive Command} emacspeak-aumix-reset ()
Reset to default audio settings.
@end deffn

@deffn {Interactive Command} emacspeak-aumix-volume-decrease (&optional GAIN)
Decrease overall volume. 
@end deffn

@deffn {Interactive Command} emacspeak-aumix-volume-increase (&optional GAIN)
Increase overall volume. 
@end deffn

@deffn {Interactive Command} emacspeak-aumix-wave-decrease (&optional GAIN)
Decrease volume of wave output. 
@end deffn

@deffn {Interactive Command} emacspeak-aumix-wave-increase (&optional GAIN)
Increase volume of wave output. 
@end deffn

@node emacspeak-bs
@section emacspeak-bs

Commentary:
speech-enable bs.el
this is an alternative to list-buffers

Automatically generated documentation
for commands defined in module  emacspeak-bs.

@deffn {Interactive Command} emacspeak-bs-speak-buffer-line ()
Speak information about this buffer
@end deffn

@node emacspeak-buff-menu
@section emacspeak-buff-menu

Automatically generated documentation
for commands defined in module  emacspeak-buff-menu.

@deffn {Interactive Command} emacspeak-list-buffers-next-line (COUNT)
Speech enabled buffer menu navigation
@end deffn

@deffn {Interactive Command} emacspeak-list-buffers-previous-line (COUNT)
Speech enabled buffer menu navigation
@end deffn

@deffn {Interactive Command} emacspeak-list-buffers-speak-buffer-line ()
Speak information about this buffer
@end deffn

@deffn {Interactive Command} emacspeak-list-buffers-speak-buffer-name ()
Speak the name of the buffer on this line
@end deffn

@node emacspeak-c
@section emacspeak-c

Commentary:
Make some of C and C++ mode more emacspeak friendly
Works with both boring c-mode
and the excellent cc-mode

Automatically generated documentation
for commands defined in module  emacspeak-c.

@deffn {Interactive Command} emacspeak-c-speak-semantics ()
Speak the C semantics of this line. 
@end deffn

@node emacspeak-calendar
@section emacspeak-calendar

Automatically generated documentation
for commands defined in module  emacspeak-calendar.

@deffn {Interactive Command} emacspeak-appt-repeat-announcement ()
@kbd{ control e  cap A  }

Speaks the most recently displayed appointment message if any.
@end deffn

@deffn {Interactive Command} emacspeak-calendar-speak-date ()
Speak the date under point when called in Calendar Mode. 
@end deffn

@node emacspeak-compile
@section emacspeak-compile

Commentary:
This module makes compiling code from inside Emacs speech friendly.
It is an example of how a little amount of code can make Emacspeak even better.

Automatically generated documentation
for commands defined in module  emacspeak-compile.

@deffn {Interactive Command} emacspeak-compilation-speak-error ()
Speech feedback about the compilation error. 
@end deffn

@node emacspeak-custom
@section emacspeak-custom

Automatically generated documentation
for commands defined in module  emacspeak-custom.

@deffn {Interactive Command} emacspeak-custom-goto-group ()
Jump to custom group when in a customization buffer.
@end deffn

@deffn {Interactive Command} emacspeak-custom-goto-toolbar ()
Jump to custom toolbar when in a customization buffer.
@end deffn

@node emacspeak-daisy
@section emacspeak-daisy

Commentary:
Daisy Digital Talking Book Reader

Automatically generated documentation
for commands defined in module  emacspeak-daisy.

@deffn {Interactive Command} emacspeak-daisy-define-outline-pattern (REGEXP)
Define persistent outline regexp for this book.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-mark-position-in-content-under-point ()
Mark current position in displayed content.
No-op if content under point is not currently displayed.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-mode ()
A DAISY front-end for the Emacspeak desktop.

Pre-requisites:

0) mpg123 for playing mp3 files
1) libxml and libxslt packages
2) xml-parse.el for parsing XML in Emacs Lisp.

The Emacspeak DAISY front-end is launched by command
emacspeak-daisy-open-book  bound to C-e C-b.

This command switches to a special buffer that has DAISY
commands bounds to single keystrokes-- see the ke-binding
list at the end of this description.  Use Emacs online help
facility to look up help on these commands.

emacspeak-daisy-mode provides the necessary functionality to
navigate and listen to Daisy talking books.

Here is a list of all emacspeak DAISY commands along with their key-bindings:

key             binding
---             -------

RET		emacspeak-daisy-play-content-under-point
SPC		emacspeak-daisy-play-audio-under-point
?		describe-mode
P		emacspeak-daisy-play-page-range
S		emacspeak-daisy-save-bookmarks
m		emacspeak-daisy-mark-position-in-content-under-point
n		emacspeak-daisy-next-line
o		emacspeak-daisy-define-outline-pattern
p		emacspeak-daisy-previous-line
q		bury-buffer
s		emacspeak-daisy-stop-audio

In addition to any hooks its parent mode `text-mode' might have run,
this mode runs the hook `emacspeak-daisy-mode-hook', as the final step
during initialization.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-next-line ()
Move to next line.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-open-book (FILENAME)
@kbd{ control e control b }

Open Digital Talking Book specified by navigation file filename.

This is the main entry point to the  Emacspeak Daisy reader.
Opening a Daisy navigation file (.ncx file) results in a
navigation buffer that can be used to browse and read the book.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-play-audio-under-point ()
Play audio clip under point.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-play-content-under-point ()
Play SMIL content  under point.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-play-page-range (START END)
Play pages in specified page range.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-previous-line ()
Move to previous line.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-save-bookmarks ()
Save bookmarks for current book.
@end deffn

@deffn {Interactive Command} emacspeak-daisy-stop-audio ()
Stop audio.
@end deffn

@node emacspeak-dired
@section emacspeak-dired

Commentary:
This module speech enables dired.
It reduces the amount of speech you hear:
Typically you hear the file names as you move through the dired buffer
Voicification is used to indicate directories, marked files etc.

Automatically generated documentation
for commands defined in module  emacspeak-dired.

@deffn {Interactive Command} emacspeak-dired-label-fields ()
Labels the fields of the listing in the dired buffer.
Currently is a no-op  unless
unless `dired-listing-switches' contains -al
@end deffn

@deffn {Interactive Command} emacspeak-dired-show-file-type (&optional FILE DEREF-SYMLINKS)
Displays type of current file by running command file.
Like Emacs' built-in dired-show-file-type but allows user to customize
options passed to command `file'.
@end deffn

@deffn {Interactive Command} emacspeak-dired-speak-file-access-time ()
Speak access time  of the current file.
@end deffn

@deffn {Interactive Command} emacspeak-dired-speak-file-modification-time ()
Speak modification time  of the current file.
@end deffn

@deffn {Interactive Command} emacspeak-dired-speak-file-permissions ()
Speak the permissions of the current file.
@end deffn

@deffn {Interactive Command} emacspeak-dired-speak-file-size ()
Speak the size of the current file.
On a directory line, run du -s on the directory to speak its size.
@end deffn

@deffn {Interactive Command} emacspeak-dired-speak-header-line ()
Speak the header line of the dired buffer. 
@end deffn

@deffn {Interactive Command} emacspeak-dired-speak-symlink-target ()
Speaks the target of the symlink on the current line.
@end deffn

@node emacspeak-dismal
@section emacspeak-dismal

Automatically generated documentation
for commands defined in module  emacspeak-dismal.

@deffn {Interactive Command} emacspeak-dismal-backward-col-and-summarize (COLS)
Move backward by arg columns
 (the previous column by default)and summarize it.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-backward-row-and-summarize (ROWS)
Move backward by arg rows
 (the previous row by default)and summarize it.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-col-summarize ()
Summarizes a col using the specification in list
emacspeak-dismal-col-summarizer-list
@end deffn

@deffn {Interactive Command} emacspeak-dismal-display-cell-expression ()
Display the expression in the message area
@end deffn

@deffn {Interactive Command} emacspeak-dismal-display-cell-value ()
Display the cell value in the message area
@end deffn

@deffn {Interactive Command} emacspeak-dismal-display-cell-with-col-header ()
Display current cell along with its column header.
The `column header' is the entry in row 0.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-display-cell-with-row-header ()
Displays current cell along with its row header.
The `row header' is the entry in column 0.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-forward-col-and-summarize (COLS)
Move forward by arg columns
 (the next column by default)and summarize it.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-forward-row-and-summarize (ROWS)
Move forward by arg rows
 (the next row by default)and summarize it.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-row-summarize ()
Summarizes a row using the specification in list
emacspeak-dismal-row-summarizer-list
@end deffn

@deffn {Interactive Command} emacspeak-dismal-set-col-summarizer-list ()
Specify or reset col summarizer list.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-set-row-summarizer-list ()
Specify or reset row summarizer list.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-set-sheet-summarizer-list ()
Specify or reset sheet summarizer list.
@end deffn

@deffn {Interactive Command} emacspeak-dismal-sheet-summarize ()
Summarizes a sheet using the specification in list
emacspeak-dismal-sheet-summarizer-list
@end deffn

@node emacspeak-ecb
@section emacspeak-ecb

Automatically generated documentation
for commands defined in module  emacspeak-ecb.

@deffn {Interactive Command} emacspeak-ecb-speak-window-directories ()
Speak contents of directories window.
@end deffn

@deffn {Interactive Command} emacspeak-ecb-speak-window-history ()
Speak contents of history window.
@end deffn

@deffn {Interactive Command} emacspeak-ecb-speak-window-methods ()
Speak contents of methods window.
@end deffn

@deffn {Interactive Command} emacspeak-ecb-speak-window-sources ()
Speak contents of sources window.
@end deffn

@deffn {Interactive Command} emacspeak-ecb-tree-backspace ()
Back up during incremental search in tree buffers.
@end deffn

@deffn {Interactive Command} emacspeak-ecb-tree-clear ()
Clear search pattern during incremental search in tree buffers.
@end deffn

@deffn {Interactive Command} emacspeak-ecb-tree-expand-common-prefix ()
Expand to longest common prefix in tree buffer.
@end deffn

@deffn {Interactive Command} emacspeak-ecb-tree-shift-return ()
Do shift return in ECB tree browser.
@end deffn

@node emacspeak-ediff
@section emacspeak-ediff

Automatically generated documentation
for commands defined in module  emacspeak-ediff.

@deffn {Interactive Command} emacspeak-ediff-speak-current-difference ()
Speak the current difference
@end deffn

@node emacspeak-enriched
@section emacspeak-enriched

Automatically generated documentation
for commands defined in module  emacspeak-enriched.

@deffn {Interactive Command} emacspeak-enriched-voiceify-faces (START END)
Map base fonts to voices.
Useful in voicifying rich text.
@end deffn

@node emacspeak-entertain
@section emacspeak-entertain

Commentary:
Auditory interface to misc games

Automatically generated documentation
for commands defined in module  emacspeak-entertain.

@deffn {Interactive Command} emacspeak-hangman-speak-guess ()
Speak current guessed string. 
@end deffn

@deffn {Interactive Command} emacspeak-hangman-speak-statistics ()
Speak statistics.
@end deffn

@node emacspeak-eperiodic
@section emacspeak-eperiodic

Automatically generated documentation
for commands defined in module  emacspeak-eperiodic.

@deffn {Interactive Command} emacspeak-eperiodic-goto-property-section ()
Mark position and jump to properties section.
@end deffn

@deffn {Interactive Command} emacspeak-eperiodic-next-line ()
Move to next row and speak element.
@end deffn

@deffn {Interactive Command} emacspeak-eperiodic-play-description ()
Play audio description from WebElements.
@end deffn

@deffn {Interactive Command} emacspeak-eperiodic-previous-line ()
Move to next row and speak element.
@end deffn

@deffn {Interactive Command} emacspeak-eperiodic-speak-current-element ()
Speak element at point.
@end deffn

@node emacspeak-erc
@section emacspeak-erc

Commentary:
erc.el is a modern Emacs client for IRC including color
and font locking support. 
erc.el - an Emacs IRC client (by Alexander L. Belikoff)
http://www.cs.cmu.edu/~berez/irc/erc.el

Automatically generated documentation
for commands defined in module  emacspeak-erc.

@deffn {Interactive Command} emacspeak-erc-add-name-to-monitor (NAME &optional QUITEN-PRONUNCIATION)
Add people to moniter in this room.
Optional interactive prefix  arg defines a pronunciation that
  silences speaking of this perso's name.
@end deffn

@deffn {Interactive Command} emacspeak-erc-delete-name-from-monitor (NAME)
Remove name to monitor in this room.
@end deffn

@deffn {Interactive Command} emacspeak-erc-setup-cricket-rules ()
Set up #cricket channels.
@end deffn

@deffn {Interactive Command} emacspeak-erc-toggle-my-monitor (&optional PREFIX)
Toggle state of ERC  monitor of my messages.
Interactive PREFIX arg means toggle the global default value, and then
set the current local value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-erc-toggle-room-monitor (&optional PREFIX)
Toggle state of ERC room monitor.
Interactive 
PREFIX arg means toggle the global default value, and then
set the current local value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-erc-toggle-speak-all-participants (&optional PREFIX)
Toggle state of ERC speak all participants..
Interactive 
PREFIX arg means toggle the global default value, and then
set the current local value to the result.
@end deffn

@node emacspeak-eterm
@section emacspeak-eterm

Commentary:
This module makes eterm talk.
Eterm is the new terminal emulator for Emacs.
Use of emacspeak with eterm really needs an info page.
At present, the only documentation is the source level documentation.
This module uses Control-t as an additional prefix key to allow the user
To move around the terminal and have different parts spoken. 

Automatically generated documentation
for commands defined in module  emacspeak-eterm.

@deffn {Interactive Command} emacspeak-eterm-copy-region-to-register (REGISTER)
Copy text from terminal to an Emacs REGISTER.
This copies  region delimited by the emacspeak eterm marker 
set by command M-x emacspeak-eterm-set-marker and the 
emacspeak eterm pointer to a register.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-define-window (ID)
Prompt for a window ID.
The window is then define to be
the rectangle delimited by point and eterm mark.  This is to
be used when emacspeak is set to review mode inside an
eterm.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-describe-window (ID)
Describe an eterm  window.
Description indicates eterm window coordinates and whether it is stretchable
@end deffn

@deffn {Interactive Command} emacspeak-eterm-goto-line (LINE)
Move emacspeak eterm pointer to a specified LINE.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-kill-ring-save-region ()
Copy text from terminal to kill ring.
This copies  region delimited by the emacspeak eterm marker 
set by command M-x emacspeak-eterm-set-marker and the 
emacspeak eterm pointer.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-maybe-send-raw ()
Send a raw character through if in the terminal buffer.
Execute end of line if
in a non eterm buffer if executed via C-e C-e
@end deffn

@deffn {Interactive Command} emacspeak-eterm-paste-register (REGISTER)
Paste contents of REGISTER at current location.
If the specified register contains text, then that text is
sent to the terminal as if it were typed by the user.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-backward-word (COUNT)
Move the pointer backward  by words. 
Interactive numeric prefix arg specifies number of words to move.
Argument COUNT specifies number of words by which to move.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-down (COUNT)
Move the pointer down a line.
Argument COUNT specifies number of lines by which to move.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-forward-word (COUNT)
Move the pointer forward by words. 
Interactive numeric prefix arg specifies number of words to move.
Argument COUNT specifies number of words by which to move.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-left (COUNT)
Move the pointer left.
Argument COUNT specifies number of columns by which to move.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-right (COUNT)
Move the pointer right.
Argument COUNT specifies number of columns by which to move.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-to-bottom ()
Move the pointer to the bottom  of the screen.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-to-cursor ()
Move the pointer to the cursor.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-to-left-edge ()
Move the pointer to the right edge.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-to-next-color-change (&optional COUNT)
Move the eterm pointer to the next color change.
This allows you to move between highlighted regions of the screen.
Optional argument COUNT specifies how many changes to skip.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-to-previous-color-change (&optional COUNT)
Move the eterm pointer to the next color change.
This allows you to move between highlighted regions of the screen.
Optional argument COUNT specifies how many changes to skip.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-to-right-edge ()
Move the pointer to the right edge.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-to-top ()
Move the pointer to the top of the screen.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-pointer-up (COUNT)
Move the pointer up a line.
Argument COUNT .specifies number of lines by which to move.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-remote-term (HOST)
@kbd{ control e CONTROL meta r }

Start a terminal-emulator in a new buffer.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-search-backward ()
Search backward on the terminal.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-search-forward ()
Search forward on the terminal.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-set-filter-window (FLAG)
Prompt for the id of a predefined window,
and set the `filter' window to it.
Non-nil interactive prefix arg `unsets' the filter window;
this is equivalent to having the entire terminal as the filter window (this is
what eterm starts up with).
Setting the filter window results in emacspeak  only monitoring screen
activity within the filter window.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-set-focus-window (FLAG)
Prompt for the id of a predefined window,
and set the `focus' window to it.
Non-nil interactive prefix arg `unsets' the focus window;
this is equivalent to having the entire terminal as the focus window (this is
what eterm starts up with).
Setting the focus window results in emacspeak  monitoring screen
and speaking that window upon seeing screen activity.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-set-marker ()
Set Emacspeak eterm marker.
This sets  the emacspeak eterm marker to the position pointed 
to by the emacspeak eterm pointer.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-speak-cursor ()
Speak cursor position.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-speak-pointer ()
Speak current pointer position.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-speak-pointer-char (&optional PREFIX)
Speak char under eterm pointer.
Pronounces character phonetically unless  called with a PREFIX arg.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-speak-pointer-line ()
Speak the line the pointer is on.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-speak-pointer-word ()
Speak the word  the pointer is on.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-speak-predefined-window ()
Speak a predefined eterm window between 1 and 10.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-speak-screen (&optional FLAG)
Speak the screen.  Default is to speak from the emacspeak pointer  to point.
Optional prefix arg FLAG causes region above
the Emacspeak pointer to be spoken.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-speak-window (ID)
Speak an eterm window.
Argument ID specifies the window.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-toggle-filter-window ()
Toggle active state of filter window.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-toggle-focus-window ()
Toggle active state of focus window.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-toggle-pointer-mode (&optional PREFIX)
Toggle emacspeak eterm pointer mode.
With optional interactive prefix  arg, turn it on.
When emacspeak eterm is in pointer mode, the eterm read pointer
stays where it is rather than automatically moving to the terminal cursor when
there is terminal activity.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-toggle-review ()
Toggle state of eterm review. 
In review mode, you can move around the terminal and listen to the contnets 
without sending input to the terminal itself.
@end deffn

@deffn {Interactive Command} emacspeak-eterm-yank-window (ID)
Yank contents of  an eterm window at point.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-eterm-autospeak (&optional PREFIX)
Toggle state of eterm autospeak.
When eterm autospeak is turned on and the terminal is in line mode,
all output to the terminal is automatically spoken. 
  Interactive prefix arg means toggle  the global default value, and then set the
  current local  value to the result. 
@end deffn

@node emacspeak-filtertext
@section emacspeak-filtertext

Automatically generated documentation
for commands defined in module  emacspeak-filtertext.

@deffn {Interactive Command} emacspeak-filtertext (START END)
@kbd{ control e ^ }

Copy over text in region to special filtertext buffer in
preparation for interactively filtering text. 
@end deffn

@deffn {Interactive Command} emacspeak-filtertext-mode ()
Major mode for FilterText interaction. 

key             binding
---             -------

=		keep-lines
^		flush-lines
r		emacspeak-filtertext-revert

In addition to any hooks its parent mode `text-mode' might have run,
this mode runs the hook `emacspeak-filtertext-mode-hook', as the final step
during initialization.
@end deffn

@deffn {Interactive Command} emacspeak-filtertext-revert ()
Revert to original text.
@end deffn

@node emacspeak-fix-interactive
@section emacspeak-fix-interactive

Automatically generated documentation
for commands defined in module  emacspeak-fix-interactive.

@deffn {Interactive Command} emacspeak-fix-all-recent-commands ()
Fix recently loaded interactive commands.
This command looks through `load-history' and fixes commands if necessary.
Memoizes call in emacspeak-load-history-pointer to memoize this call. 
@end deffn

@deffn {Interactive Command} emacspeak-fix-commands-loaded-from (MODULE)
Fix all commands loaded from a specified module.
@end deffn

@node emacspeak-forms
@section emacspeak-forms

Automatically generated documentation
for commands defined in module  emacspeak-forms.

@deffn {Interactive Command} emacspeak-forms-find-file (FILENAME)
Visit a forms file
@end deffn

@deffn {Interactive Command} emacspeak-forms-flush-unwanted-records ()
Prompt for pattern and flush matching lines
@end deffn

@deffn {Interactive Command} emacspeak-forms-rerun-filter ()
Rerun  filter --allows us to nuke more matching records
@end deffn

@deffn {Interactive Command} emacspeak-forms-speak-field ()
Speak current form field name and value.
Assumes that point is at the front of a field value.
@end deffn

@deffn {Interactive Command} emacspeak-forms-summarize-current-position ()
Summarize current position in list of records
@end deffn

@deffn {Interactive Command} emacspeak-forms-summarize-current-record ()
Summarize current record
@end deffn

@node emacspeak-gnus
@section emacspeak-gnus

Automatically generated documentation
for commands defined in module  emacspeak-gnus.

@deffn {Interactive Command} emacspeak-gnus-summary-catchup-quietly-and-exit ()
Catch up on all articles in current group.
@end deffn

@node emacspeak-gomoku
@section emacspeak-gomoku

Automatically generated documentation
for commands defined in module  emacspeak-gomoku.

@deffn {Interactive Command} emacspeak-gomoku-display-statistics ()
Display statistics from previous games
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-goto-x-y (X Y)
Prompt for and go to that square.
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-show-current-column ()
Aurally display current column
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-show-current-negative-diagonal ()
Aurally display current negative sloped diagonal 
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-show-current-positive-diagonal ()
Aurally display current positively sloped diagonal
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-show-current-row ()
Aurally display current row
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-speak-emacs-previous-move ()
Speak emacs' previous move
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-speak-humans-previous-move ()
Speak human' previous move
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-speak-number-of-moves ()
Speak number of moves so far
@end deffn

@deffn {Interactive Command} emacspeak-gomoku-speak-square ()
Speak coordinates and state of square at point
@end deffn

@node emacspeak-gridtext
@section emacspeak-gridtext

Commentary:
Emacspeak's table browsing mode allows one to
efficiently access  content that is tabular in nature.
That module also provides functions for infering table
structure where possible.
Often, such structure is hard to infer automatically
--but might be known to the user 
e.g. treat columns 1 through 30 as one column of a table
and so on.
This module allows the user to specify a conceptual grid
that is "overlaid" on the region of text to turn it into
a table for tabular browsing. For now, elements of the
grid are "one line" high --but that may change in the
future if necessary. This module is useful for browsing
structured text files and the output from programs that
tabulate their output.
It's also useful for handling multicolumn text.

Automatically generated documentation
for commands defined in module  emacspeak-gridtext.

@deffn {Interactive Command} emacspeak-gridtext-apply (START END GRID)
@kbd{ control e # a }

Apply grid to region.
@end deffn

@deffn {Interactive Command} emacspeak-gridtext-load (FILE)
@kbd{ control e # l }

Load saved grid settings.
@end deffn

@deffn {Interactive Command} emacspeak-gridtext-save (FILE)
@kbd{ control e # s }

Save out grid settings.
@end deffn

@node emacspeak-hide
@section emacspeak-hide

Commentary:
Flexible hide and show for emacspeak.
This module allows one to easily hide or expose
blocks of lines starting with a common prefix.
It is motivated by the need to flexibly hide quoted text in email
but is designed to be more general.
the prefix parsing is inspired by filladapt.el

Automatically generated documentation
for commands defined in module  emacspeak-hide.

@deffn {Interactive Command} emacspeak-hide-or-expose-all-blocks ()
Hide or expose all blocks in buffer.
@end deffn

@deffn {Interactive Command} emacspeak-hide-or-expose-block (&optional PREFIX)
@kbd{ control e j }

Hide or expose a block of text.
This command either hides or exposes a block of text
starting on the current line.  A block of text is defined as
a portion of the buffer in which all lines start with a
common PREFIX.  Optional interactive prefix arg causes all
blocks in current buffer to be hidden or exposed.
@end deffn

@deffn {Interactive Command} emacspeak-hide-speak-block-sans-prefix ()
@kbd{ control e control j }

Speaks current block after stripping its prefix.
If the current block is not hidden, it first hides it.
This is useful because as you locate blocks, you can invoke this
command to listen to the block,
and when you have heard enough navigate easily  to move past the block.
@end deffn

@node emacspeak-ibuffer
@section emacspeak-ibuffer

Commentary:
speech-enable ibuffer.el
this is an alternative to buffer-menu

Automatically generated documentation
for commands defined in module  emacspeak-ibuffer.

@deffn {Interactive Command} emacspeak-ibuffer-speak-buffer-line ()
Speak information about this buffer
@end deffn

@node emacspeak-imenu
@section emacspeak-imenu

Automatically generated documentation
for commands defined in module  emacspeak-imenu.

@deffn {Interactive Command} emacspeak-imenu-goto-next-index-position ()
Goto the next index position in current buffer
@end deffn

@deffn {Interactive Command} emacspeak-imenu-goto-previous-index-position ()
Goto the previous index position in current buffer
@end deffn

@deffn {Interactive Command} emacspeak-imenu-speak-this-section ()
Speak upto start of next index entry
@end deffn

@node emacspeak-info
@section emacspeak-info

Automatically generated documentation
for commands defined in module  emacspeak-info.

@deffn {Interactive Command} emacspeak-info-speak-header ()
Speak info header line.
@end deffn

@deffn {Interactive Command} emacspeak-info-wizard (NODE-SPEC)
@kbd{ control h TAB   <f1> TAB   <help> TAB }

Read a node spec from the minibuffer and launch
Info-goto-node.
See documentation for command `Info-goto-node' for details on
node-spec.
@end deffn

@node emacspeak-jabber
@section emacspeak-jabber

Commentary:
emacs-jabber.el implements a  jabber client for emacs
emacs-jabber is hosted at sourceforge.
I use emacs-jabber with my gmail.com account

Automatically generated documentation
for commands defined in module  emacspeak-jabber.

@deffn {Interactive Command} emacspeak-jabber-popup-roster ()
Pop to Jabber roster.
@end deffn

@node emacspeak-keymap
@section emacspeak-keymap

Automatically generated documentation
for commands defined in module  emacspeak-keymap.

@deffn {Interactive Command} emacspeak-keymap-choose-new-emacspeak-prefix (PREFIX-KEY)
Interactively select a new prefix key to use for all emacspeak
commands.  The default is to use `C-e'  This command
lets you switch the prefix to something else.  This is a useful thing
to do if you run emacspeak on a remote machine from inside a terminal
that is running inside a local emacspeak session.  You can have the
remote emacspeak use a different control key to give your fingers some
relief.
@end deffn

@node emacspeak-loaddefs
@section emacspeak-loaddefs

Automatically generated documentation
for commands defined in module  emacspeak-loaddefs.

@deffn {Interactive Command} emacspeak-mark-forward-mark ()
@kbd{ <control down> }

Jump to mark, and pop a new position for mark off the ring
(does not affect global mark ring).

This function is advised.

After-advice `emacspeak':
Produce an auditory icon if possible.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-comint-output-monitor (&optional PREFIX)
@kbd{ control e o }

Toggle state of Emacspeak comint monitor.
When turned on, comint output is automatically spoken.  Turn this on if
you want your shell to speak its results.  Interactive
PREFIX arg means toggle the global default value, and then
set the current local value to the result.
@end deffn

@node emacspeak-m-player
@section emacspeak-m-player

Commentary:
Defines a simple derived mode for interacting with mplayer.
mplayer  is a versatile media player capable of playing many
streaming formats  and is especially useful for playing windows
media (WMA) and streaming windows media (ASF) files.
mplayer is available  on the WWW:
RPM package
http://mirrors.sctpc.com/dominik/linux/pkgs/mplayer/i586/mplayer-0.90pre5-2.i586.rpm
You may need the  win32 codecs which can be downloaded from 
http://ftp.lug.udel.edu/MPlayer/releases/w32codec-0.60.tar.bz2
Mplayer FAQ at
http://www.mplayerhq.hu/DOCS/faq.html
Mplayer docs at 
http://www.mplayerhq.hu/DOCS/

Automatically generated documentation
for commands defined in module  emacspeak-m-player.

@deffn {Interactive Command} emacspeak-m-player-add-equalizer ()
Add equalizer for next MPlayer invocation.

Use arrow keys, page-up, page-down, home and end keys to
  manipulate the values.
Hit enter to finish setting the equalizer values.

The Mplayer equalizer provides 10 bands, G0 -- G9, see the
  MPlayer man page for details.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-add-filter ()
Adds specified filter  to use for the next invocation of MPlayer.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-alt-src-step (STEP)
Move within an ASF playlist.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-backward-10min ()
Move backward by ten minutes.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-backward-10s ()
Move back by 10 seconds.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-backward-1min ()
Move back by 1 minute.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-beginning-of-track ()
Move to beginning of track.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-command (COMMAND-CHAR)
Invoke MPlayer commands.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-customize-options ()
Use Customize to manipulate MPlayer options.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-display-position ()
Display current position in track and its length.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-double-speed ()
Scale speed by 2.0
@end deffn

@deffn {Interactive Command} emacspeak-m-player-end-of-track ()
Move to beginning of track.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-equalizer-control (V)
Manipulate values in specified vector using minibuffer.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-faster ()
Speed up  playback.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-forward-10min ()
Move forward by ten minutes.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-forward-10s ()
Move forward by 10 seconds.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-forward-1min ()
Move forward by 1 minute.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-half-speed ()
Scale speed by 0.5.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-load-file (F)
Load specified file.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-load-playlist (F)
Load specified playlist file.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-mode ()
Major mode for m-player interaction. 

key             binding
---             -------

RET		emacspeak-m-player
SPC		emacspeak-m-player-pause
+		emacspeak-m-player-volume-up
,		emacspeak-m-player-backward-10s
-		emacspeak-m-player-volume-down
.		emacspeak-m-player-forward-10s
:		emacspeak-m-player
<		emacspeak-m-player-backward-1min
=		emacspeak-m-player-volume-up
>		emacspeak-m-player-forward-1min
?		emacspeak-m-player-display-position
L		emacspeak-m-player-load-playlist
O		emacspeak-m-player-reset-options
[		emacspeak-m-player-slower
]		emacspeak-m-player-faster
b		bury-buffer
e		emacspeak-m-player-add-equalizer
f		emacspeak-m-player-add-filter
g		emacspeak-m-player-seek-absolute
l		emacspeak-m-player-load-file
n		emacspeak-m-player-next-track
o		emacspeak-m-player-customize-options
p		emacspeak-m-player-previous-track
q		emacspeak-m-player-quit
r		emacspeak-m-player-seek-relative
s		emacspeak-m-player-scale-speed
t		emacspeak-m-player-play-tree-step
@{		emacspeak-m-player-half-speed
@}		emacspeak-m-player-double-speed
DEL		emacspeak-m-player-reset-speed
<down>		emacspeak-m-player-forward-1min
<end>		emacspeak-m-player-end-of-track
<home>		emacspeak-m-player-beginning-of-track
<left>		emacspeak-m-player-backward-10s
<next>		emacspeak-m-player-forward-10min
<prior>		emacspeak-m-player-backward-10min
<right>		emacspeak-m-player-forward-10s
<up>		emacspeak-m-player-backward-1min

In addition to any hooks its parent mode `comint-mode' might have run,
this mode runs the hook `emacspeak-m-player-mode-hook', as the final step
during initialization.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-next-track ()
Move to next track.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-pause ()
Pause or unpause media player.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-play-tree-step (STEP)
Move within the play tree.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-play-tree-up (STEP)
Move within the play tree.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-previous-track ()
Move to previous track.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-quit ()
Quit media player.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-reset-options ()
Reset MPlayer options to initial defaults.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-reset-speed ()
Reset playing speed to normal.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-scale-speed (FACTOR)
Scale speed by specified factor.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-seek-absolute (POSITION)
Seek  to absolute specified position.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-seek-relative (OFFSET)
Seek  by offset into stream from current position.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-slower ()
Slow down playback.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-volume-down ()
Decrease volume.
@end deffn

@deffn {Interactive Command} emacspeak-m-player-volume-up ()
Increase volume.
@end deffn

@deffn {Interactive Command} emacspeak-multimedia ()
@kbd{ control e ; }

Start or control Emacspeak multimedia player.
@end deffn

@node emacspeak-madplay
@section emacspeak-madplay

Commentary:
Defines a simple derived mode for interacting with
madplay.
madplay navigation commands  work via single keystrokes.

Automatically generated documentation
for commands defined in module  emacspeak-madplay.

@deffn {Interactive Command} emacspeak-madplay (RESOURCE)
Play specified resource using madplay.
Resource is an  MP3 file or directory containing mp3 files.
The player is placed in a buffer in emacspeak-madplay-mode.
@end deffn

@deffn {Interactive Command} emacspeak-madplay-madplay-call-command ()
Call appropriate madplay command.
@end deffn

@deffn {Interactive Command} emacspeak-madplay-madplay-command (CHAR)
Execute Madplay command.
@end deffn

@deffn {Interactive Command} emacspeak-madplay-mode ()
Major mode for madplay interaction. 

key             binding
---             -------

+		emacspeak-madplay-madplay-call-command
-		emacspeak-madplay-madplay-call-command
b		emacspeak-madplay-madplay-call-command
f		emacspeak-madplay-madplay-call-command
o		emacspeak-madplay
p .. q		emacspeak-madplay-madplay-call-command
s .. t		emacspeak-madplay-madplay-call-command
<left>		emacspeak-aumix-wave-decrease
<right>		emacspeak-aumix-wave-increase

This mode runs the hook `emacspeak-madplay-mode-hook', as the final step
during initialization.
@end deffn

@node emacspeak-man
@section emacspeak-man

Automatically generated documentation
for commands defined in module  emacspeak-man.

@deffn {Interactive Command} emacspeak-man-browse-man-page ()
Browse the man page --read it a paragraph at a time
@end deffn

@deffn {Interactive Command} emacspeak-man-speak-this-section ()
Speak current section
@end deffn

@node emacspeak-ocr
@section emacspeak-ocr

Commentary:
This module defines Emacspeak front-end to OCR.
This module assumes that sane is installed and working
for image acquisition,
and that there is an OCR engine that can take acquired
images and produce text.
Prerequisites:
Sane installed and working.
scanimage to generate tiff files from scanner.
tiffcp to compress the tiff file.
working ocr executable 
by default this module assumes that the OCR executable
is named "ocr"

Automatically generated documentation
for commands defined in module  emacspeak-ocr.

@deffn {Interactive Command} emacspeak-ocr ()
@kbd{ control e control o }

An OCR front-end for the Emacspeak desktop.  

Page image is acquired using tools from the SANE package.
The acquired image is run through the OCR engine if one is
available, and the results placed in a buffer that is
suitable for browsing the results.

For detailed help, invoke command emacspeak-ocr bound to
C-e C-o to launch emacspeak-ocr-mode, and press
`?' to display mode-specific help for emacspeak-ocr-mode.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-backward-page (&optional COUNT-IGNORED)
Like backward page, but tracks page number of current document.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-customize ()
Customize OCR settings.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-forward-page (&optional COUNT-IGNORED)
Like forward page, but tracks page number of current document.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-mode ()
 An OCR front-end for the Emacspeak desktop.

Pre-requisites:

1) A working scanner back-end like SANE on Linux.

2) An OCR engine.

1: Make sure your scanner back-end works, and that you have
the utilities to scan a document and acquire an image as a
tiff file.  Then set variable
emacspeak-ocr-scan-image-program to point at this utility.
By default, this is set to `scanimage' which is the image
scanning utility provided by SANE.

By default, this front-end attempts to compress the acquired
tiff image; make sure you have a utility like tiffcp.
Variable emacspeak-ocr-compress-image is set to `tiffcp' by
default; if you use something else, you should customize
this variable.

2: Next, make sure you have an OCR engine installed and
working.  By default this front-end assumes that OCR is
available as /usr/bin/ocr.

Once you have ensured that acquiring an image and applying
OCR to it work independently of Emacs, you can use this
Emacspeak front-end to enable easy OCR access from within
Emacspeak.

The Emacspeak OCR front-end is launched by command
emacspeak-ocr bound to C-e C-o.  

This command switches to a special buffer that has OCR
commands bounds to single keystrokes-- see the ke-binding
list at the end of this description.  Use Emacs online help
facility to look up help on these commands.

emacspeak-ocr-mode provides the necessary functionality to
scan, OCR, read and save documents.  By default, scanned
images and the resulting text are saved under directory
~/ocr; see variable emacspeak-ocr-working-directory.
Invoking command emacspeak-ocr-open-working-directory bound
to M-x emacspeak-ocr-open-working-directory will open this directory.

By default, the document being scanned is named `untitled'.
You can name the document by using command
emacspeak-ocr-name-document bound to
M-x emacspeak-ocr-name-document.  The document name is used
in constructing the name of the image and text files.

Key Bindings: 

See key             binding
---             -------

RET		emacspeak-ocr-scan-and-recognize
SPC		emacspeak-ocr-read-current-page
1 .. 9		emacspeak-ocr-page
?		describe-mode
C		emacspeak-ocr-set-compress-image-options
I		emacspeak-ocr-set-scan-image-options
[		emacspeak-ocr-backward-page
]		emacspeak-ocr-forward-page
c		emacspeak-ocr-customize
d		emacspeak-ocr-open-working-directory
i		emacspeak-ocr-scan-image
j		emacspeak-ocr-scan-photo
n		emacspeak-ocr-name-document
o		emacspeak-ocr-recognize-image
p		emacspeak-ocr-page
q		bury-buffer
s		emacspeak-ocr-save-current-page
w		emacspeak-ocr-write-document

.

In addition to any hooks its parent mode `text-mode' might have run,
this mode runs the hook `emacspeak-ocr-mode-hook', as the final step
during initialization.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-name-document (NAME)
Name document being scanned in the current OCR buffer.
Pick a short but meaningful name.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-open-working-directory ()
Launch dired on OCR working directory.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-page ()
Move to specified page.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-read-current-page ()
Speaks current page.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-recognize-image ()
Run OCR engine on current image.
Prompts for image file if file corresponding to the expected
`current page' is not found.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-save-current-page ()
Writes out recognized text from current page
to an appropriately named file.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-scan-and-recognize ()
Scan in a page and run OCR engine on it.
Use this command once you've verified that the separate
steps of acquiring an image and running the OCR engine work
correctly by themselves.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-scan-image ()
Acquire page image.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-scan-photo (&optional METADATA)
Scan in a photograph.
The scanned image is converted to JPEG.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-set-compress-image-options (SETTING)
Interactively update  image compression options.
Prompts with current setting in the minibuffer.
Setting persists for current Emacs session.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-set-scan-image-options (SETTING)
Interactively update scan image options.
Prompts with current setting in the minibuffer.
Setting persists for current Emacs session.
@end deffn

@deffn {Interactive Command} emacspeak-ocr-write-document ()
Writes out recognized text from all pages in current document.
@end deffn

@node emacspeak-outline
@section emacspeak-outline

Commentary:
Provide additional advice to outline-mode

Automatically generated documentation
for commands defined in module  emacspeak-outline.

@deffn {Interactive Command} emacspeak-outline-speak-backward-heading ()
Analogous to outline-backward-same-level
except that the outline section is optionally spoken
@end deffn

@deffn {Interactive Command} emacspeak-outline-speak-forward-heading ()
Analogous to outline-forward-same-level,
except that the outline section is optionally spoken
@end deffn

@deffn {Interactive Command} emacspeak-outline-speak-next-heading ()
Analogous to outline-next-visible-heading,
except that the outline section is optionally spoken
@end deffn

@deffn {Interactive Command} emacspeak-outline-speak-previous-heading ()
Analogous to outline-previous-visible-heading,
except that the outline section is optionally spoken
@end deffn

@deffn {Interactive Command} emacspeak-outline-speak-this-heading ()
Speak current outline section starting from point
@end deffn

@node emacspeak-pronounce
@section emacspeak-pronounce

Commentary:
This module implements user customizable pronunciation dictionaries
for emacspeak. Custom pronunciations can be defined per file, per
directory and/or per major mode. Emacspeak maintains a persistent
user dictionary upon request and loads these in new emacspeak
sessions. This module implements the user interface to the custom
dictionary as well as providing the internal API used by the rest
of emacspeak in using the dictionary.
Algorithm:

The persistent dictionary is a hash table where the hash keys are
filenames, directory names, or major-mode names. The hash values
are association lists defining the dictionary. Users of this module
can retrieve a dictionary made up of all applicable association
lists for a given file.

Automatically generated documentation
for commands defined in module  emacspeak-pronounce.

@deffn {Interactive Command} emacspeak-pronounce-clear-dictionaries ()
Clear all current pronunciation dictionaries.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-define-local-pronunciation (WORD PRONUNCIATION)
Define buffer local pronunciation.
Argument WORD specifies the word which should be pronounced as specified by PRONUNCIATION.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-define-pronunciation ()
Interactively define entries in the pronunciation dictionaries.
Default term to define is delimited by region.
First loads any persistent dictionaries if not already loaded.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-define-template-pronunciation ()
Interactively define template entries in the pronunciation dictionaries.
Default term to define is delimited by region.
First loads any persistent dictionaries if not already loaded.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-dispatch ()
@kbd{ control e meta d }

Provides the user interface front-end to Emacspeak's pronunciation dictionaries.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-edit-pronunciations (KEY)
Prompt for and launch a pronunciation editor on the
specified pronunciation dictionary key.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-load-dictionaries (&optional FILENAME)
Load pronunciation dictionaries.
Optional argument FILENAME specifies the dictionary file.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-refresh-pronunciations ()
Refresh pronunciation table for current buffer.
Activates pronunciation dictionaries if not already active.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-save-dictionaries ()
Writes out the persistent emacspeak pronunciation dictionaries.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-toggle-use-of-dictionaries (&optional STATE)
Toggle use of pronunciation dictionaries in current buffer.
Pronunciations can be defined on a per file, per directory and/or per
mode basis.
Pronunciations are activated on a per buffer basis.
Turning on the use of pronunciation dictionaries results in emacspeak
composing a pronunciation table based on the currently defined
pronunciation dictionaries.
After this, the pronunciations will be applied whenever text in the
buffer is spoken.
Optional argument state can be used from Lisp programs to
explicitly turn pronunciations on or off.
@end deffn

@deffn {Interactive Command} emacspeak-pronounce-yank-word ()
Yank word at point into minibuffer.
@end deffn

@node emacspeak-python
@section emacspeak-python

Commentary:
This speech-enables python-mode available on sourceforge

Automatically generated documentation
for commands defined in module  emacspeak-python.

@deffn {Interactive Command} emacspeak-py-next-block ()
Move forward to the beginning of the next block.
@end deffn

@deffn {Interactive Command} emacspeak-py-previous-block ()
Move backward to the beginning of the current block.
If already at the beginning then move to previous block.
@end deffn

@node emacspeak-realaudio
@section emacspeak-realaudio

Commentary:
Assuming you have a correctly configured RealAudio
player, this package provides single click access to
starting and stopping a RealAudio stream from anywhere
on the Emacspeak desktop.  Before using this package,
make sure that your realaudio player works outside
Emacs. Then set variable Emacspeak-realaudio-player to
point to the program you use to play RealAudio streams.

Automatically generated documentation
for commands defined in module  emacspeak-realaudio.

@deffn {Interactive Command} emacspeak-realaudio-browse (RAMFILE &optional START-TIME)
Browse RAM file before playing the selected component.
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-get-current-time-in-seconds ()
Return current time in seconds.
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-mode ()
Major mode for streaming audio. 

key             binding
---             -------

This mode runs the hook `emacspeak-realaudio-mode-hook', as the final step
during initialization.
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-play (RESOURCE &optional PLAY-LIST NOSELECT)
Play a realaudio stream.  Uses files from your Realaudio
shortcuts directory for completion.  See documentation for
user configurable variable emacspeak-realaudio-shortcuts-directory. 
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-select-realaudio-buffer ()
Switch to realaudio buffer.
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-set-end-mark (&optional MARK-TIME)
Set end mark. Default is to set marker to current play time.
Mark is specified in seconds.
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-set-start-mark (&optional MARK-TIME)
Set start mark. Default is to set marker to current play time.
Mark is specified in seconds.
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-stop ()
Stop playing realaudio
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-trplayer-call-command ()
Call appropriate TRPlayer command.
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-trplayer-command (CHAR)
Execute TRPlayer command.
@end deffn

@deffn {Interactive Command} emacspeak-realaudio-write-mp3-clip (START END FILE)
Writes specified clip from current mp3 stream.
Prompts for start and end times as well as file  to save the clippi
@end deffn

@node emacspeak-redefine
@section emacspeak-redefine

Automatically generated documentation
for commands defined in module  emacspeak-redefine.

@deffn {Interactive Command} emacspeak-backward-char (&optional ARG)
@kbd{ <left>   control b }

Backward-char redefined to speak char moved to. 
@end deffn

@deffn {Interactive Command} emacspeak-forward-char (&optional ARG)
@kbd{ <right>   control f }

Forward-char redefined to speak char moved to. 
@end deffn

@deffn {Interactive Command} emacspeak-self-insert-command (&optional ARG)
@kbd{ Generic char 491520: all of JISX0213-2   Generic char 458752: all of Tibetan 2-col   Generic char 442368: all of Indian 2-col   Generic char 425984: all of CNS11643-7   Generic char 409600: all of CNS11643-6   Generic char 393216: all of CNS11643-5   Generic char 376832: all of CNS11643-4   Generic char 360448: all of CNS11643-3   Generic char 344064: all of Ethiopic   Generic char 327680: all of Unicode subset   Generic char 311296: all of Unicode subset 3   Generic char 294912: all of Unicode subset 2   Generic char 278528: all of Tibetan 1-col   Generic char 262144: all of Indian glyph   Generic char 14464: all of IS 13194   Generic char 14336: all of Arabic 2-col   Generic char 7040: all of Lao   Generic char 6912: all of rev ASCII   Generic char 6784: all of Arabic 1-col   Generic char 6656: all of Arabic digit   Generic char 6528: all of VISCII upper   Generic char 6400: all of VISCII lower   Generic char 6272: all of IPA   Generic char 6144: all of SiSheng   Generic char 163840: all of Big5 (Level-2)   Generic char 147456: all of Big5 (Level-1)   Generic char 131072: all of JISX0213-1   Generic char 114688: all of CNS11643-2   Generic char 98304: all of CNS11643-1   Generic char 81920: all of JISX0212   Generic char 65536: all of KSC5601   Generic char 49152: all of JISX0208   Generic char 32768: all of GB2312   Generic char 16384: all of JISX0208.1978   Generic char 3968: all of RHP of Latin-8   Generic char 3840: all of RHP of Latin-9   Generic char 3712: all of RHP of Latin-5   Generic char 3584: all of RHP of ISO8859/5   Generic char 3328: all of JISX0201 Roman   Generic char 3200: all of JISX0201 Katakana   Generic char 3072: all of RHP of ISO8859/8   Generic char 2944: all of RHP of ISO8859/6   Generic char 2816: all of RHP of ISO8859/7   Generic char 2688: all of RHP of TIS620   Generic char 2560: all of RHP of Latin-4   Generic char 2432: all of RHP of Latin-3   Generic char 2304: all of RHP of Latin-2   Generic char 2176: all of RHP of Latin-1   ÿ   þ   ý   ü   û   ú   ù   ø   ÷   ö   õ   ô   ó   ò   ñ   ð   ï   î   í   ì   ë   ê   é   è   ç   æ   å   ä   ã   â   á   à   ß   Þ   Ý   Ü   Û   Ú   Ù   Ø   ×   Ö   Õ   Ô   Ó   Ò   Ñ   Ð   Ï   Î   Í   Ì   Ë   Ê   É   È   Ç   Æ   Å   Ä   Ã   Â   Á   À   ¿   ¾   ½   ¼   »   º   ¹   ¸   ·   ¶   µ   ´   ³   ²   ±   °   ¯   ®   ­   ¬   «   ª   ©   ¨   §   ¦   ¥   ¤   £   ¢   ¡       ~   @}   |   @{   z   y   x   w   v   u   t   s   r   q   p   o   n   m   l   k   j   i   h   g   f   e   d   c   b   a   `   _   ^   ]   \   [    cap Z     cap Y     cap X     cap W     cap V     cap U     cap T     cap S     cap R     cap Q     cap P     cap O     cap N     cap M     cap L     cap K     cap J     cap I     cap H     cap G     cap F     cap E     cap D     cap C     cap B     cap A    @@   ?   >   =   <   ;   :   9   8   7   6   5   4   3   2   1   0   /   .   -   ,   +   *   )   (   '   &   %   $   #   !   SPACE }

Insert a character.
Speaks the character if emacspeak-character-echo is true.
See  command emacspeak-toggle-word-echo bound to
C-e d w.
Toggle variable dtk-stop-immediately-while-typing if you want to have
speech flush as you type.
@end deffn

@node emacspeak-remote
@section emacspeak-remote

Automatically generated documentation
for commands defined in module  emacspeak-remote.

@deffn {Interactive Command} emacspeak-remote-connect-to-server (HOST PORT)
@kbd{ control e meta r }

Connect to and start using remote speech server running on host host
and listening on port port.  Host is the hostname of the remote
server, typically the desktop machine.  Port is the tcp port that that
host is listening on for speech requests.
@end deffn

@deffn {Interactive Command} emacspeak-remote-home ()
Open ssh session to where we came from.
Uses value returned by `emacspeak-remote-get-current-remote-hostname'.
@end deffn

@deffn {Interactive Command} emacspeak-remote-quick-connect-to-server ()
Connect to remote server.
Does not prompt for host or port, but quietly uses the
guesses that appear as defaults when prompting.
Use this once you are sure the guesses are usually correct.
@end deffn

@deffn {Interactive Command} emacspeak-remote-ssh-to-server (LOGIN HOST PORT)
Open ssh session to where we came from.
@end deffn

@node emacspeak-rmail
@section emacspeak-rmail

Automatically generated documentation
for commands defined in module  emacspeak-rmail.

@deffn {Interactive Command} emacspeak-rmail-speak-current-message-labels ()
Speak labels of current message
@end deffn

@deffn {Interactive Command} emacspeak-rmail-summarize-current-message ()
Summarize current message
@end deffn

@node emacspeak-solitaire
@section emacspeak-solitaire

Automatically generated documentation
for commands defined in module  emacspeak-solitaire.

@deffn {Interactive Command} emacspeak-solitaire-show-column ()
Display current row auditorallly
@end deffn

@deffn {Interactive Command} emacspeak-solitaire-show-row ()
Display current row auditorallly
@end deffn

@deffn {Interactive Command} emacspeak-solitaire-speak-coordinates ()
Speak coordinates of current position
@end deffn

@node emacspeak-sounds
@section emacspeak-sounds

Commentary:
This module provides the interface for generating auditory icons in emacspeak.
Design goal:
1) Auditory icons should be used to provide additional feedback,
not as a gimmick.
2) The interface should be usable at all times without the icons:
e.g. when on a machine without a sound card.
3) General principle for when to use an icon:
Convey information about events taking place in parallel.
For instance, if making a selection automatically moves the current focus
to the next choice,
We speak the next choice, while indicating the fact that something was selected with a sound cue.
 This interface will assume the availability of a shell command "play"
that can take one or more sound files and play them.
This module will also provide a mapping between names in the elisp world and actual sound files.
Modules that wish to use auditory icons should use these names, instead of actual file names.
As of Emacspeak 13.0, this module defines a themes
architecture for  auditory icons.
Sound files corresponding to a given theme are found in
appropriate subdirectories of emacspeak-sounds-directory

Automatically generated documentation
for commands defined in module  emacspeak-sounds.

@deffn {Interactive Command} emacspeak-play-all-icons ()
Plays all defined icons and speaks their names.
@end deffn

@deffn {Interactive Command} emacspeak-set-auditory-icon-player (PLAYER)
@kbd{ control e meta a }

Select  player used for producing auditory icons.
Recommended choices:

emacspeak-serve-auditory-icon for  the wave device.
emacspeak-queue-auditory-icon when using software TTS.
@end deffn

@deffn {Interactive Command} emacspeak-sounds-reset-local-player ()
Ask Emacspeak to use a local audio player.
This lets me have Emacspeak switch to using audioplay on
solaris after I've used it for a while from a remote session
where it would use the more primitive speech-server based
audio player.
@end deffn

@deffn {Interactive Command} emacspeak-sounds-reset-sound ()
Reload sound drivers.
@end deffn

@deffn {Interactive Command} emacspeak-sounds-select-theme (THEME)
@kbd{ control e ) }

Select theme for auditory icons.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-auditory-icons (&optional PREFIX)
@kbd{ control e control a }

Toggle use of auditory icons.
Optional interactive PREFIX arg toggles global value.
@end deffn

@node emacspeak-speak
@section emacspeak-speak

Commentary:
This module defines the core speech services used by emacspeak.
It depends on the speech server interface modules
It protects other parts of emacspeak
from becoming dependent on the speech server modules

Automatically generated documentation
for commands defined in module  emacspeak-speak.

@deffn {Interactive Command} emacspeak-audio-annotate-paragraphs ()
Set property auditory-icon at front of all paragraphs.
@end deffn

@deffn {Interactive Command} emacspeak-blink-matching-open ()
Move cursor momentarily to the beginning of the sexp before point.
Also display match context in minibuffer.
@end deffn

@deffn {Interactive Command} emacspeak-completion-pick-completion ()
Pick completion and return safely where we came from.
@end deffn

@deffn {Interactive Command} emacspeak-completions-move-to-completion-group ()
Move to group of choices beginning with character last
typed. If no such group exists, then we try to search for that
char, or dont move. 
@end deffn

@deffn {Interactive Command} emacspeak-dial-dtk (NUMBER)
@kbd{ control e d t }

Prompt for and dial a phone NUMBER with the Dectalk.
@end deffn

@deffn {Interactive Command} emacspeak-execute-repeatedly (COMMAND)
Execute COMMAND repeatedly.
@end deffn

@deffn {Interactive Command} emacspeak-mark-backward-mark ()
@kbd{ <control up> }

Cycle backward through the mark ring.
@end deffn

@deffn {Interactive Command} emacspeak-owindow-next-line (COUNT)
@kbd{ ESCAPE <down> }

Move to the next line in the other window and speak it.
Numeric prefix arg COUNT can specify number of lines to move.
@end deffn

@deffn {Interactive Command} emacspeak-owindow-previous-line (COUNT)
@kbd{ ESCAPE <up> }

Move to the next line in the other window and speak it.
Numeric prefix arg COUNT specifies number of lines to move.
@end deffn

@deffn {Interactive Command} emacspeak-owindow-scroll-down ()
@kbd{ ESCAPE <prior> }

Scroll down  the window that command `other-window' would move to.
Speak the window contents after scrolling.
@end deffn

@deffn {Interactive Command} emacspeak-owindow-scroll-up ()
@kbd{ ESCAPE <next> }

Scroll up the window that command `other-window' would move to.
Speak the window contents after scrolling.
@end deffn

@deffn {Interactive Command} emacspeak-owindow-speak-line ()
@kbd{ ESCAPE <select> }

Speak the current line in the other window.
@end deffn

@deffn {Interactive Command} emacspeak-read-next-line (&optional ARG)
@kbd{ control e <down> }

Read next line, specified by an offset, without moving.
Default is to read the next line. 
@end deffn

@deffn {Interactive Command} emacspeak-read-next-word (&optional ARG)
Read next word, specified as a numeric  arg, without moving.
Default is to read the next word. 
@end deffn

@deffn {Interactive Command} emacspeak-read-previous-line (&optional ARG)
@kbd{ control e <up> }

Read previous line, specified by an offset, without moving.
Default is to read the previous line. 
@end deffn

@deffn {Interactive Command} emacspeak-read-previous-word (&optional ARG)
Read previous word, specified as a prefix arg, without moving.
Default is to read the previous word. 
@end deffn

@deffn {Interactive Command} emacspeak-speak-and-skip-extent-upto-char (CHAR)
Search forward from point until we hit char.
Speak text between point and the char we hit.
@end deffn

@deffn {Interactive Command} emacspeak-speak-and-skip-extent-upto-this-char ()
Speak extent delimited by point and last character typed.
@end deffn

@deffn {Interactive Command} emacspeak-speak-browse-buffer (&optional BROWSE)
@kbd{ control e , }

Browse current buffer.
Default is to speak chunk having current personality.
Interactive prefix arg `browse'  repeatedly browses  through
  chunks having same personality as the current text chunk.
@end deffn

@deffn {Interactive Command} emacspeak-speak-buffer (&optional ARG)
@kbd{ control e b }

Speak current buffer  contents.
With prefix ARG, speaks the rest of the buffer from point.
Negative prefix arg speaks from start of buffer to point.
 If voice lock mode is on, the paragraphs in the buffer are
voice annotated first,  see command `emacspeak-speak-voice-annotate-paragraphs'.
@end deffn

@deffn {Interactive Command} emacspeak-speak-buffer-filename (&optional FILENAME)
@kbd{ control e f }

Speak name of file being visited in current buffer.
Speak default directory if invoked in a dired buffer,
or when the buffer is not visiting any file.
Interactive prefix arg `filename' speaks only the final path
component.
The result is put in the kill ring for convenience.
@end deffn

@deffn {Interactive Command} emacspeak-speak-buffer-interactively ()
@kbd{ control e  cap B  }

Speak the start of, rest of, or the entire buffer.
's' to speak the start.
'r' to speak the rest.
any other key to speak entire buffer.
@end deffn

@deffn {Interactive Command} emacspeak-speak-char (&optional PREFIX)
@kbd{ control e c }

Speak character under point.
Pronounces character phonetically unless  called with a PREFIX arg.
@end deffn

@deffn {Interactive Command} emacspeak-speak-comint-send-input ()
Causes output to be spoken i.e., as if comint autospeak were turned
on.
@end deffn

@deffn {Interactive Command} emacspeak-speak-continuously ()
@kbd{ control e RETURN }

Speak a buffer continuously.
First prompts using the minibuffer for the kind of action to
perform after speaking each chunk.  E.G.  speak a line at a time
etc.  Speaking commences at current buffer position.  Pressing
C-g breaks out, leaving point on last chunk that
was spoken.  Any other key continues to speak the buffer.
@end deffn

@deffn {Interactive Command} emacspeak-speak-current-column ()
@kbd{ control e = }

Speak the current column.
@end deffn

@deffn {Interactive Command} emacspeak-speak-current-field ()
@kbd{ control e . }

Speak current field.
@end deffn

@deffn {Interactive Command} emacspeak-speak-current-kill (COUNT)
@kbd{ control e k }

Speak the current kill entry.
This is the text that will be yanked in by the next C-y.
Prefix numeric arg, COUNT, specifies that the text that will be yanked as a
result of a
C-y  followed by count-1 M-y
be spoken.
 The kill number that is spoken says what numeric prefix arg to give
to command yank.
@end deffn

@deffn {Interactive Command} emacspeak-speak-current-mark (COUNT)
@kbd{ control e control @@ }

Speak the line containing the mark.
With no argument, speaks the
line containing the mark--this is where `exchange-point-and-mark'
C-x C-x would jump.  Numeric prefix arg 'COUNT' speaks
line containing mark 'n' where 'n' is one less than the number of
times one has to jump using `set-mark-command' to get to this marked
position.  The location of the mark is indicated by an aural highlight
achieved by a change in voice personality.
@end deffn

@deffn {Interactive Command} emacspeak-speak-current-percentage ()
@kbd{ control e % }

Announce the percentage into the current buffer.
@end deffn

@deffn {Interactive Command} emacspeak-speak-current-window ()
Speak contents of current window.
Speaks entire window irrespective of point.
@end deffn

@deffn {Interactive Command} emacspeak-speak-display-char (&optional PREFIX)
Display char under point using current speech display table.
Behavior is the same as command `emacspeak-speak-char'
bound to C-e c
for characters in the range 0--127.
Optional argument PREFIX  specifies that the character should be spoken phonetically.
@end deffn

@deffn {Interactive Command} emacspeak-speak-front-of-buffer ()
Speak   the buffer from start to   point
@end deffn

@deffn {Interactive Command} emacspeak-speak-help (&optional ARG)
@kbd{ control e h }

Speak help buffer if one present.
With prefix arg, speaks the rest of the buffer from point.
Negative prefix arg speaks from start of buffer to point.
@end deffn

@deffn {Interactive Command} emacspeak-speak-help-interactively ()
Speak the start of, rest of, or the entire help.
's' to speak the start.
'r' to speak the rest.
any other key to speak entire help.
@end deffn

@deffn {Interactive Command} emacspeak-speak-line (&optional ARG)
@kbd{ control e l }

Speaks current line.  With prefix ARG, speaks the rest of the line
from point.  Negative prefix optional arg speaks from start of line to
point.  Voicifies if option `voice-lock-mode' is on.  Indicates
indentation with a tone if audio indentation is in use.  Indicates
position of point with an aural highlight if option
`emacspeak-show-point' is turned on --see command
`emacspeak-show-point' bound to M-x emacspeak-show-point.  Lines that
start hidden blocks of text, e.g.  outline header lines, or header
lines of blocks created by command `emacspeak-hide-or-expose-block'
are indicated with auditory icon ellipses.
@end deffn

@deffn {Interactive Command} emacspeak-speak-line-interactively ()
@kbd{ control e  cap L  }

Speak the start of, rest of, or the entire line.
's' to speak the start.
'r' to speak the rest.
any other key to speak entire line.
@end deffn

@deffn {Interactive Command} emacspeak-speak-line-number ()
@kbd{ control e control l }

Print the current buffer line number and narrowed line number of point.
@end deffn

@deffn {Interactive Command} emacspeak-speak-line-set-column-filter (FILTER)
@kbd{ control e | }

Set up filter for selectively speaking or ignoring portions of lines.
The filter is specified as a list of pairs.
For example, to filter  columns 1 -- 10 and 20 -- 25,
specify filter as
((0 9) (20 25)). Filter settings are persisted across sessions.  A
persisted filter is used as the default when prompting for a filter.
This allows one to accumulate a set of filters for specific files like
/var/adm/messages and /var/adm/maillog over time.
Option emacspeak-speak-line-invert-filter determines
the sense of the filter. 
@end deffn

@deffn {Interactive Command} emacspeak-speak-load-directory-settings (&optional DIRECTORY)
Load a directory specific Emacspeak settings file.
This is typically used to load up settings that are specific to
an electronic book consisting of many files in the same
directory.
@end deffn

@deffn {Interactive Command} emacspeak-speak-message-again (&optional FROM-MESSAGE-CACHE)
@kbd{ control e a }

Speak the last message from Emacs once again.
Optional interactive prefix arg
`from-message-cache' speaks message cached from the most
recent call to function `message'.
The message is also placed in the kill ring for convenient yanking
if `emacspeak-speak-message-again-should-copy-to-kill-ring' is set.
@end deffn

@deffn {Interactive Command} emacspeak-speak-message-at-time (TIME MESSAGE)
@kbd{ control e @@ }

Set up ring-at-time to speak message at specified time.
Provides simple stop watch functionality in addition to other things.
See documentation for command run-at-time for details on time-spec.
@end deffn

@deffn {Interactive Command} emacspeak-speak-minibuffer (&optional ARG)
Speak the minibuffer contents
 With prefix arg, speaks the rest of the buffer from point.
Negative prefix arg speaks from start of buffer to point.
@end deffn

@deffn {Interactive Command} emacspeak-speak-minor-mode-line ()
@kbd{ control e  cap M  }

Speak the minor mode-information.
@end deffn

@deffn {Interactive Command} emacspeak-speak-mode-line (&optional BUFFER-INFO)
@kbd{ control e m }

Speak the mode-line.
Interactive prefix arg speaks buffer info.
@end deffn

@deffn {Interactive Command} emacspeak-speak-next-field ()
@kbd{ control e > }

Move to and speak next field.
@end deffn

@deffn {Interactive Command} emacspeak-speak-next-personality-chunk ()
Moves to the front of next chunk having current personality.
Speak that chunk after moving.
@end deffn

@deffn {Interactive Command} emacspeak-speak-next-window ()
@kbd{ control e control n }

Speak the next window.
@end deffn

@deffn {Interactive Command} emacspeak-speak-other-buffer (BUFFER)
@kbd{ control e meta b }

Speak specified buffer.
Useful to listen to a buffer without switching  contexts.
@end deffn

@deffn {Interactive Command} emacspeak-speak-other-window (&optional ARG)
Speak contents of `other' window.
Speaks entire window irrespective of point.
Semantics  of `other' is the same as for the builtin Emacs command
`other-window'.
Optional argument ARG  specifies `other' window to speak.
@end deffn

@deffn {Interactive Command} emacspeak-speak-page (&optional ARG)
@kbd{ control e [ }

Speak a page.
With prefix ARG, speaks rest of current page.
Negative prefix arg will read from start of current page to point.
If option  `voice-lock-mode' is on, then it will use any defined personality.
@end deffn

@deffn {Interactive Command} emacspeak-speak-page-interactively ()
@kbd{ control e ] }

Speak the start of, rest of, or the entire page.
's' to speak the start.
'r' to speak the rest.
any other key to speak entire page.
@end deffn

@deffn {Interactive Command} emacspeak-speak-paragraph (&optional ARG)
@kbd{ control e @{ }

Speak paragraph.
With prefix arg, speaks rest of current paragraph.
Negative prefix arg will read from start of current paragraph to point.
If voice-lock-mode is on, then it will use any defined personality. 
@end deffn

@deffn {Interactive Command} emacspeak-speak-paragraph-interactively ()
@kbd{ control e  cap P  }

Speak the start of, rest of, or the entire paragraph.
's' to speak the start.
'r' to speak the rest.
any other key to speak entire paragraph.
@end deffn

@deffn {Interactive Command} emacspeak-speak-predefined-window (&optional ARG)
@kbd{ control e 0   control e 1   control e 2   control e 3   control e 4   control e 5   control e 6   control e 7   control e 8   control e 9 }

Speak one of the first 10 windows on the screen.
Speaks entire window irrespective of point.
In general, you'll never have Emacs split the screen into more than
two or three.
Argument ARG determines the 'other' window to speak.
Semantics  of `other' is the same as for the builtin Emacs command
`other-window'.
@end deffn

@deffn {Interactive Command} emacspeak-speak-previous-field ()
@kbd{ control e < }

Move to previous field and speak it.
@end deffn

@deffn {Interactive Command} emacspeak-speak-previous-personality-chunk ()
Moves to the front of previous chunk having current personality.
Speak that chunk after moving.
@end deffn

@deffn {Interactive Command} emacspeak-speak-previous-window ()
@kbd{ control e control p }

Speak the previous window.
@end deffn

@deffn {Interactive Command} emacspeak-speak-rectangle (START END)
@kbd{ control e  cap R  }

Speak a rectangle of text.
Rectangle is delimited by point and mark.
When call from a program,
arguments specify the START and END of the rectangle.
@end deffn

@deffn {Interactive Command} emacspeak-speak-region (START END)
@kbd{ control e r }

Speak region.
Argument START  and END specify region to speak.
@end deffn

@deffn {Interactive Command} emacspeak-speak-rest-of-buffer ()
@kbd{ control e n }

Speak remainder of the buffer starting at point
@end deffn

@deffn {Interactive Command} emacspeak-speak-sentence (&optional ARG)
Speak current sentence.
With prefix ARG, speaks the rest of the sentence  from point.
Negative prefix arg speaks from start of sentence to point.
@end deffn

@deffn {Interactive Command} emacspeak-speak-set-display-table (&optional PREFIX)
Sets up buffer specific speech display table that controls how
special characters are spoken. Interactive prefix argument causes
setting to be global.
@end deffn

@deffn {Interactive Command} emacspeak-speak-sexp (&optional ARG)
@kbd{ control e ' }

Speak current sexp.
With prefix ARG, speaks the rest of the sexp  from point.
Negative prefix arg speaks from start of sexp to point.
If option  `voice-lock-mode' is on, then uses the personality.
@end deffn

@deffn {Interactive Command} emacspeak-speak-sexp-interactively ()
@kbd{ control e " }

Speak the start of, rest of, or the entire sexp.
's' to speak the start.
'r' to speak the rest.
any other key to speak entire sexp.
@end deffn

@deffn {Interactive Command} emacspeak-speak-skim-buffer ()
Skim the current buffer  a paragraph at a time.
@end deffn

@deffn {Interactive Command} emacspeak-speak-skim-next-paragraph ()
Skim next paragraph.
@end deffn

@deffn {Interactive Command} emacspeak-speak-skim-paragraph ()
Skim paragraph.
Skimming a paragraph results in the speech speeding up after
the first clause.
Speech is scaled by the value of dtk-speak-skim-scale
@end deffn

@deffn {Interactive Command} emacspeak-speak-spaces-at-point ()
@kbd{ control e CONTROL meta @@ }

Speak the white space at point.
@end deffn

@deffn {Interactive Command} emacspeak-speak-spell-current-word ()
Spell word at  point.
@end deffn

@deffn {Interactive Command} emacspeak-speak-this-personality-chunk ()
Speak chunk of text around point that has current
personality.
@end deffn

@deffn {Interactive Command} emacspeak-speak-time (&optional WORLD)
@kbd{ control e t }

Speak the time.
Optional interactive prefix arg `C-u'invokes world clock.
Timezone is specified using minibuffer completion.
Second interactive prefix sets clock to new timezone.
@end deffn

@deffn {Interactive Command} emacspeak-speak-version ()
@kbd{ control e  cap V  }

Announce version information for running emacspeak.
@end deffn

@deffn {Interactive Command} emacspeak-speak-voice-annotate-paragraphs ()
Locate paragraphs and voice annotate the first word.
Here, paragraph is taken to mean a chunk of text preceded by a blank line.
Useful to do this before you listen to an entire buffer.
@end deffn

@deffn {Interactive Command} emacspeak-speak-window-information ()
@kbd{ control e control w }

Speaks information about current window.
@end deffn

@deffn {Interactive Command} emacspeak-speak-word (&optional ARG)
@kbd{ control e w }

Speak current word.
With prefix ARG, speaks the rest of the word from point.
Negative prefix arg speaks from start of word to point.
If executed  on the same buffer position a second time, the word is
spelt instead of being spoken.
@end deffn

@deffn {Interactive Command} emacspeak-speak-word-interactively ()
Speak the start of, rest of, or the entire word.
's' to speak the start.
'r' to speak the rest.
any other key to speak entire word.
@end deffn

@deffn {Interactive Command} emacspeak-speak-world-clock (ZONE &optional SET)
Display current date and time  for specified zone.
Optional second arg `set' sets the TZ environment variable as well.
@end deffn

@deffn {Interactive Command} emacspeak-switch-to-reference-buffer ()
Switch back to buffer that generated completions.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-action-mode (&optional PREFIX)
Toggle state of  Emacspeak  action mode.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-audio-indentation (&optional PREFIX)
@kbd{ control e d i }

Toggle state of  Emacspeak  audio indentation.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
Specifying the method of indentation as `tones'
results in the Dectalk producing a tone whose length is a function of the
line's indentation.  Specifying `speak'
results in the number of initial spaces being spoken.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-character-echo (&optional PREFIX)
@kbd{ control e d k }

Toggle state of  Emacspeak  character echo.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-comint-autospeak (&optional PREFIX)
@kbd{ control e control q }

Toggle state of Emacspeak comint autospeak.
When turned on, comint output is automatically spoken.  Turn this on if
you want your shell to speak its results.  Interactive
PREFIX arg means toggle the global default value, and then
set the current local value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-line-echo (&optional PREFIX)
@kbd{ control e d l }

Toggle state of  Emacspeak  line echo.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-mail-alert (&optional PREFIX)
@kbd{ control e meta m }

Toggle state of  Emacspeak  mail alert.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
Turning on this option results in Emacspeak producing an auditory icon
indicating the arrival  of new mail when displaying the mode line.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-show-point (&optional PREFIX)
@kbd{ control e control d }

Toggle state of  Emacspeak-show-point.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-speak-line-invert-filter (&optional PREFIX)
@kbd{ control e \ }

Toggle state of   how column filter is interpreted.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-speak-messages (&optional PREFIX)
@kbd{ control e q }

Toggle the state of whether emacspeak echoes messages.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-which-function (&optional PREFIX)
@kbd{ control e meta w }

Toggle state of  Emacspeak  which function mode.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-toggle-word-echo (&optional PREFIX)
@kbd{ control e d w }

Toggle state of  Emacspeak  word echo.
Interactive PREFIX arg means toggle  the global default value, and then set the
current local  value to the result.
@end deffn

@deffn {Interactive Command} emacspeak-use-customized-blink-paren ()
A customized blink-paren to speak  matching opening paren.
We need to call this in case Emacs is anal and loads its own
builtin blink-paren function which does not talk.
@end deffn

@deffn {Interactive Command} emacspeak-voicify-rectangle (START END &optional PERSONALITY)
Voicify the current rectangle.
When calling from a program,arguments are
START END personality
Prompts for PERSONALITY  with completion when called interactively.
@end deffn

@deffn {Interactive Command} emacspeak-voicify-region (START END &optional PERSONALITY)
Voicify the current region.
When calling from a program,arguments are
START END personality.
Prompts for PERSONALITY  with completion when called interactively.
@end deffn

@deffn {Interactive Command} emacspeak-zap-tts ()
@kbd{ control e d z }

Send this command to the TTS directly.
@end deffn

@node emacspeak-speedbar
@section emacspeak-speedbar

Commentary:
This module advises speedbar.el for use with Emacs.  The
latest speedbar can be obtained from
ftp://ftp.ultranet.com/pub/zappo/ This module ensures
that speedbar works smoothly outside a windowing system
in addition to speech enabling all interactive
commands. Emacspeak also adds an Emacspeak environment
specific entry point to speedbar
--emacspeak-speedbar-goto-speedbar-- and binds this

Automatically generated documentation
for commands defined in module  emacspeak-speedbar.

@deffn {Interactive Command} emacspeak-speedbar-click ()
Does the equivalent of the mouse click from the keyboard
@end deffn

@deffn {Interactive Command} emacspeak-speedbar-goto-speedbar ()
Switch to the speedbar
@end deffn

@node emacspeak-table-ui
@section emacspeak-table-ui

Automatically generated documentation
for commands defined in module  emacspeak-table-ui.

@deffn {Interactive Command} emacspeak-table-copy-current-element-to-kill-ring ()
Copy current table element to kill ring.
@end deffn

@deffn {Interactive Command} emacspeak-table-copy-current-element-to-register (REGISTER)
Copy current table element to specified register.
@end deffn

@deffn {Interactive Command} emacspeak-table-copy-to-clipboard ()
Copy table in current buffer to the table clipboard.
Current buffer must be in emacspeak-table mode.
@end deffn

@deffn {Interactive Command} emacspeak-table-display-table-in-region (START END)
@kbd{ control e TAB }

Recognize tabular data in current region and display it in table
browsing mode in a a separate buffer.
emacspeak table mode is designed to let you browse tabular data using
all the power of the two-dimensional spatial layout while giving you
sufficient contextual information.  The tables subdirectory of the
emacspeak distribution contains some sample tables --these are the
CalTrain schedules.  Execute command `describe-mode' bound to
C-h m in a buffer that is in emacspeak table mode to read
the documentation on the table browser.
@end deffn

@deffn {Interactive Command} emacspeak-table-find-csv-file (FILENAME)
Process a csv (comma separated values) file.
The processed  data and presented using emacspeak table navigation. 
@end deffn

@deffn {Interactive Command} emacspeak-table-find-file (FILENAME)
@kbd{ control e control t }

Open a file containing table data and display it in table mode.
emacspeak table mode is designed to let you browse tabular data using
all the power of the two-dimensional spatial layout while giving you
sufficient contextual information.  The etc/tables subdirectory of the
emacspeak distribution contains some sample tables --these are the
CalTrain schedules.  Execute command `describe-mode' bound to
C-h m in a buffer that is in emacspeak table mode to read
the documentation on the table browser.
@end deffn

@deffn {Interactive Command} emacspeak-table-get-entry-with-headers (ROW COLUMN &optional ROW-HEAD-P COL-HEAD-P)
Return   both row and column header and table element
@end deffn

@deffn {Interactive Command} emacspeak-table-goto (ROW COLUMN)
Prompt for a table cell coordinates and jump to it.
@end deffn

@deffn {Interactive Command} emacspeak-table-goto-bottom ()
Goes to the bottom of the current column.
@end deffn

@deffn {Interactive Command} emacspeak-table-goto-left ()
Goes to the left of the current row.
@end deffn

@deffn {Interactive Command} emacspeak-table-goto-right ()
Goes to the right of the current row.
@end deffn

@deffn {Interactive Command} emacspeak-table-goto-top ()
Goes to the top of the current column.
@end deffn

@deffn {Interactive Command} emacspeak-table-next-column (&optional COUNT)
Move to the next column if possible
@end deffn

@deffn {Interactive Command} emacspeak-table-next-row (&optional COUNT)
Move to the next row if possible
@end deffn

@deffn {Interactive Command} emacspeak-table-paste-from-clipboard ()
Paste the emacspeak table clipboard into the current buffer.
Use the major  mode of this buffer to  decide what kind of table
markup to use.
@end deffn

@deffn {Interactive Command} emacspeak-table-previous-column (&optional COUNT)
Move to the previous column  if possible
@end deffn

@deffn {Interactive Command} emacspeak-table-previous-row (&optional COUNT)
Move to the previous row if possible
@end deffn

@deffn {Interactive Command} emacspeak-table-search (&optional WHAT)
Search the table for matching elements.  Interactively prompts for
row or column to search and pattern to look for.    If there is a match, makes
the matching cell current. When called from a program, `what' can
  be either `row' or `column'.
@end deffn

@deffn {Interactive Command} emacspeak-table-search-column ()
Search in current table column.
@end deffn

@deffn {Interactive Command} emacspeak-table-search-headers ()
Search the table row or column headers.  Interactively prompts for
row or column to search and pattern to look for.  If there is a
match, makes the matching row or column current.
@end deffn

@deffn {Interactive Command} emacspeak-table-search-row ()
Search in current table row.
@end deffn

@deffn {Interactive Command} emacspeak-table-select-automatic-speaking-method ()
Interactively select the kind of automatic speech to produce when
browsing table elements
@end deffn

@deffn {Interactive Command} emacspeak-table-sort-on-current-column ()
Sort table on current column. 
@end deffn

@deffn {Interactive Command} emacspeak-table-speak-both-headers-and-element ()
Speak  both row and column header and table element
@end deffn

@deffn {Interactive Command} emacspeak-table-speak-column-filtered (&optional PREFIX)
Speaks a table column after applying a specified column filter.
Optional prefix arg prompts for a new filter.
@end deffn

@deffn {Interactive Command} emacspeak-table-speak-column-header-and-element ()
Speak  column header and table element
@end deffn

@deffn {Interactive Command} emacspeak-table-speak-coordinates ()
Speak current table coordinates.
@end deffn

@deffn {Interactive Command} emacspeak-table-speak-current-element ()
Speak current table element
@end deffn

@deffn {Interactive Command} emacspeak-table-speak-dimensions ()
Speak current table dimensions.
@end deffn

@deffn {Interactive Command} emacspeak-table-speak-row-filtered (&optional PREFIX)
Speaks a table row after applying a specified row filter.
Optional prefix arg prompts for a new filter.
@end deffn

@deffn {Interactive Command} emacspeak-table-speak-row-header-and-element ()
Speak  row header and table element
@end deffn

@deffn {Interactive Command} emacspeak-table-ui-filter-load (FILE)
Load saved filter settings.
@end deffn

@deffn {Interactive Command} emacspeak-table-ui-filter-save (FILE)
Save out filter settings.
@end deffn

@deffn {Interactive Command} emacspeak-table-view-csv-buffer (&optional BUFFER-NAME)
Process a csv (comma separated values) data.
The processed  data and presented using emacspeak table navigation. 
@end deffn

@node emacspeak-tabulate
@section emacspeak-tabulate

Automatically generated documentation
for commands defined in module  emacspeak-tabulate.

@deffn {Interactive Command} emacspeak-tabulate-region (START END &optional MARK-FIELDS)
@kbd{ control e i }

Voicifies the white-space of a table if one found.  Optional interactive prefix
arg mark-fields specifies if the header row information is used to mark fields
in the white-space.
@end deffn

@node emacspeak-tapestry
@section emacspeak-tapestry

Automatically generated documentation
for commands defined in module  emacspeak-tapestry.

@deffn {Interactive Command} emacspeak-tapestry-describe-tapestry (&optional DETAILS)
@kbd{ control e meta t }

Describe the current layout of visible buffers in current frame.
Use interactive prefix arg to get coordinate positions of the
displayed buffers.
@end deffn

@deffn {Interactive Command} emacspeak-tapestry-select-window-by-name (BUFFER-NAME)
@kbd{ control e  cap W  }

Select window by the name of the buffer it displays.
This is useful when using modes like ECB or the new GDB UI where
  you want to preserve the window layout 
but quickly switch to a window by name.
@end deffn

@node emacspeak-tar
@section emacspeak-tar

Automatically generated documentation
for commands defined in module  emacspeak-tar.

@deffn {Interactive Command} emacspeak-tar-speak-file-date ()
Speak date of file current entry 
@end deffn

@deffn {Interactive Command} emacspeak-tar-speak-file-permissions ()
Speak permissions of file current entry 
@end deffn

@deffn {Interactive Command} emacspeak-tar-speak-file-size ()
Speak size of file current entry 
@end deffn

@node emacspeak-tetris
@section emacspeak-tetris

Automatically generated documentation
for commands defined in module  emacspeak-tetris.

@deffn {Interactive Command} emacspeak-tetris-goto-bottom-row ()
Move to and speak bottom row
@end deffn

@deffn {Interactive Command} emacspeak-tetris-goto-top-row ()
Move to and speak the top row
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-column (&optional X)
Speak  column --default is to speak current column
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-coordinates ()
Speak current position
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-current-shape ()
Speak current shape
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-current-shape-and-coordinates ()
Speak shape orientation and coordinates
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-next-shape ()
Speak next shape
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-row ()
Speak current tetris row
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-row-number ()
Speak where on the tetris board we are
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-score ()
Speak the score
@end deffn

@deffn {Interactive Command} emacspeak-tetris-speak-x-coordinate ()
Speak current position
@end deffn

@node emacspeak-tnt
@section emacspeak-tnt

Commentary:
Speech-enables TNT -- the Emacs AOL Instant Messenger
client 

Automatically generated documentation
for commands defined in module  emacspeak-tnt.

@deffn {Interactive Command} emacspeak-tnt-toggle-autospeak (&optional PREFIX)
Toggle TNT autospeak for this chat session.
@end deffn

@node emacspeak-url-template
@section emacspeak-url-template

Commentary:
It is often useful to have ``parameterized hot list entries''
i.e., hotlist entries  that are ``templates'' for the
actual URL.
The user provides values for the parameterized portions
of the URL e.g. the date.
See @xref{URL Templates}, for details on the URL templates
that are presently defined.

Automatically generated documentation
for commands defined in module  emacspeak-url-template.

@deffn {Interactive Command} emacspeak-url-template-fetch (&optional DOCUMENTATION)
@kbd{ control e u }

Fetch a pre-defined resource.
Use Emacs completion to obtain a list of available resources.
Resources typically prompt for the relevant information
before completing the request.
Optional interactive prefix arg displays documentation for specified resource.
@end deffn

@deffn {Interactive Command} emacspeak-url-template-help ()
Display documentation for  a URL template.
Use Emacs completion to obtain a list of available
resources.
@end deffn

@deffn {Interactive Command} emacspeak-url-template-load (FILE)
Load URL template resources from specified location.
@end deffn

@deffn {Interactive Command} emacspeak-url-template-save (FILE)
Save out url templates.
@end deffn

@node emacspeak-view-process
@section emacspeak-view-process

Automatically generated documentation
for commands defined in module  emacspeak-view-process.

@deffn {Interactive Command} emacspeak-view-process-goto-current-field-next-line ()
Set point to the current field in the next line.
@end deffn

@deffn {Interactive Command} emacspeak-view-process-speak-current-field ()
Speak current field
@end deffn

@node emacspeak-view
@section emacspeak-view

Automatically generated documentation
for commands defined in module  emacspeak-view.

@deffn {Interactive Command} emacspeak-view-line-to-top ()
Moves current line to top of window
@end deffn

@node emacspeak-vm
@section emacspeak-vm

Automatically generated documentation
for commands defined in module  emacspeak-vm.

@deffn {Interactive Command} emacspeak-vm-browse-message ()
Browse an email message --read it paragraph at a time. 
@end deffn

@deffn {Interactive Command} emacspeak-vm-catch-up-all-messages ()
Mark all messages in folder to be deleted. Use with caution.
@end deffn

@deffn {Interactive Command} emacspeak-vm-locate-subject-line ()
Locates the subject line in a message being read.
Useful when you're reading a message
that has been forwarded multiple times.
@end deffn

@deffn {Interactive Command} emacspeak-vm-mode-line ()
VM mode line information. 
@end deffn

@deffn {Interactive Command} emacspeak-vm-next-button (N)
Move point to N buttons forward.
If N is negative, move backward instead.
@end deffn

@deffn {Interactive Command} emacspeak-vm-speak-labels ()
Speak a message's labels
@end deffn

@deffn {Interactive Command} emacspeak-vm-speak-message ()
Move point to the message body.
@end deffn

@deffn {Interactive Command} emacspeak-vm-yank-header ()
Yank specified header into kill ring.
@end deffn

@node emacspeak-w3
@section emacspeak-w3

Commentary:
Ensure that speech support for W3 gets installed and
loaded correctly.
The emacs W3 browser comes with builtin support for
Emacspeak and ACSS

Automatically generated documentation
for commands defined in module  emacspeak-w3.

@deffn {Interactive Command} emacspeak-realaudio (&optional IGNORED)
@kbd{ control e : }

Start or control streaming audio including MP3 and
realaudio.  If using `TRPlayer' as the player, accepts
trplayer control commands if a stream is already playing.
Otherwise, the playing stream is simply stopped.  If no
stream is playing, this command prompts for a realaudio
resource.  Realaudio resources can be specified either as a
Realaudio URL, the location of a local Realaudio file, or as
the name of a local Realaudio metafile. Realaudio resources
you have played in this session are available in the
minibuffer history.  The default is to play the resource you
played most recently. Emacspeak uses the contents of the
directory specified by variable
emacspeak-realaudio-shortcuts-directory to offer a set of
completions. Hit space to use this completion list.

If using TRPlayer, you can either give one-shot commands
using command emacspeak-realaudio available from anywhere on
the audio desktop as `C-e :'.
Alternatively, switch to buffer *realaudio* using
`C-e :;' if you wish to issue many
navigation commands.  Note that buffer *realaudio* uses a
special major mode that provides the various navigation
commands via single keystrokes.
@end deffn

@deffn {Interactive Command} emacspeak-w3-curl-url-under-point ()
Display contents of URL under point using Curl and W3.  The
document is displayed in a separate buffer. 
@end deffn

@deffn {Interactive Command} emacspeak-w3-customize-base-uri-pronunciation ()
Defines custom buffer local pronunciation for base URI.
@end deffn

@deffn {Interactive Command} emacspeak-w3-do-onclick ()
Do  onclick action.
@end deffn

@deffn {Interactive Command} emacspeak-w3-javascript-follow-link ()
Follow URL hidden inside a javascript link
@end deffn

@deffn {Interactive Command} emacspeak-w3-jump-to-submit ()
Jump to next available submit button.
@end deffn

@deffn {Interactive Command} emacspeak-w3-lynx-url-under-point ()
Display contents of URL under point using LYNX.  The
document is displayed in a separate buffer. Note that the
hyperlinks in that display are not active-- this facility is
present only to help me iron out the remaining problems with
the table structure extraction code in W3.
@end deffn

@deffn {Interactive Command} emacspeak-w3-next-block ()
Move by block level displays.
@end deffn

@deffn {Interactive Command} emacspeak-w3-next-doc-element (&optional COUNT)
Move forward  to the next document element.
Optional interactive prefix argument COUNT
specifies by how many eleemnts to move.
@end deffn

@deffn {Interactive Command} emacspeak-w3-next-parsed-item ()
Move to and speak next parsed item.
@end deffn

@deffn {Interactive Command} emacspeak-w3-previous-doc-element (&optional COUNT)
Move back  to the previous document element.
Optional interactive prefix argument COUNT
specifies by how many eleemnts to move.
@end deffn

@deffn {Interactive Command} emacspeak-w3-show-anchor-class ()
Display any class attributes set on corresponding anchor
element. 
@end deffn

@deffn {Interactive Command} emacspeak-w3-show-http-headers ()
Show HTTP headers using lwp-request
@end deffn

@deffn {Interactive Command} emacspeak-w3-speak-next-block ()
Move to next block and speak it.
@end deffn

@deffn {Interactive Command} emacspeak-w3-speak-next-element ()
Speak next document element.
@end deffn

@deffn {Interactive Command} emacspeak-w3-speak-this-element ()
Speak document element under point.
@end deffn

@deffn {Interactive Command} emacspeak-w3-toggle-table-borders ()
Toggle drawing of W3 table borders
@end deffn

@node emacspeak-w3m
@section emacspeak-w3m

Commentary:



Automatically generated documentation
for commands defined in module  emacspeak-w3m.

@deffn {Interactive Command} emacspeak-m-player (RESOURCE &optional PLAY-LIST NOSELECT)
Play specified resource using m-player.
Optional prefix argument play-list interprets resource as a play-list.
Resource is a media resource or playlist containing media resources.
The player is placed in a buffer in emacspeak-m-player-mode.
@end deffn

@deffn {Interactive Command} emacspeak-w3m-preview-this-buffer ()
Preview this buffer in w3m.
@end deffn

@node emacspeak-we
@section emacspeak-we

Commentary:
we is for webedit
Invoke XSLT to edit/transform Web pages before they get
rendered.
we makes emacspeak's webedit layer independent of a given
Emacs web browser like W3 or W3M
This module will use the abstraction provided by browse-url
to handle Web pages.
Module emacspeak-webutils provides the needed additional
abstractions not already covered by browse-url

Automatically generated documentation
for commands defined in module  emacspeak-we.

@deffn {Interactive Command} emacspeak-we-class-filter-and-follow (CLASS URL)
Follow url and point, and filter the result by specified class.
Class can be set locally for a buffer, and overridden with an
interactive prefix arg. If there is a known rewrite url rule, that is
used as well.
@end deffn

@deffn {Interactive Command} emacspeak-we-count-matches (URL LOCATOR)
Count matches for locator  in Web page.
@end deffn

@deffn {Interactive Command} emacspeak-we-count-nested-tables (URL)
Count nested tables in Web page.
@end deffn

@deffn {Interactive Command} emacspeak-we-count-tables (URL)
Count  tables in Web page.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-by-class (CLASS URL &optional SPEAK)
Extract elements having specified class attribute from HTML. Extracts
specified elements from current WWW page and displays it in a separate
buffer. Interactive use provides list of class values as completion.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-by-class-list (CLASSES URL &optional SPEAK)
Extract elements having class specified in list `classes' from HTML.
Extracts specified elements from current WWW page and displays it
in a separate buffer.  Interactive use provides list of class
values as completion. 
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-by-id (ID URL &optional SPEAK)
Extract elements having specified id attribute from HTML. Extracts
specified elements from current WWW page and displays it in a separate
buffer.
Interactive use provides list of id values as completion.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-by-id-list (IDS URL &optional SPEAK)
Extract elements having id specified in list `ids' from HTML.
Extracts specified elements from current WWW page and displays it in a
separate buffer. Interactive use provides list of id values as completion. 
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-matching-urls (PATTERN URL &optional SPEAK)
Extracts links whose URL matches pattern.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-media-streams (URL &optional SPEAK)
Extract links to media streams.
operate on current web page when in a browser buffer; otherwise
 prompt for url.  Optional arg `speak' specifies if the result
 should be spoken automatically.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-media-streams-under-point ()
In browser buffers, extract media streams from url under point.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-nested-table (INDEX URL &optional SPEAK)
Extract nested table specified by `table-index'. Default is to
operate on current web page when in a browser buffer; otherwise
prompt for URL. Optional arg `speak' specifies if the result should be
spoken automatically.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-nested-table-list (TABLES URL &optional SPEAK)
Extract specified list of tables from a Web page.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-print-streams (URL &optional SPEAK)
Extract links to printable  streams.
operate on current web page when in a browser buffer; otherwise
 prompt for url.  Optional arg `speak' specifies if the result
 should be spoken automatically.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-table-by-match (MATCH URL &optional SPEAK)
Extract table containing  specified match.
 Optional arg url specifies the page to extract content from.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-table-by-position (POSITION URL &optional SPEAK)
Extract table at specified position.
Default is to extract from current page.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-tables-by-match-list (MATCH-LIST URL &optional SPEAK)
Extract specified  tables from a WWW page.
Tables are specified by containing  match pattern
 found in the match list.
@end deffn

@deffn {Interactive Command} emacspeak-we-extract-tables-by-position-list (POSITIONS URL &optional SPEAK)
Extract specified list of nested tables from a WWW page.
Tables are specified by their position in the list
 of nested tables found in the page.
@end deffn

@deffn {Interactive Command} emacspeak-we-follow-and-filter-by-id (ID)
Follow url and point, and filter the result by specified id.
Id can be set locally for a buffer, and overridden with an
interactive prefix arg. If there is a known rewrite url rule, that is
used as well.
@end deffn

@deffn {Interactive Command} emacspeak-we-junk-by-class-list (CLASSES URL &optional SPEAK)
Junk elements having class specified in list `classes' from HTML.
Extracts specified elements from current WWW page and displays it in a
separate buffer.
 Interactive use provides list of class values as
completion. 
@end deffn

@deffn {Interactive Command} emacspeak-we-style-filter (STYLE URL &optional SPEAK)
Extract elements matching specified style
from HTML.  Extracts specified elements from current WWW
page and displays it in a separate buffer.  Optional arg url
specifies the page to extract contents  from.
@end deffn

@deffn {Interactive Command} emacspeak-we-toggle-xsl-keep-result ()
Toggle xsl keep result flag.
@end deffn

@deffn {Interactive Command} emacspeak-we-url-expand-and-execute ()
Applies buffer-specific URL expander/executor function.
@end deffn

@deffn {Interactive Command} emacspeak-we-url-rewrite-and-follow (&optional PROMPT)
Apply a url rewrite rule as specified in the current buffer
before following link under point.  If no rewrite rule is
defined, first prompt for one.  Rewrite rules are of the
form `(from to)' where from and to are strings.  Typically, the
rewrite rule is automatically set up by Emacspeak tools like
websearch where a rewrite rule is known.  Rewrite rules are
useful in jumping directly to the printer friendly version of an
article for example.  Optional interactive prefix arg prompts for
a rewrite rule even if one is already defined.
@end deffn

@deffn {Interactive Command} emacspeak-we-xpath-filter-and-follow (&optional PROMPT)
Follow url and point, and filter the result by specified xpath.
XPath can be set locally for a buffer, and overridden with an
interactive prefix arg. If there is a known rewrite url rule, that is
used as well.
@end deffn

@deffn {Interactive Command} emacspeak-we-xpath-junk-and-follow (&optional PROMPT)
Follow url and point, and filter the result by junking
elements specified by xpath.
XPath can be set locally for a buffer, and overridden with an
interactive prefix arg. If there is a known rewrite url rule, that is
used as well.
@end deffn

@deffn {Interactive Command} emacspeak-we-xsl-toggle ()
Toggle  application of XSL transformations.
@end deffn

@deffn {Interactive Command} emacspeak-we-xslt-apply (XSL)
Apply specified transformation to current Web page.
@end deffn

@deffn {Interactive Command} emacspeak-we-xslt-filter (PATH URL &optional SPEAK)
Extract elements matching specified XPath path locator
from Web page -- default is the current page being viewed.
@end deffn

@deffn {Interactive Command} emacspeak-we-xslt-junk (PATH URL &optional SPEAK)
Junk elements matching specified locator.
@end deffn

@deffn {Interactive Command} emacspeak-we-xslt-select (XSL)
Select XSL transformation applied to Web pages before they are displayed .
@end deffn

@node emacspeak-websearch
@section emacspeak-websearch

Commentary:
This module provides utility functions for searching the WWW

Automatically generated documentation
for commands defined in module  emacspeak-websearch.

@deffn {Interactive Command} emacspeak-websearch-accessible-google (QUERY)
Google Accessible Search -- see http://labs.google.com/accessible
@end deffn

@deffn {Interactive Command} emacspeak-websearch-alltheweb-search (QUERY)
Perform an AllTheWeb  search.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-altavista-search (QUERY)
Perform an Altavista search
@end deffn

@deffn {Interactive Command} emacspeak-websearch-amazon-search ()
Amazon search.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-ask-jeeves (QUERY)
Ask Jeeves for the answer.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-bbc-search (QUERY)
Search BBC archives.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-biblio-search (QUERY)
Search Computer Science Bibliographies.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-blinkx-search (QUERY)
BlinkX RSS Generator.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-britannica-search (QUERY)
Search Encyclopedia Britannica.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-citeseer-search (TERM)
Perform a CiteSeer search. 
@end deffn

@deffn {Interactive Command} emacspeak-websearch-company-news (TICKER &optional PREFIX)
Perform an company news lookup.
Retrieves company news, research, profile, insider trades,  or upgrades/downgrades.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-cpan-search (QUERY)
Search CPAN  Comprehensive Perl Archive Network   Site. 
@end deffn

@deffn {Interactive Command} emacspeak-websearch-ctan-search (QUERY)
Search CTAN Comprehensive TeX Archive Network   Site. 
@end deffn

@deffn {Interactive Command} emacspeak-websearch-dictionary-hypertext-webster-search (QUERY)
Search the Webster Dictionary.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-dispatch (&optional PREFIX)
@kbd{ control e ? }

Launches specific websearch queries.
Press `?' to list available search engines.
Once selected, the selected searcher prompts for additional information as appropriate.
When using supported browsers,  this interface attempts to speak the most relevant information on the result page.
@end deffn

@deffn {Interactive Command} emacspeak-websearch-display-form (FORM-MARKUP)
Display form specified by form-markup.
@end deffn

@def