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


12.70 emacspeak-eterm

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.

12.70.1 emacspeak-eterm Commands

12.70.1.1 emacspeak-eterm-copy-region-to-register

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.

(fn REGISTER)

12.70.1.2 emacspeak-eterm-define-window

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.

(fn ID)

12.70.1.3 emacspeak-eterm-describe-window

Command: emacspeak-eterm-describe-window (id)
Describe an eterm  window.
Description indicates eterm window coordinates and whether it is stretchable

(fn ID)

12.70.1.4 emacspeak-eterm-goto-line

Command: emacspeak-eterm-goto-line (line)
Move emacspeak eterm pointer to a specified LINE.

(fn LINE)

12.70.1.5 emacspeak-eterm-kill-ring-save-region

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.

12.70.1.6 emacspeak-eterm-maybe-send-raw

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

12.70.1.7 emacspeak-eterm-paste-register

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.

(fn REGISTER)

12.70.1.8 emacspeak-eterm-pointer-backward-word

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.

(fn COUNT)

12.70.1.9 emacspeak-eterm-pointer-down

Command: emacspeak-eterm-pointer-down (count)
Move the pointer down a line.
Argument COUNT specifies number of lines by which to move.

(fn COUNT)

12.70.1.10 emacspeak-eterm-pointer-forward-word

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.

(fn COUNT)

12.70.1.11 emacspeak-eterm-pointer-left

Command: emacspeak-eterm-pointer-left (count)
Move the pointer left.
Argument COUNT specifies number of columns by which to move.

(fn COUNT)

12.70.1.12 emacspeak-eterm-pointer-right

Command: emacspeak-eterm-pointer-right (count)
Move the pointer right.
Argument COUNT specifies number of columns by which to move.

(fn COUNT)

12.70.1.13 emacspeak-eterm-pointer-to-bottom

Command: emacspeak-eterm-pointer-to-bottom
Move the pointer to the bottom  of the screen.

12.70.1.14 emacspeak-eterm-pointer-to-cursor

Command: emacspeak-eterm-pointer-to-cursor
Move the pointer to the cursor.

12.70.1.15 emacspeak-eterm-pointer-to-left-edge

Command: emacspeak-eterm-pointer-to-left-edge
Move the pointer to the right edge.

12.70.1.16 emacspeak-eterm-pointer-to-next-color-change

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.

(fn &optional COUNT)

12.70.1.17 emacspeak-eterm-pointer-to-previous-color-change

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.

(fn &optional COUNT)

12.70.1.18 emacspeak-eterm-pointer-to-right-edge

Command: emacspeak-eterm-pointer-to-right-edge
Move the pointer to the right edge.

12.70.1.19 emacspeak-eterm-pointer-to-top

Command: emacspeak-eterm-pointer-to-top
Move the pointer to the top of the screen.

12.70.1.20 emacspeak-eterm-pointer-up

Command: emacspeak-eterm-pointer-up (count)
Move the pointer up a line.
Argument COUNT .specifies number of lines by which to move.

(fn COUNT)

12.70.1.21 emacspeak-eterm-remote-term

Command: emacspeak-eterm-remote-term (host)
Start a terminal-emulator in a new buffer.

(fn HOST)

12.70.1.22 emacspeak-eterm-search-backward

Command: emacspeak-eterm-search-backward
Search backward on the terminal.

12.70.1.23 emacspeak-eterm-search-forward

Command: emacspeak-eterm-search-forward
Search forward on the terminal.

12.70.1.24 emacspeak-eterm-set-filter-window

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.

(fn FLAG)

12.70.1.25 emacspeak-eterm-set-focus-window

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.

(fn FLAG)

12.70.1.26 emacspeak-eterm-set-marker

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.

12.70.1.27 emacspeak-eterm-speak-cursor

Command: emacspeak-eterm-speak-cursor
Speak cursor position.

12.70.1.28 emacspeak-eterm-speak-pointer

Command: emacspeak-eterm-speak-pointer
Speak current pointer position.

12.70.1.29 emacspeak-eterm-speak-pointer-char

Command: emacspeak-eterm-speak-pointer-char (&optional prefix)
Speak char under eterm pointer.
Pronounces character phonetically unless  called with a PREFIX arg.

(fn &optional PREFIX)

12.70.1.30 emacspeak-eterm-speak-pointer-line

Command: emacspeak-eterm-speak-pointer-line
Speak the line the pointer is on.

12.70.1.31 emacspeak-eterm-speak-pointer-word

Command: emacspeak-eterm-speak-pointer-word
Speak the word  the pointer is on.

12.70.1.32 emacspeak-eterm-speak-predefined-window

Command: emacspeak-eterm-speak-predefined-window
Speak a predefined eterm window between 1 and 10.

12.70.1.33 emacspeak-eterm-speak-screen

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.

(fn &optional FLAG)

12.70.1.34 emacspeak-eterm-speak-window

Command: emacspeak-eterm-speak-window (id)
Speak an eterm window.
Argument ID specifies the window.

(fn ID)

12.70.1.35 emacspeak-eterm-toggle-filter-window

Command: emacspeak-eterm-toggle-filter-window
Toggle active state of filter window.

12.70.1.36 emacspeak-eterm-toggle-focus-window

Command: emacspeak-eterm-toggle-focus-window
Toggle active state of focus window.

12.70.1.37 emacspeak-eterm-toggle-pointer-mode

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.

12.70.1.38 emacspeak-eterm-toggle-review

Command: emacspeak-eterm-toggle-review
Toggle state of eterm review. 
In review mode, you can move around the terminal and listen to the contents 
without sending input to the terminal itself.

12.70.1.39 emacspeak-eterm-yank-window

Command: emacspeak-eterm-yank-window (id)
Yank contents of  an eterm window at point.

(fn ID)

12.70.1.40 emacspeak-toggle-eterm-autospeak

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. 

12.70.2 emacspeak-eterm Options

Variable: User Option emacspeak-eterm-bold-personality

Personality to indicate terminal bold.

Variable: User Option emacspeak-eterm-default-personality

Default personality for terminal.

Variable: User Option emacspeak-eterm-highlight-personality

Personality to show terminal highlighting.

Variable: User Option emacspeak-eterm-remote-hosts-cache

File where list of known remote hosts is cached

Variable: User Option emacspeak-eterm-underline-personality

Personality to indicate terminal underlining.


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