@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 883 commands. @menu * cd-tool:: * dtk-speak:: * dtk-unicode:: * emacspeak-alsaplayer:: * emacspeak-amark:: * 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-emms:: * emacspeak-enriched:: * emacspeak-entertain:: * emacspeak-eperiodic:: * emacspeak-erc:: * emacspeak-eterm:: * emacspeak-eudc:: * emacspeak-filtertext:: * emacspeak-fix-interactive:: * emacspeak-forms:: * emacspeak-gnus:: * emacspeak-gomoku:: * emacspeak-google:: * 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-realaudio:: * emacspeak-redefine:: * emacspeak-remote:: * emacspeak-rmail:: * emacspeak-solitaire:: * emacspeak-sounds:: * emacspeak-speak:: * emacspeak-speedbar:: * emacspeak-sudoku:: * emacspeak-table-ui:: * emacspeak-tabulate:: * emacspeak-tapestry:: * emacspeak-tar:: * emacspeak-tetris:: * emacspeak-tnt:: * emacspeak-url-template:: * emacspeak-view:: * emacspeak-w3:: * emacspeak-we:: * emacspeak-webmarks:: * emacspeak-websearch:: * emacspeak-webspace:: * emacspeak-webutils:: * emacspeak-widget:: * emacspeak-wizards:: * emacspeak-xml-shell:: * emacspeak-xslt:: * emacspeak-zinf:: * emacspeak:: * voice-setup:: * emacspeak-w3search:: * emacspeak-ebook:: * emacspeak-firevox:: * emacspeak-jawbreaker:: * emacspeak-moz:: * emacspeak-org:: * emacspeak-piglets:: * emacspeak-w3m:: * 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 nil @kbd{ control e DEL } Front-end to CDTool. Bind this function to a convenient key- Emacspeak users automatically have this bound to 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 nil @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 nil @kbd{ control e p } Pause ongoing speech. The speech can be resumed with command `dtk-resume' normally bound to M-x dtk-resume. 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 nil @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 nil @kbd{Not bound to any key.} 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 nil @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 nil @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 nil @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 nil @kbd{Not bound to any key.} Set language according to the argument lang. @end deffn @deffn {Interactive Command} dtk-set-next-language nil @kbd{Not bound to any key.} Switch to the next available language @end deffn @deffn {Interactive Command} dtk-set-predefined-speech-rate nil @kbd{ control e d 9 control e d 8 control e d 7 control e d 6 control e d 5 control e d 4 control e d 3 control e d 2 control e d 1 control e d 0 } 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Switch to the previous available language @end deffn @deffn {Interactive Command} dtk-set-punctuations nil @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 nil @kbd{Not bound to any key.} Set punctuation mode to all. Interactive PREFIX arg sets punctuation mode globally. @end deffn @deffn {Interactive Command} dtk-set-punctuations-to-some nil @kbd{Not bound to any key.} Set punctuation mode to some. Interactive PREFIX arg sets punctuation mode globally. @end deffn @deffn {Interactive Command} dtk-set-rate nil @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 nil @kbd{ control e s } Stop speech now. @end deffn @deffn {Interactive Command} dtk-toggle-allcaps-beep nil @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 nil @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 nil @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 nil @kbd{ control e d , } Toggle punctuation mode between "some" and "all". Interactive PREFIX arg makes the new setting global. @end deffn @deffn {Interactive Command} dtk-toggle-quiet nil @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 nil @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 nil @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 nil @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 nil @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 nil @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 dtk-unicode @section dtk-unicode Commentary: This Provides Unicode support to the speech layer. Automatically generated documentation for commands defined in module dtk-unicode. @deffn {Interactive Command} dtk-unicode-customize-char nil @kbd{Not bound to any key.} Add a custom replacement string for CHAR. When called interactively, CHAR defaults to the character after point. @end deffn @deffn {Interactive Command} dtk-unicode-uncustomize-char nil @kbd{Not bound to any key.} Delete custom replacement for CHAR. When called interactively, CHAR defaults to the character after point. @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 nil @kbd{Not bound to any key.} Add specified resource to queue. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-amark-add nil @kbd{Not bound to any key.} Set AMark `name' at current position in current audio stream. Interactive prefix arg prompts for position. As the default, use current position. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-amark-jump nil @kbd{Not bound to any key.} Jump to specified AMark. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-backward-10-seconds nil @kbd{Not bound to any key.} Skip backward by 10 seconds. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-backward-minute nil @kbd{Not bound to any key.} Skip backwards by minutes. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-backward-ten-minutes nil @kbd{Not bound to any key.} Skip backwards by chunks of minutes. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-cd nil @kbd{Not bound to any key.} Change default directory, and silence its pronounciation. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-clear nil @kbd{Not bound to any key.} Clear or resume alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-clip nil @kbd{Not bound to any key.} Invoke mp3splt to clip selected range. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-find-and-add-to-queue nil @kbd{Not bound to any key.} Find specified resource and add to queue. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-forward-10-seconds nil @kbd{Not bound to any key.} Skip forward by seconds. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-forward-minute nil @kbd{Not bound to any key.} Skip forward by minutes. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-forward-ten-minutes nil @kbd{Not bound to any key.} Skip forward by chunks of ten minutes. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-info nil @kbd{Not bound to any key.} Speak current path and copy it to kill ring. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-jump nil @kbd{Not bound to any key.} Jump to specified track. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-launch nil @kbd{Not bound to any key.} Launch Alsaplayer. user is placed in a buffer associated with the newly created Alsaplayer session. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-mark-position nil @kbd{Not bound to any key.} Mark currently displayed position. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-mode nil @kbd{Not bound to any key.} Major mode for alsaplayer interaction. key binding --- ------- ESC Prefix Command 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 J emacspeak-alsaplayer-amark-jump M emacspeak-alsaplayer-amark-add S emacspeak-alsaplayer-stop [ emacspeak-alsaplayer-backward-ten-minutes ] emacspeak-alsaplayer-forward-ten-minutes a emacspeak-alsaplayer-add-to-queue c emacspeak-alsaplayer-clear d emacspeak-alsaplayer-cd f emacspeak-alsaplayer-find-and-add-to-queue 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 o other-window 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 M-l emacspeak-amark-load M-s emacspeak-amark-save This mode runs the hook `emacspeak-alsaplayer-mode-hook', as the final step during initialization. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-next nil @kbd{Not bound to any key.} Next alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-pause nil @kbd{Not bound to any key.} Pause or resume alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-previous nil @kbd{Not bound to any key.} Previous alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-quit nil @kbd{Not bound to any key.} Quit alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-relative nil @kbd{Not bound to any key.} Relative seek alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-replace-queue nil @kbd{Not bound to any key.} Replace currently playing music. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-seek nil @kbd{Not bound to any key.} Absolute seek alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-speed nil @kbd{Not bound to any key.} Set speed in alsaplayer. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-start nil @kbd{Not bound to any key.} Start alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-status nil @kbd{Not bound to any key.} Show alsaplayer status @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-stop nil @kbd{Not bound to any key.} Stop alsaplayer @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-volume nil @kbd{Not bound to any key.} Set volume. @end deffn @deffn {Interactive Command} emacspeak-alsaplayer-where nil @kbd{Not bound to any key.} Speak current position and copy it to kill ring. @end deffn @node emacspeak-amark @section emacspeak-amark Commentary: Structure emacspeak-amark holds a bookmark into an mp3 file path: fully qualified pathname to file being marked name: Bookmark tag Position: time offset from start This library will be used from emacspeak-m-player, emacspeak-alsaplayer and friends to set and jump to bookmarks. Automatically generated documentation for commands defined in module emacspeak-amark. @deffn {Interactive Command} emacspeak-amark-add nil @kbd{Not bound to any key.} Add an AMark to the buffer local list of AMarks. AMarks are bookmarks in audio content. @end deffn @deffn {Interactive Command} emacspeak-amark-find nil @kbd{Not bound to any key.} Return matching AMark if found in buffer-local AMark list. @end deffn @deffn {Interactive Command} emacspeak-amark-load nil @kbd{Not bound to any key.} Locate AMarks file from current directory, and load it. @end deffn @deffn {Interactive Command} emacspeak-amark-save nil @kbd{Not bound to any key.} Save buffer-local AMarks in current directory. @end deffn @node emacspeak-amphetadesk @section emacspeak-amphetadesk No Commentary Automatically generated documentation for commands defined in module emacspeak-amphetadesk. @deffn {Interactive Command} emacspeak-amphetadesk nil @kbd{Not bound to any key.} Open amphetadesk. Interactive prefix-arg use-opml opens the myChannels.opml file. @end deffn @deffn {Interactive Command} emacspeak-amphetadesk-quick-add nil @kbd{Not bound to any key.} Quick add URL to Amphetadesk by prompting for URL. @end deffn @node emacspeak-arc @section emacspeak-arc No Commentary Automatically generated documentation for commands defined in module emacspeak-arc. @deffn {Interactive Command} emacspeak-arc-speak-file-modification-time nil @kbd{Not bound to any key.} Speak modification time of the file on current line @end deffn @deffn {Interactive Command} emacspeak-arc-speak-file-name nil @kbd{Not bound to any key.} Speak the name of the file on current line @end deffn @deffn {Interactive Command} emacspeak-arc-speak-file-permissions nil @kbd{Not bound to any key.} Speak permissions of file current entry @end deffn @deffn {Interactive Command} emacspeak-arc-speak-file-size nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Reset to default audio settings. @end deffn @deffn {Interactive Command} emacspeak-aumix-volume-decrease nil @kbd{Not bound to any key.} Decrease overall volume. @end deffn @deffn {Interactive Command} emacspeak-aumix-volume-increase nil @kbd{Not bound to any key.} Increase overall volume. @end deffn @deffn {Interactive Command} emacspeak-aumix-wave-decrease nil @kbd{Not bound to any key.} Decrease volume of wave output. @end deffn @deffn {Interactive Command} emacspeak-aumix-wave-increase nil @kbd{Not bound to any key.} Increase volume of wave output. @end deffn @node emacspeak-bs @section emacspeak-bs Commentary: speech-enable bs.el -- an alternative to Emacs' default list-buffers Automatically generated documentation for commands defined in module emacspeak-bs. @deffn {Interactive Command} emacspeak-bs-speak-buffer-line nil @kbd{Not bound to any key.} Speak information about this buffer @end deffn @node emacspeak-buff-menu @section emacspeak-buff-menu No Commentary Automatically generated documentation for commands defined in module emacspeak-buff-menu. @deffn {Interactive Command} emacspeak-list-buffers-next-line nil @kbd{Not bound to any key.} Speech enabled buffer menu navigation @end deffn @deffn {Interactive Command} emacspeak-list-buffers-previous-line nil @kbd{Not bound to any key.} Speech enabled buffer menu navigation @end deffn @deffn {Interactive Command} emacspeak-list-buffers-speak-buffer-line nil @kbd{Not bound to any key.} Speak information about this buffer @end deffn @deffn {Interactive Command} emacspeak-list-buffers-speak-buffer-name nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Speak the C semantics of this line. @end deffn @node emacspeak-calendar @section emacspeak-calendar No Commentary Automatically generated documentation for commands defined in module emacspeak-calendar. @deffn {Interactive Command} emacspeak-appt-repeat-announcement nil @kbd{ control e cap A } Speaks the most recently displayed appointment message if any. @end deffn @deffn {Interactive Command} emacspeak-calendar-speak-date nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Speech feedback about the compilation error. @end deffn @node emacspeak-custom @section emacspeak-custom No Commentary Automatically generated documentation for commands defined in module emacspeak-custom. @deffn {Interactive Command} emacspeak-custom-goto-group nil @kbd{Not bound to any key.} Jump to custom group when in a customization buffer. @end deffn @deffn {Interactive Command} emacspeak-custom-goto-toolbar nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Define persistent outline regexp for this book. @end deffn @deffn {Interactive Command} emacspeak-daisy-mark-position-in-content-under-point nil @kbd{Not bound to any key.} Mark current position in displayed content. No-op if content under point is not currently displayed. @end deffn @deffn {Interactive Command} emacspeak-daisy-mode nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Move to next line. @end deffn @deffn {Interactive Command} emacspeak-daisy-open-book nil @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 nil @kbd{Not bound to any key.} Play audio clip under point. @end deffn @deffn {Interactive Command} emacspeak-daisy-play-content-under-point nil @kbd{Not bound to any key.} Play SMIL content under point. @end deffn @deffn {Interactive Command} emacspeak-daisy-play-page-range nil @kbd{Not bound to any key.} Play pages in specified page range. @end deffn @deffn {Interactive Command} emacspeak-daisy-previous-line nil @kbd{Not bound to any key.} Move to previous line. @end deffn @deffn {Interactive Command} emacspeak-daisy-save-bookmarks nil @kbd{Not bound to any key.} Save bookmarks for current book. @end deffn @deffn {Interactive Command} emacspeak-daisy-stop-audio nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Speak access time of the current file. @end deffn @deffn {Interactive Command} emacspeak-dired-speak-file-modification-time nil @kbd{Not bound to any key.} Speak modification time of the current file. @end deffn @deffn {Interactive Command} emacspeak-dired-speak-file-permissions nil @kbd{Not bound to any key.} Speak the permissions of the current file. @end deffn @deffn {Interactive Command} emacspeak-dired-speak-file-size nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Speak the header line of the dired buffer. @end deffn @deffn {Interactive Command} emacspeak-dired-speak-symlink-target nil @kbd{Not bound to any key.} Speaks the target of the symlink on the current line. @end deffn @node emacspeak-dismal @section emacspeak-dismal No Commentary Automatically generated documentation for commands defined in module emacspeak-dismal. @deffn {Interactive Command} emacspeak-dismal-backward-col-and-summarize nil @kbd{Not bound to any key.} Move backward by arg columns (the previous column by default)and summarize it. @end deffn @deffn {Interactive Command} emacspeak-dismal-backward-row-and-summarize nil @kbd{Not bound to any key.} Move backward by arg rows (the previous row by default)and summarize it. @end deffn @deffn {Interactive Command} emacspeak-dismal-col-summarize nil @kbd{Not bound to any key.} Summarizes a col using the specification in list emacspeak-dismal-col-summarizer-list @end deffn @deffn {Interactive Command} emacspeak-dismal-display-cell-expression nil @kbd{Not bound to any key.} Display the expression in the message area @end deffn @deffn {Interactive Command} emacspeak-dismal-display-cell-value nil @kbd{Not bound to any key.} Display the cell value in the message area @end deffn @deffn {Interactive Command} emacspeak-dismal-display-cell-with-col-header nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Move forward by arg columns (the next column by default)and summarize it. @end deffn @deffn {Interactive Command} emacspeak-dismal-forward-row-and-summarize nil @kbd{Not bound to any key.} Move forward by arg rows (the next row by default)and summarize it. @end deffn @deffn {Interactive Command} emacspeak-dismal-row-summarize nil @kbd{Not bound to any key.} Summarizes a row using the specification in list emacspeak-dismal-row-summarizer-list @end deffn @deffn {Interactive Command} emacspeak-dismal-set-col-summarizer-list nil @kbd{Not bound to any key.} Specify or reset col summarizer list. @end deffn @deffn {Interactive Command} emacspeak-dismal-set-row-summarizer-list nil @kbd{Not bound to any key.} Specify or reset row summarizer list. @end deffn @deffn {Interactive Command} emacspeak-dismal-set-sheet-summarizer-list nil @kbd{Not bound to any key.} Specify or reset sheet summarizer list. @end deffn @deffn {Interactive Command} emacspeak-dismal-sheet-summarize nil @kbd{Not bound to any key.} Summarizes a sheet using the specification in list emacspeak-dismal-sheet-summarizer-list @end deffn @node emacspeak-ecb @section emacspeak-ecb No Commentary Automatically generated documentation for commands defined in module emacspeak-ecb. @deffn {Interactive Command} emacspeak-ecb-speak-window-directories nil @kbd{Not bound to any key.} Speak contents of directories window. @end deffn @deffn {Interactive Command} emacspeak-ecb-speak-window-history nil @kbd{Not bound to any key.} Speak contents of history window. @end deffn @deffn {Interactive Command} emacspeak-ecb-speak-window-methods nil @kbd{Not bound to any key.} Speak contents of methods window. @end deffn @deffn {Interactive Command} emacspeak-ecb-speak-window-sources nil @kbd{Not bound to any key.} Speak contents of sources window. @end deffn @deffn {Interactive Command} emacspeak-ecb-tree-backspace nil @kbd{Not bound to any key.} Back up during incremental search in tree buffers. @end deffn @deffn {Interactive Command} emacspeak-ecb-tree-clear nil @kbd{Not bound to any key.} Clear search pattern during incremental search in tree buffers. @end deffn @deffn {Interactive Command} emacspeak-ecb-tree-expand-common-prefix nil @kbd{Not bound to any key.} Expand to longest common prefix in tree buffer. @end deffn @deffn {Interactive Command} emacspeak-ecb-tree-shift-return nil @kbd{Not bound to any key.} Do shift return in ECB tree browser. @end deffn @node emacspeak-ediff @section emacspeak-ediff No Commentary Automatically generated documentation for commands defined in module emacspeak-ediff. @deffn {Interactive Command} emacspeak-ediff-speak-current-difference nil @kbd{Not bound to any key.} Speak the current difference @end deffn @node emacspeak-emms @section emacspeak-emms Commentary: Speech-enables EMMS --- the Emacs equivalent of XMMS See http://savannah.gnu.org/project/emms EMMS is under active development, to get the current CVS version, use Emacspeak command M-x emacspeak-cvs-gnu-get-project-snapshot RET emms RET Automatically generated documentation for commands defined in module emacspeak-emms. @deffn {Interactive Command} emacspeak-emms-speak-current-track nil @kbd{Not bound to any key.} Speak current track. @end deffn @node emacspeak-enriched @section emacspeak-enriched No Commentary Automatically generated documentation for commands defined in module emacspeak-enriched. @deffn {Interactive Command} emacspeak-enriched-voiceify-faces nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Speak current guessed string. @end deffn @deffn {Interactive Command} emacspeak-hangman-speak-statistics nil @kbd{Not bound to any key.} Speak statistics. @end deffn @node emacspeak-eperiodic @section emacspeak-eperiodic No Commentary Automatically generated documentation for commands defined in module emacspeak-eperiodic. @deffn {Interactive Command} emacspeak-eperiodic-goto-property-section nil @kbd{Not bound to any key.} Mark position and jump to properties section. @end deffn @deffn {Interactive Command} emacspeak-eperiodic-next-line nil @kbd{Not bound to any key.} Move to next row and speak element. @end deffn @deffn {Interactive Command} emacspeak-eperiodic-play-description nil @kbd{Not bound to any key.} Play audio description from WebElements. @end deffn @deffn {Interactive Command} emacspeak-eperiodic-previous-line nil @kbd{Not bound to any key.} Move to next row and speak element. @end deffn @deffn {Interactive Command} emacspeak-eperiodic-speak-current-element nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Remove name to monitor in this room. @end deffn @deffn {Interactive Command} emacspeak-erc-setup-cricket-rules nil @kbd{Not bound to any key.} Set up #cricket channels. @end deffn @deffn {Interactive Command} emacspeak-erc-toggle-my-monitor nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Describe an eterm window. Description indicates eterm window coordinates and whether it is stretchable @end deffn @deffn {Interactive Command} emacspeak-eterm-goto-line nil @kbd{Not bound to any key.} Move emacspeak eterm pointer to a specified LINE. @end deffn @deffn {Interactive Command} emacspeak-eterm-kill-ring-save-region nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Move the pointer left. Argument COUNT specifies number of columns by which to move. @end deffn @deffn {Interactive Command} emacspeak-eterm-pointer-right nil @kbd{Not bound to any key.} Move the pointer right. Argument COUNT specifies number of columns by which to move. @end deffn @deffn {Interactive Command} emacspeak-eterm-pointer-to-bottom nil @kbd{Not bound to any key.} Move the pointer to the bottom of the screen. @end deffn @deffn {Interactive Command} emacspeak-eterm-pointer-to-cursor nil @kbd{Not bound to any key.} Move the pointer to the cursor. @end deffn @deffn {Interactive Command} emacspeak-eterm-pointer-to-left-edge nil @kbd{Not bound to any key.} Move the pointer to the right edge. @end deffn @deffn {Interactive Command} emacspeak-eterm-pointer-to-next-color-change nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Move the pointer to the right edge. @end deffn @deffn {Interactive Command} emacspeak-eterm-pointer-to-top nil @kbd{Not bound to any key.} Move the pointer to the top of the screen. @end deffn @deffn {Interactive Command} emacspeak-eterm-pointer-up nil @kbd{Not bound to any key.} 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 nil @kbd{ control e CONTROL meta r } Start a terminal-emulator in a new buffer. @end deffn @deffn {Interactive Command} emacspeak-eterm-search-backward nil @kbd{Not bound to any key.} Search backward on the terminal. @end deffn @deffn {Interactive Command} emacspeak-eterm-search-forward nil @kbd{Not bound to any key.} Search forward on the terminal. @end deffn @deffn {Interactive Command} emacspeak-eterm-set-filter-window nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Speak cursor position. @end deffn @deffn {Interactive Command} emacspeak-eterm-speak-pointer nil @kbd{Not bound to any key.} Speak current pointer position. @end deffn @deffn {Interactive Command} emacspeak-eterm-speak-pointer-char nil @kbd{Not bound to any key.} Speak char under eterm pointer. Pronounces character phonetically unless called with a PREFIX arg. @end deffn @deffn {Interactive Command} emacspeak-eterm-speak-pointer-line nil @kbd{Not bound to any key.} Speak the line the pointer is on. @end deffn @deffn {Interactive Command} emacspeak-eterm-speak-pointer-word nil @kbd{Not bound to any key.} Speak the word the pointer is on. @end deffn @deffn {Interactive Command} emacspeak-eterm-speak-predefined-window nil @kbd{Not bound to any key.} Speak a predefined eterm window between 1 and 10. @end deffn @deffn {Interactive Command} emacspeak-eterm-speak-screen nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Speak an eterm window. Argument ID specifies the window. @end deffn @deffn {Interactive Command} emacspeak-eterm-toggle-filter-window nil @kbd{Not bound to any key.} Toggle active state of filter window. @end deffn @deffn {Interactive Command} emacspeak-eterm-toggle-focus-window nil @kbd{Not bound to any key.} Toggle active state of focus window. @end deffn @deffn {Interactive Command} emacspeak-eterm-toggle-pointer-mode nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Yank contents of an eterm window at point. @end deffn @deffn {Interactive Command} emacspeak-toggle-eterm-autospeak nil @kbd{Not bound to any key.} 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-eudc @section emacspeak-eudc Commentary: EUDC --Emacs Universal Directory Client provides a unified interface to directory servers e.g. ldap servers this module speech enables eudc Automatically generated documentation for commands defined in module emacspeak-eudc. @deffn {Interactive Command} emacspeak-eudc-send-mail nil @kbd{Not bound to any key.} Send email to the address given by the current record. @end deffn @node emacspeak-filtertext @section emacspeak-filtertext No Commentary Automatically generated documentation for commands defined in module emacspeak-filtertext. @deffn {Interactive Command} emacspeak-filtertext nil @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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Revert to original text. @end deffn @node emacspeak-fix-interactive @section emacspeak-fix-interactive No Commentary Automatically generated documentation for commands defined in module emacspeak-fix-interactive. @deffn {Interactive Command} emacspeak-fix-all-recent-commands nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Fix all commands loaded from a specified module. @end deffn @node emacspeak-forms @section emacspeak-forms No Commentary Automatically generated documentation for commands defined in module emacspeak-forms. @deffn {Interactive Command} emacspeak-forms-find-file nil @kbd{Not bound to any key.} Visit a forms file @end deffn @deffn {Interactive Command} emacspeak-forms-flush-unwanted-records nil @kbd{Not bound to any key.} Prompt for pattern and flush matching lines @end deffn @deffn {Interactive Command} emacspeak-forms-rerun-filter nil @kbd{Not bound to any key.} Rerun filter --allows us to nuke more matching records @end deffn @deffn {Interactive Command} emacspeak-forms-speak-field nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Summarize current position in list of records @end deffn @deffn {Interactive Command} emacspeak-forms-summarize-current-record nil @kbd{Not bound to any key.} Summarize current record @end deffn @node emacspeak-gnus @section emacspeak-gnus No Commentary Automatically generated documentation for commands defined in module emacspeak-gnus. @deffn {Interactive Command} emacspeak-gnus-summary-catchup-quietly-and-exit nil @kbd{Not bound to any key.} Catch up on all articles in current group. @end deffn @node emacspeak-gomoku @section emacspeak-gomoku No Commentary Automatically generated documentation for commands defined in module emacspeak-gomoku. @deffn {Interactive Command} emacspeak-gomoku-display-statistics nil @kbd{Not bound to any key.} Display statistics from previous games @end deffn @deffn {Interactive Command} emacspeak-gomoku-goto-x-y nil @kbd{Not bound to any key.} Prompt for and go to that square. @end deffn @deffn {Interactive Command} emacspeak-gomoku-show-current-column nil @kbd{Not bound to any key.} Aurally display current column @end deffn @deffn {Interactive Command} emacspeak-gomoku-show-current-negative-diagonal nil @kbd{Not bound to any key.} Aurally display current negative sloped diagonal @end deffn @deffn {Interactive Command} emacspeak-gomoku-show-current-positive-diagonal nil @kbd{Not bound to any key.} Aurally display current positively sloped diagonal @end deffn @deffn {Interactive Command} emacspeak-gomoku-show-current-row nil @kbd{Not bound to any key.} Aurally display current row @end deffn @deffn {Interactive Command} emacspeak-gomoku-speak-emacs-previous-move nil @kbd{Not bound to any key.} Speak emacs' previous move @end deffn @deffn {Interactive Command} emacspeak-gomoku-speak-humans-previous-move nil @kbd{Not bound to any key.} Speak human' previous move @end deffn @deffn {Interactive Command} emacspeak-gomoku-speak-number-of-moves nil @kbd{Not bound to any key.} Speak number of moves so far @end deffn @deffn {Interactive Command} emacspeak-gomoku-speak-square nil @kbd{Not bound to any key.} Speak coordinates and state of square at point @end deffn @node emacspeak-google @section emacspeak-google Commentary: There are a number of search tools that can be implemented on the Google search page --- in a JS-powered browser, these show up as the Google tool-belt. This module implements a minor mode for use in Google result pages that enables these tools via single keyboard commands. (require 'cl) (declaim (optimize (safety 0) (speed 3))) (require 'emacspeak-preamble) (require 'easy-mmode) One tool on a tool-belt (defstruct emacspeak-google-tool name ; human readable param ; url param bit range ; range of possible values default value ; current setting ) (defvar emacspeak-google-query nil "Current Google Query. This variable is buffer-local.") (make-variable-buffer-local 'emacspeak-google-query) (defvar emacspeak-google-toolbelt nil "List of tools on the toolbelt.") (make-variable-buffer-local 'emacspeak-google-toolbelt) (defun emacspeak-google-toolbelt-to-tbs () "Return value for use in tbs parameter in search queries." (let ((settings (delq nil (mapcar #'(lambda (tool) (cond ((equal (emacspeak-google-tool-value tool) (emacspeak-google-tool-default tool)) nil) (t (format "%s:%s" (emacspeak-google-tool-param tool) (emacspeak-google-tool-value tool))))) (emacspeak-google-toolbelt))))) (when settings (concat "&tbs=" (mapconcat #'identity settings ","))))) (defun emacspeak-google-toolbelt () "Returns buffer-local toolbelt or a a newly initialized toolbelt." (declare (special emacspeak-google-toolbelt)) (or emacspeak-google-toolbelt (list video vid: 1/0 (make-emacspeak-google-tool :name "video" :param "vid" :range '(0 1) :default 0 :default 0 :value 0) Recent (make-emacspeak-google-tool :name "recent" :param "rcnt" :range '( 0 1) :default 0 :value 0) Duration restrict for video (make-emacspeak-google-tool :name "duration" :param "dur" :range '("m" "s" "l") :default "m" :value "m") Blog mode (make-emacspeak-google-tool :name "blog" :param "blg" :range '(0 1) :default 0 :value 0) Books mode (make-emacspeak-google-tool :name "books" :param "bks" :range '(0 1) :default 0 :default 0 :value 0) Books viewability (make-emacspeak-google-tool :name "books-viewability" :param "bkv" :range '("a" "f") :default "a" :value "a") Book Type (make-emacspeak-google-tool :name "books-type" :param "bkt" :range '("b" "p" "m") :default "b" :value "b") Forums Mode (make-emacspeak-google-tool :name "forums" :param "frm" :range '(0 1) :default 0 :value 0) News Mode (make-emacspeak-google-tool :name "news" :param "nws" :range '(0 1) :default 0 :value 0) Reviews (make-emacspeak-google-tool :name "reviews" :param "rvw" :range '(0 1) :default 0 :value 0) Web History Visited (make-emacspeak-google-tool :name "web-history-visited" :param "whv" :range '(0 1) :default 0 :value 0) Web History Not Visited (make-emacspeak-google-tool :name "web-history-not-visited" :param "whnv" :range '(0 1) :default 0 :value 0) Images (make-emacspeak-google-tool :name "images" :param "img" :range '(0 1) :default 0 :value 0) Structured Snippets (make-emacspeak-google-tool :name "structured-snippets" :param "sts" :range '(0 1) :default 0 :value 0) sort by date (make-emacspeak-google-tool :name "sort-by-date" :param "std" :range '(0 1) :default 0 :value 0) Timeline (make-emacspeak-google-tool :name "timeline" :param "tl" :range '(0 1) :default 0 :value 0) Timeline Low (make-emacspeak-google-tool :name "timeline-low" :param "tll" :range "YYYY/MM" :default "" :value "") Date Filter (make-emacspeak-google-tool :name "date-filter" :param "qdr" :range "tn" :default "" :value "") Timeline High (make-emacspeak-google-tool :name "timeline-high" :param "tlh" :range "YYYY/MM" :default "" :value "") more:commercial promotion with prices (make-emacspeak-google-tool :name "commercial" :param "cpk" :range '(0 1) :default 0 :value 0) (make-emacspeak-google-tool :name "commercial-prices" :param "cp" :range '(0 1) :default 0 :value 0) less:commercial (demotion) (make-emacspeak-google-tool :name "non-commercial" :param "cdcpk" :range '(0 1) :default 0 :value 0)))) (loop for this-tool in (emacspeak-google-toolbelt) do (eval `(defun ,(intern (format "emacspeak-google-toolbelt-change-%s" (emacspeak-google-tool-name this-tool))) () ,(format "Change %s in the currently active toolbelt." (emacspeak-google-tool-name this-tool)) (interactive) (let* ( (belt (emacspeak-google-toolbelt)) (tool (find-if #'(lambda (tool) (string-equal (emacspeak-google-tool-name tool) ,(emacspeak-google-tool-name this-tool))) belt)) (param (emacspeak-google-tool-param tool)) (value (emacspeak-google-tool-value tool)) (range (emacspeak-google-tool-range tool))) (cond ((and (listp range) (= 2 (length range))) toggle value (setf (emacspeak-google-tool-value tool) (if (equal value (first range)) (second range) (first range)))) ((listp range) Prompt using completion (setf (emacspeak-google-tool-value tool) (completing-read "Set tool to: " range))) ((stringp range) (setf (emacspeak-google-tool-value tool) (read-from-minibuffer range))) (t (error "Unexpected type!"))) (let ((emacspeak-websearch-google-options (emacspeak-google-toolbelt-to-tbs))) (emacspeak-websearch-google (or emacspeak-google-query (gweb-google-autocomplete)))))))) ###autoload (define-minor-mode emacspeak-google-mode "Google minor mode." :lighter " Google" ) (define-prefix-command 'emacspeak-google-command 'emacspeak-google-keymap) (loop for k in '( ("r" emacspeak-google-toolbelt-change-recent) ("b" emacspeak-google-toolbelt-change-blog) ("n" emacspeak-google-toolbelt-change-news) ("c" emacspeak-google-toolbelt-change-commercial) ("p" emacspeak-google-toolbelt-change-commercial-prices) ("n" emacspeak-google-toolbelt-change-non-commercial) ("f" emacspeak-google-toolbelt-change-forums) ("v" emacspeak-google-toolbelt-change-video) ("i" emacspeak-google-toolbelt-change-images) ("B" emacspeak-google-toolbelt-change-books) ("t" emacspeak-google-toolbelt-change-books-type) ("\C-b" emacspeak-google-toolbelt-change-books-viewability) ("l" emacspeak-google-toolbelt-change-non-commercial) ("s" emacspeak-google-toolbelt-change-structured-snippets) ) do (emacspeak-keymap-update emacspeak-google-keymap k)) (provide 'emacspeak-google) local variables: folded-file: t byte-compile-dynamic: t Automatically generated documentation for commands defined in module emacspeak-google. @deffn {Interactive Command} emacspeak-google-mode nil @kbd{Not bound to any key.} Google minor mode. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-blog nil @kbd{Not bound to any key.} Change blog in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-books nil @kbd{Not bound to any key.} Change books in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-books-type nil @kbd{Not bound to any key.} Change books-type in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-books-viewability nil @kbd{Not bound to any key.} Change books-viewability in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-commercial nil @kbd{Not bound to any key.} Change commercial in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-commercial-prices nil @kbd{Not bound to any key.} Change commercial-prices in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-date-filter nil @kbd{Not bound to any key.} Change date-filter in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-duration nil @kbd{Not bound to any key.} Change duration in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-forums nil @kbd{Not bound to any key.} Change forums in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-images nil @kbd{Not bound to any key.} Change images in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-news nil @kbd{Not bound to any key.} Change news in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-non-commercial nil @kbd{Not bound to any key.} Change non-commercial in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-recent nil @kbd{Not bound to any key.} Change recent in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-reviews nil @kbd{Not bound to any key.} Change reviews in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-sort-by-date nil @kbd{Not bound to any key.} Change sort-by-date in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-structured-snippets nil @kbd{Not bound to any key.} Change structured-snippets in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-timeline nil @kbd{Not bound to any key.} Change timeline in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-timeline-high nil @kbd{Not bound to any key.} Change timeline-high in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-timeline-low nil @kbd{Not bound to any key.} Change timeline-low in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-video nil @kbd{Not bound to any key.} Change video in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-web-history-not-visited nil @kbd{Not bound to any key.} Change web-history-not-visited in the currently active toolbelt. @end deffn @deffn {Interactive Command} emacspeak-google-toolbelt-change-web-history-visited nil @kbd{Not bound to any key.} Change web-history-visited in the currently active toolbelt. @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 nil @kbd{ control e # a } Apply grid to region. @end deffn @deffn {Interactive Command} emacspeak-gridtext-load nil @kbd{ control e # l } Load saved grid settings. @end deffn @deffn {Interactive Command} emacspeak-gridtext-save nil @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 nil @kbd{Not bound to any key.} Hide or expose all blocks in buffer. @end deffn @deffn {Interactive Command} emacspeak-hide-or-expose-block nil @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 nil @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 nil @kbd{Not bound to any key.} Speak information about this buffer @end deffn @node emacspeak-imenu @section emacspeak-imenu No Commentary Automatically generated documentation for commands defined in module emacspeak-imenu. @deffn {Interactive Command} emacspeak-imenu-goto-next-index-position nil @kbd{Not bound to any key.} Goto the next index position in current buffer @end deffn @deffn {Interactive Command} emacspeak-imenu-goto-previous-index-position nil @kbd{Not bound to any key.} Goto the previous index position in current buffer @end deffn @deffn {Interactive Command} emacspeak-imenu-speak-this-section nil @kbd{Not bound to any key.} Speak upto start of next index entry @end deffn @node emacspeak-info @section emacspeak-info No Commentary Automatically generated documentation for commands defined in module emacspeak-info. @deffn {Interactive Command} emacspeak-info-speak-header nil @kbd{Not bound to any key.} Speak info header line. @end deffn @deffn {Interactive Command} emacspeak-info-wizard nil @kbd{ control h TAB TAB 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-chat-next-message nil @kbd{Not bound to any key.} Move forward to and speak the next message in this chat session. @end deffn @deffn {Interactive Command} emacspeak-jabber-chat-previous-message nil @kbd{Not bound to any key.} Move backward to and speak the previous message in this chat session. @end deffn @deffn {Interactive Command} emacspeak-jabber-chat-speak-this-message nil @kbd{Not bound to any key.} Speaks message starting on current line. Assumes point is at the front of the message. Returns a cons (start . end) that delimits the message. @end deffn @deffn {Interactive Command} emacspeak-jabber-popup-roster nil @kbd{Not bound to any key.} Pop to Jabber roster. @end deffn @node emacspeak-keymap @section emacspeak-keymap No Commentary Automatically generated documentation for commands defined in module emacspeak-keymap. @deffn {Interactive Command} emacspeak-keymap-choose-new-emacspeak-prefix nil @kbd{Not bound to any 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 No Commentary Automatically generated documentation for commands defined in module emacspeak-loaddefs. @deffn {Interactive Command} emacspeak-mark-forward-mark nil @kbd{ } 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 nil @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 nil @kbd{Not bound to any key.} 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-m-player-add-equalizer nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Adds specified filter to use for the next invocation of MPlayer. @end deffn @deffn {Interactive Command} emacspeak-m-player-alt-src-step nil @kbd{Not bound to any key.} Move within an ASF playlist. @end deffn @deffn {Interactive Command} emacspeak-m-player-backward-10min nil @kbd{Not bound to any key.} Move backward by ten minutes. @end deffn @deffn {Interactive Command} emacspeak-m-player-backward-10s nil @kbd{Not bound to any key.} Move back by 10 seconds. @end deffn @deffn {Interactive Command} emacspeak-m-player-backward-1min nil @kbd{Not bound to any key.} Move back by 1 minute. @end deffn @deffn {Interactive Command} emacspeak-m-player-beginning-of-track nil @kbd{Not bound to any key.} Move to beginning of track. @end deffn @deffn {Interactive Command} emacspeak-m-player-bind-accelerator nil @kbd{Not bound to any key.} Binds key to invoke m-player on specified directory. @end deffn @deffn {Interactive Command} emacspeak-m-player-command nil @kbd{Not bound to any key.} Invoke MPlayer commands. @end deffn @deffn {Interactive Command} emacspeak-m-player-customize-options nil @kbd{Not bound to any key.} Use Customize to manipulate MPlayer options. @end deffn @deffn {Interactive Command} emacspeak-m-player-display-position nil @kbd{Not bound to any key.} Display current position in track and its length. @end deffn @deffn {Interactive Command} emacspeak-m-player-double-speed nil @kbd{Not bound to any key.} Scale speed by 2.0 @end deffn @deffn {Interactive Command} emacspeak-m-player-end-of-track nil @kbd{Not bound to any key.} Move to beginning of track. @end deffn @deffn {Interactive Command} emacspeak-m-player-equalizer-control nil @kbd{Not bound to any key.} Manipulate values in specified vector using minibuffer. @end deffn @deffn {Interactive Command} emacspeak-m-player-faster nil @kbd{Not bound to any key.} Speed up playback. @end deffn @deffn {Interactive Command} emacspeak-m-player-forward-10min nil @kbd{Not bound to any key.} Move forward by ten minutes. @end deffn @deffn {Interactive Command} emacspeak-m-player-forward-10s nil @kbd{Not bound to any key.} Move forward by 10 seconds. @end deffn @deffn {Interactive Command} emacspeak-m-player-forward-1min nil @kbd{Not bound to any key.} Move forward by 1 minute. @end deffn @deffn {Interactive Command} emacspeak-m-player-get-length nil @kbd{Not bound to any key.} Display length of track in seconds. @end deffn @deffn {Interactive Command} emacspeak-m-player-half-speed nil @kbd{Not bound to any key.} Scale speed by 0.5. @end deffn @deffn {Interactive Command} emacspeak-m-player-load-file nil @kbd{Not bound to any key.} Load specified file. @end deffn @deffn {Interactive Command} emacspeak-m-player-load-playlist nil @kbd{Not bound to any key.} Load specified playlist file. @end deffn @deffn {Interactive Command} emacspeak-m-player-mode nil @kbd{Not bound to any key.} Major mode for m-player interaction. key binding --- ------- RET emacspeak-m-player ESC Prefix Command 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-backward-1min = emacspeak-m-player-volume-up > emacspeak-m-player-forward-1min ? emacspeak-m-player-display-position L emacspeak-m-player-load-file 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-get-length 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 v emacspeak-m-player-volume-change @{ emacspeak-m-player-half-speed @} emacspeak-m-player-double-speed DEL emacspeak-m-player-reset-speed emacspeak-m-player-forward-1min emacspeak-m-player-end-of-track emacspeak-m-player-beginning-of-track emacspeak-m-player-backward-10s emacspeak-m-player-forward-10min emacspeak-m-player-backward-10min emacspeak-m-player-forward-10s emacspeak-m-player-backward-1min M-l emacspeak-m-player-load-playlist 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 nil @kbd{Not bound to any key.} Move to next track. @end deffn @deffn {Interactive Command} emacspeak-m-player-pause nil @kbd{Not bound to any key.} Pause or unpause media player. @end deffn @deffn {Interactive Command} emacspeak-m-player-play-tree-step nil @kbd{Not bound to any key.} Move within the play tree. @end deffn @deffn {Interactive Command} emacspeak-m-player-play-tree-up nil @kbd{Not bound to any key.} Move within the play tree. @end deffn @deffn {Interactive Command} emacspeak-m-player-previous-track nil @kbd{Not bound to any key.} Move to previous track. @end deffn @deffn {Interactive Command} emacspeak-m-player-quit nil @kbd{Not bound to any key.} Quit media player. @end deffn @deffn {Interactive Command} emacspeak-m-player-reset-options nil @kbd{Not bound to any key.} Reset MPlayer options to initial defaults. @end deffn @deffn {Interactive Command} emacspeak-m-player-reset-speed nil @kbd{Not bound to any key.} Reset playing speed to normal. @end deffn @deffn {Interactive Command} emacspeak-m-player-scale-speed nil @kbd{Not bound to any key.} Scale speed by specified factor. @end deffn @deffn {Interactive Command} emacspeak-m-player-seek-absolute nil @kbd{Not bound to any key.} Seek to absolute specified position. @end deffn @deffn {Interactive Command} emacspeak-m-player-seek-relative nil @kbd{Not bound to any key.} Seek by offset into stream from current position. @end deffn @deffn {Interactive Command} emacspeak-m-player-slower nil @kbd{Not bound to any key.} Slow down playback. @end deffn @deffn {Interactive Command} emacspeak-m-player-volume-change nil @kbd{Not bound to any key.} Change volume. A value of changes volume by specified offset. A string of the form ` 1' sets volume as an absolute. @end deffn @deffn {Interactive Command} emacspeak-m-player-volume-down nil @kbd{Not bound to any key.} Decrease volume. @end deffn @deffn {Interactive Command} emacspeak-m-player-volume-up nil @kbd{Not bound to any key.} Increase volume. @end deffn @deffn {Interactive Command} emacspeak-m-player-youtube-player nil @kbd{Not bound to any key.} Use youtube-dl and mplayer to stream YouTube content. @end deffn @deffn {Interactive Command} emacspeak-multimedia nil @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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Call appropriate madplay command. @end deffn @deffn {Interactive Command} emacspeak-madplay-madplay-command nil @kbd{Not bound to any key.} Execute Madplay command. @end deffn @deffn {Interactive Command} emacspeak-madplay-mode nil @kbd{Not bound to any key.} 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 emacspeak-aumix-wave-decrease 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 No Commentary Automatically generated documentation for commands defined in module emacspeak-man. @deffn {Interactive Command} emacspeak-man-browse-man-page nil @kbd{Not bound to any key.} Browse the man page --read it a paragraph at a time @end deffn @deffn {Interactive Command} emacspeak-man-speak-this-section nil @kbd{Not bound to any key.} 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 nil @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 nil @kbd{Not bound to any key.} Like backward page, but tracks page number of current document. @end deffn @deffn {Interactive Command} emacspeak-ocr-customize nil @kbd{Not bound to any key.} Customize OCR settings. @end deffn @deffn {Interactive Command} emacspeak-ocr-flipflop-and-recognize-image nil @kbd{Not bound to any key.} Run OCR engine on current image after flip-flopping it. Useful if you've scanned a page upside down and are using an engine that does not automatically flip the image for you. You need the imagemagik family of tools --- we use mogrify to transform the image. Prompts for image file if file corresponding to the expected `current page' is not found. @end deffn @deffn {Interactive Command} emacspeak-ocr-forward-page nil @kbd{Not bound to any key.} Like forward page, but tracks page number of current document. @end deffn @deffn {Interactive Command} emacspeak-ocr-mode nil @kbd{Not bound to any key.} 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 f emacspeak-ocr-flipflop-and-recognize-image 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Launch dired on OCR working directory. @end deffn @deffn {Interactive Command} emacspeak-ocr-page nil @kbd{Not bound to any key.} Move to specified page. @end deffn @deffn {Interactive Command} emacspeak-ocr-read-current-page nil @kbd{Not bound to any key.} Speaks current page. @end deffn @deffn {Interactive Command} emacspeak-ocr-recognize-image nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Writes out recognized text from current page to an appropriately named file. @end deffn @deffn {Interactive Command} emacspeak-ocr-scan-and-recognize nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Acquire page image. @end deffn @deffn {Interactive Command} emacspeak-ocr-scan-photo nil @kbd{Not bound to any key.} Scan in a photograph. The scanned image is converted to JPEG. @end deffn @deffn {Interactive Command} emacspeak-ocr-set-compress-image-options nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Analogous to outline-backward-same-level except that the outline section is optionally spoken @end deffn @deffn {Interactive Command} emacspeak-outline-speak-forward-heading nil @kbd{Not bound to any key.} Analogous to outline-forward-same-level, except that the outline section is optionally spoken @end deffn @deffn {Interactive Command} emacspeak-outline-speak-next-heading nil @kbd{Not bound to any key.} Analogous to outline-next-visible-heading, except that the outline section is optionally spoken @end deffn @deffn {Interactive Command} emacspeak-outline-speak-previous-heading nil @kbd{Not bound to any key.} Analogous to outline-previous-visible-heading, except that the outline section is optionally spoken @end deffn @deffn {Interactive Command} emacspeak-outline-speak-this-heading nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Clear all current pronunciation dictionaries. @end deffn @deffn {Interactive Command} emacspeak-pronounce-define-local-pronunciation nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @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 nil @kbd{Not bound to any key.} Prompt for and launch a pronunciation editor on the specified pronunciation dictionary key. @end deffn @deffn {Interactive Command} emacspeak-pronounce-load-dictionaries nil @kbd{Not bound to any key.} Load pronunciation dictionaries. Optional argument FILENAME specifies the dictionary file. @end deffn @deffn {Interactive Command} emacspeak-pronounce-refresh-pronunciations nil @kbd{Not bound to any key.} Refresh pronunciation table for current buffer. Activates pronunciation dictionaries if not already active. @end deffn @deffn {Interactive Command} emacspeak-pronounce-save-dictionaries nil @kbd{Not bound to any key.} Writes out the persistent emacspeak pronunciation dictionaries. @end deffn @deffn {Interactive Command} emacspeak-pronounce-toggle-use-of-dictionaries nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Yank word at point into minibuffer. @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 nil @kbd{Not bound to any key.} Browse RAM file before playing the selected component. @end deffn @deffn {Interactive Command} emacspeak-realaudio-get-current-time-in-seconds nil @kbd{Not bound to any key.} Return current time in seconds. @end deffn @deffn {Interactive Command} emacspeak-realaudio-mode nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Switch to realaudio buffer. @end deffn @deffn {Interactive Command} emacspeak-realaudio-set-end-mark nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Stop playing realaudio @end deffn @deffn {Interactive Command} emacspeak-realaudio-trplayer-call-command nil @kbd{Not bound to any key.} Call appropriate TRPlayer command. @end deffn @deffn {Interactive Command} emacspeak-realaudio-trplayer-command nil @kbd{Not bound to any key.} Execute TRPlayer command. @end deffn @deffn {Interactive Command} emacspeak-realaudio-write-mp3-clip nil @kbd{Not bound to any key.} 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 No Commentary Automatically generated documentation for commands defined in module emacspeak-redefine. @deffn {Interactive Command} emacspeak-backward-char nil @kbd{ control b } Backward-char redefined to speak char moved to. @end deffn @deffn {Interactive Command} emacspeak-forward-char nil @kbd{ control f } Forward-char redefined to speak char moved to. @end deffn @deffn {Interactive Command} emacspeak-self-insert-command nil @kbd{ 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 No Commentary Automatically generated documentation for commands defined in module emacspeak-remote. @deffn {Interactive Command} emacspeak-remote-connect-to-server nil @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-edit-current-remote-hostname nil @kbd{Not bound to any key.} Interactively set up where we came from. Value is persisted for use with ssh servers. @end deffn @deffn {Interactive Command} emacspeak-remote-home nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Open ssh session to where we came from. @end deffn @node emacspeak-rmail @section emacspeak-rmail No Commentary Automatically generated documentation for commands defined in module emacspeak-rmail. @deffn {Interactive Command} emacspeak-rmail-speak-current-message-labels nil @kbd{Not bound to any key.} Speak labels of current message @end deffn @deffn {Interactive Command} emacspeak-rmail-summarize-current-message nil @kbd{Not bound to any key.} Summarize current message @end deffn @node emacspeak-solitaire @section emacspeak-solitaire No Commentary Automatically generated documentation for commands defined in module emacspeak-solitaire. @deffn {Interactive Command} emacspeak-solitaire-show-column nil @kbd{Not bound to any key.} Display current row auditorallly @end deffn @deffn {Interactive Command} emacspeak-solitaire-show-row nil @kbd{Not bound to any key.} Display current row auditorallly @end deffn @deffn {Interactive Command} emacspeak-solitaire-speak-coordinates nil @kbd{Not bound to any key.} 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-audio-setup nil @kbd{ control e ( } Call appropriate audio environment set command. @end deffn @deffn {Interactive Command} emacspeak-play-all-icons nil @kbd{Not bound to any key.} Plays all defined icons and speaks their names. @end deffn @deffn {Interactive Command} emacspeak-set-auditory-icon-player nil @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 nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Reload sound drivers. @end deffn @deffn {Interactive Command} emacspeak-sounds-select-theme nil @kbd{ control e ) } Select theme for auditory icons. @end deffn @deffn {Interactive Command} emacspeak-toggle-auditory-icons nil @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 nil @kbd{Not bound to any key.} Set property auditory-icon at front of all paragraphs. @end deffn @deffn {Interactive Command} emacspeak-blink-matching-open nil @kbd{Not bound to any key.} 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 nil @kbd{Not bound to any key.} Pick completion and return safely where we came from. @end deffn @deffn {Interactive Command} emacspeak-completions-move-to-completion-group nil @kbd{Not bound to any key.} 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 nil @kbd{ control e d t } Prompt for and dial a phone NUMBER with the Dectalk. @end deffn @deffn {Interactive Command} emacspeak-execute-repeatedly nil @kbd{Not bound to any key.} Execute COMMAND repeatedly. @end deffn @deffn {Interactive Command} emacspeak-mark-backward-mark nil @kbd{ } Cycle backward through the mark ring. @end deffn @deffn {Interactive Command} emacspeak-owindow-next-line nil @kbd{ ESCAPE } 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 nil @kbd{ ESCAPE } 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 nil @kbd{ ESCAPE } 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 nil @kbd{ ESCAPE } 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 nil @kbd{ ESCAPE