]>
Commit | Line | Data |
---|---|---|
176d893c | 1 | --- emacspeak-24.orig/info/tts-server.texi |
2 | +++ emacspeak-24/info/tts-server.texi | |
3 | @@ -1,209 +1,209 @@ | |
4 | - @c $Id$ | |
5 | - @node TTS Servers | |
6 | - @chapter Emacspeak TTS Servers | |
7 | - | |
8 | - Emacspeak produces spoken output by communicating with one of many | |
9 | - speech servers. This section documents the communication protocol | |
10 | - between the client application i.e. Emacspeak, and the TTS | |
11 | - server. This section is primarily intended for developers wishing to: | |
12 | - @itemize @bullet | |
13 | - @item Create new speech servers that comply with this communication | |
14 | - protocol | |
15 | - @item Developers of other client applications who wish to use | |
16 | - the various Emacspeak speech servers. | |
17 | - @end itemize | |
18 | - | |
19 | - @subsection High-level Overview | |
20 | - | |
21 | - The TTS server reads commands from standard input, and script | |
22 | - @emph{speech-server} can be used to cause a TTS server to communicate | |
23 | - via a TCP socket. Speech server commands are used by the client | |
24 | - application to make specific requests of the server; the server | |
25 | - listens for these requests in a non-blocking read loop and executes | |
26 | - requests as they become available. Requests can be classified | |
27 | - as follows: | |
28 | - @itemize @bullet | |
29 | - @item Commands that send text to be spoken. | |
30 | - @item Commands that set @emph{state} of the TTS server. | |
31 | - @end itemize | |
32 | - | |
33 | - All commands are of the form | |
34 | - @example | |
35 | - commandWord @{arguments@} | |
36 | - @end example | |
37 | - The braces are optional if the command argument contains no white | |
38 | - space. The speech server maintains a @emph{current state} that | |
39 | - determines various characteristics of spoken output such as speech | |
40 | - rate, punctuations mode etc. (see set of commands that manipulate | |
41 | - speech state for complete list). The client application @emph{queues} The | |
42 | - text and non-speech audio output to be produced before asking the | |
43 | - server to @emph{dispatch} the set of queued requests, i.e. start | |
44 | - producing output. | |
45 | - | |
46 | - Once the server has been asked to produce output, it removes items | |
47 | - from the front of the queue, sends the requisite commands to the | |
48 | - underlying TTS engine, and waits for the engine to acknowledge that | |
49 | - the request has been completely processed. This is a non-blocking | |
50 | - operation, i.e., if the client application generates additional | |
51 | - requests, these are processed @emph{immediately}. | |
52 | - | |
53 | - The above design allows the Emacspeak TTS server to be | |
54 | - @emph{highly} responsive; Cleint applications can queue large | |
55 | - amounts of text (typically queued a clause at a time to | |
56 | - achieve the best prosody), ask the TTS server to start speaking, | |
57 | - and interrupt the spoken output at any time. | |
58 | - | |
59 | - @subsection Commands That Queue Output. | |
60 | - | |
61 | - This section documents commands that either produce spoken | |
62 | - output, or queue output to be produced on demand. | |
63 | - Commands that place the request on the queue are clearly marked. | |
64 | - | |
65 | - @example | |
66 | - version | |
67 | - @end example | |
68 | - | |
69 | - Speaks the @emph{version} of the TTS engine. Produces output | |
70 | - immediately. | |
71 | - | |
72 | - @example | |
73 | - tts_say text | |
74 | - @end example | |
75 | - | |
76 | - Speaks the specified @emph{text} immediately. The text is not | |
77 | - pre-processed in any way, contrast this with the primary way of | |
78 | - speaking text which is to queue text before asking the server to | |
79 | - process the queue. | |
80 | - | |
81 | - @example | |
82 | - l c | |
83 | - @end example | |
84 | - | |
85 | - Speak @emph{c} a single character, as a letter. The character is | |
86 | - spoken immediately. This command uses the TTS engine's capability to | |
87 | - speak a single character with the ability to flush speech | |
88 | - @emph{immediately}. Client applications wishing to produce | |
89 | - character-at-a-time output, e.g., when providing character echo during | |
90 | - keyboard input should use this command. | |
91 | - | |
92 | - @example | |
93 | - d | |
94 | - @end example | |
95 | - | |
96 | - This command is used to @emph{dispatch} all queued requests. | |
97 | - It was renamed to a single character command (like many of the | |
98 | - commonly used TTS server commands) to work more effectively over | |
99 | - slow (9600) dialup lines. | |
100 | - The effect of calling this command is for the TTS server to start | |
101 | - processing items that have been queued via earlier requests. | |
102 | - | |
103 | - @example | |
104 | - tts_pause | |
105 | - @end example | |
106 | - | |
107 | - This pauses speech @emph{immediately}. | |
108 | - It does not affect queued requests; when command | |
109 | - @emph{tts_resume} is called, the output resumes at the point | |
110 | - where it was paused. Not all TTS engines provide this capability. | |
111 | - | |
112 | - @example | |
113 | - tts_resume | |
114 | - @end example | |
115 | - | |
116 | - Resume spoken output if it has been paused earlier. | |
117 | - | |
118 | - @example | |
119 | - s | |
120 | - @end example | |
121 | - | |
122 | - Stop speech @emph{immediately}. | |
123 | - Spoken output is interrupted, and all pending requests are | |
124 | - flushed from the queue. | |
125 | - | |
126 | - @example | |
127 | - q text | |
128 | - @end example | |
129 | - | |
130 | - Queues text to be spoken. No spoken output is produced until a | |
131 | - @emph{dispatch} request is received via execution of command | |
132 | - @emph{d}. | |
133 | - | |
134 | - @example | |
135 | - a filename | |
136 | - @end example | |
137 | - | |
138 | - Cues the audio file identified by filename for playing. | |
139 | - | |
140 | - @example | |
141 | - t freq length | |
142 | - @end example | |
143 | - | |
144 | - Queues a tone to be played at the specified frequency and having the | |
145 | - specified length. Frequency is specified in hertz and length is | |
146 | - specified in milliseconds. | |
147 | - | |
148 | - @example | |
149 | - sh duration | |
150 | - @end example | |
151 | - | |
152 | - Queues the specified duration of silence. Silence is specified in | |
153 | - milliseconds. | |
154 | - | |
155 | - @subsection Commands That Set State | |
156 | - | |
157 | - @example | |
158 | - tts_reset | |
159 | - @end example | |
160 | - | |
161 | - Reset TTS engine to default settings. | |
162 | - | |
163 | - @example | |
164 | - tts_set_punctuations mode | |
165 | - @end example | |
166 | - | |
167 | - Sets TTS engine to the specified punctuation mode. Typicaly, TTS | |
168 | - servers provide at least three modes: | |
169 | - @itemize @bullet | |
170 | - @item None: Do not speak punctuation characters. | |
171 | - @item some: Speak some punctuation characters. Used for English | |
172 | - prose. | |
173 | - @item all: Speak out @emph{all} punctuation characters; useful in | |
174 | - programming modes. | |
175 | - @end itemize | |
176 | - | |
177 | - @example | |
178 | - tts_set_speech_rate rate | |
179 | - @end example | |
180 | - | |
181 | - Sets speech rate. The interpretation of this value is typically | |
182 | - engine specific. | |
183 | - | |
184 | - @example | |
185 | - tts_set_character_scale factor | |
186 | - @end example | |
187 | - | |
188 | - Scale factor applied to speech rate when speaking individual | |
189 | - characters.Thus, setting speech rate to 500 and character | |
190 | - scale to 1.2 will cause command @emph{l} to use a speech rate | |
191 | - of @emph{500 * 1.2 = 600}. | |
192 | - | |
193 | - @example | |
194 | - tts_split_caps flag | |
195 | - @end example | |
196 | - | |
197 | - Set state of @emph{split caps} processing. Turn this on to | |
198 | - speak mixed-case (AKA Camel Case) identifiers. | |
199 | - | |
200 | - @example | |
201 | - tts_capitalize flag | |
202 | - @end example | |
203 | - | |
204 | - Indicate capitalization via a beep tone or voice pitch. | |
205 | - | |
206 | - @example | |
207 | - tts_allcaps_beep flag | |
208 | - @end example | |
209 | +@c $Id$ | |
210 | +@node TTS Servers | |
211 | +@chapter Emacspeak TTS Servers | |
212 | + | |
213 | +Emacspeak produces spoken output by communicating with one of many | |
214 | +speech servers. This section documents the communication protocol | |
215 | +between the client application i.e. Emacspeak, and the TTS | |
216 | +server. This section is primarily intended for developers wishing to: | |
217 | +@itemize @bullet | |
218 | +@item Create new speech servers that comply with this communication | |
219 | +protocol | |
220 | +@item Developers of other client applications who wish to use | |
221 | +the various Emacspeak speech servers. | |
222 | +@end itemize | |
223 | + | |
224 | +@subsection High-level Overview | |
225 | + | |
226 | +The TTS server reads commands from standard input, and script | |
227 | +@emph{speech-server} can be used to cause a TTS server to communicate | |
228 | +via a TCP socket. Speech server commands are used by the client | |
229 | +application to make specific requests of the server; the server | |
230 | +listens for these requests in a non-blocking read loop and executes | |
231 | +requests as they become available. Requests can be classified | |
232 | +as follows: | |
233 | +@itemize @bullet | |
234 | +@item Commands that send text to be spoken. | |
235 | +@item Commands that set @emph{state} of the TTS server. | |
236 | +@end itemize | |
237 | + | |
238 | +All commands are of the form | |
239 | +@example | |
240 | +commandWord @{arguments@} | |
241 | +@end example | |
242 | +The braces are optional if the command argument contains no white | |
243 | +space. The speech server maintains a @emph{current state} that | |
244 | +determines various characteristics of spoken output such as speech | |
245 | +rate, punctuations mode etc. (see set of commands that manipulate | |
246 | +speech state for complete list). The client application @emph{queues} The | |
247 | +text and non-speech audio output to be produced before asking the | |
248 | +server to @emph{dispatch} the set of queued requests, i.e. start | |
249 | +producing output. | |
250 | + | |
251 | +Once the server has been asked to produce output, it removes items | |
252 | +from the front of the queue, sends the requisite commands to the | |
253 | +underlying TTS engine, and waits for the engine to acknowledge that | |
254 | +the request has been completely processed. This is a non-blocking | |
255 | +operation, i.e., if the client application generates additional | |
256 | +requests, these are processed @emph{immediately}. | |
257 | + | |
258 | +The above design allows the Emacspeak TTS server to be | |
259 | +@emph{highly} responsive; Cleint applications can queue large | |
260 | +amounts of text (typically queued a clause at a time to | |
261 | +achieve the best prosody), ask the TTS server to start speaking, | |
262 | +and interrupt the spoken output at any time. | |
263 | + | |
264 | +@subsection Commands That Queue Output. | |
265 | + | |
266 | +This section documents commands that either produce spoken | |
267 | +output, or queue output to be produced on demand. | |
268 | +Commands that place the request on the queue are clearly marked. | |
269 | + | |
270 | +@example | |
271 | +version | |
272 | +@end example | |
273 | + | |
274 | +Speaks the @emph{version} of the TTS engine. Produces output | |
275 | +immediately. | |
276 | + | |
277 | +@example | |
278 | +tts_say text | |
279 | +@end example | |
280 | + | |
281 | +Speaks the specified @emph{text} immediately. The text is not | |
282 | +pre-processed in any way, contrast this with the primary way of | |
283 | +speaking text which is to queue text before asking the server to | |
284 | +process the queue. | |
285 | + | |
286 | +@example | |
287 | +l c | |
288 | +@end example | |
289 | + | |
290 | +Speak @emph{c} a single character, as a letter. The character is | |
291 | +spoken immediately. This command uses the TTS engine's capability to | |
292 | +speak a single character with the ability to flush speech | |
293 | +@emph{immediately}. Client applications wishing to produce | |
294 | +character-at-a-time output, e.g., when providing character echo during | |
295 | +keyboard input should use this command. | |
296 | + | |
297 | +@example | |
298 | +d | |
299 | +@end example | |
300 | + | |
301 | +This command is used to @emph{dispatch} all queued requests. | |
302 | +It was renamed to a single character command (like many of the | |
303 | +commonly used TTS server commands) to work more effectively over | |
304 | +slow (9600) dialup lines. | |
305 | +The effect of calling this command is for the TTS server to start | |
306 | +processing items that have been queued via earlier requests. | |
307 | + | |
308 | +@example | |
309 | +tts_pause | |
310 | +@end example | |
311 | + | |
312 | +This pauses speech @emph{immediately}. | |
313 | +It does not affect queued requests; when command | |
314 | +@emph{tts_resume} is called, the output resumes at the point | |
315 | +where it was paused. Not all TTS engines provide this capability. | |
316 | + | |
317 | +@example | |
318 | +tts_resume | |
319 | +@end example | |
320 | + | |
321 | +Resume spoken output if it has been paused earlier. | |
322 | + | |
323 | +@example | |
324 | +s | |
325 | +@end example | |
326 | + | |
327 | +Stop speech @emph{immediately}. | |
328 | +Spoken output is interrupted, and all pending requests are | |
329 | +flushed from the queue. | |
330 | + | |
331 | +@example | |
332 | +q text | |
333 | +@end example | |
334 | + | |
335 | +Queues text to be spoken. No spoken output is produced until a | |
336 | +@emph{dispatch} request is received via execution of command | |
337 | +@emph{d}. | |
338 | + | |
339 | +@example | |
340 | +a filename | |
341 | +@end example | |
342 | + | |
343 | +Cues the audio file identified by filename for playing. | |
344 | + | |
345 | +@example | |
346 | +t freq length | |
347 | +@end example | |
348 | + | |
349 | +Queues a tone to be played at the specified frequency and having the | |
350 | +specified length. Frequency is specified in hertz and length is | |
351 | +specified in milliseconds. | |
352 | + | |
353 | +@example | |
354 | +sh duration | |
355 | +@end example | |
356 | + | |
357 | +Queues the specified duration of silence. Silence is specified in | |
358 | +milliseconds. | |
359 | + | |
360 | +@subsection Commands That Set State | |
361 | + | |
362 | +@example | |
363 | +tts_reset | |
364 | +@end example | |
365 | + | |
366 | +Reset TTS engine to default settings. | |
367 | + | |
368 | +@example | |
369 | +tts_set_punctuations mode | |
370 | +@end example | |
371 | + | |
372 | +Sets TTS engine to the specified punctuation mode. Typicaly, TTS | |
373 | +servers provide at least three modes: | |
374 | +@itemize @bullet | |
375 | +@item None: Do not speak punctuation characters. | |
376 | +@item some: Speak some punctuation characters. Used for English | |
377 | +prose. | |
378 | +@item all: Speak out @emph{all} punctuation characters; useful in | |
379 | +programming modes. | |
380 | +@end itemize | |
381 | + | |
382 | +@example | |
383 | +tts_set_speech_rate rate | |
384 | +@end example | |
385 | + | |
386 | +Sets speech rate. The interpretation of this value is typically | |
387 | +engine specific. | |
388 | + | |
389 | +@example | |
390 | +tts_set_character_scale factor | |
391 | +@end example | |
392 | + | |
393 | +Scale factor applied to speech rate when speaking individual | |
394 | +characters.Thus, setting speech rate to 500 and character | |
395 | +scale to 1.2 will cause command @emph{l} to use a speech rate | |
396 | +of @emph{500 * 1.2 = 600}. | |
397 | + | |
398 | +@example | |
399 | +tts_split_caps flag | |
400 | +@end example | |
401 | + | |
402 | +Set state of @emph{split caps} processing. Turn this on to | |
403 | +speak mixed-case (AKA Camel Case) identifiers. | |
404 | + | |
405 | +@example | |
406 | +tts_capitalize flag | |
407 | +@end example | |
408 | + | |
409 | +Indicate capitalization via a beep tone or voice pitch. | |
410 | + | |
411 | +@example | |
412 | +tts_allcaps_beep flag | |
413 | +@end example | |
414 | ||
415 | - Setting this flag produces a high-pitched beep when speaking words that are in | |
416 | - all-caps, e.g. abbreviations. | |
417 | +Setting this flag produces a high-pitched beep when speaking words that are in | |
418 | +all-caps, e.g. abbreviations. | |
419 | ||
420 | --- emacspeak-24.orig/info/tts.texi | |
421 | +++ emacspeak-24/info/tts.texi | |
422 | @@ -1,5 +1,4 @@ | |
423 | @c $Id$ | |
424 | - @section Speech System Commands | |
425 | ||
426 | @cindex tts | |
427 | @cindex speech system | |
428 | @@ -10,7 +9,7 @@ | |
429 | ||
430 | @menu | |
431 | * Controlling Echo:: Character, Word and Line Echo. | |
432 | -* Speech Output Control:: Indicating case, capitalization and indentation. | |
433 | +* Speech Output Control:: Indicating case, capitalization and indentation. | |
434 | * Miscellaneous:: Miscellaneous TTS Commands. | |
435 | @end menu | |
436 | ||
437 | @@ -36,30 +35,30 @@ | |
438 | ||
439 | @table @kbd | |
440 | @findex emacspeak-toggle-character-echo | |
441 | - @kindex control e d k | |
442 | +@kindex control e d k | |
443 | @item @kbd{control e d k } | |
444 | emacspeak-toggle-character-echo | |
445 | - Toggle state of Emacspeak character echo. | |
446 | +Toggle state of Emacspeak character echo. | |
447 | Interactive PREFIX arg means toggle the global default value, and then set the | |
448 | current local value to the result. | |
449 | ||
450 | ||
451 | @findex emacspeak-toggle-word-echo | |
452 | - @kindex control e d w | |
453 | - | |
454 | +@kindex control e d w | |
455 | + | |
456 | @item @kbd{ control e d w } | |
457 | emacspeak-toggle-word-echo | |
458 | - Toggle state of Emacspeak word echo. | |
459 | +Toggle state of Emacspeak word echo. | |
460 | Interactive PREFIX arg means toggle the global default value, and then set the | |
461 | current local value to the result. | |
462 | ||
463 | ||
464 | @findex emacspeak-toggle-line-echo | |
465 | - @kindex control e d l | |
466 | - | |
467 | +@kindex control e d l | |
468 | + | |
469 | @item @kbd{ control e d l } | |
470 | emacspeak-toggle-line-echo | |
471 | - Toggle state of Emacspeak line echo. | |
472 | +Toggle state of Emacspeak line echo. | |
473 | Interactive PREFIX arg means toggle the global default value, and then set the | |
474 | current local value to the result. | |
475 | @end table | |
476 | @@ -82,21 +81,21 @@ | |
477 | @table @kbd | |
478 | ||
479 | @findex dtk-set-rate | |
480 | - @kindex control e d r | |
481 | - | |
482 | +@kindex control e d r | |
483 | + | |
484 | @item @kbd{ control e d r } | |
485 | dtk-set-rate | |
486 | - Set speaking RATE for the tts. | |
487 | +Set speaking RATE for the tts. | |
488 | Interactive PREFIX arg means set the global default value, and then set the | |
489 | current local value to the result. | |
490 | ||
491 | ||
492 | @findex dtk-set-character-scale | |
493 | - @kindex control e d f | |
494 | - | |
495 | +@kindex control e d f | |
496 | + | |
497 | @item @kbd{ control e d f } | |
498 | dtk-set-character-scale | |
499 | - Set scale FACTOR for speech rate. | |
500 | +Set scale FACTOR for speech rate. | |
501 | Speech rate is scaled by this factor | |
502 | when speaking characters. | |
503 | Interactive PREFIX arg means set the global default value, and then set the | |
504 | @@ -109,20 +108,20 @@ | |
505 | ||
506 | ||
507 | @findex dtk-set-predefined-speech-rate | |
508 | - @kindex 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 | |
509 | - | |
510 | +@kindex 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 | |
511 | + | |
512 | @item @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 } | |
513 | dtk-set-predefined-speech-rate | |
514 | - Set speech rate to one of nine predefined levels. | |
515 | +Set speech rate to one of nine predefined levels. | |
516 | Interactive PREFIX arg says to set the rate globally. | |
517 | ||
518 | ||
519 | @findex dtk-set-punctuations | |
520 | - @kindex control e d p | |
521 | - | |
522 | +@kindex control e d p | |
523 | + | |
524 | @item @kbd{ control e d p } | |
525 | dtk-set-punctuations | |
526 | - Set punctuation mode to MODE. | |
527 | +Set punctuation mode to MODE. | |
528 | Possible values are `some', `all', or `none'. | |
529 | Interactive PREFIX arg means set the global default value, and then set the | |
530 | current local value to the result. | |
531 | @@ -130,11 +129,11 @@ | |
532 | ||
533 | ||
534 | @findex dtk-set-pronunciation-mode | |
535 | - @kindex control e d m | |
536 | - | |
537 | +@kindex control e d m | |
538 | + | |
539 | @item @kbd{ control e d m } | |
540 | dtk-set-pronunciation-mode | |
541 | - Set pronunciation MODE. | |
542 | +Set pronunciation MODE. | |
543 | This command is valid only for newer | |
544 | Dectalks, e.g. the Dectalk Express. Possible values are `math, name, | |
545 | europe, spell', all of which can be turned on or off. | |
546 | @@ -143,11 +142,11 @@ | |
547 | ||
548 | ||
549 | @findex dtk-toggle-split-caps | |
550 | - @kindex control e d s | |
551 | +@kindex control e d s | |
552 | ||
553 | @item @kbd{ control e d s } | |
554 | dtk-toggle-split-caps | |
555 | - Toggle split caps mode. | |
556 | +Toggle split caps mode. | |
557 | Split caps mode is useful when reading | |
558 | Hungarian notation in program source code. Interactive PREFIX arg | |
559 | means toggle the global default value, and then set the current local | |
560 | @@ -155,22 +154,22 @@ | |
561 | ||
562 | ||
563 | @findex dtk-toggle-capitalization | |
564 | - @kindex control e d c | |
565 | - | |
566 | +@kindex control e d c | |
567 | + | |
568 | @item @kbd{ control e d c } | |
569 | dtk-toggle-capitalization | |
570 | - Toggle capitalization. | |
571 | +Toggle capitalization. | |
572 | when set, capitalization is indicated by a | |
573 | short beep. Interactive PREFIX arg means toggle the global default | |
574 | value, and then set the current local value to the result. | |
575 | ||
576 | ||
577 | @findex dtk-toggle-allcaps-beep | |
578 | - @kindex control e d cap C | |
579 | - | |
580 | +@kindex control e d cap C | |
581 | + | |
582 | @item @kbd{ control e d cap C } | |
583 | dtk-toggle-allcaps-beep | |
584 | - Toggle allcaps-beep. | |
585 | +Toggle allcaps-beep. | |
586 | when set, allcaps words are indicated by a | |
587 | short beep. Interactive PREFIX arg means toggle the global default | |
588 | value, and then set the current local value to the result. | |
589 | @@ -188,11 +187,11 @@ | |
590 | @table @kbd | |
591 | ||
592 | @findex emacspeak-toggle-audio-indentation | |
593 | - @kindex control e d i | |
594 | - | |
595 | +@kindex control e d i | |
596 | + | |
597 | @item @kbd{ control e d i } | |
598 | emacspeak-toggle-audio-indentation | |
599 | - Toggle state of Emacspeak audio indentation. | |
600 | +Toggle state of Emacspeak audio indentation. | |
601 | Interactive PREFIX arg means toggle the global default value, and then set the | |
602 | current local value to the result. | |
603 | Specifying the method of indentation as `tones' | |
604 | @@ -227,19 +226,19 @@ | |
605 | @table @kbd | |
606 | ||
607 | @findex dtk-stop | |
608 | - @kindex pause control e s | |
609 | - | |
610 | +@kindex pause control e s | |
611 | + | |
612 | @item @kbd{Control e s} | |
613 | dtk-stop | |
614 | - Stop speech now. | |
615 | +Stop speech now. | |
616 | ||
617 | ||
618 | @findex dtk-pause | |
619 | - @kindex control e p | |
620 | - | |
621 | +@kindex control e p | |
622 | + | |
623 | @item @kbd{ control e p } | |
624 | dtk-pause | |
625 | - Pause ongoing speech. | |
626 | +Pause ongoing speech. | |
627 | The speech can be resumed with command `dtk-resume' | |
628 | normally bound to C-e SPC. Pausing speech is useful when one needs to | |
629 | perform a few actions before continuing to read a large document. Emacspeak | |
630 | @@ -250,24 +249,24 @@ | |
631 | ||
632 | ||
633 | @findex dtk-resume | |
634 | - @kindex control e SPACE | |
635 | - | |
636 | +@kindex control e SPACE | |
637 | + | |
638 | @item @kbd{ control e SPACE } | |
639 | dtk-resume | |
640 | - Resume paused speech. | |
641 | +Resume paused speech. | |
642 | This command resumes speech that has been suspended by executing | |
643 | command `dtk-pause' bound to C-e p. | |
644 | If speech has not been paused, | |
645 | and variable `dtk-resume-should-toggle' is t | |
646 | - then this command will pause ongoing speech. | |
647 | +then this command will pause ongoing speech. | |
648 | ||
649 | ||
650 | @findex dtk-toggle-quiet | |
651 | - @kindex control e d q | |
652 | - | |
653 | +@kindex control e d q | |
654 | + | |
655 | @item @kbd{ control e d q } | |
656 | dtk-toggle-quiet | |
657 | - Toggle state of the speech device between being quiet and talkative. | |
658 | +Toggle state of the speech device between being quiet and talkative. | |
659 | Useful if you want to continue using an Emacs session that has | |
660 | emacspeak loaded but wish to make the speech shut up. | |
661 | Optional argument PREFIX specifies whether speech is turned off in the current buffer or in all buffers. | |
662 | @@ -275,11 +274,11 @@ | |
663 | ||
664 | ||
665 | @findex dtk-emergency-restart | |
666 | - @kindex control e control s | |
667 | - | |
668 | +@kindex control e control s | |
669 | + | |
670 | @item @kbd{ control e control s } | |
671 | dtk-emergency-restart | |
672 | - Use this to nuke the currently running dtk server and restart it. | |
673 | +Use this to nuke the currently running dtk server and restart it. | |
674 | Useful if you want to switch to another synthesizer while emacspeak is | |
675 | running. Also useful for emergency stopping of speech. | |
676 | ||
677 | @@ -293,11 +292,11 @@ | |
678 | @table @kbd | |
679 | ||
680 | @findex dtk-add-cleanup-pattern | |
681 | - @kindex control e d a | |
682 | - | |
683 | +@kindex control e d a | |
684 | + | |
685 | @item @kbd{ control e d a } | |
686 | dtk-add-cleanup-pattern | |
687 | - Add this pattern to the list of repeating patterns that are cleaned up. | |
688 | +Add this pattern to the list of repeating patterns that are cleaned up. | |
689 | Optional interactive prefix arg deletes this pattern if | |
690 | previously added. Cleaning up repeated patterns results in emacspeak | |
691 | speaking the pattern followed by a repeat count instead of speaking | |
692 | @@ -310,22 +309,22 @@ | |
693 | ||
694 | ||
695 | @findex dtk-select-server | |
696 | - @kindex control e d d | |
697 | - | |
698 | +@kindex control e d d | |
699 | + | |
700 | @item @kbd{ control e d d } | |
701 | dtk-select-server | |
702 | - Select a speech server interactively. | |
703 | +Select a speech server interactively. | |
704 | This will be the server that is used when you next call either | |
705 | M-x dtk-initialize or C-e C-s. | |
706 | Argument PROGRAM specifies the speech server program. | |
707 | ||
708 | ||
709 | @findex dtk-toggle-splitting-on-white-space | |
710 | - @kindex control e d SPACE | |
711 | - | |
712 | +@kindex control e d SPACE | |
713 | + | |
714 | @item @kbd{ control e d SPACE } | |
715 | dtk-toggle-splitting-on-white-space | |
716 | - Toggle splitting of speech on white space. | |
717 | +Toggle splitting of speech on white space. | |
718 | This affects the internal state of emacspeak that decides if we split | |
719 | text purely by clause boundaries, or also include | |
720 | whitespace. By default, emacspeak sends a clause at a time | |
721 | @@ -342,37 +341,37 @@ | |
722 | ||
723 | ||
724 | @findex dtk-set-chunk-separator-syntax | |
725 | - @kindex control e d RETURN | |
726 | - | |
727 | +@kindex control e d RETURN | |
728 | + | |
729 | @item @kbd{ control e d RETURN } | |
730 | dtk-set-chunk-separator-syntax | |
731 | - Interactively set how text is split in chunks. | |
732 | +Interactively set how text is split in chunks. | |
733 | See the Emacs documentation on syntax tables for details on how characters are | |
734 | classified into various syntactic classes. | |
735 | Argument S specifies the syntax class. | |
736 | ||
737 | ||
738 | @findex emacspeak-dial-dtk | |
739 | - @kindex control e d t | |
740 | - | |
741 | +@kindex control e d t | |
742 | + | |
743 | @item @kbd{ control e d t } | |
744 | emacspeak-dial-dtk | |
745 | - Prompt for and dial a phone NUMBER with the Dectalk. | |
746 | +Prompt for and dial a phone NUMBER with the Dectalk. | |
747 | ||
748 | ||
749 | @findex emacspeak-dtk-speak-version | |
750 | - @kindex control e d cap V | |
751 | - | |
752 | +@kindex control e d cap V | |
753 | + | |
754 | @item @kbd{ control e d cap V } | |
755 | emacspeak-dtk-speak-version | |
756 | - Use this to find out which version of the TTS firmware you are running. | |
757 | +Use this to find out which version of the TTS firmware you are running. | |
758 | ||
759 | ||
760 | @findex emacspeak-zap-dtk | |
761 | - @kindex control e d z | |
762 | - | |
763 | +@kindex control e d z | |
764 | + | |
765 | @item @kbd{ control e d z } | |
766 | emacspeak-zap-dtk | |
767 | - Send this command to the TTS engine directly. | |
768 | +Send this command to the TTS engine directly. | |
769 | ||
770 | @end table | |
771 | --- emacspeak-24.orig/info/emacspeak.texi | |
772 | +++ emacspeak-24/info/emacspeak.texi | |
773 | @@ -12,7 +12,7 @@ | |
774 | ||
775 | @include preamble.texi | |
776 | @include copyright.texi | |
777 | -@include announce.texi | |
778 | +@include announce.texi | |
779 | @include introduction.texi | |
780 | @include install.texi | |
781 | @include using.texi | |
782 | --- emacspeak-24.orig/servers/tts-lib.tcl | |
783 | +++ emacspeak-24/servers/tts-lib.tcl | |
784 | @@ -1,3 +1,4 @@ | |
785 | +#!/usr/bin/tclsh | |
786 | #$Id$ | |
787 | # {{{ LCD Entry: | |
788 | #x | |
789 | --- emacspeak-24.orig/etc/Makefile | |
790 | +++ emacspeak-24/etc/Makefile | |
791 | @@ -47,7 +47,8 @@ | |
792 | # {{{ User level target-- config | |
793 | config: | |
794 | @rm -f emacspeak.sh | |
795 | - @sed "s@<emacspeak-dir>@$(SRC)/lisp@g" \ | |
796 | + @sed -e "s@<emacspeak-dir>@/usr/share/$(FLAVOR)/site-lisp/emacspeak/lisp@g" \ | |
797 | + -e 's/exec emacs/exec $(FLAVOR)/' \ | |
798 | emacspeak.sh.def > emacspeak.sh | |
799 | @chmod 755 emacspeak.sh | |
800 | @chmod 755 *.pl | |
801 | --- emacspeak-24.orig/debian/README.Debian | |
802 | +++ emacspeak-24/debian/README.Debian | |
803 | @@ -0,0 +1,87 @@ | |
804 | +emacspeak for DEBIAN | |
805 | +---------------------- | |
806 | + | |
807 | +Emacspeak is authored by T. V. Raman <raman@cs.cornell.edu>. These | |
808 | +are the primary changes made in building the Debian package: html and | |
809 | +plain text versions of the documentation were added. A configuration | |
810 | +script (/usr/sbin/emacspeakconfig) and associated speech server | |
811 | +descriptions (/usr/share/emacs/site-lisp/emacspeak/blurbs/*) were | |
812 | +added. Manual pages for emacspeak and the configuration script were | |
813 | +added. Minor changes are listed in changelog.Debian. | |
814 | + | |
815 | +The user is expected to start emacspeak with /usr/bin/emacspeak, which | |
816 | +gets configuration parameters from /etc/emacspeak.conf and starts | |
817 | +emacs with emacspeak support. | |
818 | + | |
819 | +Several "flavors" of emacs may be installed at the same time (emacs20, | |
820 | +emacs21, xemacs21, etc.). In accordance with the Debian emacs policy, | |
821 | +emacspeak is byte-compiled separately for each supported flavor - | |
822 | +currently only emacs21. There is a separate script to start each | |
823 | +flavor of emacs with emacspeak support - for example, | |
824 | +/usr/bin/emacspeak.emacs21. /usr/bin/emacspeak is actually a symlink | |
825 | +managed by the "alternatives" mechanism. That is, it points to | |
826 | +/etc/alternatives/emacspeak, which points to one of several links like | |
827 | +/usr/bin/emacspeak.emacs21. (See the manpage for | |
828 | +update-alternatives.) | |
829 | + | |
830 | +The alternatives for emacspeak inherit their priorities from the | |
831 | +corresponding emacs packages. So, as long as the emacs and emacspeak | |
832 | +alternatives are in "automatic" mode, both "emacs" and "emacspeak" | |
833 | +will start emacs21. If someday an emacs22 package is installed, with | |
834 | +priority higher than for emacs 21, then by default both "emacs" and | |
835 | +"emacspeak" will start emacs22. | |
836 | + | |
837 | +The administrator can use update-alternatives to change which flavor | |
838 | +is started by either /usr/bin/emacs or /usr/bin/emacspeak. Or, of | |
839 | +course, any user can use one of the flavor-specific links like | |
840 | +/usr/bin/emacspeak.emacs21 to start whichever flavor he wants. | |
841 | + | |
842 | +Starting with version 11.0, the Emacspeak sources include a speech | |
843 | +server written in C++ for the IBM ViaVoice speech synthesis software. | |
844 | +However, it depends on the ViaVoice runtime kit which does not meet | |
845 | +the Debian Free Software Guidelines. (It is available only as object | |
846 | +code, and only under a temporary license.) Therefore, support for | |
847 | +ViaVoice is not included in this Debian package. If you would like to | |
848 | +try it, you can find some information in | |
849 | +/usr/share/docs/emacspeak/VIAVOICE. | |
850 | + | |
851 | +Starting with version 10.0, Dr. Raman has rewritten the documentation | |
852 | +files. Approximately 100 commands are described there, compared to | |
853 | +over 800 in the documentation shipped with the previous release. | |
854 | +Therefore, the user should pay particular attention to the section | |
855 | +"Using Online Help". | |
856 | + | |
857 | +Many command-line applications can be run under emacs, and can | |
858 | +therefore be made accessible with emacspeak. Much of this is | |
859 | +explained in the documentation entitled "Running Terminal Based | |
860 | +Applications". However, it is worth emphasizing this point: "For | |
861 | +regular shell interaction just use M-x shell instead of using the | |
862 | +terminal emulator." | |
863 | + | |
864 | +The example file "tables.html" was supplied by Dr. Raman in a separate | |
865 | +email. It may be found in /usr/doc/emacspeak/examples. It includes a | |
866 | +sample table with three columns (labeled "item", "date", and | |
867 | +"amount"), and three rows. For a discussion of the support for tables | |
868 | +in emacspeak and w3, see NEWS (or NEWS.gz) in /usr/doc/emacspeak. | |
869 | + | |
870 | +The Emacspeak-HOWTO contains additional documentation. The plain text | |
871 | +form of this can be found in the Debian package doc-linux, and is | |
872 | +installed as /usr/doc/HOWTO/Emacspeak-HOWTO.gz. Other formats are | |
873 | +also available. For example, these can be found at sunsite.unc.edu: | |
874 | + | |
875 | + /pub/Linux/docs/HOWTO/other-formats/dvi/Emacspeak-HOWTO.dvi.gz | |
876 | + /pub/Linux/docs/HOWTO/other-formats/html/Emacspeak-HOWTO-html.tar.gz | |
877 | + /pub/Linux/docs/HOWTO/other-formats/ps/Emacspeak-HOWTO.ps.gz | |
878 | + /pub/Linux/docs/HOWTO/other-formats/sgml/Emacspeak-HOWTO.sgml.gz | |
879 | + | |
880 | +There is also an Emacspeak mailing list. To subscribe, send a message | |
881 | +to: | |
882 | + | |
883 | + emacspeak-request@cs.vassar.edu | |
884 | + | |
885 | +with a subject of: | |
886 | + | |
887 | + subscribe | |
888 | + | |
889 | +James R. Van Zandt <jrv@debian.org>, Mon Jan 30 21:36:59 EST 2006 | |
890 | + | |
891 | --- emacspeak-24.orig/debian/DOC | |
892 | +++ emacspeak-24/debian/DOC | |
893 | @@ -0,0 +1,3373 @@ | |
894 | +DOC --- Automatically generated by command emacspeak-generate-documentation | |
895 | +$Id$ | |
896 | +------------------------------------------------------------ | |
897 | + | |
898 | +** dtk-add-cleanup-pattern Key Sequence: control e d a | |
899 | + | |
900 | +Add this pattern to the list of repeating patterns that | |
901 | +are cleaned up. Optional interactive prefix arg deletes | |
902 | +this pattern if previously added. Cleaning up repeated | |
903 | +patterns results in emacspeak speaking the pattern followed | |
904 | +by a repeat count instead of speaking all the characters | |
905 | +making up the pattern. Thus, by adding the repeating | |
906 | +pattern `.' (this is already added by default) emacspeak | |
907 | +will say ``aw fifteen dot'' when speaking the string | |
908 | +``...............'' instead of ``period period period period | |
909 | +'' | |
910 | + | |
911 | +------------------------------------------------------------ | |
912 | + | |
913 | +** dtk-notes-shutdown | |
914 | + | |
915 | +Shutdown midi system. | |
916 | + | |
917 | +------------------------------------------------------------ | |
918 | + | |
919 | +** dtk-pause Key Sequence: control e p | |
920 | + | |
921 | +Pause ongoing speech. | |
922 | +The speech can be resumed with command `dtk-resume' | |
923 | +normally bound to C-e SPC. Pausing speech is useful when one needs to | |
924 | +perform a few actions before continuing to read a large document. Emacspeak | |
925 | +gives you speech feedback as usual once speech has been paused. `dtk-resume' | |
926 | +continues the interrupted speech irrespective of the buffer | |
927 | +in which it is executed. | |
928 | +Optional PREFIX arg flushes any previously paused speech. | |
929 | + | |
930 | +------------------------------------------------------------ | |
931 | + | |
932 | +** dtk-reset-state Key Sequence: control e d cap R | |
933 | + | |
934 | +Restore sanity to the Dectalk. | |
935 | +Typically used after the Dectalk has been power cycled. | |
936 | + | |
937 | +------------------------------------------------------------ | |
938 | + | |
939 | +** dtk-resume Key Sequence: control e SPACE | |
940 | + | |
941 | +Resume paused speech. | |
942 | +This command resumes speech that has been suspended by executing | |
943 | +command `dtk-pause' bound to C-e p. | |
944 | +If speech has not been paused, | |
945 | +and variable `dtk-resume-should-toggle' is t | |
946 | + then this command will pause ongoing speech. | |
947 | + | |
948 | +------------------------------------------------------------ | |
949 | + | |
950 | +** dtk-select-server Key Sequence: control e d d | |
951 | + | |
952 | +Select a speech server interactively. | |
953 | +Argument PROGRAM specifies the speech server program. | |
954 | +When called interactively, The selected server is started immediately. | |
955 | + | |
956 | +------------------------------------------------------------ | |
957 | + | |
958 | +** dtk-set-character-scale Key Sequence: control e d f | |
959 | + | |
960 | +Set scale FACTOR for speech rate. | |
961 | +Speech rate is scaled by this factor | |
962 | +when speaking characters. | |
963 | +Interactive PREFIX arg means set the global default value, and then set the | |
964 | +current local value to the result. | |
965 | + | |
966 | +------------------------------------------------------------ | |
967 | + | |
968 | +** dtk-set-chunk-separator-syntax Key Sequence: control e d RETURN | |
969 | + | |
970 | +Interactively set how text is split in chunks. | |
971 | +See the Emacs documentation on syntax tables for details on how characters are | |
972 | +classified into various syntactic classes. | |
973 | +Argument S specifies the syntax class. | |
974 | + | |
975 | +------------------------------------------------------------ | |
976 | + | |
977 | +** dtk-set-predefined-speech-rate Key Sequence: 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 | |
978 | + | |
979 | +Set speech rate to one of nine predefined levels. | |
980 | +Interactive PREFIX arg says to set the rate globally. | |
981 | +Formula used is: | |
982 | +rate = dtk-speech-rate-base + dtk-speech-rate-step * level. | |
983 | + | |
984 | +------------------------------------------------------------ | |
985 | + | |
986 | +** dtk-set-punctuations Key Sequence: control e d p | |
987 | + | |
988 | +Set punctuation mode to MODE. | |
989 | +Possible values are `some', `all', or `none'. | |
990 | +Interactive PREFIX arg means set the global default value, and then set the | |
991 | +current local value to the result. | |
992 | + | |
993 | +------------------------------------------------------------ | |
994 | + | |
995 | +** dtk-set-punctuations-to-all | |
996 | + | |
997 | +Set punctuation mode to all. | |
998 | +Interactive PREFIX arg sets punctuation mode globally. | |
999 | + | |
1000 | +------------------------------------------------------------ | |
1001 | + | |
1002 | +** dtk-set-punctuations-to-some | |
1003 | + | |
1004 | +Set punctuation mode to some. | |
1005 | +Interactive PREFIX arg sets punctuation mode globally. | |
1006 | + | |
1007 | +------------------------------------------------------------ | |
1008 | + | |
1009 | +** dtk-set-rate Key Sequence: control e d r | |
1010 | + | |
1011 | +Set speaking RATE for the tts. | |
1012 | +Interactive PREFIX arg means set the global default value, and then set the | |
1013 | +current local value to the result. | |
1014 | + | |
1015 | +------------------------------------------------------------ | |
1016 | + | |
1017 | +** dtk-stop Key Sequence: <pause> control e s | |
1018 | + | |
1019 | +Stop speech now. | |
1020 | + | |
1021 | +------------------------------------------------------------ | |
1022 | + | |
1023 | +** dtk-toggle-allcaps-beep Key Sequence: control e d cap C | |
1024 | + | |
1025 | +Toggle allcaps-beep. | |
1026 | +when set, allcaps words are indicated by a | |
1027 | +short beep. Interactive PREFIX arg means toggle the global default | |
1028 | +value, and then set the current local value to the result. | |
1029 | +Note that allcaps-beep is a very useful thing when programming. | |
1030 | +However it is irritating to have it on when reading documents. | |
1031 | + | |
1032 | +------------------------------------------------------------ | |
1033 | + | |
1034 | +** dtk-toggle-capitalization Key Sequence: control e d c | |
1035 | + | |
1036 | +Toggle capitalization. | |
1037 | +when set, capitalization is indicated by a | |
1038 | +short beep. Interactive PREFIX arg means toggle the global default | |
1039 | +value, and then set the current local value to the result. | |
1040 | + | |
1041 | +------------------------------------------------------------ | |
1042 | + | |
1043 | +** dtk-toggle-debug Key Sequence: control e d b | |
1044 | + | |
1045 | +Toggle state of the debug FLAG. | |
1046 | +When debugging is on, you can switch to the buffer | |
1047 | +*speaker* to examine the output from the process | |
1048 | +that talks to the speech device by using command C-e d C-M-b. | |
1049 | +Note: *speaker* is a hidden buffer, ie it has a leading space in its name. | |
1050 | + | |
1051 | +------------------------------------------------------------ | |
1052 | + | |
1053 | +** dtk-toggle-punctuation-mode | |
1054 | + | |
1055 | +Toggle punctuation mode between "some" and "all". | |
1056 | +Interactive PREFIX arg makes the new setting global. | |
1057 | + | |
1058 | +------------------------------------------------------------ | |
1059 | + | |
1060 | +** dtk-toggle-quiet Key Sequence: control e d q | |
1061 | + | |
1062 | +Toggles state of dtk-quiet. | |
1063 | +Turning on this switch silences speech. | |
1064 | +Optional interactive prefix arg causes this setting to become global. | |
1065 | + | |
1066 | +------------------------------------------------------------ | |
1067 | + | |
1068 | +** dtk-toggle-speak-nonprinting-chars Key Sequence: control e d n | |
1069 | + | |
1070 | +Toggle speak-nonprinting-chars. | |
1071 | +Switches behavior of how characters with the high bit set are handled. | |
1072 | +Interactive PREFIX arg means toggle the global default | |
1073 | +value, and then set the current local value to the result. | |
1074 | + | |
1075 | +------------------------------------------------------------ | |
1076 | + | |
1077 | +** dtk-toggle-split-caps Key Sequence: control e d s | |
1078 | + | |
1079 | +Toggle split caps mode. | |
1080 | +Split caps mode is useful when reading | |
1081 | +Hungarian notation in program source code. Interactive PREFIX arg | |
1082 | +means toggle the global default value, and then set the current local | |
1083 | +value to the result. | |
1084 | + | |
1085 | +------------------------------------------------------------ | |
1086 | + | |
1087 | +** dtk-toggle-splitting-on-white-space Key Sequence: control e d SPACE | |
1088 | + | |
1089 | +Toggle splitting of speech on white space. | |
1090 | +This affects the internal state of emacspeak that decides if we split | |
1091 | +text purely by clause boundaries, or also include | |
1092 | +whitespace. By default, emacspeak sends a clause at a time | |
1093 | +to the speech device. This produces fluent speech for | |
1094 | +normal use. However in modes such as `shell-mode' and some | |
1095 | +programming language modes, clause markers appear | |
1096 | +infrequently, and this can result in large amounts of text | |
1097 | +being sent to the speech device at once, making the system | |
1098 | +unresponsive when asked to stop talking. Splitting on white | |
1099 | +space makes emacspeak's stop command responsive. However, | |
1100 | +when splitting on white space, the speech sounds choppy | |
1101 | +since the synthesizer is getting a word at a time. | |
1102 | + | |
1103 | +------------------------------------------------------------ | |
1104 | + | |
1105 | +** dtk-toggle-stop-immediately-while-typing Key Sequence: control e d cap I | |
1106 | + | |
1107 | +Toggle state of variable `dtk-stop-immediately-while-typing'. | |
1108 | +As the name implies, if T then speech flushes immediately as you | |
1109 | +type. Optional argument PREFIX specifies if the setting applies | |
1110 | +to all buffers. | |
1111 | + | |
1112 | +------------------------------------------------------------ | |
1113 | + | |
1114 | +** emacspeak-describe-emacspeak Key Sequence: control h control e | |
1115 | + | |
1116 | +Give a brief overview of emacspeak. | |
1117 | + | |
1118 | +------------------------------------------------------------ | |
1119 | + | |
1120 | +** emacspeak-submit-bug Key Sequence: control e CONTROL meta b | |
1121 | + | |
1122 | +Function to submit a bug to the programs maintainer. | |
1123 | + | |
1124 | +------------------------------------------------------------ | |
1125 | + | |
1126 | +** emacspeak-aumix Key Sequence: control e ( | |
1127 | + | |
1128 | +Setup output parameters of the auditory display. | |
1129 | + Launch this tool while you have auditory output on | |
1130 | +multiple channels playing so you can | |
1131 | +adjust the settings to your preference. Hit q to quit when | |
1132 | +you are done. | |
1133 | + | |
1134 | +------------------------------------------------------------ | |
1135 | + | |
1136 | +** emacspeak-aumix-edit | |
1137 | + | |
1138 | +Edit aumix settings interactively. | |
1139 | +Run command M-x emacspeak-aumix-reset | |
1140 | +after saving the settings to have them take effect. | |
1141 | + | |
1142 | +------------------------------------------------------------ | |
1143 | + | |
1144 | +** emacspeak-aumix-reset | |
1145 | + | |
1146 | +Reset to default audio settings. | |
1147 | + | |
1148 | +------------------------------------------------------------ | |
1149 | + | |
1150 | +** emacspeak-aumix-volume-decrease | |
1151 | + | |
1152 | +Decrease overall volume. | |
1153 | + | |
1154 | +------------------------------------------------------------ | |
1155 | + | |
1156 | +** emacspeak-aumix-volume-increase | |
1157 | + | |
1158 | +Increase overall volume. | |
1159 | + | |
1160 | +------------------------------------------------------------ | |
1161 | + | |
1162 | +** emacspeak-aumix-wave-decrease | |
1163 | + | |
1164 | +Decrease volume of wave output. | |
1165 | + | |
1166 | +------------------------------------------------------------ | |
1167 | + | |
1168 | +** emacspeak-aumix-wave-increase | |
1169 | + | |
1170 | +Increase volume of wave output. | |
1171 | + | |
1172 | +------------------------------------------------------------ | |
1173 | + | |
1174 | +** emacspeak-list-buffers-next-line | |
1175 | + | |
1176 | +Speech enabled buffer menu navigation | |
1177 | + | |
1178 | +------------------------------------------------------------ | |
1179 | + | |
1180 | +** emacspeak-list-buffers-previous-line | |
1181 | + | |
1182 | +Speech enabled buffer menu navigation | |
1183 | + | |
1184 | +------------------------------------------------------------ | |
1185 | + | |
1186 | +** emacspeak-list-buffers-speak-buffer-line | |
1187 | + | |
1188 | +Speak information about this buffer | |
1189 | + | |
1190 | +------------------------------------------------------------ | |
1191 | + | |
1192 | +** emacspeak-list-buffers-speak-buffer-name | |
1193 | + | |
1194 | +Speak the name of the buffer on this line | |
1195 | + | |
1196 | +------------------------------------------------------------ | |
1197 | + | |
1198 | +** emacspeak-compilation-speak-error | |
1199 | + | |
1200 | +Speech feedback about the compilation error. | |
1201 | + | |
1202 | +------------------------------------------------------------ | |
1203 | + | |
1204 | +** emacspeak-custom-goto-group | |
1205 | + | |
1206 | +Jump to custom group when in a customization buffer. | |
1207 | + | |
1208 | +------------------------------------------------------------ | |
1209 | + | |
1210 | +** emacspeak-custom-goto-toolbar | |
1211 | + | |
1212 | +Jump to custom toolbar when in a customization buffer. | |
1213 | + | |
1214 | +------------------------------------------------------------ | |
1215 | + | |
1216 | +** emacspeak-dired-label-fields | |
1217 | + | |
1218 | +Labels the fields of the listing in the dired buffer. | |
1219 | +Currently is a no-op unless | |
1220 | +unless `dired-listing-switches' contains -al | |
1221 | + | |
1222 | +------------------------------------------------------------ | |
1223 | + | |
1224 | +** emacspeak-dired-show-file-type | |
1225 | + | |
1226 | +Displays type of current file by running command file. | |
1227 | +Like Emacs' built-in dired-show-file-type but allows user to customize | |
1228 | +options passed to command `file'. | |
1229 | + | |
1230 | +------------------------------------------------------------ | |
1231 | + | |
1232 | +** emacspeak-dired-speak-file-access-time | |
1233 | + | |
1234 | +Speak access time of the current file. | |
1235 | + | |
1236 | +------------------------------------------------------------ | |
1237 | + | |
1238 | +** emacspeak-dired-speak-file-modification-time | |
1239 | + | |
1240 | +Speak modification time of the current file. | |
1241 | + | |
1242 | +------------------------------------------------------------ | |
1243 | + | |
1244 | +** emacspeak-dired-speak-file-permissions | |
1245 | + | |
1246 | +Speak the permissions of the current file. | |
1247 | + | |
1248 | +------------------------------------------------------------ | |
1249 | + | |
1250 | +** emacspeak-dired-speak-file-size | |
1251 | + | |
1252 | +Speak the size of the current file. | |
1253 | +On a directory line, run du -s on the directory to speak its size. | |
1254 | + | |
1255 | +------------------------------------------------------------ | |
1256 | + | |
1257 | +** emacspeak-dired-speak-header-line | |
1258 | + | |
1259 | +Speak the header line of the dired buffer. | |
1260 | + | |
1261 | +------------------------------------------------------------ | |
1262 | + | |
1263 | +** emacspeak-dired-speak-symlink-target | |
1264 | + | |
1265 | +Speaks the target of the symlink on the current line. | |
1266 | + | |
1267 | +------------------------------------------------------------ | |
1268 | + | |
1269 | +** emacspeak-eterm-copy-region-to-register | |
1270 | + | |
1271 | +Copy text from terminal to an Emacs REGISTER. | |
1272 | +This copies region delimited by the emacspeak eterm marker | |
1273 | +set by command M-x emacspeak-eterm-set-marker and the | |
1274 | +emacspeak eterm pointer to a register. | |
1275 | + | |
1276 | +------------------------------------------------------------ | |
1277 | + | |
1278 | +** emacspeak-eterm-define-window | |
1279 | + | |
1280 | +Prompt for a window ID. | |
1281 | +The window is then define to be | |
1282 | +the rectangle delimited by point and eterm mark. This is to | |
1283 | +be used when emacspeak is set to review mode inside an | |
1284 | +eterm. | |
1285 | + | |
1286 | +------------------------------------------------------------ | |
1287 | + | |
1288 | +** emacspeak-eterm-describe-window | |
1289 | + | |
1290 | +Describe an eterm window. | |
1291 | +Description indicates eterm window coordinates and whether it is stretchable | |
1292 | + | |
1293 | +------------------------------------------------------------ | |
1294 | + | |
1295 | +** emacspeak-eterm-goto-line | |
1296 | + | |
1297 | +Move emacspeak eterm pointer to a specified LINE. | |
1298 | + | |
1299 | +------------------------------------------------------------ | |
1300 | + | |
1301 | +** emacspeak-eterm-kill-ring-save-region | |
1302 | + | |
1303 | +Copy text from terminal to kill ring. | |
1304 | +This copies region delimited by the emacspeak eterm marker | |
1305 | +set by command M-x emacspeak-eterm-set-marker and the | |
1306 | +emacspeak eterm pointer. | |
1307 | + | |
1308 | +------------------------------------------------------------ | |
1309 | + | |
1310 | +** emacspeak-eterm-maybe-send-raw | |
1311 | + | |
1312 | +Send a raw character through if in the terminal buffer. | |
1313 | +Execute end of line if | |
1314 | +in a non eterm buffer if executed via C-e C-e | |
1315 | + | |
1316 | +------------------------------------------------------------ | |
1317 | + | |
1318 | +** emacspeak-eterm-paste-register | |
1319 | + | |
1320 | +Paste contents of REGISTER at current location. | |
1321 | +If the specified register contains text, then that text is | |
1322 | +sent to the terminal as if it were typed by the user. | |
1323 | + | |
1324 | +------------------------------------------------------------ | |
1325 | + | |
1326 | +** emacspeak-eterm-pointer-backward-word | |
1327 | + | |
1328 | +Move the pointer backward by words. | |
1329 | +Interactive numeric prefix arg specifies number of words to move. | |
1330 | +Argument COUNT specifies number of words by which to move. | |
1331 | + | |
1332 | +------------------------------------------------------------ | |
1333 | + | |
1334 | +** emacspeak-eterm-pointer-down | |
1335 | + | |
1336 | +Move the pointer down a line. | |
1337 | +Argument COUNT specifies number of lines by which to move. | |
1338 | + | |
1339 | +------------------------------------------------------------ | |
1340 | + | |
1341 | +** emacspeak-eterm-pointer-forward-word | |
1342 | + | |
1343 | +Move the pointer forward by words. | |
1344 | +Interactive numeric prefix arg specifies number of words to move. | |
1345 | +Argument COUNT specifies number of words by which to move. | |
1346 | + | |
1347 | +------------------------------------------------------------ | |
1348 | + | |
1349 | +** emacspeak-eterm-pointer-left | |
1350 | + | |
1351 | +Move the pointer left. | |
1352 | +Argument COUNT specifies number of columns by which to move. | |
1353 | + | |
1354 | +------------------------------------------------------------ | |
1355 | + | |
1356 | +** emacspeak-eterm-pointer-right | |
1357 | + | |
1358 | +Move the pointer right. | |
1359 | +Argument COUNT specifies number of columns by which to move. | |
1360 | + | |
1361 | +------------------------------------------------------------ | |
1362 | + | |
1363 | +** emacspeak-eterm-pointer-to-bottom | |
1364 | + | |
1365 | +Move the pointer to the bottom of the screen. | |
1366 | + | |
1367 | +------------------------------------------------------------ | |
1368 | + | |
1369 | +** emacspeak-eterm-pointer-to-cursor | |
1370 | + | |
1371 | +Move the pointer to the cursor. | |
1372 | + | |
1373 | +------------------------------------------------------------ | |
1374 | + | |
1375 | +** emacspeak-eterm-pointer-to-left-edge | |
1376 | + | |
1377 | +Move the pointer to the right edge. | |
1378 | + | |
1379 | +------------------------------------------------------------ | |
1380 | + | |
1381 | +** emacspeak-eterm-pointer-to-next-color-change | |
1382 | + | |
1383 | +Move the eterm pointer to the next color change. | |
1384 | +This allows you to move between highlighted regions of the screen. | |
1385 | +Optional argument COUNT specifies how many changes to skip. | |
1386 | + | |
1387 | +------------------------------------------------------------ | |
1388 | + | |
1389 | +** emacspeak-eterm-pointer-to-previous-color-change | |
1390 | + | |
1391 | +Move the eterm pointer to the next color change. | |
1392 | +This allows you to move between highlighted regions of the screen. | |
1393 | +Optional argument COUNT specifies how many changes to skip. | |
1394 | + | |
1395 | +------------------------------------------------------------ | |
1396 | + | |
1397 | +** emacspeak-eterm-pointer-to-right-edge | |
1398 | + | |
1399 | +Move the pointer to the right edge. | |
1400 | + | |
1401 | +------------------------------------------------------------ | |
1402 | + | |
1403 | +** emacspeak-eterm-pointer-to-top | |
1404 | + | |
1405 | +Move the pointer to the top of the screen. | |
1406 | + | |
1407 | +------------------------------------------------------------ | |
1408 | + | |
1409 | +** emacspeak-eterm-pointer-up | |
1410 | + | |
1411 | +Move the pointer up a line. | |
1412 | +Argument COUNT .specifies number of lines by which to move. | |
1413 | + | |
1414 | +------------------------------------------------------------ | |
1415 | + | |
1416 | +** emacspeak-eterm-remote-term Key Sequence: control e CONTROL meta r | |
1417 | + | |
1418 | +Start a terminal-emulator in a new buffer. | |
1419 | + | |
1420 | +------------------------------------------------------------ | |
1421 | + | |
1422 | +** emacspeak-eterm-search-backward | |
1423 | + | |
1424 | +Search backward on the terminal. | |
1425 | + | |
1426 | +------------------------------------------------------------ | |
1427 | + | |
1428 | +** emacspeak-eterm-search-forward | |
1429 | + | |
1430 | +Search forward on the terminal. | |
1431 | + | |
1432 | +------------------------------------------------------------ | |
1433 | + | |
1434 | +** emacspeak-eterm-set-filter-window | |
1435 | + | |
1436 | +Prompt for the id of a predefined window, | |
1437 | +and set the `filter' window to it. | |
1438 | +Non-nil interactive prefix arg `unsets' the filter window; | |
1439 | +this is equivalent to having the entire terminal as the filter window (this is | |
1440 | +what eterm starts up with). | |
1441 | +Setting the filter window results in emacspeak only monitoring screen | |
1442 | +activity within the filter window. | |
1443 | + | |
1444 | +------------------------------------------------------------ | |
1445 | + | |
1446 | +** emacspeak-eterm-set-focus-window | |
1447 | + | |
1448 | +Prompt for the id of a predefined window, | |
1449 | +and set the `focus' window to it. | |
1450 | +Non-nil interactive prefix arg `unsets' the focus window; | |
1451 | +this is equivalent to having the entire terminal as the focus window (this is | |
1452 | +what eterm starts up with). | |
1453 | +Setting the focus window results in emacspeak monitoring screen | |
1454 | +and speaking that window upon seeing screen activity. | |
1455 | + | |
1456 | +------------------------------------------------------------ | |
1457 | + | |
1458 | +** emacspeak-eterm-set-marker | |
1459 | + | |
1460 | +Set Emacspeak eterm marker. | |
1461 | +This sets the emacspeak eterm marker to the position pointed | |
1462 | +to by the emacspeak eterm pointer. | |
1463 | + | |
1464 | +------------------------------------------------------------ | |
1465 | + | |
1466 | +** emacspeak-eterm-speak-cursor | |
1467 | + | |
1468 | +Speak cursor position. | |
1469 | + | |
1470 | +------------------------------------------------------------ | |
1471 | + | |
1472 | +** emacspeak-eterm-speak-pointer | |
1473 | + | |
1474 | +Speak current pointer position. | |
1475 | + | |
1476 | +------------------------------------------------------------ | |
1477 | + | |
1478 | +** emacspeak-eterm-speak-pointer-char | |
1479 | + | |
1480 | +Speak char under eterm pointer. | |
1481 | +Pronounces character phonetically unless called with a PREFIX arg. | |
1482 | + | |
1483 | +------------------------------------------------------------ | |
1484 | + | |
1485 | +** emacspeak-eterm-speak-pointer-line | |
1486 | + | |
1487 | +Speak the line the pointer is on. | |
1488 | + | |
1489 | +------------------------------------------------------------ | |
1490 | + | |
1491 | +** emacspeak-eterm-speak-pointer-word | |
1492 | + | |
1493 | +Speak the word the pointer is on. | |
1494 | + | |
1495 | +------------------------------------------------------------ | |
1496 | + | |
1497 | +** emacspeak-eterm-speak-predefined-window | |
1498 | + | |
1499 | +Speak a predefined eterm window between 1 and 10. | |
1500 | + | |
1501 | +------------------------------------------------------------ | |
1502 | + | |
1503 | +** emacspeak-eterm-speak-screen | |
1504 | + | |
1505 | +Speak the screen. Default is to speak from the emacspeak pointer to point. | |
1506 | +Optional prefix arg FLAG causes region above | |
1507 | +the Emacspeak pointer to be spoken. | |
1508 | + | |
1509 | +------------------------------------------------------------ | |
1510 | + | |
1511 | +** emacspeak-eterm-speak-window | |
1512 | + | |
1513 | +Speak an eterm window. | |
1514 | +Argument ID specifies the window. | |
1515 | + | |
1516 | +------------------------------------------------------------ | |
1517 | + | |
1518 | +** emacspeak-eterm-toggle-filter-window | |
1519 | + | |
1520 | +Toggle active state of filter window. | |
1521 | + | |
1522 | +------------------------------------------------------------ | |
1523 | + | |
1524 | +** emacspeak-eterm-toggle-focus-window | |
1525 | + | |
1526 | +Toggle active state of focus window. | |
1527 | + | |
1528 | +------------------------------------------------------------ | |
1529 | + | |
1530 | +** emacspeak-eterm-toggle-pointer-mode | |
1531 | + | |
1532 | +Toggle emacspeak eterm pointer mode. | |
1533 | +With optional interactive prefix arg, turn it on. | |
1534 | +When emacspeak eterm is in pointer mode, the eterm read pointer | |
1535 | +stays where it is rather than automatically moving to the terminal cursor when | |
1536 | +there is terminal activity. | |
1537 | + | |
1538 | +------------------------------------------------------------ | |
1539 | + | |
1540 | +** emacspeak-eterm-toggle-review | |
1541 | + | |
1542 | +Toggle state of eterm review. | |
1543 | +In review mode, you can move around the terminal and listen to the contnets | |
1544 | +without sending input to the terminal itself. | |
1545 | + | |
1546 | +------------------------------------------------------------ | |
1547 | + | |
1548 | +** emacspeak-eterm-yank-window | |
1549 | + | |
1550 | +Yank contents of an eterm window at point. | |
1551 | + | |
1552 | +------------------------------------------------------------ | |
1553 | + | |
1554 | +** emacspeak-toggle-eterm-autospeak | |
1555 | + | |
1556 | +Toggle state of eterm autospeak. | |
1557 | +When eterm autospeak is turned on and the terminal is in line mode, | |
1558 | +all output to the terminal is automatically spoken. | |
1559 | + Interactive prefix arg means toggle the global default value, and then set the | |
1560 | + current local value to the result. | |
1561 | + | |
1562 | +------------------------------------------------------------ | |
1563 | + | |
1564 | +** emacspeak-fix-all-recent-commands | |
1565 | + | |
1566 | +Fix recently loaded interactive commands. | |
1567 | +This command looks through `load-history' and fixes commands if necessary. | |
1568 | +Memoizes call in emacspeak-load-history-pointer to memoize this call. | |
1569 | + | |
1570 | +------------------------------------------------------------ | |
1571 | + | |
1572 | +** emacspeak-fix-commands-loaded-from | |
1573 | + | |
1574 | +Fix all commands loaded from a specified module. | |
1575 | + | |
1576 | +------------------------------------------------------------ | |
1577 | + | |
1578 | +** emacspeak-forms-find-file | |
1579 | + | |
1580 | +Visit a forms file | |
1581 | + | |
1582 | +------------------------------------------------------------ | |
1583 | + | |
1584 | +** emacspeak-forms-flush-unwanted-records | |
1585 | + | |
1586 | +Prompt for pattern and flush matching lines | |
1587 | + | |
1588 | +------------------------------------------------------------ | |
1589 | + | |
1590 | +** emacspeak-forms-rerun-filter | |
1591 | + | |
1592 | +Rerun filter --allows us to nuke more matching records | |
1593 | + | |
1594 | +------------------------------------------------------------ | |
1595 | + | |
1596 | +** emacspeak-forms-speak-field | |
1597 | + | |
1598 | +Speak current form field name and value. | |
1599 | +Assumes that point is at the front of a field value. | |
1600 | + | |
1601 | +------------------------------------------------------------ | |
1602 | + | |
1603 | +** emacspeak-forms-summarize-current-position | |
1604 | + | |
1605 | +Summarize current position in list of records | |
1606 | + | |
1607 | +------------------------------------------------------------ | |
1608 | + | |
1609 | +** emacspeak-forms-summarize-current-record | |
1610 | + | |
1611 | +Summarize current record | |
1612 | + | |
1613 | +------------------------------------------------------------ | |
1614 | + | |
1615 | +** emacspeak-keymap-choose-new-emacspeak-prefix | |
1616 | + | |
1617 | +Interactively select a new prefix key to use for all emacspeak | |
1618 | +commands. The default is to use `C-e' This command | |
1619 | +lets you switch the prefix to something else. This is a useful thing | |
1620 | +to do if you run emacspeak on a remote machine from inside a terminal | |
1621 | +that is running inside a local emacspeak session. You can have the | |
1622 | +remote emacspeak use a different control key to give your fingers some | |
1623 | +relief. | |
1624 | + | |
1625 | +------------------------------------------------------------ | |
1626 | + | |
1627 | +** emacspeak-toggle-comint-output-monitor Key Sequence: control e o | |
1628 | + | |
1629 | +Toggle state of Emacspeak comint monitor. | |
1630 | +When turned on, comint output is automatically spoken. Turn this on if | |
1631 | +you want your shell to speak its results. Interactive | |
1632 | +PREFIX arg means toggle the global default value, and then | |
1633 | +set the current local value to the result. | |
1634 | + | |
1635 | +------------------------------------------------------------ | |
1636 | + | |
1637 | +** emacspeak-pronounce-clear-dictionaries | |
1638 | + | |
1639 | +Clear all current pronunciation dictionaries. | |
1640 | + | |
1641 | +------------------------------------------------------------ | |
1642 | + | |
1643 | +** emacspeak-pronounce-define-local-pronunciation | |
1644 | + | |
1645 | +Define buffer local pronunciation. | |
1646 | +Argument WORD specifies the word which should be pronounced as specified by PRONUNCIATION. | |
1647 | + | |
1648 | +------------------------------------------------------------ | |
1649 | + | |
1650 | +** emacspeak-pronounce-define-pronunciation | |
1651 | + | |
1652 | +Interactively define entries in the pronunciation dictionaries. | |
1653 | +Default term to define is delimited by region. | |
1654 | +First loads any persistent dictionaries if not already loaded. | |
1655 | + | |
1656 | +------------------------------------------------------------ | |
1657 | + | |
1658 | +** emacspeak-pronounce-define-template-pronunciation | |
1659 | + | |
1660 | +Interactively define template entries in the pronunciation dictionaries. | |
1661 | +Default term to define is delimited by region. | |
1662 | +First loads any persistent dictionaries if not already loaded. | |
1663 | + | |
1664 | +------------------------------------------------------------ | |
1665 | + | |
1666 | +** emacspeak-pronounce-dispatch Key Sequence: control e meta d | |
1667 | + | |
1668 | +Provides the user interface front-end to Emacspeak's pronunciation dictionaries. | |
1669 | + | |
1670 | +------------------------------------------------------------ | |
1671 | + | |
1672 | +** emacspeak-pronounce-edit-pronunciations | |
1673 | + | |
1674 | +Prompt for and launch a pronunciation editor on the | |
1675 | +specified pronunciation dictionary key. | |
1676 | + | |
1677 | +------------------------------------------------------------ | |
1678 | + | |
1679 | +** emacspeak-pronounce-load-dictionaries | |
1680 | + | |
1681 | +Load pronunciation dictionaries. | |
1682 | +Optional argument FILENAME specifies the dictionary file. | |
1683 | + | |
1684 | +------------------------------------------------------------ | |
1685 | + | |
1686 | +** emacspeak-pronounce-refresh-pronunciations | |
1687 | + | |
1688 | +Refresh pronunciation table for current buffer. | |
1689 | +Activates pronunciation dictionaries if not already active. | |
1690 | + | |
1691 | +------------------------------------------------------------ | |
1692 | + | |
1693 | +** emacspeak-pronounce-save-dictionaries | |
1694 | + | |
1695 | +Writes out the persistent emacspeak pronunciation dictionaries. | |
1696 | + | |
1697 | +------------------------------------------------------------ | |
1698 | + | |
1699 | +** emacspeak-pronounce-toggle-use-of-dictionaries | |
1700 | + | |
1701 | +Toggle use of pronunciation dictionaries in current buffer. | |
1702 | +Pronunciations can be defined on a per file, per directory and/or per | |
1703 | +mode basis. | |
1704 | +Pronunciations are activated on a per buffer basis. | |
1705 | +Turning on the use of pronunciation dictionaries results in emacspeak | |
1706 | +composing a pronunciation table based on the currently defined | |
1707 | +pronunciation dictionaries. | |
1708 | +After this, the pronunciations will be applied whenever text in the | |
1709 | +buffer is spoken. | |
1710 | +Optional argument state can be used from Lisp programs to | |
1711 | +explicitly turn pronunciations on or off. | |
1712 | + | |
1713 | +------------------------------------------------------------ | |
1714 | + | |
1715 | +** emacspeak-pronounce-yank-word | |
1716 | + | |
1717 | +Yank word at point into minibuffer. | |
1718 | + | |
1719 | +------------------------------------------------------------ | |
1720 | + | |
1721 | +** emacspeak-backward-char Key Sequence: control b <left> | |
1722 | + | |
1723 | +Backward-char redefined to speak char moved to. | |
1724 | + | |
1725 | +------------------------------------------------------------ | |
1726 | + | |
1727 | +** emacspeak-forward-char Key Sequence: control f <right> | |
1728 | + | |
1729 | +Forward-char redefined to speak char moved to. | |
1730 | + | |
1731 | +------------------------------------------------------------ | |
1732 | + | |
1733 | Content-type: text/html ]>