File: screader.1

package info (click to toggle)
screader 1.8-5.1
  • links: PTS
  • area: main
  • in suites: squeeze
  • size: 1,048 kB
  • ctags: 1,394
  • sloc: ansic: 21,587; sh: 1,128; makefile: 147
file content (183 lines) | stat: -rw-r--r-- 5,462 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
.TH SCREADER 1 "Screader version 1.8" "27 Februari 2000" ""
.SH NAME
screader - Screen reader using a software Text-To-Speech package or
a hardware speech synthesizer.
.SH SYNOPSIS
.B screader
[`screen' options]
.SH DESCRIPTION
The
.B screader
background program reads the screen and puts the information through
to a software Text-To-Speech package (Like `festival') or a hardware 
speech synthesizer. (like `Accent')
It uses the device /dev/vcsa. (See below)

A reverse space at column 80 indicates the line containing the internal 
pointer.

.SH SCREADER KEYS
The following TTS-commands are
available:
(Each command must be pressed with the left-ALT-key, unless
.B screader
is in direct mode. See the `z'-command.)
.IP "a"
Toggles auto_speak on or off. When toggled on
.B screader
will speak out the character being typed or the typed word if word_mode
is toggled on.
.IP "b"
Put internal pointer to begin of current line and speaks that line out
if line_speak is toggled on.
.IP "c"
.B Screader
speaks out the line containing the cursor.
.IP "d"
Puts the internal pointer one line down.
If line_speak is on
.B screader
speaks out that line.
.IP "e"
Speak out character or word under the cursor.
.IP "f"
Toggle for the internal pointer to follow the cursor or not.
.IP "g"
Puts the internal pointer to the bottom of the screen.
If line_speak is on
.B screader
speaks that line out.
.IP "h"
Puts the internal pointer to the top of the screen.
If line_speak is on
.B screader
speaks that line out.
.IP "i"
Toggles line_speak on or off. When toggled on
.B screader
will speak out the line, which is pointed to by the internal pointer, 
every time it has changed.
.IP "k"
Toggles key clicking on or off. When toggled on
.B screader
will give a short click after a key is pressed.
.IP "," (comma)
Puts the pointer left one word. If auto_speak is toggled on
.B screader
speaks out that word.
.IP "l"
Puts the internal pointer one character left. If auto_speak is on,
.B screader
speaks out the character pointed to by the internal pointer.
.IP "m"
Toggles the word_mode on or off. When toggled on
.B screader
speaks out words instead of characters.
.IP "n"
Toggle for numbers. If toggled on (default)
.B screader
speaks out the value of the digits.
Otherwise
.B screader
speaks out digit by digit.
If in word_mode, words will be spelled.
.IP "o"
Silence please.
.IP "p"
Speaks out character or word pointed to by the pointer.
.IP "q"
Toggles punctuation on or off.  When toggled on 
.B screader
will put each punctuation mark through to a  script punctuation.N.sh.   
Otherwise 
.B screader
will replace each punctuation mark by a space, so  that  only  alphabetic 
characters and digits are spoken.  (See 
.BR "PUNCTUATION SCRIPT" .)
.IP "." (dot)
Puts the pointer right one word. If auto_speak is toggled on
.B screader
speaks out that word.
.IP "r"
Puts the internal pointer one character right. If auto_speak is on,
.B screader
speaks out the character pointed to by the internal pointer.
.IP "s"
.B Screader
speaks out the line pointed to by the internal pointer.
.IP "u"
Puts the internal pointer one line up.
If line_speak is on
.B screader
speaks out that line.
.IP "w"
Speaks out the whole screen.
.IP "x"
Re-read the `tts' file. (if another TTS is desired.)
Each time this combination is pressed
.B screader
will select the next TTS-command from this file. (if any, else the first one
will be selected. and so on)
.IP "z"
Put
.B screader
in direct mode. In this mode each command can be given without the 
alt-key, so that reviewing the screen is easier.
When the `z'-key is pressed, 
.B screader
goes back to application mode, so that you can work with your application
again.
.IP "-"
Toggles repeat_mode on or off. If toggled on, every sequence of the same
characters will be spoken as `character n times`. where n stands for
the number of that character in the sequence.
.IP "'" (quote)
Toggles caps_mode on or off. If toggled on
.B screader
speaks the word `cap' before each capitalized character.
.IP "=" (equals)
Makes the internal pointer equal to the cursor.

.SH SCREEN_DEVICE
.B Screader
reads its information from a device
/dev/vcsa. Kernels 1.1.92 or later provide this
device.
.SH "PUNCTUATION SCRIPT"
Each time
.B screader
encounters a punctuation mark, it will be put through to a script called
punctuation.N.sh, where N corresponds to the Nth tts-command in the
tts-file. If there is no punctuation script the punctuation mark
will be directly put through to the current tts-command.
.SH FESTIVAL CLIENT
If you want to use the server/client option of Festival place the line:
.IP
festival_client.sh
.P
as first command in the file /etc/screader/tts.
It is supposed that before using this tts-command the festival server
is started by the following command:
.IP
festival --server &
.P
Festival Speech Synthesis System
.br
Copyright (C) University of Edinburgh, 1996,1997. 
.br
All rights reserved.
.SH BUGS
When typing fast sometimes the whole line will be spoken out instead
of the characters being typed when line_speak and auto_speak are toggled on.
Also when word_mode is toggled on the whole line will be spoken out when typing.
.SH FILES
.IP "/etc/screader/tts"
This file contains the name(s) of the Text-To-Speech utility(s) to be used.
.IP "/etc/screader/punctuation.?.sh"
Punctuation scripts.
.IP "/dev/vcsa"
Screen_device.
.SH SEE ALSO
.BR screen "(1L), " vcs "(4), " festival "(1)"
.SH AUTHOR
Jos Lemmens (jlemmens@inter.nl.net)