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