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