Next: , Previous: , Up: Emacspeak Commands And Options   [Contents][Index]


12.175 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.175.1 emacspeak-speak Commands

12.175.1.1 emacspeak–choose-completion

Command: emacspeak--choose-completion
Choose the completion at point.

12.175.1.2 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)

12.175.1.3 emacspeak-blink-matching-open

Command: emacspeak-blink-matching-open
        Move cursor momentarily to the beginning of the sexp before point.
Also display match context in minibuffer.

12.175.1.4 emacspeak-completion-pick-completion

Command: emacspeak-completion-pick-completion
        Pick completion and return safely where we came from.

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

12.175.1.6 emacspeak-dial-dtk

Command: emacspeak-dial-dtk (number)
        Prompt for and dial a phone NUMBER with the Dectalk.

(fn NUMBER)

12.175.1.7 emacspeak-execute-repeatedly

Command: emacspeak-execute-repeatedly (command)
Execute COMMAND repeatedly.

(fn COMMAND)

12.175.1.8 emacspeak-goto-percent

Command: emacspeak-goto-percent (percent)
C-e M-%
<fn> 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)

12.175.1.9 emacspeak-launch-application

Command: emacspeak-launch-application (command)
C-&
Launch an application.
This command  is designed for use in a windowing environment like X.

(fn COMMAND)

12.175.1.10 emacspeak-mark-backward-mark

Command: emacspeak-mark-backward-mark
<C-up>
Cycle backward through the mark ring.

12.175.1.11 emacspeak-minibuffer-choose-completion

Command: emacspeak-minibuffer-choose-completion
Choose current completion.

12.175.1.12 emacspeak-minibuffer-next-completion

Command: emacspeak-minibuffer-next-completion
        Move to next available minibuffer completion.

12.175.1.13 emacspeak-minibuffer-previous-completion

Command: emacspeak-minibuffer-previous-completion
        Move to previous available minibuffer completion.

12.175.1.14 emacspeak-open-info

Command: emacspeak-open-info
C-e TAB
<fn> TAB
Open Emacspeak Info Manual.

12.175.1.15 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)

12.175.1.16 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)

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

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

12.175.1.19 emacspeak-owindow-speak-line

Command: emacspeak-owindow-speak-line
ESC <select>
        Speak the current line in the other window.

12.175.1.20 emacspeak-read-next-line

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

(fn &optional ARG)

12.175.1.21 emacspeak-read-next-word

Command: emacspeak-read-next-word (&optional arg)
        Read next word, specified as a numeric  arg, without moving.
Default is to read the next word. 

(fn &optional ARG)

12.175.1.22 emacspeak-read-previous-line

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

(fn &optional ARG)

12.175.1.23 emacspeak-read-previous-word

Command: emacspeak-read-previous-word (&optional arg)
        Read previous word, specified as a prefix arg, without moving.
Default is to read the previous word. 

(fn &optional ARG)

12.175.1.24 emacspeak-search

Command: emacspeak-search
<search>
Call search defined in <search>.

12.175.1.25 emacspeak-shell-command

Command: emacspeak-shell-command (command)
C-e $
<fn> $
        Run shell command COMMANDAND speak its output.

(fn COMMAND)

12.175.1.26 emacspeak-silence

Command: emacspeak-silence
<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.

12.175.1.27 emacspeak-speak-and-skip-extent-upto-char

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.

(fn CHAR)

12.175.1.28 emacspeak-speak-and-skip-extent-upto-this-char

Command: emacspeak-speak-and-skip-extent-upto-this-char
        Speak extent delimited by point and last character typed.

12.175.1.29 emacspeak-speak-browse-buffer-by-style

Command: emacspeak-speak-browse-buffer-by-style (&optional browse)
Browse current buffer by style.
Default is to speak chunk having current style.
Interactive prefix arg ‘browse’  repeatedly browses  through
  chunks having same style as the current text chunk.

(fn &optional BROWSE)

12.175.1.30 emacspeak-speak-buffer

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

(fn &optional ARG)

12.175.1.31 emacspeak-speak-buffer-filename

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

12.175.1.32 emacspeak-speak-buffer-interactively

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

12.175.1.33 emacspeak-speak-char

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

(fn &optional PREFIX)

12.175.1.34 emacspeak-speak-char-name

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

(fn CHAR)

12.175.1.35 emacspeak-speak-completions-if-available

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

12.175.1.36 emacspeak-speak-continuously

Command: emacspeak-speak-continuously
C-e RET
<fn> RET
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.

12.175.1.37 emacspeak-speak-current-column

Command: emacspeak-speak-current-column
C-e =
<fn> =
Speak the current column.

12.175.1.38 emacspeak-speak-current-field

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

12.175.1.39 emacspeak-speak-current-kill

Command: emacspeak-speak-current-kill (&optional count)
C-e k
<fn> k
Speak the current kill entry.
This is the text that will be yanked in
by the next <S-insertchar>. Prefix numeric arg, COUNT, specifies that the
text that will be yanked as a result of a <S-insertchar> 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)

12.175.1.40 emacspeak-speak-current-mark

Command: emacspeak-speak-current-mark (count)
C-e C-SPC
C-e C-@
<fn> C-SPC
<fn> C-@
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.

(fn COUNT)

12.175.1.41 emacspeak-speak-current-percentage

Command: emacspeak-speak-current-percentage
C-e %
<fn> %
        Announce the percentage into the current buffer.

12.175.1.42 emacspeak-speak-current-window

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

12.175.1.43 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)

12.175.1.44 emacspeak-speak-display-char

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.

(fn &optional PREFIX)

12.175.1.45 emacspeak-speak-face-interval-and-move

Command: emacspeak-speak-face-interval-and-move
        Speaks region delimited by text in current face, and moves past the chunk.

12.175.1.46 emacspeak-speak-front-of-buffer

Command: emacspeak-speak-front-of-buffer
        Speak   the buffer from start to   point

12.175.1.47 emacspeak-speak-header-line

Command: emacspeak-speak-header-line
C-e SPC
<fn> SPC
Speak header line if set.

12.175.1.48 emacspeak-speak-help

Command: emacspeak-speak-help (&optional arg)
C-e h
<fn> 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.

(fn &optional ARG)

12.175.1.49 emacspeak-speak-help-interactively

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.

12.175.1.50 emacspeak-speak-hostname

Command: emacspeak-speak-hostname
C-e M-h
<fn> M-h
Speak host name.

12.175.1.51 emacspeak-speak-line

Command: emacspeak-speak-line (&optional arg)
C-e l
<fn> 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 or a spoken message if audio indentation is in
use 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 turned 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 ‘more’.  These can then be spoken using command
C-e C-M-l.

(fn &optional ARG)

12.175.1.52 emacspeak-speak-line-interactively

Command: emacspeak-speak-line-interactively
C-e L
<fn> 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.

12.175.1.53 emacspeak-speak-line-number

Command: emacspeak-speak-line-number
C-e C-l
<fn> C-l
        Print the current buffer line number and narrowed line number of point.

12.175.1.54 emacspeak-speak-line-set-column-filter

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

12.175.1.55 emacspeak-speak-load-directory-settings

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.

(fn &optional DIRECTORY)

12.175.1.56 emacspeak-speak-message-again

Command: emacspeak-speak-message-again (&optional from-message-cache)
C-e a
<fn> a
        Speak the last message from Emacs once again.
The message is also placed in the kill ring for convenient yanking
if ‘emacspeak-speak-message-again-should-copy-to-kill-ring’ is set.

(fn &optional FROM-MESSAGE-CACHE)

12.175.1.57 emacspeak-speak-message-at-time

Command: emacspeak-speak-message-at-time (time message)
C-e @
<fn> @
        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.

(fn TIME MESSAGE)

12.175.1.58 emacspeak-speak-microseconds-since-epoch

Command: emacspeak-speak-microseconds-since-epoch (ms)
        Speaks time value specified as microseconds  since epoch, e.g. as from float-time.

(fn MS)

12.175.1.59 emacspeak-speak-milliseconds-since-epoch

Command: emacspeak-speak-milliseconds-since-epoch (ms)
        Speaks time value specified as milliseconds  since epoch, e.g. as from float-time.

(fn MS)

12.175.1.60 emacspeak-speak-minibuffer

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.

(fn &optional ARG)

12.175.1.61 emacspeak-speak-minor-mode-line

Command: emacspeak-speak-minor-mode-line (&optional copy-as-kill)
C-e M
<fn> M
Speak the minor mode-information.
Optional  interactive prefix arg ‘copy-as-kill’ copies spoken info to kill ring.

(fn &optional COPY-AS-KILL)

12.175.1.62 emacspeak-speak-mode-line

Command: emacspeak-speak-mode-line (&optional buffer-info)
C-e m
<fn> 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)

12.175.1.63 emacspeak-speak-next-face-chunk

Command: emacspeak-speak-next-face-chunk
        Moves to the front of next chunk having current style.
Speak that chunk after moving.

12.175.1.64 emacspeak-speak-next-field

Command: emacspeak-speak-next-field
C-e >
<fn> >
Move to and speak next field.

12.175.1.65 emacspeak-speak-next-personality-chunk

Command: emacspeak-speak-next-personality-chunk
        Moves to the front of next chunk having current personality.
Speak that chunk after moving.

12.175.1.66 emacspeak-speak-next-window

Command: emacspeak-speak-next-window
C-e C-n
<fn> C-n
Speak the next window.

12.175.1.67 emacspeak-speak-other-buffer

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

(fn BUFFER)

12.175.1.68 emacspeak-speak-other-window

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.

(fn &optional ARG)

12.175.1.69 emacspeak-speak-overlay-properties

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

12.175.1.70 emacspeak-speak-page

Command: emacspeak-speak-page (&optional arg)
C-e [
<fn> [
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.

(fn &optional ARG)

12.175.1.71 emacspeak-speak-page-interactively

Command: emacspeak-speak-page-interactively
C-e ]
<fn> ]
        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.

12.175.1.72 emacspeak-speak-paragraph

Command: emacspeak-speak-paragraph (&optional arg)
C-e {
C-e p
<fn> {
<fn> p
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. 

(fn &optional ARG)

12.175.1.73 emacspeak-speak-paragraph-interactively

Command: emacspeak-speak-paragraph-interactively
C-e P
<fn> 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.

12.175.1.74 emacspeak-speak-preceding-char

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

12.175.1.75 emacspeak-speak-predefined-window

Command: emacspeak-speak-predefined-window (&optional arg)
C-e 9
C-e 8
C-e 7
C-e 6
C-e 5
C-e 4
C-e 3
C-e 2
C-e 1
C-e 0
<fn> 9
<fn> 8
<fn> 7
<fn> 6
<fn> 5
<fn> 4
<fn> 3
<fn> 2
<fn> 1
<fn> 0
        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’.

(fn &optional ARG)

12.175.1.76 emacspeak-speak-previous-face-chunk

Command: emacspeak-speak-previous-face-chunk
        Moves to the front of previous chunk having current face.
Speak that chunk after moving.

12.175.1.77 emacspeak-speak-previous-field

Command: emacspeak-speak-previous-field
C-e <
<fn> <
Move to previous field and speak it.

12.175.1.78 emacspeak-speak-previous-personality-chunk

Command: emacspeak-speak-previous-personality-chunk
        Moves to the front of previous chunk having current personality.
Speak that chunk after moving.

12.175.1.79 emacspeak-speak-previous-window

Command: emacspeak-speak-previous-window
C-e C-p
<fn> C-p
Speak the previous window.

12.175.1.80 emacspeak-speak-rectangle

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

12.175.1.81 emacspeak-speak-region

Command: emacspeak-speak-region (start end)
C-e r
<fn> r
Speak region.
Argument START  and END specify region to speak.

(fn START END)

12.175.1.82 emacspeak-speak-rest-of-buffer

Command: emacspeak-speak-rest-of-buffer
C-e n
<fn> n
        Speak remainder of the buffer starting at point

12.175.1.83 emacspeak-speak-run-shell-command

Command: emacspeak-speak-run-shell-command (command &optional read-as-csv)
C-e !
<fn> !
        Invoke shell COMMAND and display its output as a table. The
results are placed in a buffer in Emacspeak’s table browsing
mode. Optional interactive prefix arg read-as-csv interprets the
result as csv. . Use this for running shell commands that produce
tabulated output. This command should be used for shell commands
that produce tabulated output that works with Emacspeak’s table
recognizer. Verify this first by running the command in a shell
and executing command ‘emacspeak-table-display-table-in-region’
normally bound to C-e M-i.

(fn COMMAND &optional READ-AS-CSV)

12.175.1.84 emacspeak-speak-seconds-since-epoch

Command: emacspeak-speak-seconds-since-epoch (seconds)
        Speaks time value specified as seconds  since epoch, e.g. as from float-time.

(fn SECONDS)

12.175.1.85 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)

12.175.1.86 emacspeak-speak-set-display-table

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.

(fn &optional PREFIX)

12.175.1.87 emacspeak-speak-set-mode-punctuations

Command: emacspeak-speak-set-mode-punctuations (setting)
C-e d m
<fn> d m
        Set punctuation mode for all buffers in current mode.

(fn SETTING)

12.175.1.88 emacspeak-speak-sexp

Command: emacspeak-speak-sexp (&optional arg)
C-e '
<fn> '
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)

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

12.175.1.90 emacspeak-speak-show-active-network-interfaces

Command: emacspeak-speak-show-active-network-interfaces (&optional address)
C-e I
<fn> I
        Shows all active network interfaces in the echo area.
With interactive prefix argument ADDRESS it prompts for a
specific interface and shows its address. The address is
also copied to the kill ring for convenient yanking.

(fn &optional ADDRESS)

12.175.1.91 emacspeak-speak-skim-buffer

Command: emacspeak-speak-skim-buffer
C-e ,
<fn> ,
        Skim the current buffer  a paragraph at a time.

12.175.1.92 emacspeak-speak-spaces-at-point

Command: emacspeak-speak-spaces-at-point
C-e C-M-SPC
C-e C-M-@
<fn> C-M-SPC
<fn> C-M-@
Speak the white space at point.

12.175.1.93 emacspeak-speak-spell-current-word

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

12.175.1.94 emacspeak-speak-text-range

Command: emacspeak-speak-text-range (property)
        Speak text range identified by this PROPERTY.

(fn PROPERTY)

12.175.1.95 emacspeak-speak-this-face-chunk

Command: emacspeak-speak-this-face-chunk
        Speak chunk of text around point that has current face.

12.175.1.96 emacspeak-speak-this-personality-chunk

Command: emacspeak-speak-this-personality-chunk
        Speak chunk of text around point that has current
personality.

12.175.1.97 emacspeak-speak-time

Command: emacspeak-speak-time (&optional world)
C-e t
<fn> 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.

(fn &optional WORLD)

12.175.1.98 emacspeak-speak-version

Command: emacspeak-speak-version (&optional speak-rev)
C-e V
<fn> V
        Announce version information for running emacspeak.
Optional interactive prefix arg ‘speak-rev’ speaks only the Git revision number.

(fn &optional SPEAK-REV)

12.175.1.99 emacspeak-speak-visual-line

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

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

12.175.1.101 emacspeak-speak-which-function

Command: emacspeak-speak-which-function
C-e M-w
<fn> M-w
        Speak which function we are on.  Uses which-function from
which-func without turning that mode on.  We actually use
semantic to do the work.

12.175.1.102 emacspeak-speak-window-information

Command: emacspeak-speak-window-information
C-e C-w
<fn> C-w
        Speaks information about current window.

12.175.1.103 emacspeak-speak-word

Command: emacspeak-speak-word (&optional arg)
C-e w
<fn> 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)

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

12.175.1.105 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)

12.175.1.106 emacspeak-switch-to-reference-buffer

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

12.175.1.107 emacspeak-toggle-action-mode

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.

12.175.1.108 emacspeak-toggle-audio-indentation

Command: emacspeak-toggle-audio-indentation (&optional prefix)
C-e d i
<fn> 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.

12.175.1.109 emacspeak-toggle-character-echo

Command: emacspeak-toggle-character-echo (&optional prefix)
C-e d k
<fn> 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.

12.175.1.110 emacspeak-toggle-comint-autospeak

Command: emacspeak-toggle-comint-autospeak (&optional prefix)
        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.

12.175.1.111 emacspeak-toggle-comint-output-monitor

Command: emacspeak-toggle-comint-output-monitor (&optional prefix)
C-e o
<fn> 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.

12.175.1.112 emacspeak-toggle-header-line

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

12.175.1.113 emacspeak-toggle-inaudible-or-comint-autospeak

Command: emacspeak-toggle-inaudible-or-comint-autospeak
C-e C-q
<fn> C-q
        Toggle comint-autospeak when in a comint buffer.
Otherwise call voice-setup-toggle-silence-personality which toggles the
personality under point.

12.175.1.114 emacspeak-toggle-line-echo

Command: emacspeak-toggle-line-echo (&optional prefix)
C-e d l
<fn> 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.

12.175.1.115 emacspeak-toggle-mail-alert

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

12.175.1.116 emacspeak-toggle-show-point

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

12.175.1.117 emacspeak-toggle-speak-line-invert-filter

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

12.175.1.118 emacspeak-toggle-speak-messages

Command: emacspeak-toggle-speak-messages (&optional prefix)
C-e q
<fn> q
        Toggle the state of whether emacspeak echoes messages.

12.175.1.119 emacspeak-toggle-word-echo

Command: emacspeak-toggle-word-echo (&optional prefix)
C-e d w
<fn> 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.

12.175.1.120 emacspeak-use-customized-blink-paren

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.

12.175.1.121 emacspeak-view-notifications

Command: emacspeak-view-notifications
C-h T
<f1> T
<help> T
Display notifications.

12.175.1.122 emacspeak-voiceify-rectangle

Command: emacspeak-voiceify-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.

(fn START END &optional PERSONALITY)

12.175.1.123 emacspeak-voiceify-region

Command: emacspeak-voiceify-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.

(fn START END &optional PERSONALITY)

12.175.1.124 emacspeak-zap-tts

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

12.175.2 emacspeak-speak Options

Variable: User Option emacspeak-audio-indentation

Option indicating if line indentation is cued. If non-nil , then speaking a line indicates its indentation. You can use command ‘emacspeak-toggle-audio-indentation’ bound to C-e d i to toggle this setting..

Variable: User Option emacspeak-audio-indentation-method

Current technique used to cue indentation. Default is ‘speak’. You can specify ‘tone’ for producing a beep indicating the indentation. Automatically becomes local in any buffer where it is set.

Variable: User Option emacspeak-character-echo

If t, then emacspeak echoes characters as you type. You can use C-e d k to toggle this setting.

Variable: User Option emacspeak-comint-autospeak

Says if comint output is automatically spoken. You can use ‘emacspeak-toggle-comint-autospeak‘ bound to M-x emacspeak-toggle-comint-autospeak to toggle this setting.

Variable: User Option emacspeak-line-echo

If t, then emacspeak echoes lines as you type. You can use C-e d l to set this option.

Variable: User Option emacspeak-mail-alert

Option to indicate cueing of new mail. If t, emacspeak will alert you about newly arrived mail with an auditory icon when displaying the mode line. You can use command ‘emacspeak-toggle-mail-alert’ bound to C-e M-m to set this option. If you have online access to a voicemail drop, you can have a voice-mail alert set up by specifying the location of the voice-mail drop via custom option emacspeak-voicemail-spool-file.

Variable: User Option emacspeak-mail-alert-interval

Interval in seconds between mail alerts for the same pending message.

Variable: User Option emacspeak-mail-spool-file

Mail spool file examined to alert you about newly arrived mail.

Variable: User Option emacspeak-search

Default search engine.

Variable: User Option emacspeak-silence-hook

Functions run after emacspeak-silence is called.

Variable: User Option emacspeak-speak-default-os-coding-system

List of coding systems on this platform.

Variable: User Option emacspeak-speak-directory-settings

Name of file that holds directory specific settings.

Variable: User Option emacspeak-speak-embedded-url-pattern

Pattern to recognize embedded URLs.

Variable: User Option emacspeak-speak-filter-persistent-store

File where emacspeak filters are persisted.

Variable: User Option emacspeak-speak-line-column-filter

List that specifies columns to be filtered. The list when set holds pairs of start-col.end-col pairs that specifies the columns that should not be spoken. Each column contains a single character –this is inspired by cut -c on UNIX.

Variable: User Option emacspeak-speak-load-directory-settings-quietly

User option that affects loading of directory specific settings. If set to T,Emacspeak will not prompt before loading directory specific settings.

Variable: User Option emacspeak-speak-maximum-line-length

Threshold for determining ‘long’ lines. Emacspeak will ask for confirmation before speaking lines that are longer than this length. This is to avoid accidentally opening a binary file and torturing the speech synthesizer with a long string of gibberish.

Variable: User Option emacspeak-speak-messages

Option indicating if messages are spoken. If nil, emacspeak will not speak messages as they are echoed to the message area. You can use command ‘emacspeak-toggle-speak-messages’ bound to C-e q.

Variable: User Option emacspeak-speak-paragraph-personality

Personality used to mark start of paragraph.

Variable: User Option emacspeak-speak-time-format-string

Format string that specifies how the time should be spoken. See the documentation for function ‘format-time-string’

Variable: User Option emacspeak-speak-zoneinfo-directory

Directory containing timezone data.

Variable: User Option emacspeak-use-header-line

Use default header line defined by Emacspeak for buffers that dont customize the header.

Variable: User Option emacspeak-voicemail-spool-file

Mail spool file examined to alert you about newly arrived voicemail.

Variable: User Option emacspeak-word-echo

If t, then emacspeak echoes words as you type. You can use C-e d w to toggle this option.


Next: , Previous: , Up: Emacspeak Commands And Options   [Contents][Index]