1 1
2 The Speakup User's Guide 2 The Speakup User's Guide
3 For Speakup 3.1.2 and Later 3 For Speakup 3.1.2 and Later
4 By Gene Collins 4 By Gene Collins
5 Updated by others 5 Updated by others
6 Last modified on Mon Sep 27 14:26:31 2010 6 Last modified on Mon Sep 27 14:26:31 2010
7 Document version 1.3 7 Document version 1.3
8 8
9 Copyright (c) 2005 Gene Collins 9 Copyright (c) 2005 Gene Collins
10 Copyright (c) 2008, 2023 Samuel Thibault !! 10 Copyright (c) 2008 Samuel Thibault
11 Copyright (c) 2009, 2010 the Speakup Team 11 Copyright (c) 2009, 2010 the Speakup Team
12 12
13 Permission is granted to copy, distribute and/ 13 Permission is granted to copy, distribute and/or modify this document
14 under the terms of the GNU Free Documentation 14 under the terms of the GNU Free Documentation License, Version 1.2 or
15 any later version published by the Free Softwa 15 any later version published by the Free Software Foundation; with no
16 Invariant Sections, no Front-Cover Texts, and 16 Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. A
17 copy of the license is included in the section 17 copy of the license is included in the section entitled "GNU Free
18 Documentation License". 18 Documentation License".
19 19
20 Preface 20 Preface
21 21
22 The purpose of this document is to familiarize 22 The purpose of this document is to familiarize users with the user
23 interface to Speakup, a Linux Screen Reader. 23 interface to Speakup, a Linux Screen Reader. If you need instructions
24 for installing or obtaining Speakup, visit the 24 for installing or obtaining Speakup, visit the web site at
25 http://linux-speakup.org/. Speakup is a set o 25 http://linux-speakup.org/. Speakup is a set of patches to the standard
26 Linux kernel source tree. It can be built as 26 Linux kernel source tree. It can be built as a series of modules, or as
27 a part of a monolithic kernel. These details 27 a part of a monolithic kernel. These details are beyond the scope of
28 this manual, but the user may need to be aware 28 this manual, but the user may need to be aware of the module
29 capabilities, depending on how your system adm 29 capabilities, depending on how your system administrator has installed
30 Speakup. If Speakup is built as a part of a m 30 Speakup. If Speakup is built as a part of a monolithic kernel, and the
31 user is using a hardware synthesizer, then Spe 31 user is using a hardware synthesizer, then Speakup will be able to
32 provide speech access from the time the kernel 32 provide speech access from the time the kernel is loaded, until the time
33 the system is shutdown. This means that if yo 33 the system is shutdown. This means that if you have obtained Linux
34 installation media for a distribution which in 34 installation media for a distribution which includes Speakup as a part
35 of its kernel, you will be able, as a blind pe 35 of its kernel, you will be able, as a blind person, to install Linux
36 with speech access unaided by a sighted person 36 with speech access unaided by a sighted person. Again, these details
37 are beyond the scope of this manual, but the u 37 are beyond the scope of this manual, but the user should be aware of
38 them. See the web site mentioned above for fu 38 them. See the web site mentioned above for further details.
39 39
40 1. Starting Speakup 40 1. Starting Speakup
41 41
42 If your system administrator has installed Spe 42 If your system administrator has installed Speakup to work with your
43 specific synthesizer by default, then all you 43 specific synthesizer by default, then all you need to do to use Speakup
44 is to boot your system, and Speakup should com 44 is to boot your system, and Speakup should come up talking. This
45 assumes of course that your synthesizer is a 45 assumes of course that your synthesizer is a supported hardware
46 synthesizer, and that it is either installed i 46 synthesizer, and that it is either installed in or connected to your
47 system, and is if necessary powered on. 47 system, and is if necessary powered on.
48 48
49 It is possible, however, that Speakup may have 49 It is possible, however, that Speakup may have been compiled into the
50 kernel with no default synthesizer. It is eve 50 kernel with no default synthesizer. It is even possible that your
51 kernel has been compiled with support for some 51 kernel has been compiled with support for some of the supported
52 synthesizers and not others. If you find that 52 synthesizers and not others. If you find that this is the case, and
53 your synthesizer is supported but not availabl 53 your synthesizer is supported but not available, complain to the person
54 who compiled and installed your kernel. Or be 54 who compiled and installed your kernel. Or better yet, go to the web
55 site, and learn how to patch Speakup into your 55 site, and learn how to patch Speakup into your own kernel source, and
56 build and install your own kernel. 56 build and install your own kernel.
57 57
58 If your kernel has been compiled with Speakup, 58 If your kernel has been compiled with Speakup, and has no default
59 synthesizer set, or you would like to use a di 59 synthesizer set, or you would like to use a different synthesizer than
60 the default one, then you may issue the follow 60 the default one, then you may issue the following command at the boot
61 prompt of your boot loader. 61 prompt of your boot loader.
62 62
63 linux speakup.synth=ltlk 63 linux speakup.synth=ltlk
64 64
65 This command would tell Speakup to look for an 65 This command would tell Speakup to look for and use a LiteTalk or
66 DoubleTalk LT at boot up. You may replace the 66 DoubleTalk LT at boot up. You may replace the ltlk synthesizer keyword
67 with the keyword for whatever synthesizer you 67 with the keyword for whatever synthesizer you wish to use. The
68 speakup.synth parameter will accept the follow 68 speakup.synth parameter will accept the following keywords, provided
69 that support for the related synthesizers has 69 that support for the related synthesizers has been built into the
70 kernel. 70 kernel.
71 71
72 acntsa -- Accent SA 72 acntsa -- Accent SA
73 acntpc -- Accent PC 73 acntpc -- Accent PC
74 apollo -- Apollo 74 apollo -- Apollo
75 audptr -- Audapter 75 audptr -- Audapter
76 bns -- Braille 'n Speak 76 bns -- Braille 'n Speak
77 dectlk -- DecTalk Express (old and new, db9 se 77 dectlk -- DecTalk Express (old and new, db9 serial only)
78 decext -- DecTalk (old) External 78 decext -- DecTalk (old) External
79 dtlk -- DoubleTalk PC 79 dtlk -- DoubleTalk PC
80 keypc -- Keynote Gold PC 80 keypc -- Keynote Gold PC
81 ltlk -- DoubleTalk LT, LiteTalk, or external T 81 ltlk -- DoubleTalk LT, LiteTalk, or external Tripletalk (db9 serial only)
82 spkout -- Speak Out 82 spkout -- Speak Out
83 txprt -- Transport 83 txprt -- Transport
84 dummy -- Plain text terminal 84 dummy -- Plain text terminal
85 85
86 Note: Speakup does * NOT * support the interna !! 86 Note: Speakup does * NOT * support usb connections! Speakup also does *
>> 87 NOT * support the internal Tripletalk!
87 88
88 Speakup does support two other synthesizers, b 89 Speakup does support two other synthesizers, but because they work in
89 conjunction with other software, they must be 90 conjunction with other software, they must be loaded as modules after
90 their related software is loaded, and so are n 91 their related software is loaded, and so are not available at boot up.
91 These are as follows: 92 These are as follows:
92 93
93 decpc -- DecTalk PC (not available at boot up) 94 decpc -- DecTalk PC (not available at boot up)
94 soft -- One of several software synthesizers ( 95 soft -- One of several software synthesizers (not available at boot up)
95 96
96 By default speakup looks for the synthesizer o <<
97 be changed with the device parameter of the mo <<
98 DoubleTalk LT: <<
99 <<
100 speakup_ltlk.dev=ttyUSB0 <<
101 <<
102 See the sections on loading modules and softwa 97 See the sections on loading modules and software synthesizers later in
103 this manual for further details. It should be 98 this manual for further details. It should be noted here that the
104 speakup.synth boot parameter will have no effe 99 speakup.synth boot parameter will have no effect if Speakup has been
105 compiled as modules. In order for Speakup mod 100 compiled as modules. In order for Speakup modules to be loaded during
106 the boot process, such action must be configur 101 the boot process, such action must be configured by your system
107 administrator. This will mean that you will h 102 administrator. This will mean that you will hear some, but not all, of
108 the bootup messages. 103 the bootup messages.
109 104
110 2. Basic operation 105 2. Basic operation
111 106
112 Once you have booted the system, and if necess 107 Once you have booted the system, and if necessary, have supplied the
113 proper bootup parameter for your synthesizer, 108 proper bootup parameter for your synthesizer, Speakup will begin
114 talking as soon as the kernel is loaded. In f 109 talking as soon as the kernel is loaded. In fact, it will talk a lot!
115 It will speak all the boot up messages that th 110 It will speak all the boot up messages that the kernel prints on the
116 screen during the boot process. This is becau 111 screen during the boot process. This is because Speakup is not a
117 separate screen reader, but is actually built 112 separate screen reader, but is actually built into the operating
118 system. Since almost all console applications 113 system. Since almost all console applications must print text on the
119 screen using the kernel, and must get their ke 114 screen using the kernel, and must get their keyboard input through the
120 kernel, they are automatically handled properl 115 kernel, they are automatically handled properly by Speakup. There are a
121 few exceptions, but we'll come to those later. 116 few exceptions, but we'll come to those later.
122 117
123 Note: In this guide I will refer to the numer 118 Note: In this guide I will refer to the numeric keypad as the keypad.
124 This is done because the speakupmap.map file r 119 This is done because the speakupmap.map file referred to later in this
125 manual uses the term keypad instead of numeric 120 manual uses the term keypad instead of numeric keypad. Also I'm lazy
126 and would rather only type one word. So keypa 121 and would rather only type one word. So keypad it is. Got it? Good.
127 122
128 Most of the Speakup review keys are located on 123 Most of the Speakup review keys are located on the keypad at the far
129 right of the keyboard. The numlock key should 124 right of the keyboard. The numlock key should be off, in order for these
130 to work. If you toggle the numlock on, the ke 125 to work. If you toggle the numlock on, the keypad will produce numbers,
131 which is exactly what you want for spreadsheet 126 which is exactly what you want for spreadsheets and such. For the
132 purposes of this guide, you should have the nu 127 purposes of this guide, you should have the numlock turned off, which is
133 its default state at bootup. 128 its default state at bootup.
134 129
135 You probably won't want to listen to all the b 130 You probably won't want to listen to all the bootup messages every time
136 you start your system, though it's a good idea 131 you start your system, though it's a good idea to listen to them at
137 least once, just so you'll know what kind of i 132 least once, just so you'll know what kind of information is available to
138 you during the boot process. You can always r 133 you during the boot process. You can always review these messages after
139 bootup with the command: 134 bootup with the command:
140 135
141 dmesg | more 136 dmesg | more
142 137
143 In order to speed the boot process, and to sil 138 In order to speed the boot process, and to silence the speaking of the
144 bootup messages, just press the keypad enter k 139 bootup messages, just press the keypad enter key. This key is located
145 in the bottom right corner of the keypad. Spe 140 in the bottom right corner of the keypad. Speakup will shut up and stay
146 that way, until you press another key. 141 that way, until you press another key.
147 142
148 You can check to see if the boot process has c 143 You can check to see if the boot process has completed by pressing the 8
149 key on the keypad, which reads the current lin 144 key on the keypad, which reads the current line. This also has the
150 effect of starting Speakup talking again, so y 145 effect of starting Speakup talking again, so you can press keypad enter
151 to silence it again if the boot process has no 146 to silence it again if the boot process has not completed.
152 147
153 When the boot process is complete, you will ar 148 When the boot process is complete, you will arrive at a "login" prompt.
154 At this point, you'll need to type in your use 149 At this point, you'll need to type in your user id and password, as
155 provided by your system administrator. You wi 150 provided by your system administrator. You will hear Speakup speak the
156 letters of your user id as you type it, but no 151 letters of your user id as you type it, but not the password. This is
157 because the password is not displayed on the s 152 because the password is not displayed on the screen for security
158 reasons. This has nothing to do with Speakup, 153 reasons. This has nothing to do with Speakup, it's a Linux security
159 feature. 154 feature.
160 155
161 Once you've logged in, you can run any Linux c 156 Once you've logged in, you can run any Linux command or program which is
162 allowed by your user id. Normal users will no 157 allowed by your user id. Normal users will not be able to run programs
163 which require root privileges. 158 which require root privileges.
164 159
165 When you are running a program or command, Spe 160 When you are running a program or command, Speakup will automatically
166 speak new text as it arrives on the screen. Y 161 speak new text as it arrives on the screen. You can at any time silence
167 the speech with keypad enter, or use any of th 162 the speech with keypad enter, or use any of the Speakup review keys.
168 163
169 Here are some basic Speakup review keys, and a 164 Here are some basic Speakup review keys, and a short description of what
170 they do. 165 they do.
171 166
172 keypad 1 -- read previous character 167 keypad 1 -- read previous character
173 keypad 2 -- read current character (pressing k 168 keypad 2 -- read current character (pressing keypad 2 twice rapidly will speak
174 the current character phonetically) 169 the current character phonetically)
175 keypad 3 -- read next character 170 keypad 3 -- read next character
176 keypad 4 -- read previous word 171 keypad 4 -- read previous word
177 keypad 5 -- read current word (press twice rap 172 keypad 5 -- read current word (press twice rapidly to spell the current word)
178 keypad 6 -- read next word 173 keypad 6 -- read next word
179 keypad 7 -- read previous line 174 keypad 7 -- read previous line
180 keypad 8 -- read current line (press twice rap 175 keypad 8 -- read current line (press twice rapidly to hear how much the
181 text on the current line is indented) 176 text on the current line is indented)
182 keypad 9 -- read next line 177 keypad 9 -- read next line
183 keypad period -- speak current cursor position 178 keypad period -- speak current cursor position and announce current
184 virtual console 179 virtual console
185 180
186 It's also worth noting that the insert key on 181 It's also worth noting that the insert key on the keypad is mapped
187 as the speakup key. Instead of pressing and r 182 as the speakup key. Instead of pressing and releasing this key, as you
188 do under DOS or Windows, you hold it like a sh 183 do under DOS or Windows, you hold it like a shift key, and press other
189 keys in combination with it. For example, rep 184 keys in combination with it. For example, repeatedly holding keypad
190 insert, from now on called speakup, and keypad 185 insert, from now on called speakup, and keypad enter will toggle the
191 speaking of new text on the screen on and off. 186 speaking of new text on the screen on and off. This is not the same as
192 just pressing keypad enter by itself, which ju 187 just pressing keypad enter by itself, which just silences the speech
193 until you hit another key. When you hit speak 188 until you hit another key. When you hit speakup plus keypad enter,
194 Speakup will say, "You turned me off.", or "He 189 Speakup will say, "You turned me off.", or "Hey, that's better." When
195 Speakup is turned off, no new text on the scre 190 Speakup is turned off, no new text on the screen will be spoken. You
196 can still use the reading controls to review t 191 can still use the reading controls to review the screen however.
197 192
198 3. Using the Speakup Help System 193 3. Using the Speakup Help System
199 194
200 In order to enter the Speakup help system, pre 195 In order to enter the Speakup help system, press and hold the speakup
201 key (remember that this is the keypad insert k 196 key (remember that this is the keypad insert key), and press the f1 key.
202 You will hear the message: 197 You will hear the message:
203 198
204 "Press space to leave help, cursor up or down 199 "Press space to leave help, cursor up or down to scroll, or a letter to
205 go to commands in list." 200 go to commands in list."
206 201
207 When you press the spacebar to leave the help 202 When you press the spacebar to leave the help system, you will hear:
208 203
209 "Leaving help." 204 "Leaving help."
210 205
211 While you are in the Speakup help system, you 206 While you are in the Speakup help system, you can scroll up or down
212 through the list of available commands using t 207 through the list of available commands using the cursor keys. The list
213 of commands is arranged in alphabetical order. 208 of commands is arranged in alphabetical order. If you wish to jump to
214 commands in a specific part of the alphabet, y 209 commands in a specific part of the alphabet, you may press the letter of
215 the alphabet you wish to jump to. 210 the alphabet you wish to jump to.
216 211
217 You can also just explore by typing keyboard k 212 You can also just explore by typing keyboard keys. Pressing keys will
218 cause Speakup to speak the command associated 213 cause Speakup to speak the command associated with that key. For
219 example, if you press the keypad 8 key, you wi 214 example, if you press the keypad 8 key, you will hear:
220 215
221 "Keypad 8 is line, say current." 216 "Keypad 8 is line, say current."
222 217
223 You'll notice that some commands do not have k 218 You'll notice that some commands do not have keys assigned to them.
224 This is because they are very infrequently use 219 This is because they are very infrequently used commands, and are also
225 accessible through the sys system. We'll disc 220 accessible through the sys system. We'll discuss the sys system later
226 in this manual. 221 in this manual.
227 222
228 You'll also notice that some commands have two 223 You'll also notice that some commands have two keys assigned to them.
229 This is because Speakup has a built in set of 224 This is because Speakup has a built in set of alternative key bindings
230 for laptop users. The alternate speakup key i 225 for laptop users. The alternate speakup key is the caps lock key. You
231 can press and hold the caps lock key, while pr 226 can press and hold the caps lock key, while pressing an alternate
232 speakup command key to activate the command. 227 speakup command key to activate the command. On most laptops, the
233 numeric keypad is defined as the keys in the j 228 numeric keypad is defined as the keys in the j k l area of the keyboard.
234 229
235 There is usually a function key which turns th 230 There is usually a function key which turns this keypad function on and
236 off, and some other key which controls the num 231 off, and some other key which controls the numlock state. Toggling the
237 keypad functionality on and off can become a r 232 keypad functionality on and off can become a royal pain. So, Speakup
238 gives you a simple way to get at an alternativ 233 gives you a simple way to get at an alternative set of key mappings for
239 your laptop. These are also available by defa 234 your laptop. These are also available by default on desktop systems,
240 because Speakup does not know whether it is ru 235 because Speakup does not know whether it is running on a desktop or
241 laptop. So you may choose which set of Speaku 236 laptop. So you may choose which set of Speakup keys to use. Some
242 system administrators may have chosen to compi 237 system administrators may have chosen to compile Speakup for a desktop
243 system without this set of alternate key bindi 238 system without this set of alternate key bindings, but these details are
244 beyond the scope of this manual. To use the c 239 beyond the scope of this manual. To use the caps lock for its normal
245 purpose, hold the shift key while toggling the 240 purpose, hold the shift key while toggling the caps lock on and off. We
246 should note here, that holding the caps lock k 241 should note here, that holding the caps lock key and pressing the z key
247 will toggle the alternate j k l keypad on and 242 will toggle the alternate j k l keypad on and off.
248 243
249 4. Keys and Their Assigned Commands 244 4. Keys and Their Assigned Commands
250 245
251 In this section, we'll go through a list of al 246 In this section, we'll go through a list of all the speakup keys and
252 commands. You can also get a list of commands 247 commands. You can also get a list of commands and assigned keys from
253 the help system. 248 the help system.
254 249
255 The following list was taken from the speakupm 250 The following list was taken from the speakupmap.map file. Key
256 assignments are on the left of the equal sign, 251 assignments are on the left of the equal sign, and the associated
257 Speakup commands are on the right. The design 252 Speakup commands are on the right. The designation "spk" means to press
258 and hold the speakup key, a.k.a. keypad insert 253 and hold the speakup key, a.k.a. keypad insert, a.k.a. caps lock, while
259 pressing the other specified key. 254 pressing the other specified key.
260 255
261 spk key_f9 = punc_level_dec 256 spk key_f9 = punc_level_dec
262 spk key_f10 = punc_level_inc 257 spk key_f10 = punc_level_inc
263 spk key_f11 = reading_punc_dec 258 spk key_f11 = reading_punc_dec
264 spk key_f12 = reading_punc_inc 259 spk key_f12 = reading_punc_inc
265 spk key_1 = vol_dec 260 spk key_1 = vol_dec
266 spk key_2 = vol_inc 261 spk key_2 = vol_inc
267 spk key_3 = pitch_dec 262 spk key_3 = pitch_dec
268 spk key_4 = pitch_inc 263 spk key_4 = pitch_inc
269 spk key_5 = rate_dec 264 spk key_5 = rate_dec
270 spk key_6 = rate_inc 265 spk key_6 = rate_inc
271 key_kpasterisk = toggle_cursoring 266 key_kpasterisk = toggle_cursoring
272 spk key_kpasterisk = speakup_goto 267 spk key_kpasterisk = speakup_goto
273 spk key_f1 = speakup_help 268 spk key_f1 = speakup_help
274 spk key_f2 = set_win 269 spk key_f2 = set_win
275 spk key_f3 = clear_win 270 spk key_f3 = clear_win
276 spk key_f4 = enable_win 271 spk key_f4 = enable_win
277 spk key_f5 = edit_some 272 spk key_f5 = edit_some
278 spk key_f6 = edit_most 273 spk key_f6 = edit_most
279 spk key_f7 = edit_delim 274 spk key_f7 = edit_delim
280 spk key_f8 = edit_repeat 275 spk key_f8 = edit_repeat
281 shift spk key_f9 = edit_exnum 276 shift spk key_f9 = edit_exnum
282 key_kp7 = say_prev_line 277 key_kp7 = say_prev_line
283 spk key_kp7 = left_edge 278 spk key_kp7 = left_edge
284 key_kp8 = say_line 279 key_kp8 = say_line
285 double key_kp8 = say_line_indent 280 double key_kp8 = say_line_indent
286 spk key_kp8 = say_from_top 281 spk key_kp8 = say_from_top
287 key_kp9 = say_next_line 282 key_kp9 = say_next_line
288 spk key_kp9 = top_edge 283 spk key_kp9 = top_edge
289 key_kpminus = speakup_parked 284 key_kpminus = speakup_parked
290 spk key_kpminus = say_char_num 285 spk key_kpminus = say_char_num
291 key_kp4 = say_prev_word 286 key_kp4 = say_prev_word
292 spk key_kp4 = say_from_left 287 spk key_kp4 = say_from_left
293 key_kp5 = say_word 288 key_kp5 = say_word
294 double key_kp5 = spell_word 289 double key_kp5 = spell_word
295 spk key_kp5 = spell_phonetic 290 spk key_kp5 = spell_phonetic
296 key_kp6 = say_next_word 291 key_kp6 = say_next_word
297 spk key_kp6 = say_to_right 292 spk key_kp6 = say_to_right
298 key_kpplus = say_screen 293 key_kpplus = say_screen
299 spk key_kpplus = say_win 294 spk key_kpplus = say_win
300 key_kp1 = say_prev_char 295 key_kp1 = say_prev_char
301 spk key_kp1 = right_edge 296 spk key_kp1 = right_edge
302 key_kp2 = say_char 297 key_kp2 = say_char
303 spk key_kp2 = say_to_bottom 298 spk key_kp2 = say_to_bottom
304 double key_kp2 = say_phonetic_char 299 double key_kp2 = say_phonetic_char
305 key_kp3 = say_next_char 300 key_kp3 = say_next_char
306 spk key_kp3 = bottom_edge 301 spk key_kp3 = bottom_edge
307 key_kp0 = spk_key 302 key_kp0 = spk_key
308 key_kpdot = say_position 303 key_kpdot = say_position
309 spk key_kpdot = say_attributes 304 spk key_kpdot = say_attributes
310 key_kpenter = speakup_quiet 305 key_kpenter = speakup_quiet
311 spk key_kpenter = speakup_off 306 spk key_kpenter = speakup_off
312 key_sysrq = speech_kill 307 key_sysrq = speech_kill
313 key_kpslash = speakup_cut 308 key_kpslash = speakup_cut
314 spk key_kpslash = speakup_paste 309 spk key_kpslash = speakup_paste
315 spk key_pageup = say_first_char 310 spk key_pageup = say_first_char
316 spk key_pagedown = say_last_char 311 spk key_pagedown = say_last_char
317 key_capslock = spk_key 312 key_capslock = spk_key
318 spk key_z = spk_lock 313 spk key_z = spk_lock
319 key_leftmeta = spk_key 314 key_leftmeta = spk_key
320 ctrl spk key_0 = speakup_goto 315 ctrl spk key_0 = speakup_goto
321 spk key_u = say_prev_line 316 spk key_u = say_prev_line
322 spk key_i = say_line 317 spk key_i = say_line
323 double spk key_i = say_line_indent 318 double spk key_i = say_line_indent
324 spk key_o = say_next_line 319 spk key_o = say_next_line
325 spk key_minus = speakup_parked 320 spk key_minus = speakup_parked
326 shift spk key_minus = say_char_num 321 shift spk key_minus = say_char_num
327 spk key_j = say_prev_word 322 spk key_j = say_prev_word
328 spk key_k = say_word 323 spk key_k = say_word
329 double spk key_k = spell_word 324 double spk key_k = spell_word
330 spk key_l = say_next_word 325 spk key_l = say_next_word
331 spk key_m = say_prev_char 326 spk key_m = say_prev_char
332 spk key_comma = say_char 327 spk key_comma = say_char
333 double spk key_comma = say_phonetic_char 328 double spk key_comma = say_phonetic_char
334 spk key_dot = say_next_char 329 spk key_dot = say_next_char
335 spk key_n = say_position 330 spk key_n = say_position
336 ctrl spk key_m = left_edge 331 ctrl spk key_m = left_edge
337 ctrl spk key_y = top_edge 332 ctrl spk key_y = top_edge
338 ctrl spk key_dot = right_edge 333 ctrl spk key_dot = right_edge
339 ctrl spk key_p = bottom_edge 334 ctrl spk key_p = bottom_edge
340 spk key_apostrophe = say_screen 335 spk key_apostrophe = say_screen
341 spk key_h = say_from_left 336 spk key_h = say_from_left
342 spk key_y = say_from_top 337 spk key_y = say_from_top
343 spk key_semicolon = say_to_right 338 spk key_semicolon = say_to_right
344 spk key_p = say_to_bottom 339 spk key_p = say_to_bottom
345 spk key_slash = say_attributes 340 spk key_slash = say_attributes
346 spk key_enter = speakup_quiet 341 spk key_enter = speakup_quiet
347 ctrl spk key_enter = speakup_off 342 ctrl spk key_enter = speakup_off
348 spk key_9 = speakup_cut 343 spk key_9 = speakup_cut
349 spk key_8 = speakup_paste 344 spk key_8 = speakup_paste
350 shift spk key_m = say_first_char 345 shift spk key_m = say_first_char
351 ctrl spk key_semicolon = say_last_char 346 ctrl spk key_semicolon = say_last_char
352 spk key_r = read_all_doc <<
353 347
354 5. The Speakup Sys System 348 5. The Speakup Sys System
355 349
356 The Speakup screen reader also creates a speak 350 The Speakup screen reader also creates a speakup subdirectory as a part
357 of the sys system. 351 of the sys system.
358 352
359 As a convenience, run as root 353 As a convenience, run as root
360 354
361 ln -s /sys/accessibility/speakup /speakup 355 ln -s /sys/accessibility/speakup /speakup
362 356
363 to directly access speakup parameters from /sp 357 to directly access speakup parameters from /speakup.
364 You can see these entries by typing the comman 358 You can see these entries by typing the command:
365 359
366 ls -1 /speakup/* 360 ls -1 /speakup/*
367 361
368 If you issue the above ls command, you will ge 362 If you issue the above ls command, you will get back something like
369 this: 363 this:
370 364
371 /speakup/attrib_bleep 365 /speakup/attrib_bleep
372 /speakup/bell_pos 366 /speakup/bell_pos
373 /speakup/bleep_time 367 /speakup/bleep_time
374 /speakup/bleeps 368 /speakup/bleeps
375 /speakup/cursor_time 369 /speakup/cursor_time
376 /speakup/delimiters 370 /speakup/delimiters
377 /speakup/ex_num 371 /speakup/ex_num
378 /speakup/key_echo 372 /speakup/key_echo
379 /speakup/keymap 373 /speakup/keymap
380 /speakup/no_interrupt 374 /speakup/no_interrupt
381 /speakup/punc_all 375 /speakup/punc_all
382 /speakup/punc_level 376 /speakup/punc_level
383 /speakup/punc_most 377 /speakup/punc_most
384 /speakup/punc_some 378 /speakup/punc_some
385 /speakup/reading_punc 379 /speakup/reading_punc
386 /speakup/repeats 380 /speakup/repeats
387 /speakup/say_control 381 /speakup/say_control
388 /speakup/say_word_ctl 382 /speakup/say_word_ctl
389 /speakup/silent 383 /speakup/silent
390 /speakup/spell_delay 384 /speakup/spell_delay
391 /speakup/synth 385 /speakup/synth
392 /speakup/synth_direct 386 /speakup/synth_direct
393 /speakup/version 387 /speakup/version
394 388
395 /speakup/i18n: 389 /speakup/i18n:
396 announcements 390 announcements
397 characters 391 characters
398 chartab 392 chartab
399 colors 393 colors
400 ctl_keys 394 ctl_keys
401 formatted 395 formatted
402 function_names 396 function_names
403 key_names 397 key_names
404 states 398 states
405 399
406 /speakup/soft: 400 /speakup/soft:
407 caps_start 401 caps_start
408 caps_stop 402 caps_stop
409 delay_time 403 delay_time
410 direct 404 direct
411 freq 405 freq
412 full_time 406 full_time
413 jiffy_delta 407 jiffy_delta
414 pitch 408 pitch
415 inflection 409 inflection
416 punct 410 punct
417 rate 411 rate
418 tone 412 tone
419 trigger_time 413 trigger_time
420 voice 414 voice
421 vol 415 vol
422 416
423 Notice the two subdirectories of /speakup: /sp 417 Notice the two subdirectories of /speakup: /speakup/i18n and
424 /speakup/soft. 418 /speakup/soft.
425 The i18n subdirectory is described in a later 419 The i18n subdirectory is described in a later section.
426 The files under /speakup/soft represent settin 420 The files under /speakup/soft represent settings that are specific to the
427 driver for the software synthesizer. If you u 421 driver for the software synthesizer. If you use the LiteTalk, your
428 synthesizer-specific settings would be found i 422 synthesizer-specific settings would be found in /speakup/ltlk. In other words,
429 a subdirectory named /speakup/KWD is created t 423 a subdirectory named /speakup/KWD is created to hold parameters specific
430 to the device whose keyword is KWD. 424 to the device whose keyword is KWD.
431 These parameters include volume, rate, pitch, 425 These parameters include volume, rate, pitch, and others.
432 426
433 In addition to using the Speakup hot keys to c 427 In addition to using the Speakup hot keys to change such things as
434 volume, pitch, and rate, you can also echo val 428 volume, pitch, and rate, you can also echo values to the appropriate
435 entry in the /speakup directory. This is very 429 entry in the /speakup directory. This is very useful, since it
436 lets you control Speakup parameters from withi 430 lets you control Speakup parameters from within a script. How you
437 would write such scripts is somewhat beyond th 431 would write such scripts is somewhat beyond the scope of this manual,
438 but I will include a couple of simple examples 432 but I will include a couple of simple examples here to give you a
439 general idea of what such scripts can do. 433 general idea of what such scripts can do.
440 434
441 Suppose for example, that you wanted to contro 435 Suppose for example, that you wanted to control both the punctuation
442 level and the reading punctuation level at the 436 level and the reading punctuation level at the same time. For
443 simplicity, we'll call them punc0, punc1, punc 437 simplicity, we'll call them punc0, punc1, punc2, and punc3. The scripts
444 might look something like this: 438 might look something like this:
445 439
446 #!/bin/bash 440 #!/bin/bash
447 # punc0 441 # punc0
448 # set punc and reading punc levels to 0 442 # set punc and reading punc levels to 0
449 echo 0 >/speakup/punc_level 443 echo 0 >/speakup/punc_level
450 echo 0 >/speakup/reading_punc 444 echo 0 >/speakup/reading_punc
451 echo Punctuation level set to 0. 445 echo Punctuation level set to 0.
452 446
453 #!/bin/bash 447 #!/bin/bash
454 # punc1 448 # punc1
455 # set punc and reading punc levels to 1 449 # set punc and reading punc levels to 1
456 echo 1 >/speakup/punc_level 450 echo 1 >/speakup/punc_level
457 echo 1 >/speakup/reading_punc 451 echo 1 >/speakup/reading_punc
458 echo Punctuation level set to 1. 452 echo Punctuation level set to 1.
459 453
460 #!/bin/bash 454 #!/bin/bash
461 # punc2 455 # punc2
462 # set punc and reading punc levels to 2 456 # set punc and reading punc levels to 2
463 echo 2 >/speakup/punc_level 457 echo 2 >/speakup/punc_level
464 echo 2 >/speakup/reading_punc 458 echo 2 >/speakup/reading_punc
465 echo Punctuation level set to 2. 459 echo Punctuation level set to 2.
466 460
467 #!/bin/bash 461 #!/bin/bash
468 # punc3 462 # punc3
469 # set punc and reading punc levels to 3 463 # set punc and reading punc levels to 3
470 echo 3 >/speakup/punc_level 464 echo 3 >/speakup/punc_level
471 echo 3 >/speakup/reading_punc 465 echo 3 >/speakup/reading_punc
472 echo Punctuation level set to 3. 466 echo Punctuation level set to 3.
473 467
474 If you were to store these four small scripts 468 If you were to store these four small scripts in a directory in your
475 path, perhaps /usr/local/bin, and set the perm 469 path, perhaps /usr/local/bin, and set the permissions to 755 with the
476 chmod command, then you could change the defau 470 chmod command, then you could change the default reading punc and
477 punctuation levels at the same time by issuing 471 punctuation levels at the same time by issuing just one command. For
478 example, if you were to execute the punc3 comm 472 example, if you were to execute the punc3 command at your shell prompt,
479 then the reading punc and punc level would bot 473 then the reading punc and punc level would both get set to 3.
480 474
481 I should note that the above scripts were writ 475 I should note that the above scripts were written to work with bash, but
482 regardless of which shell you use, you should 476 regardless of which shell you use, you should be able to do something
483 similar. 477 similar.
484 478
485 The Speakup sys system also has another intere 479 The Speakup sys system also has another interesting use. You can echo
486 Speakup parameters into the sys system in a sc 480 Speakup parameters into the sys system in a script during system
487 startup, and speakup will return to your prefe 481 startup, and speakup will return to your preferred parameters every time
488 the system is rebooted. 482 the system is rebooted.
489 483
490 Most of the Speakup sys parameters can be mani 484 Most of the Speakup sys parameters can be manipulated by a regular user
491 on the system. However, there are a few param 485 on the system. However, there are a few parameters that are dangerous
492 enough that they should only be manipulated by 486 enough that they should only be manipulated by the root user on your
493 system. There are even some parameters that a 487 system. There are even some parameters that are read only, and cannot
494 be written to at all. For example, the versio 488 be written to at all. For example, the version entry in the Speakup
495 sys system is read only. This is because ther 489 sys system is read only. This is because there is no reason for a user
496 to tamper with the version number which is rep 490 to tamper with the version number which is reported by Speakup. Doing
497 an ls -l on /speakup/version will return this: 491 an ls -l on /speakup/version will return this:
498 492
499 -r--r--r-- 1 root root 0 Mar 493 -r--r--r-- 1 root root 0 Mar 21 13:46 /speakup/version
500 494
501 As you can see, the version entry in the Speak 495 As you can see, the version entry in the Speakup sys system is read
502 only, is owned by root, and belongs to the roo 496 only, is owned by root, and belongs to the root group. Doing a cat of
503 /speakup/version will display the Speakup vers 497 /speakup/version will display the Speakup version number, like
504 this: 498 this:
505 499
506 cat /speakup/version 500 cat /speakup/version
507 Speakup v-2.00 CVS: Thu Oct 21 10:38:21 EDT 20 501 Speakup v-2.00 CVS: Thu Oct 21 10:38:21 EDT 2004
508 synth dtlk version 1.1 502 synth dtlk version 1.1
509 503
510 The display shows the Speakup version number, 504 The display shows the Speakup version number, along with the version
511 number of the driver for the current synthesiz 505 number of the driver for the current synthesizer.
512 506
513 Looking at entries in the Speakup sys system c 507 Looking at entries in the Speakup sys system can be useful in many
514 ways. For example, you might wish to know wha 508 ways. For example, you might wish to know what level your volume is set
515 at. You could type: 509 at. You could type:
516 510
517 cat /speakup/KWD/vol 511 cat /speakup/KWD/vol
518 # Replace KWD with the keyword for your synthe 512 # Replace KWD with the keyword for your synthesizer, E.G., ltlk for LiteTalk.
519 5 513 5
520 514
521 The number five which comes back is the level 515 The number five which comes back is the level at which the synthesizer
522 volume is set at. 516 volume is set at.
523 517
524 All the entries in the Speakup sys system are 518 All the entries in the Speakup sys system are readable, some are
525 writable by root only, and some are writable b 519 writable by root only, and some are writable by everyone. Unless you
526 know what you are doing, you should probably l 520 know what you are doing, you should probably leave the ones that are
527 writable by root only alone. Most of the name 521 writable by root only alone. Most of the names are self explanatory.
528 Vol for controlling volume, pitch for pitch, i 522 Vol for controlling volume, pitch for pitch, inflection for pitch range, rate
529 for controlling speaking rate, etc. If you fi 523 for controlling speaking rate, etc. If you find one you aren't sure about, you
530 can post a query on the Speakup list. 524 can post a query on the Speakup list.
531 525
532 6. Changing Synthesizers 526 6. Changing Synthesizers
533 527
534 It is possible to change to a different synthe 528 It is possible to change to a different synthesizer while speakup is
535 running. In other words, it is not necessary 529 running. In other words, it is not necessary to reboot the system
536 in order to use a different synthesizer. You 530 in order to use a different synthesizer. You can simply echo the
537 synthesizer keyword to the /speakup/synth sys 531 synthesizer keyword to the /speakup/synth sys entry.
538 Depending on your situation, you may wish to e 532 Depending on your situation, you may wish to echo none to the synth
539 sys entry, to disable speech while one synthes 533 sys entry, to disable speech while one synthesizer is disconnected and
540 a second one is connected in its place. Then 534 a second one is connected in its place. Then echo the keyword for the
541 new synthesizer into the synth sys entry in or 535 new synthesizer into the synth sys entry in order to start speech
542 with the newly connected synthesizer. See the 536 with the newly connected synthesizer. See the list of synthesizer
543 keywords in section 1 to find the keyword whic 537 keywords in section 1 to find the keyword which matches your synth.
544 538
545 7. Loading modules 539 7. Loading modules
546 540
547 As mentioned earlier, Speakup can either be co 541 As mentioned earlier, Speakup can either be completely compiled into the
548 kernel, with the exception of the help module, 542 kernel, with the exception of the help module, or it can be compiled as
549 a series of modules. When compiled as module 543 a series of modules. When compiled as modules, Speakup will only be
550 able to speak some of the bootup messages if y 544 able to speak some of the bootup messages if your system administrator
551 has configured the system to load the modules !! 545 has configured the system to load the modules at boo time. The modules
552 can be loaded after the file systems have bee 546 can be loaded after the file systems have been checked and mounted, or
553 from an initrd. There is a third possibility. 547 from an initrd. There is a third possibility. Speakup can be compiled
554 with some components built into the kernel, an 548 with some components built into the kernel, and others as modules. As
555 we'll see in the next section, this is particu 549 we'll see in the next section, this is particularly useful when you are
556 working with software synthesizers. 550 working with software synthesizers.
557 551
558 If Speakup is completely compiled as modules, 552 If Speakup is completely compiled as modules, then you must use the
559 modprobe command to load Speakup. You do this 553 modprobe command to load Speakup. You do this by loading the module for
560 the synthesizer driver you wish to use. The d 554 the synthesizer driver you wish to use. The driver modules are all
561 named speakup_<keyword>, where <keyword> is th 555 named speakup_<keyword>, where <keyword> is the keyword for the
562 synthesizer you want. So, in order to load th 556 synthesizer you want. So, in order to load the driver for the DecTalk
563 Express, you would type the following command: 557 Express, you would type the following command:
564 558
565 modprobe speakup_dectlk 559 modprobe speakup_dectlk
566 560
567 Issuing this command would load the DecTalk Ex 561 Issuing this command would load the DecTalk Express driver and all other
568 related Speakup modules necessary to get Speak 562 related Speakup modules necessary to get Speakup up and running.
569 563
570 To completely unload Speakup, again presuming 564 To completely unload Speakup, again presuming that it is entirely built
571 as modules, you would give the command: 565 as modules, you would give the command:
572 566
573 modprobe -r speakup_dectlk 567 modprobe -r speakup_dectlk
574 568
575 The above command assumes you were running a D 569 The above command assumes you were running a DecTalk Express. If you
576 were using a different synth, then you would s 570 were using a different synth, then you would substitute its keyword in
577 place of dectlk. 571 place of dectlk.
578 572
579 If you have multiple drivers loaded, you need 573 If you have multiple drivers loaded, you need to unload all of them, in
580 order to completely unload Speakup. 574 order to completely unload Speakup.
581 For example, if you have loaded both the dectl 575 For example, if you have loaded both the dectlk and ltlk drivers, use the
582 command: 576 command:
583 modprobe -r speakup_dectlk speakup_ltlk 577 modprobe -r speakup_dectlk speakup_ltlk
584 578
585 You cannot unload the driver for software synt 579 You cannot unload the driver for software synthesizers when a user-space
586 daemon is using /dev/softsynth. First, kill t 580 daemon is using /dev/softsynth. First, kill the daemon. Next, remove
587 the driver with the command: 581 the driver with the command:
588 modprobe -r speakup_soft 582 modprobe -r speakup_soft
589 583
590 Now, suppose we have a situation where the mai 584 Now, suppose we have a situation where the main Speakup component
591 is built into the kernel, and some or all of t 585 is built into the kernel, and some or all of the drivers are built as
592 modules. Since the main part of Speakup is co 586 modules. Since the main part of Speakup is compiled into the kernel, a
593 partial Speakup sys system has been created wh 587 partial Speakup sys system has been created which we can take advantage
594 of by simply echoing the synthesizer keyword i 588 of by simply echoing the synthesizer keyword into the
595 /speakup/synth sys entry. This will cause the 589 /speakup/synth sys entry. This will cause the kernel to
596 automatically load the appropriate driver modu 590 automatically load the appropriate driver module, and start Speakup
597 talking. To switch to another synth, just ech 591 talking. To switch to another synth, just echo a new keyword to the
598 synth sys entry. For example, to load the Dou 592 synth sys entry. For example, to load the DoubleTalk LT driver,
599 you would type: 593 you would type:
600 594
601 echo ltlk >/speakup/synth 595 echo ltlk >/speakup/synth
602 596
603 You can use the modprobe -r command to unload 597 You can use the modprobe -r command to unload driver modules, regardless
604 of whether the main part of Speakup has been b 598 of whether the main part of Speakup has been built into the kernel or
605 not. 599 not.
606 600
607 8. Using Software Synthesizers 601 8. Using Software Synthesizers
608 602
609 Using a software synthesizer requires that som 603 Using a software synthesizer requires that some other software be
610 installed and running on your system. For thi 604 installed and running on your system. For this reason, software
611 synthesizers are not available for use at boot 605 synthesizers are not available for use at bootup, or during a system
612 installation process. 606 installation process.
613 There are two freely-available solutions for s 607 There are two freely-available solutions for software speech: Espeakup and
614 Speech Dispatcher. 608 Speech Dispatcher.
615 These are described in subsections 8.1 and 8.2 609 These are described in subsections 8.1 and 8.2, respectively.
616 610
617 During the rest of this section, we assume tha 611 During the rest of this section, we assume that speakup_soft is either
618 built in to your kernel, or loaded as a module 612 built in to your kernel, or loaded as a module.
619 613
620 If your system does not have udev installed , 614 If your system does not have udev installed , before you can use a
621 software synthesizer, you must have created th 615 software synthesizer, you must have created the /dev/softsynth device.
622 If you have not already done so, issue the fol 616 If you have not already done so, issue the following commands as root:
623 617
624 cd /dev 618 cd /dev
625 mknod softsynth c 10 26 619 mknod softsynth c 10 26
626 620
627 While we are at it, we might just as well crea 621 While we are at it, we might just as well create the /dev/synth device,
628 which can be used to let user space programs s 622 which can be used to let user space programs send information to your
629 synthesizer. To create /dev/synth, change to 623 synthesizer. To create /dev/synth, change to the /dev directory, and
630 issue the following command as root: 624 issue the following command as root:
631 625
632 mknod synth c 10 25 626 mknod synth c 10 25
633 627
634 of both. 628 of both.
635 629
636 8.1. Espeakup 630 8.1. Espeakup
637 631
638 Espeakup is a connector between Speakup and th 632 Espeakup is a connector between Speakup and the eSpeak software synthesizer.
639 Espeakup may already be available as a package 633 Espeakup may already be available as a package for your distribution
640 of Linux. If it is not packaged, you need to 634 of Linux. If it is not packaged, you need to install it manually.
641 You can find it in the contrib/ subdirectory o 635 You can find it in the contrib/ subdirectory of the Speakup sources.
642 The filename is espeakup-$VERSION.tar.bz2, whe 636 The filename is espeakup-$VERSION.tar.bz2, where $VERSION
643 depends on the current release of Espeakup. T 637 depends on the current release of Espeakup. The Speakup 3.1.2 source
644 ships with version 0.71 of Espeakup. 638 ships with version 0.71 of Espeakup.
645 The README file included with the Espeakup sou 639 The README file included with the Espeakup sources describes the process
646 of manual installation. 640 of manual installation.
647 641
648 Assuming that Espeakup is installed, either by 642 Assuming that Espeakup is installed, either by the user or by the distributor,
649 follow these steps to use it. 643 follow these steps to use it.
650 644
651 Tell Speakup to use the "soft driver: 645 Tell Speakup to use the "soft driver:
652 echo soft > /speakup/synth 646 echo soft > /speakup/synth
653 647
654 Finally, start the espeakup program. There ar 648 Finally, start the espeakup program. There are two ways to do it.
655 Both require root privileges. 649 Both require root privileges.
656 650
657 If Espeakup was installed as a package for you 651 If Espeakup was installed as a package for your Linux distribution,
658 you probably have a distribution-specific scri 652 you probably have a distribution-specific script that controls the operation
659 of the daemon. Look for a file named espeakup 653 of the daemon. Look for a file named espeakup under /etc/init.d or
660 /etc/rc.d. Execute the following command with 654 /etc/rc.d. Execute the following command with root privileges:
661 /etc/init.d/espeakup start 655 /etc/init.d/espeakup start
662 Replace init.d with rc.d, if your distribution 656 Replace init.d with rc.d, if your distribution uses scripts located under
663 /etc/rc.d. 657 /etc/rc.d.
664 Your distribution will also have a procedure f 658 Your distribution will also have a procedure for starting daemons at
665 boot-time, so it is possible to have software 659 boot-time, so it is possible to have software speech as soon as user-space
666 daemons are started by the bootup scripts. 660 daemons are started by the bootup scripts.
667 These procedures are not described in this doc 661 These procedures are not described in this document.
668 662
669 If you built Espeakup manually, the "make inst 663 If you built Espeakup manually, the "make install" step placed the binary
670 under /usr/bin. 664 under /usr/bin.
671 Run the following command as root: 665 Run the following command as root:
672 /usr/bin/espeakup 666 /usr/bin/espeakup
673 Espeakup should start speaking. 667 Espeakup should start speaking.
674 668
675 8.2. Speech Dispatcher 669 8.2. Speech Dispatcher
676 670
677 For this option, you must have a package calle 671 For this option, you must have a package called
678 Speech Dispatcher running on your system, and 672 Speech Dispatcher running on your system, and it must be configured to
679 work with one of its supported software synthe 673 work with one of its supported software synthesizers.
680 674
681 Two open source synthesizers you might use are 675 Two open source synthesizers you might use are Flite and Festival. You
682 might also choose to purchase the Software Dec 676 might also choose to purchase the Software DecTalk from Fonix Sales Inc.
683 If you run a google search for Fonix, you'll f 677 If you run a google search for Fonix, you'll find their web site.
684 678
685 You can obtain a copy of Speech Dispatcher fro 679 You can obtain a copy of Speech Dispatcher from free(b)soft at
686 http://www.freebsoft.org/. Follow the install 680 http://www.freebsoft.org/. Follow the installation instructions that
687 come with Speech Dispatcher in order to instal 681 come with Speech Dispatcher in order to install and configure Speech
688 Dispatcher. You can check out the web site fo 682 Dispatcher. You can check out the web site for your Linux distribution
689 in order to get a copy of either Flite or Fest 683 in order to get a copy of either Flite or Festival. Your Linux
690 distribution may also have a precompiled Speec 684 distribution may also have a precompiled Speech Dispatcher package.
691 685
692 Once you've installed, configured, and tested 686 Once you've installed, configured, and tested Speech Dispatcher with your
693 chosen software synthesizer, you still need on 687 chosen software synthesizer, you still need one more piece of software
694 in order to make things work. You need a pack 688 in order to make things work. You need a package called speechd-up.
695 You get it from the free(b)soft web site menti 689 You get it from the free(b)soft web site mentioned above. After you've
696 compiled and installed speechd-up, you are alm 690 compiled and installed speechd-up, you are almost ready to begin using
697 your software synthesizer. 691 your software synthesizer.
698 692
699 Now you can begin using your software synthesi 693 Now you can begin using your software synthesizer. In order to do so,
700 echo the soft keyword to the synth sys entry l 694 echo the soft keyword to the synth sys entry like this:
701 695
702 echo soft >/speakup/synth 696 echo soft >/speakup/synth
703 697
704 Next run the speechd_up command like this: 698 Next run the speechd_up command like this:
705 699
706 speechd_up & 700 speechd_up &
707 701
708 Your synth should now start talking, and you s 702 Your synth should now start talking, and you should be able to adjust
709 the pitch, rate, etc. 703 the pitch, rate, etc.
710 704
711 9. Using The DecTalk PC Card 705 9. Using The DecTalk PC Card
712 706
713 The DecTalk PC card is an ISA card that is ins 707 The DecTalk PC card is an ISA card that is inserted into one of the ISA
714 slots in your computer. It requires that the 708 slots in your computer. It requires that the DecTalk PC software be
715 installed on your computer, and that the softw 709 installed on your computer, and that the software be loaded onto the
716 Dectalk PC card before it can be used. 710 Dectalk PC card before it can be used.
717 711
718 You can get the dec_pc.tgz file from the linux 712 You can get the dec_pc.tgz file from the linux-speakup.org site. The
719 dec_pc.tgz file is in the ~ftp/pub/linux/speak 713 dec_pc.tgz file is in the ~ftp/pub/linux/speakup directory.
720 714
721 After you have downloaded the dec_pc.tgz file, 715 After you have downloaded the dec_pc.tgz file, untar it in your home
722 directory, and read the Readme file in the new 716 directory, and read the Readme file in the newly created dec_pc
723 directory. 717 directory.
724 718
725 The easiest way to get the software working is 719 The easiest way to get the software working is to copy the entire dec_pc
726 directory into /user/local/lib. To do this, s 720 directory into /user/local/lib. To do this, su to root in your home
727 directory, and issue the command: 721 directory, and issue the command:
728 722
729 cp dec_pc /usr/local/lib 723 cp dec_pc /usr/local/lib
730 724
731 You will need to copy the dtload command from 725 You will need to copy the dtload command from the dec_pc directory to a
732 directory in your path. Either /usr/bin or /u 726 directory in your path. Either /usr/bin or /usr/local/bin is a good
733 choice. 727 choice.
734 728
735 You can now run the dtload command in order to 729 You can now run the dtload command in order to load the DecTalk PC
736 software onto the card. After you have done t 730 software onto the card. After you have done this, echo the decpc
737 keyword to the synth entry in the sys system l 731 keyword to the synth entry in the sys system like this:
738 732
739 echo decpc >/speakup/synth 733 echo decpc >/speakup/synth
740 734
741 Your DecTalk PC should start talking, and then 735 Your DecTalk PC should start talking, and then you can adjust the pitch,
742 rate, volume, voice, etc. The voice entry in 736 rate, volume, voice, etc. The voice entry in the Speakup sys system
743 will accept a number from 0 through 7 for the 737 will accept a number from 0 through 7 for the DecTalk PC synthesizer,
744 which will give you access to some of the DecT 738 which will give you access to some of the DecTalk voices.
745 739
746 10. Using Cursor Tracking 740 10. Using Cursor Tracking
747 741
748 In Speakup version 2.0 and later, cursor track 742 In Speakup version 2.0 and later, cursor tracking is turned on by
749 default. This means that when you are using a 743 default. This means that when you are using an editor, Speakup will
750 automatically speak characters as you move lef 744 automatically speak characters as you move left and right with the
751 cursor keys, and lines as you move up and down 745 cursor keys, and lines as you move up and down with the cursor keys.
752 This is the traditional sort of cursor trackin 746 This is the traditional sort of cursor tracking.
753 Recent versions of Speakup provide two additio 747 Recent versions of Speakup provide two additional ways to control the
754 text that is spoken when the cursor is moved: 748 text that is spoken when the cursor is moved:
755 "highlight tracking" and "read window." 749 "highlight tracking" and "read window."
756 They are described later in this section. 750 They are described later in this section.
757 Sometimes, these modes get in your way, so you 751 Sometimes, these modes get in your way, so you can disable cursor tracking
758 altogether. 752 altogether.
759 753
760 You may select among the various forms of curs 754 You may select among the various forms of cursor tracking using the keypad
761 asterisk key. 755 asterisk key.
762 Each time you press this key, a new mode is se 756 Each time you press this key, a new mode is selected, and Speakup speaks
763 the name of the new mode. The names for the f 757 the name of the new mode. The names for the four possible states of cursor
764 tracking are: "cursoring on", "highlight track 758 tracking are: "cursoring on", "highlight tracking", "read window",
765 and "cursoring off." The keypad asterisk key 759 and "cursoring off." The keypad asterisk key moves through the list of
766 modes in a circular fashion. 760 modes in a circular fashion.
767 761
768 If highlight tracking is enabled, Speakup trac 762 If highlight tracking is enabled, Speakup tracks highlighted text,
769 rather than the cursor itself. When you move t 763 rather than the cursor itself. When you move the cursor with the arrow keys,
770 Speakup speaks the currently highlighted infor 764 Speakup speaks the currently highlighted information.
771 This is useful when moving through various men 765 This is useful when moving through various menus and dialog boxes.
772 If cursor tracking isn't helping you while nav 766 If cursor tracking isn't helping you while navigating a menu,
773 try highlight tracking. 767 try highlight tracking.
774 768
775 With the "read window" variety of cursor track 769 With the "read window" variety of cursor tracking, you can limit the text
776 that Speakup speaks by specifying a window of 770 that Speakup speaks by specifying a window of interest on the screen.
777 See section 15 for a description of the proces 771 See section 15 for a description of the process of defining windows.
778 When you move the cursor via the arrow keys, S 772 When you move the cursor via the arrow keys, Speakup only speaks
779 the contents of the window. This is especiall 773 the contents of the window. This is especially helpful when you are hearing
780 superfluous speech. Consider the following ex 774 superfluous speech. Consider the following example.
781 775
782 Suppose that you are at a shell prompt. You u 776 Suppose that you are at a shell prompt. You use bash, and you want to
783 explore your command history using the up and 777 explore your command history using the up and down arrow keys. If you
784 have enabled cursor tracking, you will hear tw 778 have enabled cursor tracking, you will hear two pieces of information.
785 Speakup speaks both your shell prompt and the 779 Speakup speaks both your shell prompt and the current entry from the
786 command history. You may not want to hear the 780 command history. You may not want to hear the prompt repeated
787 each time you move, so you can silence it by s 781 each time you move, so you can silence it by specifying a window. Find
788 the last line of text on the screen. Clear th 782 the last line of text on the screen. Clear the current window by pressing
789 the key combination speakup f3. Use the revie 783 the key combination speakup f3. Use the review cursor to find the first
790 character that follows your shell prompt. Pre 784 character that follows your shell prompt. Press speakup + f2 twice, to
791 define a one-line window. The boundaries of t 785 define a one-line window. The boundaries of the window are the
792 character following the shell prompt and the e 786 character following the shell prompt and the end of the line. Now, cycle
793 through the cursor tracking modes using keypad 787 through the cursor tracking modes using keypad asterisk, until Speakup
794 says "read window." Move through your history 788 says "read window." Move through your history using your arrow keys.
795 You will notice that Speakup no longer speaks 789 You will notice that Speakup no longer speaks the redundant prompt.
796 790
797 Some folks like to turn cursor tracking off wh 791 Some folks like to turn cursor tracking off while they are using the
798 lynx web browser. You definitely want to turn 792 lynx web browser. You definitely want to turn cursor tracking off when
799 you are using the alsamixer application. Othe 793 you are using the alsamixer application. Otherwise, you won't be able
800 to hear your mixer settings while you are usin 794 to hear your mixer settings while you are using the arrow keys.
801 795
802 11. Cut and Paste 796 11. Cut and Paste
803 797
804 One of Speakup's more useful features is the a 798 One of Speakup's more useful features is the ability to cut and paste
805 text on the screen. This means that you can c 799 text on the screen. This means that you can capture information from a
806 program, and paste that captured text into a d 800 program, and paste that captured text into a different place in the
807 program, or into an entirely different program 801 program, or into an entirely different program, which may even be
808 running on a different console. 802 running on a different console.
809 803
810 For example, in this manual, we have made refe 804 For example, in this manual, we have made references to several web
811 sites. It would be nice if you could cut and 805 sites. It would be nice if you could cut and paste these urls into your
812 web browser. Speakup does this quite nicely. 806 web browser. Speakup does this quite nicely. Suppose you wanted to
813 past the following url into your browser: 807 past the following url into your browser:
814 808
815 http://linux-speakup.org/ 809 http://linux-speakup.org/
816 810
817 Use the speakup review keys to position the re 811 Use the speakup review keys to position the reading cursor on the first
818 character of the above url. When the reading 812 character of the above url. When the reading cursor is in position,
819 press the keypad slash key once. Speakup will 813 press the keypad slash key once. Speakup will say, "mark". Next,
820 position the reading cursor on the rightmost c 814 position the reading cursor on the rightmost character of the above
821 url. Press the keypad slash key once again to 815 url. Press the keypad slash key once again to actually cut the text
822 from the screen. Speakup will say, "cut". Al 816 from the screen. Speakup will say, "cut". Although we call this
823 cutting, Speakup does not actually delete the 817 cutting, Speakup does not actually delete the cut text from the screen.
824 It makes a copy of the text in a special buffe 818 It makes a copy of the text in a special buffer for later pasting.
825 819
826 Now that you have the url cut from the screen, 820 Now that you have the url cut from the screen, you can paste it into
827 your browser, or even paste the url on a comma 821 your browser, or even paste the url on a command line as an argument to
828 your browser. 822 your browser.
829 823
830 Suppose you want to start lynx and go to the S 824 Suppose you want to start lynx and go to the Speakup site.
831 825
832 You can switch to a different console with the 826 You can switch to a different console with the alt left and right
833 arrows, or you can switch to a specific consol 827 arrows, or you can switch to a specific console by typing alt and a
834 function key. These are not Speakup commands, 828 function key. These are not Speakup commands, just standard Linux
835 console capabilities. 829 console capabilities.
836 830
837 Once you've changed to an appropriate console, 831 Once you've changed to an appropriate console, and are at a shell prompt,
838 type the word lynx, followed by a space. Now 832 type the word lynx, followed by a space. Now press and hold the speakup
839 key, while you type the keypad slash character 833 key, while you type the keypad slash character. The url will be pasted
840 onto the command line, just as though you had 834 onto the command line, just as though you had typed it in. Press the
841 enter key to execute the command. 835 enter key to execute the command.
842 836
843 The paste buffer will continue to hold the cut 837 The paste buffer will continue to hold the cut information, until a new
844 mark and cut operation is carried out. This m 838 mark and cut operation is carried out. This means you can paste the cut
845 information as many times as you like before d 839 information as many times as you like before doing another cut
846 operation. 840 operation.
847 841
848 You are not limited to cutting and pasting onl 842 You are not limited to cutting and pasting only one line on the screen.
849 You can also cut and paste rectangular regions 843 You can also cut and paste rectangular regions of the screen. Just
850 position the reading cursor at the top left co 844 position the reading cursor at the top left corner of the text to be
851 cut, mark it with the keypad slash key, then p 845 cut, mark it with the keypad slash key, then position the reading cursor
852 at the bottom right corner of the region to be 846 at the bottom right corner of the region to be cut, and cut it with the
853 keypad slash key. 847 keypad slash key.
854 848
855 12. Changing the Pronunciation of Characters 849 12. Changing the Pronunciation of Characters
856 850
857 Through the /speakup/i18n/characters sys entry 851 Through the /speakup/i18n/characters sys entry, Speakup gives you the
858 ability to change how Speakup pronounces a giv 852 ability to change how Speakup pronounces a given character. You could,
859 for example, change how some punctuation chara 853 for example, change how some punctuation characters are spoken. You can
860 even change how Speakup will pronounce certain 854 even change how Speakup will pronounce certain letters.
861 855
862 You may, for example, wish to change how Speak 856 You may, for example, wish to change how Speakup pronounces the z
863 character. The author of Speakup, Kirk Reiser 857 character. The author of Speakup, Kirk Reiser, is Canadian, and thus
864 believes that the z should be pronounced zed. 858 believes that the z should be pronounced zed. If you are an American,
865 you might wish to use the zee pronunciation in 859 you might wish to use the zee pronunciation instead of zed. You can
866 change the pronunciation of both the upper and 860 change the pronunciation of both the upper and lower case z with the
867 following two commands: 861 following two commands:
868 862
869 echo 90 zee >/speakup/characters 863 echo 90 zee >/speakup/characters
870 echo 122 zee >/speakup/characters 864 echo 122 zee >/speakup/characters
871 865
872 Let's examine the parts of the two previous co 866 Let's examine the parts of the two previous commands. They are issued
873 at the shell prompt, and could be placed in a 867 at the shell prompt, and could be placed in a startup script.
874 868
875 The word echo tells the shell that you want to 869 The word echo tells the shell that you want to have it display the
876 string of characters that follow the word echo 870 string of characters that follow the word echo. If you were to just
877 type: 871 type:
878 872
879 echo hello. 873 echo hello.
880 874
881 You would get the word hello printed on your s 875 You would get the word hello printed on your screen as soon as you
882 pressed the enter key. In this case, we are e 876 pressed the enter key. In this case, we are echoing strings that we
883 want to be redirected into the sys system. 877 want to be redirected into the sys system.
884 878
885 The numbers 90 and 122 in the above echo comma 879 The numbers 90 and 122 in the above echo commands are the ascii numeric
886 values for the upper and lower case z, the cha 880 values for the upper and lower case z, the characters we wish to change.
887 881
888 The string zee is the pronunciation that we wa 882 The string zee is the pronunciation that we want Speakup to use for the
889 upper and lower case z. 883 upper and lower case z.
890 884
891 The > symbol redirects the output of the echo 885 The > symbol redirects the output of the echo command to a file, just
892 like in DOS, or at the Windows command prompt. 886 like in DOS, or at the Windows command prompt.
893 887
894 And finally, /speakup/i18n/characters is the f 888 And finally, /speakup/i18n/characters is the file entry in the sys system
895 where we want the output to be directed. Spea 889 where we want the output to be directed. Speakup looks at the numeric
896 value of the character we want to change, and 890 value of the character we want to change, and inserts the pronunciation
897 string into an internal table. 891 string into an internal table.
898 892
899 You can look at the whole table with the follo 893 You can look at the whole table with the following command:
900 894
901 cat /speakup/i18n/characters 895 cat /speakup/i18n/characters
902 896
903 Speakup will then print out the entire charact 897 Speakup will then print out the entire character pronunciation table. I
904 won't display it here, but leave you to look a 898 won't display it here, but leave you to look at it at your convenience.
905 899
906 13. Mapping Keys 900 13. Mapping Keys
907 901
908 Speakup has the capability of allowing you to 902 Speakup has the capability of allowing you to assign or "map" keys to
909 internal Speakup commands. This section neces 903 internal Speakup commands. This section necessarily assumes you have a
910 Linux kernel source tree installed, and that i 904 Linux kernel source tree installed, and that it has been patched and
911 configured with Speakup. How you do this is b 905 configured with Speakup. How you do this is beyond the scope of this
912 manual. For this information, visit the Speak 906 manual. For this information, visit the Speakup web site at
913 http://linux-speakup.org/. The reason you'll 907 http://linux-speakup.org/. The reason you'll need the kernel source
914 tree patched with Speakup is that the genmap u 908 tree patched with Speakup is that the genmap utility you'll need for
915 processing keymaps is in the 909 processing keymaps is in the
916 /usr/src/linux-<version_number>/drivers/char/s 910 /usr/src/linux-<version_number>/drivers/char/speakup directory. The
917 <version_number> in the above directory path i 911 <version_number> in the above directory path is the version number of
918 the Linux source tree you are working with. 912 the Linux source tree you are working with.
919 913
920 So ok, you've gone off and gotten your kernel 914 So ok, you've gone off and gotten your kernel source tree, and patched
921 and configured it. Now you can start manipula 915 and configured it. Now you can start manipulating keymaps.
922 916
923 You can either use the 917 You can either use the
924 /usr/src/linux-<version_number>/drivers/char/s 918 /usr/src/linux-<version_number>/drivers/char/speakup/speakupmap.map file
925 included with the Speakup source, or you can c 919 included with the Speakup source, or you can cut and paste the copy in
926 section 4 into a separate file. If you use th 920 section 4 into a separate file. If you use the one in the Speakup
927 source tree, make sure you make a backup of it 921 source tree, make sure you make a backup of it before you start making
928 changes. You have been warned! 922 changes. You have been warned!
929 923
930 Suppose that you want to swap the key assignme 924 Suppose that you want to swap the key assignments for the Speakup
931 say_last_char and the Speakup say_first_char c 925 say_last_char and the Speakup say_first_char commands. The
932 speakupmap.map lists the key mappings for thes 926 speakupmap.map lists the key mappings for these two commands as follows:
933 927
934 spk key_pageup = say_first_char 928 spk key_pageup = say_first_char
935 spk key_pagedown = say_last_char 929 spk key_pagedown = say_last_char
936 930
937 You can edit your copy of the speakupmap.map f 931 You can edit your copy of the speakupmap.map file and swap the command
938 names on the right side of the = (equals) sign 932 names on the right side of the = (equals) sign. You did make a backup,
939 right? The new keymap lines would look like t 933 right? The new keymap lines would look like this:
940 934
941 spk key_pageup = say_last_char 935 spk key_pageup = say_last_char
942 spk key_pagedown = say_first_char 936 spk key_pagedown = say_first_char
943 937
944 After you edit your copy of the speakupmap.map 938 After you edit your copy of the speakupmap.map file, save it under a new
945 file name, perhaps newmap.map. Then exit your 939 file name, perhaps newmap.map. Then exit your editor and return to the
946 shell prompt. 940 shell prompt.
947 941
948 You are now ready to load your keymap with you 942 You are now ready to load your keymap with your swapped key assignments.
949 Assuming that you saved your new keymap as th 943 Assuming that you saved your new keymap as the file newmap.map, you
950 would load your keymap into the sys system lik 944 would load your keymap into the sys system like this:
951 945
952 /usr/src/linux-<version_number>/drivers/char/s 946 /usr/src/linux-<version_number>/drivers/char/speakup/genmap newmap.map
953 >/speakup/keymap 947 >/speakup/keymap
954 948
955 Remember to substitute your kernel version num 949 Remember to substitute your kernel version number for the
956 <version_number> in the above command. Also n 950 <version_number> in the above command. Also note that although the
957 above command wrapped onto two lines in this d 951 above command wrapped onto two lines in this document, you should type
958 it all on one line. 952 it all on one line.
959 953
960 Your say first and say last characters should 954 Your say first and say last characters should now be swapped. Pressing
961 speakup pagedown should read you the first non 955 speakup pagedown should read you the first non-whitespace character on
962 the line your reading cursor is in, and pressi 956 the line your reading cursor is in, and pressing speakup pageup should
963 read you the last character on the line your r 957 read you the last character on the line your reading cursor is in.
964 958
965 You should note that these new mappings will o 959 You should note that these new mappings will only stay in effect until
966 you reboot, or until you load another keymap. 960 you reboot, or until you load another keymap.
967 961
968 One final warning. If you try to load a parti 962 One final warning. If you try to load a partial map, you will quickly
969 find that all the mappings you didn't include 963 find that all the mappings you didn't include in your file got deleted
970 from the working map. Be extremely careful, a 964 from the working map. Be extremely careful, and always make a backup!
971 You have been warned! 965 You have been warned!
972 966
973 14. Internationalizing Speakup 967 14. Internationalizing Speakup
974 968
975 Speakup indicates various conditions to the us 969 Speakup indicates various conditions to the user by speaking messages.
976 For instance, when you move to the left edge o 970 For instance, when you move to the left edge of the screen with the
977 review keys, Speakup says, "left." 971 review keys, Speakup says, "left."
978 Prior to version 3.1.0 of Speakup, all of thes 972 Prior to version 3.1.0 of Speakup, all of these messages were in English,
979 and they could not be changed. If you used a 973 and they could not be changed. If you used a non-English synthesizer,
980 you still heard English messages, such as "lef 974 you still heard English messages, such as "left" and "cursoring on."
981 In version 3.1.0 or higher, one may load trans 975 In version 3.1.0 or higher, one may load translations for the various
982 messages via the /sys filesystem. 976 messages via the /sys filesystem.
983 977
984 The directory /speakup/i18n contains several c 978 The directory /speakup/i18n contains several collections of messages.
985 Each group of messages is stored in its own fi 979 Each group of messages is stored in its own file.
986 The following section lists all of these files 980 The following section lists all of these files, along with a brief description
987 of each. 981 of each.
988 982
989 14.1. Files Under the i18n Subdirectory 983 14.1. Files Under the i18n Subdirectory
990 984
991 * announcements: 985 * announcements:
992 This file contains various general announcemen 986 This file contains various general announcements, most of which cannot
993 be categorized. You will find messages such a 987 be categorized. You will find messages such as "You killed Speakup",
994 "I'm alive", "leaving help", "parked", "unpark 988 "I'm alive", "leaving help", "parked", "unparked", and others.
995 You will also find the names of the screen edg 989 You will also find the names of the screen edges and cursor tracking modes
996 here. 990 here.
997 991
998 * characters: 992 * characters:
999 See section 12 for a description of this file. 993 See section 12 for a description of this file.
1000 994
1001 * chartab: 995 * chartab:
1002 See section 12. Unlike the rest of the files 996 See section 12. Unlike the rest of the files in the i18n subdirectory,
1003 this one does not contain messages to be spok 997 this one does not contain messages to be spoken.
1004 998
1005 * colors: 999 * colors:
1006 When you use the "say attributes" function, S 1000 When you use the "say attributes" function, Speakup says the name of the
1007 foreground and background colors. These name 1001 foreground and background colors. These names come from the i18n/colors
1008 file. 1002 file.
1009 1003
1010 * ctl_keys: 1004 * ctl_keys:
1011 Here, you will find names of control keys. T 1005 Here, you will find names of control keys. These are used with Speakup's
1012 say_control feature. 1006 say_control feature.
1013 1007
1014 * formatted: 1008 * formatted:
1015 This group of messages contains embedded form 1009 This group of messages contains embedded formatting codes, to specify
1016 the type and width of displayed data. If you 1010 the type and width of displayed data. If you change these, you must
1017 preserve all of the formatting codes, and the 1011 preserve all of the formatting codes, and they must appear in the order
1018 used by the default messages. 1012 used by the default messages.
1019 1013
1020 * function_names: 1014 * function_names:
1021 Here, you will find a list of names for Speak 1015 Here, you will find a list of names for Speakup functions. These are used
1022 by the help system. For example, suppose tha 1016 by the help system. For example, suppose that you have activated help mode,
1023 and you pressed keypad 3. Speakup says: 1017 and you pressed keypad 3. Speakup says:
1024 "keypad 3 is character, say next." 1018 "keypad 3 is character, say next."
1025 The message "character, say next" names a Spe 1019 The message "character, say next" names a Speakup function, and it
1026 comes from this function_names file. 1020 comes from this function_names file.
1027 1021
1028 * key_names: 1022 * key_names:
1029 Again, key_names is used by Speakup's help sy 1023 Again, key_names is used by Speakup's help system. In the previous
1030 example, Speakup said that you pressed "keypa 1024 example, Speakup said that you pressed "keypad 3."
1031 This name came from the key_names file. 1025 This name came from the key_names file.
1032 1026
1033 * states: 1027 * states:
1034 This file contains names for key states. 1028 This file contains names for key states.
1035 Again, these are part of the help system. Fo 1029 Again, these are part of the help system. For instance, if you had pressed
1036 speakup + keypad 3, you would hear: 1030 speakup + keypad 3, you would hear:
1037 "speakup keypad 3 is go to bottom edge." 1031 "speakup keypad 3 is go to bottom edge."
1038 The speakup key is depressed, so the name of 1032 The speakup key is depressed, so the name of the key state is speakup.
1039 This part of the message comes from the state 1033 This part of the message comes from the states collection.
1040 1034
1041 14.2. Changing language !! 1035 14.2. Loading Your Own Messages
1042 <<
1043 14.2.1. Loading Your Own Messages <<
1044 1036
1045 The files under the i18n subdirectory all fol 1037 The files under the i18n subdirectory all follow the same format.
1046 They consist of lines, with one message per l 1038 They consist of lines, with one message per line.
1047 Each message is represented by a number, foll 1039 Each message is represented by a number, followed by the text of the message.
1048 The number is the position of the message in 1040 The number is the position of the message in the given collection.
1049 For example, if you view the file /speakup/i1 1041 For example, if you view the file /speakup/i18n/colors, you will see the
1050 following list: 1042 following list:
1051 1043
1052 0 black 1044 0 black
1053 1 blue 1045 1 blue
1054 2 green 1046 2 green
1055 3 cyan 1047 3 cyan
1056 4 red 1048 4 red
1057 5 magenta 1049 5 magenta
1058 6 yellow 1050 6 yellow
1059 7 white 1051 7 white
1060 8 grey 1052 8 grey
1061 1053
1062 You can change one message, or you can change 1054 You can change one message, or you can change a whole group.
1063 To load a whole collection of messages from a 1055 To load a whole collection of messages from a new source, simply use
1064 the cp command: 1056 the cp command:
1065 cp ~/my_colors /speakup/i18n/colors 1057 cp ~/my_colors /speakup/i18n/colors
1066 You can change an individual message with the 1058 You can change an individual message with the echo command,
1067 as shown in the following example. 1059 as shown in the following example.
1068 1060
1069 The Spanish name for the color blue is azul. 1061 The Spanish name for the color blue is azul.
1070 Looking at the colors file, we see that the n 1062 Looking at the colors file, we see that the name "blue" is at position 1
1071 within the colors group. Let's change blue t 1063 within the colors group. Let's change blue to azul:
1072 echo '1 azul' > /speakup/i18n/colors 1064 echo '1 azul' > /speakup/i18n/colors
1073 The next time that Speakup says message 1 fro 1065 The next time that Speakup says message 1 from the colors group, it will
1074 say "azul", rather than "blue." 1066 say "azul", rather than "blue."
1075 1067
1076 14.2.2. Choose a language <<
1077 <<
1078 In the future, translations into various lang 1068 In the future, translations into various languages will be made available,
1079 and most users will just load the files neces !! 1069 and most users will just load the files necessary for their language.
1080 only French language is available beyond nati <<
1081 <<
1082 French is only available after you are logged <<
1083 <<
1084 Canadian English is the default language. To <<
1085 download the source of Speakup and untar it i <<
1086 following command should let you do this: <<
1087 <<
1088 tar xvjf speakup-<version>.tar.bz2 <<
1089 <<
1090 where <version> is the version number of the <<
1091 <<
1092 Next, change to the newly created directory, <<
1093 run the script speakup_setlocale. You are ask <<
1094 use. Type the number associated to your langu <<
1095 Enter. Needed files are copied in the i18n di <<
1096 <<
1097 Note: the speakupconf must be installed on yo <<
1098 Otherwise, you will have an error: your langu <<
1099 have to run the script again every time Speak <<
1100 See section 16.1. for information about speak <<
1101 <<
1102 You will have to repeat these steps for any c <<
1103 change the speakup's language or charset (iso <<
1104 <<
1105 If you wish store the settings, note that at <<
1106 do: <<
1107 <<
1108 speakup load <<
1109 <<
1110 Alternatively, you can add the above line to <<
1111 ~/.bashrc or ~/.bash_profile. <<
1112 <<
1113 If your system administrator himself ran the <<
1114 to change from English to the language chosen <<
1115 speakupconf load (or add this to the ~/.bashr <<
1116 ~/.bash_profile file). If there are several l <<
1117 administrator (or every user) will have to ru <<
1118 save, choosing the appropriate language, in e <<
1119 user will then be able to do speakupconf load <<
1120 1070
1121 14.3. No Support for Non-Western-European La 1071 14.3. No Support for Non-Western-European Languages
1122 1072
1123 As of the current release, Speakup only suppo 1073 As of the current release, Speakup only supports Western European languages.
1124 Support for the extended characters used by l 1074 Support for the extended characters used by languages outside of the Western
1125 European family of languages is a work in pro 1075 European family of languages is a work in progress.
1126 1076
1127 15. Using Speakup's Windowing Capability 1077 15. Using Speakup's Windowing Capability
1128 1078
1129 Speakup has the capability of defining and ma 1079 Speakup has the capability of defining and manipulating windows on the
1130 screen. Speakup uses the term "Window", to m 1080 screen. Speakup uses the term "Window", to mean a user defined area of
1131 the screen. The key strokes for defining and 1081 the screen. The key strokes for defining and manipulating Speakup
1132 windows are as follows: 1082 windows are as follows:
1133 1083
1134 speakup + f2 -- Set the bounds of the window. 1084 speakup + f2 -- Set the bounds of the window.
1135 Speakup + f3 -- clear the current window defi 1085 Speakup + f3 -- clear the current window definition.
1136 speakup + f4 -- Toggle window silence on and 1086 speakup + f4 -- Toggle window silence on and off.
1137 speakup + keypad plus -- Say the currently de 1087 speakup + keypad plus -- Say the currently defined window.
1138 1088
1139 These capabilities are useful for tracking a 1089 These capabilities are useful for tracking a certain part of the screen
1140 without rereading the whole screen, or for si 1090 without rereading the whole screen, or for silencing a part of the
1141 screen that is constantly changing, such as a 1091 screen that is constantly changing, such as a clock or status line.
1142 1092
1143 There is no way to save these window settings 1093 There is no way to save these window settings, and you can only have one
1144 window defined for each virtual console. The 1094 window defined for each virtual console. There is also no way to have
1145 windows automatically defined for specific ap 1095 windows automatically defined for specific applications.
1146 1096
1147 In order to define a window, use the review k 1097 In order to define a window, use the review keys to move your reading
1148 cursor to the beginning of the area you want 1098 cursor to the beginning of the area you want to define. Then press
1149 speakup + f2. Speakup will tell you that the 1099 speakup + f2. Speakup will tell you that the window starts at the
1150 indicated row and column position. Then move 1100 indicated row and column position. Then move the reading cursor to the
1151 end of the area to be defined as a window, an 1101 end of the area to be defined as a window, and press speakup + f2 again.
1152 If there is more than one line in the window 1102 If there is more than one line in the window, Speakup will tell you
1153 that the window ends at the indicated row and 1103 that the window ends at the indicated row and column position. If there
1154 is only one line in the window, then Speakup 1104 is only one line in the window, then Speakup will tell you that the
1155 window is the specified line on the screen. 1105 window is the specified line on the screen. If you are only defining a
1156 one line window, you can just press speakup + 1106 one line window, you can just press speakup + f2 twice after placing the
1157 reading cursor on the line you want to define 1107 reading cursor on the line you want to define as a window. It is not
1158 necessary to position the reading cursor at t 1108 necessary to position the reading cursor at the end of the line in order
1159 to define the whole line as a window. 1109 to define the whole line as a window.
1160 1110
1161 16. Tools for Controlling Speakup 1111 16. Tools for Controlling Speakup
1162 1112
1163 The speakup distribution includes extra tools 1113 The speakup distribution includes extra tools (in the tools directory)
1164 which were written to make speakup easier to 1114 which were written to make speakup easier to use. This section will
1165 briefly describe the use of these tools. 1115 briefly describe the use of these tools.
1166 1116
1167 16.1. Speakupconf 1117 16.1. Speakupconf
1168 1118
1169 speakupconf began life as a contribution from 1119 speakupconf began life as a contribution from Steve Holmes, a member of
1170 the speakup community. We would like to than 1120 the speakup community. We would like to thank him for his work on the
1171 early versions of this project. 1121 early versions of this project.
1172 1122
1173 This script may be installed as part of your 1123 This script may be installed as part of your linux distribution, but if
1174 it isn't, the recommended places to put it ar 1124 it isn't, the recommended places to put it are /usr/local/bin or
1175 /usr/bin. This script can be run by any user 1125 /usr/bin. This script can be run by any user, so it does not require
1176 root privileges. 1126 root privileges.
1177 1127
1178 Speakupconf allows you to save and load your 1128 Speakupconf allows you to save and load your Speakup settings. It works
1179 by reading and writing the /sys files describ 1129 by reading and writing the /sys files described above.
1180 1130
1181 The directory that speakupconf uses to store 1131 The directory that speakupconf uses to store your settings depends on
1182 whether it is run from the root account. If 1132 whether it is run from the root account. If you execute speakupconf as
1183 root, it uses the directory /etc/speakup. Ot 1133 root, it uses the directory /etc/speakup. Otherwise, it uses the directory
1184 ~/.speakup, where ~ is your home directory. 1134 ~/.speakup, where ~ is your home directory.
1185 Anyone who needs to use Speakup from your con 1135 Anyone who needs to use Speakup from your console can load his own custom
1186 settings with this script. 1136 settings with this script.
1187 1137
1188 speakupconf takes one required argument: load 1138 speakupconf takes one required argument: load or save.
1189 Use the command 1139 Use the command
1190 speakupconf save 1140 speakupconf save
1191 to save your Speakup settings, and 1141 to save your Speakup settings, and
1192 speakupconf load 1142 speakupconf load
1193 to load them into Speakup. 1143 to load them into Speakup.
1194 A second argument may be specified to use an 1144 A second argument may be specified to use an alternate directory to
1195 load or save the speakup parameters. 1145 load or save the speakup parameters.
1196 1146
1197 16.2. Talkwith 1147 16.2. Talkwith
1198 1148
1199 Charles Hallenbeck, another member of the spe 1149 Charles Hallenbeck, another member of the speakup community, wrote the
1200 initial versions of this script, and we would 1150 initial versions of this script, and we would also like to thank him for
1201 his work on it. 1151 his work on it.
1202 1152
1203 This script needs root privileges to run, so 1153 This script needs root privileges to run, so if it is not installed as
1204 part of your linux distribution, the recommen 1154 part of your linux distribution, the recommended places to install it
1205 are /usr/local/sbin or /usr/sbin. 1155 are /usr/local/sbin or /usr/sbin.
1206 1156
1207 Talkwith allows you to switch synthesizers on 1157 Talkwith allows you to switch synthesizers on the fly. It takes a synthesizer
1208 name as an argument. For instance, 1158 name as an argument. For instance,
1209 talkwith dectlk 1159 talkwith dectlk
1210 causes Speakup to use the DecTalk Express. I 1160 causes Speakup to use the DecTalk Express. If you wish to switch to a
1211 software synthesizer, you must also indicate 1161 software synthesizer, you must also indicate which daemon you wish to
1212 use. There are two possible choices: 1162 use. There are two possible choices:
1213 spd and espeakup. spd is an abbreviation for 1163 spd and espeakup. spd is an abbreviation for speechd-up.
1214 If you wish to use espeakup for software synt 1164 If you wish to use espeakup for software synthesis, give the command
1215 talkwith soft espeakup 1165 talkwith soft espeakup
1216 To use speechd-up, type: 1166 To use speechd-up, type:
1217 talkwith soft spd 1167 talkwith soft spd
1218 Any arguments that follow the name of the dae 1168 Any arguments that follow the name of the daemon are passed to the daemon
1219 when it is invoked. For instance: 1169 when it is invoked. For instance:
1220 talkwith espeakup --default-voice=fr 1170 talkwith espeakup --default-voice=fr
1221 causes espeakup to use the French voice. 1171 causes espeakup to use the French voice.
1222 Note that talkwith must always be executed wi 1172 Note that talkwith must always be executed with root privileges.
1223 1173
1224 Talkwith does not attempt to load your settin 1174 Talkwith does not attempt to load your settings after the new
1225 synthesizer is activated. You can use speaku 1175 synthesizer is activated. You can use speakupconf to load your settings
1226 if desired. 1176 if desired.
1227 1177
1228 GNU Free Documentation Licens 1178 GNU Free Documentation License
1229 Version 1.2, November 2002 1179 Version 1.2, November 2002
1230 1180
1231 1181
1232 Copyright (C) 2000,2001,2002 Free Software 1182 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc.
1233 Everyone is permitted to copy and distribute 1183 Everyone is permitted to copy and distribute verbatim copies
1234 of this license document, but changing it is 1184 of this license document, but changing it is not allowed.
1235 1185
1236 1186
1237 0. PREAMBLE 1187 0. PREAMBLE
1238 1188
1239 The purpose of this License is to make a manu 1189 The purpose of this License is to make a manual, textbook, or other
1240 functional and useful document "free" in the 1190 functional and useful document "free" in the sense of freedom: to
1241 assure everyone the effective freedom to copy 1191 assure everyone the effective freedom to copy and redistribute it,
1242 with or without modifying it, either commerci 1192 with or without modifying it, either commercially or noncommercially.
1243 Secondarily, this License preserves for the a 1193 Secondarily, this License preserves for the author and publisher a way
1244 to get credit for their work, while not being 1194 to get credit for their work, while not being considered responsible
1245 for modifications made by others. 1195 for modifications made by others.
1246 1196
1247 This License is a kind of "copyleft", which m 1197 This License is a kind of "copyleft", which means that derivative
1248 works of the document must themselves be free 1198 works of the document must themselves be free in the same sense. It
1249 complements the GNU General Public License, w 1199 complements the GNU General Public License, which is a copyleft
1250 license designed for free software. 1200 license designed for free software.
1251 1201
1252 We have designed this License in order to use 1202 We have designed this License in order to use it for manuals for free
1253 software, because free software needs free do 1203 software, because free software needs free documentation: a free
1254 program should come with manuals providing th 1204 program should come with manuals providing the same freedoms that the
1255 software does. But this License is not limit 1205 software does. But this License is not limited to software manuals;
1256 it can be used for any textual work, regardle 1206 it can be used for any textual work, regardless of subject matter or
1257 whether it is published as a printed book. W 1207 whether it is published as a printed book. We recommend this License
1258 principally for works whose purpose is instru 1208 principally for works whose purpose is instruction or reference.
1259 1209
1260 1210
1261 1. APPLICABILITY AND DEFINITIONS 1211 1. APPLICABILITY AND DEFINITIONS
1262 1212
1263 This License applies to any manual or other w 1213 This License applies to any manual or other work, in any medium, that
1264 contains a notice placed by the copyright hol 1214 contains a notice placed by the copyright holder saying it can be
1265 distributed under the terms of this License. 1215 distributed under the terms of this License. Such a notice grants a
1266 world-wide, royalty-free license, unlimited i 1216 world-wide, royalty-free license, unlimited in duration, to use that
1267 work under the conditions stated herein. The 1217 work under the conditions stated herein. The "Document", below,
1268 refers to any such manual or work. Any membe 1218 refers to any such manual or work. Any member of the public is a
1269 licensee, and is addressed as "you". You acc 1219 licensee, and is addressed as "you". You accept the license if you
1270 copy, modify or distribute the work in a way 1220 copy, modify or distribute the work in a way requiring permission
1271 under copyright law. 1221 under copyright law.
1272 1222
1273 A "Modified Version" of the Document means an 1223 A "Modified Version" of the Document means any work containing the
1274 Document or a portion of it, either copied ve 1224 Document or a portion of it, either copied verbatim, or with
1275 modifications and/or translated into another 1225 modifications and/or translated into another language.
1276 1226
1277 A "Secondary Section" is a named appendix or 1227 A "Secondary Section" is a named appendix or a front-matter section of
1278 the Document that deals exclusively with the 1228 the Document that deals exclusively with the relationship of the
1279 publishers or authors of the Document to the 1229 publishers or authors of the Document to the Document's overall subject
1280 (or to related matters) and contains nothing 1230 (or to related matters) and contains nothing that could fall directly
1281 within that overall subject. (Thus, if the D 1231 within that overall subject. (Thus, if the Document is in part a
1282 textbook of mathematics, a Secondary Section 1232 textbook of mathematics, a Secondary Section may not explain any
1283 mathematics.) The relationship could be a ma 1233 mathematics.) The relationship could be a matter of historical
1284 connection with the subject or with related m 1234 connection with the subject or with related matters, or of legal,
1285 commercial, philosophical, ethical or politic 1235 commercial, philosophical, ethical or political position regarding
1286 them. 1236 them.
1287 1237
1288 The "Invariant Sections" are certain Secondar 1238 The "Invariant Sections" are certain Secondary Sections whose titles
1289 are designated, as being those of Invariant S 1239 are designated, as being those of Invariant Sections, in the notice
1290 that says that the Document is released under 1240 that says that the Document is released under this License. If a
1291 section does not fit the above definition of 1241 section does not fit the above definition of Secondary then it is not
1292 allowed to be designated as Invariant. The D 1242 allowed to be designated as Invariant. The Document may contain zero
1293 Invariant Sections. If the Document does not 1243 Invariant Sections. If the Document does not identify any Invariant
1294 Sections then there are none. 1244 Sections then there are none.
1295 1245
1296 The "Cover Texts" are certain short passages 1246 The "Cover Texts" are certain short passages of text that are listed,
1297 as Front-Cover Texts or Back-Cover Texts, in 1247 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
1298 the Document is released under this License. 1248 the Document is released under this License. A Front-Cover Text may
1299 be at most 5 words, and a Back-Cover Text may 1249 be at most 5 words, and a Back-Cover Text may be at most 25 words.
1300 1250
1301 A "Transparent" copy of the Document means a 1251 A "Transparent" copy of the Document means a machine-readable copy,
1302 represented in a format whose specification i 1252 represented in a format whose specification is available to the
1303 general public, that is suitable for revising 1253 general public, that is suitable for revising the document
1304 straightforwardly with generic text editors o 1254 straightforwardly with generic text editors or (for images composed of
1305 pixels) generic paint programs or (for drawin 1255 pixels) generic paint programs or (for drawings) some widely available
1306 drawing editor, and that is suitable for inpu 1256 drawing editor, and that is suitable for input to text formatters or
1307 for automatic translation to a variety of for 1257 for automatic translation to a variety of formats suitable for input
1308 to text formatters. A copy made in an otherw 1258 to text formatters. A copy made in an otherwise Transparent file
1309 format whose markup, or absence of markup, ha 1259 format whose markup, or absence of markup, has been arranged to thwart
1310 or discourage subsequent modification by read 1260 or discourage subsequent modification by readers is not Transparent.
1311 An image format is not Transparent if used fo 1261 An image format is not Transparent if used for any substantial amount
1312 of text. A copy that is not "Transparent" is 1262 of text. A copy that is not "Transparent" is called "Opaque".
1313 1263
1314 Examples of suitable formats for Transparent 1264 Examples of suitable formats for Transparent copies include plain
1315 ASCII without markup, Texinfo input format, L 1265 ASCII without markup, Texinfo input format, LaTeX input format, SGML
1316 or XML using a publicly available DTD, and st 1266 or XML using a publicly available DTD, and standard-conforming simple
1317 HTML, PostScript or PDF designed for human mo 1267 HTML, PostScript or PDF designed for human modification. Examples of
1318 transparent image formats include PNG, XCF an 1268 transparent image formats include PNG, XCF and JPG. Opaque formats
1319 include proprietary formats that can be read 1269 include proprietary formats that can be read and edited only by
1320 proprietary word processors, SGML or XML for 1270 proprietary word processors, SGML or XML for which the DTD and/or
1321 processing tools are not generally available, 1271 processing tools are not generally available, and the
1322 machine-generated HTML, PostScript or PDF pro 1272 machine-generated HTML, PostScript or PDF produced by some word
1323 processors for output purposes only. 1273 processors for output purposes only.
1324 1274
1325 The "Title Page" means, for a printed book, t 1275 The "Title Page" means, for a printed book, the title page itself,
1326 plus such following pages as are needed to ho 1276 plus such following pages as are needed to hold, legibly, the material
1327 this License requires to appear in the title 1277 this License requires to appear in the title page. For works in
1328 formats which do not have any title page as s 1278 formats which do not have any title page as such, "Title Page" means
1329 the text near the most prominent appearance o 1279 the text near the most prominent appearance of the work's title,
1330 preceding the beginning of the body of the te 1280 preceding the beginning of the body of the text.
1331 1281
1332 A section "Entitled XYZ" means a named subuni 1282 A section "Entitled XYZ" means a named subunit of the Document whose
1333 title either is precisely XYZ or contains XYZ 1283 title either is precisely XYZ or contains XYZ in parentheses following
1334 text that translates XYZ in another language. 1284 text that translates XYZ in another language. (Here XYZ stands for a
1335 specific section name mentioned below, such a 1285 specific section name mentioned below, such as "Acknowledgements",
1336 "Dedications", "Endorsements", or "History".) 1286 "Dedications", "Endorsements", or "History".) To "Preserve the Title"
1337 of such a section when you modify the Documen 1287 of such a section when you modify the Document means that it remains a
1338 section "Entitled XYZ" according to this defi 1288 section "Entitled XYZ" according to this definition.
1339 1289
1340 The Document may include Warranty Disclaimers 1290 The Document may include Warranty Disclaimers next to the notice which
1341 states that this License applies to the Docum 1291 states that this License applies to the Document. These Warranty
1342 Disclaimers are considered to be included by 1292 Disclaimers are considered to be included by reference in this
1343 License, but only as regards disclaiming warr 1293 License, but only as regards disclaiming warranties: any other
1344 implication that these Warranty Disclaimers m 1294 implication that these Warranty Disclaimers may have is void and has
1345 no effect on the meaning of this License. 1295 no effect on the meaning of this License.
1346 1296
1347 1297
1348 2. VERBATIM COPYING 1298 2. VERBATIM COPYING
1349 1299
1350 You may copy and distribute the Document in a 1300 You may copy and distribute the Document in any medium, either
1351 commercially or noncommercially, provided tha 1301 commercially or noncommercially, provided that this License, the
1352 copyright notices, and the license notice say 1302 copyright notices, and the license notice saying this License applies
1353 to the Document are reproduced in all copies, 1303 to the Document are reproduced in all copies, and that you add no other
1354 conditions whatsoever to those of this Licens 1304 conditions whatsoever to those of this License. You may not use
1355 technical measures to obstruct or control the 1305 technical measures to obstruct or control the reading or further
1356 copying of the copies you make or distribute. 1306 copying of the copies you make or distribute. However, you may accept
1357 compensation in exchange for copies. If you 1307 compensation in exchange for copies. If you distribute a large enough
1358 number of copies you must also follow the con 1308 number of copies you must also follow the conditions in section 3.
1359 1309
1360 You may also lend copies, under the same cond 1310 You may also lend copies, under the same conditions stated above, and
1361 you may publicly display copies. 1311 you may publicly display copies.
1362 1312
1363 1313
1364 3. COPYING IN QUANTITY 1314 3. COPYING IN QUANTITY
1365 1315
1366 If you publish printed copies (or copies in m 1316 If you publish printed copies (or copies in media that commonly have
1367 printed covers) of the Document, numbering mo 1317 printed covers) of the Document, numbering more than 100, and the
1368 Document's license notice requires Cover Text 1318 Document's license notice requires Cover Texts, you must enclose the
1369 copies in covers that carry, clearly and legi 1319 copies in covers that carry, clearly and legibly, all these Cover
1370 Texts: Front-Cover Texts on the front cover, 1320 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
1371 the back cover. Both covers must also clearl 1321 the back cover. Both covers must also clearly and legibly identify
1372 you as the publisher of these copies. The fr 1322 you as the publisher of these copies. The front cover must present
1373 the full title with all words of the title eq 1323 the full title with all words of the title equally prominent and
1374 visible. You may add other material on the c 1324 visible. You may add other material on the covers in addition.
1375 Copying with changes limited to the covers, a 1325 Copying with changes limited to the covers, as long as they preserve
1376 the title of the Document and satisfy these c 1326 the title of the Document and satisfy these conditions, can be treated
1377 as verbatim copying in other respects. 1327 as verbatim copying in other respects.
1378 1328
1379 If the required texts for either cover are to 1329 If the required texts for either cover are too voluminous to fit
1380 legibly, you should put the first ones listed 1330 legibly, you should put the first ones listed (as many as fit
1381 reasonably) on the actual cover, and continue 1331 reasonably) on the actual cover, and continue the rest onto adjacent
1382 pages. 1332 pages.
1383 1333
1384 If you publish or distribute Opaque copies of 1334 If you publish or distribute Opaque copies of the Document numbering
1385 more than 100, you must either include a mach 1335 more than 100, you must either include a machine-readable Transparent
1386 copy along with each Opaque copy, or state in 1336 copy along with each Opaque copy, or state in or with each Opaque copy
1387 a computer-network location from which the ge 1337 a computer-network location from which the general network-using
1388 public has access to download using public-st 1338 public has access to download using public-standard network protocols
1389 a complete Transparent copy of the Document, 1339 a complete Transparent copy of the Document, free of added material.
1390 If you use the latter option, you must take r 1340 If you use the latter option, you must take reasonably prudent steps,
1391 when you begin distribution of Opaque copies 1341 when you begin distribution of Opaque copies in quantity, to ensure
1392 that this Transparent copy will remain thus a 1342 that this Transparent copy will remain thus accessible at the stated
1393 location until at least one year after the la 1343 location until at least one year after the last time you distribute an
1394 Opaque copy (directly or through your agents 1344 Opaque copy (directly or through your agents or retailers) of that
1395 edition to the public. 1345 edition to the public.
1396 1346
1397 It is requested, but not required, that you c 1347 It is requested, but not required, that you contact the authors of the
1398 Document well before redistributing any large 1348 Document well before redistributing any large number of copies, to give
1399 them a chance to provide you with an updated 1349 them a chance to provide you with an updated version of the Document.
1400 1350
1401 1351
1402 4. MODIFICATIONS 1352 4. MODIFICATIONS
1403 1353
1404 You may copy and distribute a Modified Versio 1354 You may copy and distribute a Modified Version of the Document under
1405 the conditions of sections 2 and 3 above, pro 1355 the conditions of sections 2 and 3 above, provided that you release
1406 the Modified Version under precisely this Lic 1356 the Modified Version under precisely this License, with the Modified
1407 Version filling the role of the Document, thu 1357 Version filling the role of the Document, thus licensing distribution
1408 and modification of the Modified Version to w 1358 and modification of the Modified Version to whoever possesses a copy
1409 of it. In addition, you must do these things 1359 of it. In addition, you must do these things in the Modified Version:
1410 1360
1411 A. Use in the Title Page (and on the covers, 1361 A. Use in the Title Page (and on the covers, if any) a title distinct
1412 from that of the Document, and from those 1362 from that of the Document, and from those of previous versions
1413 (which should, if there were any, be liste 1363 (which should, if there were any, be listed in the History section
1414 of the Document). You may use the same ti 1364 of the Document). You may use the same title as a previous version
1415 if the original publisher of that version 1365 if the original publisher of that version gives permission.
1416 B. List on the Title Page, as authors, one or 1366 B. List on the Title Page, as authors, one or more persons or entities
1417 responsible for authorship of the modifica 1367 responsible for authorship of the modifications in the Modified
1418 Version, together with at least five of th 1368 Version, together with at least five of the principal authors of the
1419 Document (all of its principal authors, if 1369 Document (all of its principal authors, if it has fewer than five),
1420 unless they release you from this requirem 1370 unless they release you from this requirement.
1421 C. State on the Title page the name of the pu 1371 C. State on the Title page the name of the publisher of the
1422 Modified Version, as the publisher. 1372 Modified Version, as the publisher.
1423 D. Preserve all the copyright notices of the 1373 D. Preserve all the copyright notices of the Document.
1424 E. Add an appropriate copyright notice for yo 1374 E. Add an appropriate copyright notice for your modifications
1425 adjacent to the other copyright notices. 1375 adjacent to the other copyright notices.
1426 F. Include, immediately after the copyright n 1376 F. Include, immediately after the copyright notices, a license notice
1427 giving the public permission to use the Mo 1377 giving the public permission to use the Modified Version under the
1428 terms of this License, in the form shown i 1378 terms of this License, in the form shown in the Addendum below.
1429 G. Preserve in that license notice the full l 1379 G. Preserve in that license notice the full lists of Invariant Sections
1430 and required Cover Texts given in the Docu 1380 and required Cover Texts given in the Document's license notice.
1431 H. Include an unaltered copy of this License. 1381 H. Include an unaltered copy of this License.
1432 I. Preserve the section Entitled "History", P 1382 I. Preserve the section Entitled "History", Preserve its Title, and add
1433 to it an item stating at least the title, 1383 to it an item stating at least the title, year, new authors, and
1434 publisher of the Modified Version as given 1384 publisher of the Modified Version as given on the Title Page. If
1435 there is no section Entitled "History" in 1385 there is no section Entitled "History" in the Document, create one
1436 stating the title, year, authors, and publ 1386 stating the title, year, authors, and publisher of the Document as
1437 given on its Title Page, then add an item 1387 given on its Title Page, then add an item describing the Modified
1438 Version as stated in the previous sentence 1388 Version as stated in the previous sentence.
1439 J. Preserve the network location, if any, giv 1389 J. Preserve the network location, if any, given in the Document for
1440 public access to a Transparent copy of the 1390 public access to a Transparent copy of the Document, and likewise
1441 the network locations given in the Documen 1391 the network locations given in the Document for previous versions
1442 it was based on. These may be placed in t 1392 it was based on. These may be placed in the "History" section.
1443 You may omit a network location for a work 1393 You may omit a network location for a work that was published at
1444 least four years before the Document itsel 1394 least four years before the Document itself, or if the original
1445 publisher of the version it refers to give 1395 publisher of the version it refers to gives permission.
1446 K. For any section Entitled "Acknowledgements 1396 K. For any section Entitled "Acknowledgements" or "Dedications",
1447 Preserve the Title of the section, and pre 1397 Preserve the Title of the section, and preserve in the section all
1448 the substance and tone of each of the cont 1398 the substance and tone of each of the contributor acknowledgements
1449 and/or dedications given therein. 1399 and/or dedications given therein.
1450 L. Preserve all the Invariant Sections of the 1400 L. Preserve all the Invariant Sections of the Document,
1451 unaltered in their text and in their title 1401 unaltered in their text and in their titles. Section numbers
1452 or the equivalent are not considered part 1402 or the equivalent are not considered part of the section titles.
1453 M. Delete any section Entitled "Endorsements" 1403 M. Delete any section Entitled "Endorsements". Such a section
1454 may not be included in the Modified Versio 1404 may not be included in the Modified Version.
1455 N. Do not retitle any existing section to be 1405 N. Do not retitle any existing section to be Entitled "Endorsements"
1456 or to conflict in title with any Invariant 1406 or to conflict in title with any Invariant Section.
1457 O. Preserve any Warranty Disclaimers. 1407 O. Preserve any Warranty Disclaimers.
1458 1408
1459 If the Modified Version includes new front-ma 1409 If the Modified Version includes new front-matter sections or
1460 appendices that qualify as Secondary Sections 1410 appendices that qualify as Secondary Sections and contain no material
1461 copied from the Document, you may at your opt 1411 copied from the Document, you may at your option designate some or all
1462 of these sections as invariant. To do this, 1412 of these sections as invariant. To do this, add their titles to the
1463 list of Invariant Sections in the Modified Ve 1413 list of Invariant Sections in the Modified Version's license notice.
1464 These titles must be distinct from any other 1414 These titles must be distinct from any other section titles.
1465 1415
1466 You may add a section Entitled "Endorsements" 1416 You may add a section Entitled "Endorsements", provided it contains
1467 nothing but endorsements of your Modified Ver 1417 nothing but endorsements of your Modified Version by various
1468 parties--for example, statements of peer revi 1418 parties--for example, statements of peer review or that the text has
1469 been approved by an organization as the autho 1419 been approved by an organization as the authoritative definition of a
1470 standard. 1420 standard.
1471 1421
1472 You may add a passage of up to five words as 1422 You may add a passage of up to five words as a Front-Cover Text, and a
1473 passage of up to 25 words as a Back-Cover Tex 1423 passage of up to 25 words as a Back-Cover Text, to the end of the list
1474 of Cover Texts in the Modified Version. Only 1424 of Cover Texts in the Modified Version. Only one passage of
1475 Front-Cover Text and one of Back-Cover Text m 1425 Front-Cover Text and one of Back-Cover Text may be added by (or
1476 through arrangements made by) any one entity. 1426 through arrangements made by) any one entity. If the Document already
1477 includes a cover text for the same cover, pre 1427 includes a cover text for the same cover, previously added by you or
1478 by arrangement made by the same entity you ar 1428 by arrangement made by the same entity you are acting on behalf of,
1479 you may not add another; but you may replace 1429 you may not add another; but you may replace the old one, on explicit
1480 permission from the previous publisher that a 1430 permission from the previous publisher that added the old one.
1481 1431
1482 The author(s) and publisher(s) of the Documen 1432 The author(s) and publisher(s) of the Document do not by this License
1483 give permission to use their names for public 1433 give permission to use their names for publicity for or to assert or
1484 imply endorsement of any Modified Version. 1434 imply endorsement of any Modified Version.
1485 1435
1486 1436
1487 5. COMBINING DOCUMENTS 1437 5. COMBINING DOCUMENTS
1488 1438
1489 You may combine the Document with other docum 1439 You may combine the Document with other documents released under this
1490 License, under the terms defined in section 4 1440 License, under the terms defined in section 4 above for modified
1491 versions, provided that you include in the co 1441 versions, provided that you include in the combination all of the
1492 Invariant Sections of all of the original doc 1442 Invariant Sections of all of the original documents, unmodified, and
1493 list them all as Invariant Sections of your c 1443 list them all as Invariant Sections of your combined work in its
1494 license notice, and that you preserve all the 1444 license notice, and that you preserve all their Warranty Disclaimers.
1495 1445
1496 The combined work need only contain one copy 1446 The combined work need only contain one copy of this License, and
1497 multiple identical Invariant Sections may be 1447 multiple identical Invariant Sections may be replaced with a single
1498 copy. If there are multiple Invariant Sectio 1448 copy. If there are multiple Invariant Sections with the same name but
1499 different contents, make the title of each su 1449 different contents, make the title of each such section unique by
1500 adding at the end of it, in parentheses, the 1450 adding at the end of it, in parentheses, the name of the original
1501 author or publisher of that section if known, 1451 author or publisher of that section if known, or else a unique number.
1502 Make the same adjustment to the section title 1452 Make the same adjustment to the section titles in the list of
1503 Invariant Sections in the license notice of t 1453 Invariant Sections in the license notice of the combined work.
1504 1454
1505 In the combination, you must combine any sect 1455 In the combination, you must combine any sections Entitled "History"
1506 in the various original documents, forming on 1456 in the various original documents, forming one section Entitled
1507 "History"; likewise combine any sections Enti 1457 "History"; likewise combine any sections Entitled "Acknowledgements",
1508 and any sections Entitled "Dedications". You 1458 and any sections Entitled "Dedications". You must delete all sections
1509 Entitled "Endorsements". 1459 Entitled "Endorsements".
1510 1460
1511 1461
1512 6. COLLECTIONS OF DOCUMENTS 1462 6. COLLECTIONS OF DOCUMENTS
1513 1463
1514 You may make a collection consisting of the D 1464 You may make a collection consisting of the Document and other documents
1515 released under this License, and replace the 1465 released under this License, and replace the individual copies of this
1516 License in the various documents with a singl 1466 License in the various documents with a single copy that is included in
1517 the collection, provided that you follow the 1467 the collection, provided that you follow the rules of this License for
1518 verbatim copying of each of the documents in 1468 verbatim copying of each of the documents in all other respects.
1519 1469
1520 You may extract a single document from such a 1470 You may extract a single document from such a collection, and distribute
1521 it individually under this License, provided 1471 it individually under this License, provided you insert a copy of this
1522 License into the extracted document, and foll 1472 License into the extracted document, and follow this License in all
1523 other respects regarding verbatim copying of 1473 other respects regarding verbatim copying of that document.
1524 1474
1525 1475
1526 7. AGGREGATION WITH INDEPENDENT WORKS 1476 7. AGGREGATION WITH INDEPENDENT WORKS
1527 1477
1528 A compilation of the Document or its derivati 1478 A compilation of the Document or its derivatives with other separate
1529 and independent documents or works, in or on 1479 and independent documents or works, in or on a volume of a storage or
1530 distribution medium, is called an "aggregate" 1480 distribution medium, is called an "aggregate" if the copyright
1531 resulting from the compilation is not used to 1481 resulting from the compilation is not used to limit the legal rights
1532 of the compilation's users beyond what the in 1482 of the compilation's users beyond what the individual works permit.
1533 When the Document is included in an aggregate 1483 When the Document is included in an aggregate, this License does not
1534 apply to the other works in the aggregate whi 1484 apply to the other works in the aggregate which are not themselves
1535 derivative works of the Document. 1485 derivative works of the Document.
1536 1486
1537 If the Cover Text requirement of section 3 is 1487 If the Cover Text requirement of section 3 is applicable to these
1538 copies of the Document, then if the Document 1488 copies of the Document, then if the Document is less than one half of
1539 the entire aggregate, the Document's Cover Te 1489 the entire aggregate, the Document's Cover Texts may be placed on
1540 covers that bracket the Document within the a 1490 covers that bracket the Document within the aggregate, or the
1541 electronic equivalent of covers if the Docume 1491 electronic equivalent of covers if the Document is in electronic form.
1542 Otherwise they must appear on printed covers 1492 Otherwise they must appear on printed covers that bracket the whole
1543 aggregate. 1493 aggregate.
1544 1494
1545 1495
1546 8. TRANSLATION 1496 8. TRANSLATION
1547 1497
1548 Translation is considered a kind of modificat 1498 Translation is considered a kind of modification, so you may
1549 distribute translations of the Document under 1499 distribute translations of the Document under the terms of section 4.
1550 Replacing Invariant Sections with translation 1500 Replacing Invariant Sections with translations requires special
1551 permission from their copyright holders, but 1501 permission from their copyright holders, but you may include
1552 translations of some or all Invariant Section 1502 translations of some or all Invariant Sections in addition to the
1553 original versions of these Invariant Sections 1503 original versions of these Invariant Sections. You may include a
1554 translation of this License, and all the lice 1504 translation of this License, and all the license notices in the
1555 Document, and any Warranty Disclaimers, provi 1505 Document, and any Warranty Disclaimers, provided that you also include
1556 the original English version of this License 1506 the original English version of this License and the original versions
1557 of those notices and disclaimers. In case of 1507 of those notices and disclaimers. In case of a disagreement between
1558 the translation and the original version of t 1508 the translation and the original version of this License or a notice
1559 or disclaimer, the original version will prev 1509 or disclaimer, the original version will prevail.
1560 1510
1561 If a section in the Document is Entitled "Ack 1511 If a section in the Document is Entitled "Acknowledgements",
1562 "Dedications", or "History", the requirement 1512 "Dedications", or "History", the requirement (section 4) to Preserve
1563 its Title (section 1) will typically require 1513 its Title (section 1) will typically require changing the actual
1564 title. 1514 title.
1565 1515
1566 1516
1567 9. TERMINATION 1517 9. TERMINATION
1568 1518
1569 You may not copy, modify, sublicense, or dist 1519 You may not copy, modify, sublicense, or distribute the Document except
1570 as expressly provided for under this License. 1520 as expressly provided for under this License. Any other attempt to
1571 copy, modify, sublicense or distribute the Do 1521 copy, modify, sublicense or distribute the Document is void, and will
1572 automatically terminate your rights under thi 1522 automatically terminate your rights under this License. However,
1573 parties who have received copies, or rights, 1523 parties who have received copies, or rights, from you under this
1574 License will not have their licenses terminat 1524 License will not have their licenses terminated so long as such
1575 parties remain in full compliance. 1525 parties remain in full compliance.
1576 1526
1577 1527
1578 10. FUTURE REVISIONS OF THIS LICENSE 1528 10. FUTURE REVISIONS OF THIS LICENSE
1579 1529
1580 The Free Software Foundation may publish new, 1530 The Free Software Foundation may publish new, revised versions
1581 of the GNU Free Documentation License from ti 1531 of the GNU Free Documentation License from time to time. Such new
1582 versions will be similar in spirit to the pre 1532 versions will be similar in spirit to the present version, but may
1583 differ in detail to address new problems or c 1533 differ in detail to address new problems or concerns. See
1584 https://www.gnu.org/copyleft/. 1534 https://www.gnu.org/copyleft/.
1585 1535
1586 Each version of the License is given a distin 1536 Each version of the License is given a distinguishing version number.
1587 If the Document specifies that a particular n 1537 If the Document specifies that a particular numbered version of this
1588 License "or any later version" applies to it, 1538 License "or any later version" applies to it, you have the option of
1589 following the terms and conditions either of 1539 following the terms and conditions either of that specified version or
1590 of any later version that has been published 1540 of any later version that has been published (not as a draft) by the
1591 Free Software Foundation. If the Document do 1541 Free Software Foundation. If the Document does not specify a version
1592 number of this License, you may choose any ve 1542 number of this License, you may choose any version ever published (not
1593 as a draft) by the Free Software Foundation. 1543 as a draft) by the Free Software Foundation.
1594 1544
1595 1545
1596 ADDENDUM: How to use this License for your do 1546 ADDENDUM: How to use this License for your documents
1597 1547
1598 To use this License in a document you have wr 1548 To use this License in a document you have written, include a copy of
1599 the License in the document and put the follo 1549 the License in the document and put the following copyright and
1600 license notices just after the title page: 1550 license notices just after the title page:
1601 1551
1602 Copyright (c) YEAR YOUR NAME. 1552 Copyright (c) YEAR YOUR NAME.
1603 Permission is granted to copy, distribute 1553 Permission is granted to copy, distribute and/or modify this document
1604 under the terms of the GNU Free Documenta 1554 under the terms of the GNU Free Documentation License, Version 1.2
1605 or any later version published by the Fre 1555 or any later version published by the Free Software Foundation;
1606 with no Invariant Sections, no Front-Cove 1556 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts.
1607 A copy of the license is included in the 1557 A copy of the license is included in the section entitled "GNU
1608 Free Documentation License". 1558 Free Documentation License".
1609 1559
1610 If you have Invariant Sections, Front-Cover T 1560 If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts,
1611 replace the "with...Texts." line with this: 1561 replace the "with...Texts." line with this:
1612 1562
1613 with the Invariant Sections being LIST TH 1563 with the Invariant Sections being LIST THEIR TITLES, with the
1614 Front-Cover Texts being LIST, and with th 1564 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
1615 1565
1616 If you have Invariant Sections without Cover 1566 If you have Invariant Sections without Cover Texts, or some other
1617 combination of the three, merge those two alt 1567 combination of the three, merge those two alternatives to suit the
1618 situation. 1568 situation.
1619 1569
1620 If your document contains nontrivial examples 1570 If your document contains nontrivial examples of program code, we
1621 recommend releasing these examples in paralle 1571 recommend releasing these examples in parallel under your choice of
1622 free software license, such as the GNU Genera 1572 free software license, such as the GNU General Public License,
1623 to permit their use in free software. 1573 to permit their use in free software.
1624 1574
1625 The End. 1575 The End.
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.