12.179 emacspeak-speak

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

12.179.1 Emacspeak-Speak Commands emacspeak–persist-variable

Command: emacspeak--persist-variable (var file)
Persist variable  ‘var’ to file ‘FILE’.
Arranges for ‘VAR’ to be restored when ‘file’ is loaded.

(fn VAR FILE) emacspeak-beginning-or-end

Command: emacspeak-beginning-or-end
Move to start or end of buffer. emacspeak-buffer-select

Command: emacspeak-buffer-select
C-e p
C-e n
C-e .
C-e ,
Select buffer by smart cycling.
Use option emacspeak-buffer-select-help to customize interactive feedback.
By default, this command is bound to multiple keys.
The final key of the initial  key-sequence, and  further invocations
of the keys below call the following bindings:

, previous-buffer
. next-buffer
b switch-to-buffer
f find-file
k emacspeak-kill-buffer-quietly
n emacspeak-cycle-to-next-buffer
o other-window
p emacspeak-cycle-to-previous-buffer emacspeak-completions-move-to-completion-group

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. emacspeak-cycle-to-next-buffer

Command: emacspeak-cycle-to-next-buffer
Cycles to next buffer having same mode. emacspeak-cycle-to-previous-buffer

Command: emacspeak-cycle-to-previous-buffer
Cycles to previous buffer having same mode. emacspeak-describe-tapestry

Command: emacspeak-describe-tapestry (&optional details)
C-e M-t
Describe the current layout of visible buffers in current frame.
Use interactive prefix arg to get coordinate positions of the
displayed buffers.

(fn &optional DETAILS) emacspeak-goto-percent

Command: emacspeak-goto-percent (percent)
C-e M-%
Move to end  PERCENT of buffer like in View mode.
Display is centered at point.
Also set the mark at the position where point was.

(fn PERCENT) emacspeak-mark-backward-mark

Command: emacspeak-mark-backward-mark
Cycle backward through the mark ring.
To cycle forward, use pop-to-mark-command bound to M-x pop-to-mark-command emacspeak-open-info

Command: emacspeak-open-info
Open Emacspeak Info Manual. emacspeak-owindow-next-line

Command: emacspeak-owindow-next-line (count)
ESC <down>
Move to the next line in the other window and speak it.
Numeric prefix arg COUNT can specify number of lines to move.

(fn COUNT) emacspeak-owindow-previous-line

Command: emacspeak-owindow-previous-line (count)
ESC <up>
Move to the next line in the other window and speak it.
Numeric prefix arg COUNT specifies number of lines to move.

(fn COUNT) emacspeak-owindow-scroll-down

Command: emacspeak-owindow-scroll-down
ESC <prior>
Scroll down  the window that command ‘other-window’ would move to.
Speak the window contents after scrolling. emacspeak-owindow-scroll-up

Command: emacspeak-owindow-scroll-up
ESC <next>
Scroll up the window that command ‘other-window’ would move to.
Speak the window contents after scrolling. emacspeak-owindow-speak-line

Command: emacspeak-owindow-speak-line
Speak the current line in the other window. emacspeak-read-next-line

Command: emacspeak-read-next-line (&optional arg)
C-e <down>
Read next line, specified by an offset, without moving.
Default is to read the next line. 

(fn &optional ARG) emacspeak-read-previous-line

Command: emacspeak-read-previous-line (&optional arg)
C-e <up>
Read previous line, specified by an offset, without moving.
Default is to read the previous line. 

(fn &optional ARG) emacspeak-select-window-by-name

Command: emacspeak-select-window-by-name (buffer-name)
C-e 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.

(fn BUFFER-NAME) emacspeak-selective-display

Command: emacspeak-selective-display (&optional arg)
C-e C-c
Continuously adjust selective-display.
Use ‘,’ and ‘.’ to continuously decrease/increase ‘selective-display’.
 If not specified, ‘arg’ defaults to current-column.

(fn &optional ARG) emacspeak-shell-command

Command: emacspeak-shell-command (command)
Run shell command COMMANDAND speak its output.

(fn COMMAND) emacspeak-silence

Command: emacspeak-silence
Silence is golden. Stop speech, and pause/resume any media
streams. Runs ‘emacspeak-silence-hook’ which can be used to
configure which media players get silenced or paused/resumed. emacspeak-speak-brief-time

Command: emacspeak-speak-brief-time
C-e <fn>
Time in brief emacspeak-speak-buffer

Command: emacspeak-speak-buffer (&optional arg)
C-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. 

(fn &optional ARG) emacspeak-speak-buffer-filename

Command: emacspeak-speak-buffer-filename (&optional filename)
C-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.

(fn &optional FILENAME) emacspeak-speak-buffer-interactively

Command: emacspeak-speak-buffer-interactively
C-e 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. emacspeak-speak-char

Command: emacspeak-speak-char (&optional prefix)
C-e c
Speak character under point.
Pronounces character phonetically unless  called with a PREFIX arg.

(fn &optional PREFIX) emacspeak-speak-char-name

Command: emacspeak-speak-char-name (char)
tell me what this is

(fn CHAR) emacspeak-speak-completions-if-available

Command: emacspeak-speak-completions-if-available
Speak completions if available. emacspeak-speak-continuously

Command: emacspeak-speak-continuously
C-e C-<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.  Pressing SPC  continues to speak the buffer; any other
  key quits. emacspeak-speak-current-column

Command: emacspeak-speak-current-column
C-e =
Speak the current column. emacspeak-speak-current-kill

Command: emacspeak-speak-current-kill (&optional count)
C-e k
Speak the current kill.
This is what will be yanked by the next <paste>. Prefix numeric
arg, COUNT, specifies that the text that will be yanked as a
result of a <paste> followed by count-1 M-x yank-pop be
spoken. The kill number that is spoken says what numeric prefix
arg to give to command yank.

(fn &optional COUNT) emacspeak-speak-current-mark

Command: emacspeak-speak-current-mark (count)
C-e C-@
Speak the line containing the mark.
With no argument, speaks the line containing the mark–this is
where 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. 

(fn COUNT) emacspeak-speak-current-percentage

Command: emacspeak-speak-current-percentage
C-e %
Announce the percentage into the current buffer. emacspeak-speak-current-window

Command: emacspeak-speak-current-window
Speak contents of current window.
Speaks entire window irrespective of point. emacspeak-speak-date-as-seconds

Command: emacspeak-speak-date-as-seconds (time)
Read time value as a human-readable string, return seconds.
Seconds value is also placed in the kill-ring.

(fn TIME) emacspeak-speak-extent

Command: emacspeak-speak-extent (beg end &optional no-case)
C-e M-r
Speak extent delimited by beg and end.
Match patterns beg and end define the extent; optional arg
  no-case determines if the match is case sensitive.  Point is
  left at the start of beg on success.

(fn BEG END &optional NO-CASE) emacspeak-speak-face-backward

Command: emacspeak-speak-face-backward
Property search for face at point see M-x text-property-search-backward emacspeak-speak-face-browse

Command: emacspeak-speak-face-browse
C-e C-.
Use C-f and C-b or left/right arrows to browse by current face. emacspeak-speak-face-forward

Command: emacspeak-speak-face-forward
Property search for face — see M-x text-property-search-forward emacspeak-speak-field

Command: emacspeak-speak-field
Speak current field. emacspeak-speak-header-line

Command: emacspeak-speak-header-line
C-e C-x
Speak header line if set. emacspeak-speak-help

Command: emacspeak-speak-help
C-e h
Speak help buffer if one present. emacspeak-speak-line

Command: emacspeak-speak-line (&optional arg)
C-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.  Indicates indentation with a spoken message if
audio indentation is on see ‘emacspeak-toggle-audio-indentation’
bound to C-e d i.  Indicates
position of point with an aural highlight if option
‘emacspeak-show-point’ is on –see command
‘emacspeak-toggle-show-point’ bound to
C-e C-d.  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. Presence of additional
presentational overlays (created via property display,
before-string, or after-string) is indicated with auditory icon
‘left’, ‘right’, or ‘more’ as appropriate.  These can then be
spoken using command C-e M-l.

(fn &optional ARG) emacspeak-speak-line-interactively

Command: emacspeak-speak-line-interactively
C-e 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. emacspeak-speak-line-set-column-filter

Command: emacspeak-speak-line-set-column-filter (filter)
C-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. 

(fn FILTER) emacspeak-speak-load-directory-settings

Command: emacspeak-speak-load-directory-settings (&optional dir)
C-e x d
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

(fn &optional DIR) emacspeak-speak-load-filter-settings

Command: emacspeak-speak-load-filter-settings
Load emacspeak filter settings. emacspeak-speak-matching-paren

Command: emacspeak-speak-matching-paren
Speak matched paren with context. emacspeak-speak-message-again

Command: emacspeak-speak-message-again (&optional from-message-cache)
C-e a
Speak the last message from Emacs once again.
The message is also placed in the kill ring for convenient yanking 

(fn &optional FROM-MESSAGE-CACHE) emacspeak-speak-message-at-time

Command: emacspeak-speak-message-at-time (time message)
C-e @
Speak message at specified time.
Provides simple stop watch functionality.
See documentation for command run-at-time for details on time-spec.

(fn TIME MESSAGE) emacspeak-speak-microseconds-since-epoch

Command: emacspeak-speak-microseconds-since-epoch (ms)
Speaks time value specified as microseconds  since epoch.

(fn MS) emacspeak-speak-milliseconds-since-epoch

Command: emacspeak-speak-milliseconds-since-epoch (ms)
Speaks time value specified as milliseconds  since epoch..

(fn MS) emacspeak-speak-minor-mode-line

Command: emacspeak-speak-minor-mode-line (&optional log-msg)
C-e M
Speak the minor mode-information.
Optional interactive prefix arg ‘log-msg’ logs spoken info to

(fn &optional LOG-MSG) emacspeak-speak-mode-line

Command: emacspeak-speak-mode-line (&optional buffer-info)
C-e m
Speak the mode-line.
Speaks header-line if that is set when called non-interactively.
Interactive prefix arg speaks buffer info.

(fn &optional BUFFER-INFO) emacspeak-speak-net-id

Command: emacspeak-speak-net-id
C-e `
Shows active network interfaces in the echo area.
 The address is also copied to the kill ring for convenient yanking. emacspeak-speak-next-field

Command: emacspeak-speak-next-field
Move to and speak next field. emacspeak-speak-other-buffer

Command: emacspeak-speak-other-buffer (buffer)
C-e M-b
Speak specified buffer.
Useful to listen to a buffer without switching  contexts.

(fn BUFFER) emacspeak-speak-other-window

Command: emacspeak-speak-other-window
C-e 2
Speak other window emacspeak-speak-overlay-properties

Command: emacspeak-speak-overlay-properties
C-e M-l
Speak display, before-string or after-string property if any. emacspeak-speak-page

Command: emacspeak-speak-page (&optional arg)
C-e ]
Speak a page.
With prefix ARG, speaks rest of current page.
Negative prefix arg will read from start of current page to point. 

(fn &optional ARG) emacspeak-speak-page-interactively

Command: emacspeak-speak-page-interactively
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. emacspeak-speak-paragraph

Command: emacspeak-speak-paragraph (&optional arg)
C-e [
Speak paragraph.
With prefix arg, speaks rest of current paragraph.
Negative prefix arg will read from start of current paragraph to point. 

(fn &optional ARG) emacspeak-speak-paragraph-interactively

Command: emacspeak-speak-paragraph-interactively
C-e 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. emacspeak-speak-persist-filter-settings

Command: emacspeak-speak-persist-filter-settings
Persist emacspeak filter settings for future sessions. emacspeak-speak-preceding-char

Command: emacspeak-speak-preceding-char
Speak character before point. emacspeak-speak-predefined-window

Command: emacspeak-speak-predefined-window (&optional arg)
Speak one of the first 10 windows on the screen, 0 is current window.
Speaks entire window irrespective of point.  Semantics of ‘other’
is the same as for the Emacs builtin ‘other-window’.

(fn &optional ARG) emacspeak-speak-previous-field

Command: emacspeak-speak-previous-field
Move to previous field and speak it. emacspeak-speak-range

Command: emacspeak-speak-range (&optional prop)
Speak and return  range at point

(fn &optional PROP) emacspeak-speak-rectangle

Command: emacspeak-speak-rectangle (start end)
C-e 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.

(fn START END) emacspeak-speak-region

Command: emacspeak-speak-region (start end)
C-e r
Speak region bounded by start and end. 

(fn START END) emacspeak-speak-rest-of-buffer

Command: emacspeak-speak-rest-of-buffer
C-e i
Speak remainder of the buffer starting at point emacspeak-speak-seconds-since-epoch

Command: emacspeak-speak-seconds-since-epoch (seconds)
Speaks time value specified as seconds  since epoch.

(fn SECONDS) emacspeak-speak-sentence

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.

(fn &optional ARG) emacspeak-speak-sexp

Command: emacspeak-speak-sexp (&optional arg)
Speak current sexp.
With prefix ARG, speaks the rest of the sexp  from point.
Negative prefix arg speaks from start of sexp to point. 

(fn &optional ARG) emacspeak-speak-sexp-interactively

Command: emacspeak-speak-sexp-interactively
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. emacspeak-speak-skim-buffer

Command: emacspeak-speak-skim-buffer
Skim the current buffer  a paragraph at a time. emacspeak-speak-spaces

Command: emacspeak-speak-spaces
C-e v SPC
Speak number of spaces at point. emacspeak-speak-spaces-at-point

Command: emacspeak-speak-spaces-at-point
Speak the white space at point. emacspeak-speak-spell-current-word

Command: emacspeak-speak-spell-current-word
Spell word at  point. emacspeak-speak-this-window

Command: emacspeak-speak-this-window
C-e 1
Speak current window. emacspeak-speak-time

Command: emacspeak-speak-time (&optional world)
C-e t
Speak the time.
Spoken time  is available via C-h N.
Optional interactive prefix arg ‘C-u’invokes world clock.
Timezone is specified using minibuffer completion.
Second interactive prefix sets clock to new timezone.

(fn &optional WORLD) emacspeak-speak-version

Command: emacspeak-speak-version
C-e V
Announce version information for running emacspeak. emacspeak-speak-visual-line

Command: emacspeak-speak-visual-line
Speaks current visual line.
Cues the start of a physical line with auditory icon ‘left’. emacspeak-speak-voice-annotate-paragraphs

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. emacspeak-speak-which-function

Command: emacspeak-speak-which-function
C-e M-w
Speak which function we are on.  Uses which-function from
which-func without turning that mode on. emacspeak-speak-window-information

Command: emacspeak-speak-window-information
C-e C-w
Speaks information about current window. emacspeak-speak-windowful

Command: emacspeak-speak-windowful
Delete other windows, Line to top, then Speak window contents. emacspeak-speak-word

Command: emacspeak-speak-word (&optional arg)
C-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
spelled out  instead of being spoken.

(fn &optional ARG) emacspeak-speak-word-interactively

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. emacspeak-speak-world-clock

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.

(fn ZONE &optional SET) emacspeak-submit-bug

Command: emacspeak-submit-bug
Function to submit a bug to the Emacspeak list emacspeak-switch-to-reference-buffer

Command: emacspeak-switch-to-reference-buffer
Switch back to buffer that generated completions. emacspeak-toggle-audio-indentation

Command: emacspeak-toggle-audio-indentation (&optional prefix)
C-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. emacspeak-toggle-character-echo

Command: emacspeak-toggle-character-echo (&optional prefix)
C-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. emacspeak-toggle-header-line

Command: emacspeak-toggle-header-line
Toggle Emacspeak’s default header line. emacspeak-toggle-line-echo

Command: emacspeak-toggle-line-echo (&optional prefix)
C-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. emacspeak-toggle-mail-alert

Command: emacspeak-toggle-mail-alert (&optional prefix)
C-e M-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. emacspeak-toggle-show-point

Command: emacspeak-toggle-show-point (&optional prefix)
C-e C-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. emacspeak-toggle-speak-line-invert-filter

Command: emacspeak-toggle-speak-line-invert-filter (&optional prefix)
C-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. emacspeak-toggle-speak-messages

Command: emacspeak-toggle-speak-messages (&optional prefix)
C-e C-M-q
Toggle  state of whether emacspeak echoes messages. emacspeak-toggle-word-echo

Command: emacspeak-toggle-word-echo (&optional prefix)
C-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. emacspeak-view-notifications

Command: emacspeak-view-notifications
C-h N
<f1> N
<help> N
Display notifications. emacspeak-zap-tts

Command: emacspeak-zap-tts
C-e d z
Send this command to the TTS directly.

12.179.2 emacspeak-speak Options

Variable: User Option emacspeak-buffer-select-help
String passed to speak help.
Set this to the empty string once you’ve learnt this command. 

Default Value:


Variable: User Option emacspeak-mail-alert-interval
Interval in seconds between mail alerts for the same pending

Default Value:


Variable: User Option emacspeak-mail-spool-file
Mail spool file examined  to alert you about newly
arrived mail.

Default Value:


Variable: User Option emacspeak-silence-hook
Functions run after emacspeak-silence is called.

Default Value:

(emacspeak-m-player-pause-or-resume emacspeak-emms-pause-or-resume)

Variable: User Option emacspeak-speak-time-brief-format
Format for time in brief.

Default Value:

"%l %M"

Variable: User Option emacspeak-speak-time-format
Format string that specifies how the time should be spoken.
See the documentation for function

Default Value:

"%l %M%p on %A %B %_e"