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 347spk key_r = read_all_doc 348 3495. The Speakup Sys System 350 351The Speakup screen reader also creates a speakup subdirectory as a part 352of the sys system. 353 354As a convenience, run as root 355 356ln -s /sys/accessibility/speakup /speakup 357 358to directly access speakup parameters from /speakup. 359You can see these entries by typing the command: 360 361ls -1 /speakup/* 362 363If you issue the above ls command, you will get back something like 364this: 365 366/speakup/attrib_bleep 367/speakup/bell_pos 368/speakup/bleep_time 369/speakup/bleeps 370/speakup/cursor_time 371/speakup/delimiters 372/speakup/ex_num 373/speakup/key_echo 374/speakup/keymap 375/speakup/no_interrupt 376/speakup/punc_all 377/speakup/punc_level 378/speakup/punc_most 379/speakup/punc_some 380/speakup/reading_punc 381/speakup/repeats 382/speakup/say_control 383/speakup/say_word_ctl 384/speakup/silent 385/speakup/spell_delay 386/speakup/synth 387/speakup/synth_direct 388/speakup/version 389 390/speakup/i18n: 391announcements 392characters 393chartab 394colors 395ctl_keys 396formatted 397function_names 398key_names 399states 400 401/speakup/soft: 402caps_start 403caps_stop 404delay_time 405direct 406freq 407full_time 408jiffy_delta 409pitch 410inflection 411punct 412rate 413tone 414trigger_time 415voice 416vol 417 418Notice the two subdirectories of /speakup: /speakup/i18n and 419/speakup/soft. 420The i18n subdirectory is described in a later section. 421The files under /speakup/soft represent settings that are specific to the 422driver for the software synthesizer. If you use the LiteTalk, your 423synthesizer-specific settings would be found in /speakup/ltlk. In other words, 424a subdirectory named /speakup/KWD is created to hold parameters specific 425to the device whose keyword is KWD. 426These parameters include volume, rate, pitch, and others. 427 428In addition to using the Speakup hot keys to change such things as 429volume, pitch, and rate, you can also echo values to the appropriate 430entry in the /speakup directory. This is very useful, since it 431lets you control Speakup parameters from within a script. How you 432would write such scripts is somewhat beyond the scope of this manual, 433but I will include a couple of simple examples here to give you a 434general idea of what such scripts can do. 435 436Suppose for example, that you wanted to control both the punctuation 437level and the reading punctuation level at the same time. For 438simplicity, we'll call them punc0, punc1, punc2, and punc3. The scripts 439might look something like this: 440 441#!/bin/bash 442# punc0 443# set punc and reading punc levels to 0 444echo 0 >/speakup/punc_level 445echo 0 >/speakup/reading_punc 446echo Punctuation level set to 0. 447 448#!/bin/bash 449# punc1 450# set punc and reading punc levels to 1 451echo 1 >/speakup/punc_level 452echo 1 >/speakup/reading_punc 453echo Punctuation level set to 1. 454 455#!/bin/bash 456# punc2 457# set punc and reading punc levels to 2 458echo 2 >/speakup/punc_level 459echo 2 >/speakup/reading_punc 460echo Punctuation level set to 2. 461 462#!/bin/bash 463# punc3 464# set punc and reading punc levels to 3 465echo 3 >/speakup/punc_level 466echo 3 >/speakup/reading_punc 467echo Punctuation level set to 3. 468 469If you were to store these four small scripts in a directory in your 470path, perhaps /usr/local/bin, and set the permissions to 755 with the 471chmod command, then you could change the default reading punc and 472punctuation levels at the same time by issuing just one command. For 473example, if you were to execute the punc3 command at your shell prompt, 474then the reading punc and punc level would both get set to 3. 475 476I should note that the above scripts were written to work with bash, but 477regardless of which shell you use, you should be able to do something 478similar. 479 480The Speakup sys system also has another interesting use. You can echo 481Speakup parameters into the sys system in a script during system 482startup, and speakup will return to your preferred parameters every time 483the system is rebooted. 484 485Most of the Speakup sys parameters can be manipulated by a regular user 486on the system. However, there are a few parameters that are dangerous 487enough that they should only be manipulated by the root user on your 488system. There are even some parameters that are read only, and cannot 489be written to at all. For example, the version entry in the Speakup 490sys system is read only. This is because there is no reason for a user 491to tamper with the version number which is reported by Speakup. Doing 492an ls -l on /speakup/version will return this: 493 494-r--r--r-- 1 root root 0 Mar 21 13:46 /speakup/version 495 496As you can see, the version entry in the Speakup sys system is read 497only, is owned by root, and belongs to the root group. Doing a cat of 498/speakup/version will display the Speakup version number, like 499this: 500 501cat /speakup/version 502Speakup v-2.00 CVS: Thu Oct 21 10:38:21 EDT 2004 503synth dtlk version 1.1 504 505The display shows the Speakup version number, along with the version 506number of the driver for the current synthesizer. 507 508Looking at entries in the Speakup sys system can be useful in many 509ways. For example, you might wish to know what level your volume is set 510at. You could type: 511 512cat /speakup/KWD/vol 513# Replace KWD with the keyword for your synthesizer, E.G., ltlk for LiteTalk. 5145 515 516The number five which comes back is the level at which the synthesizer 517volume is set at. 518 519All the entries in the Speakup sys system are readable, some are 520writable by root only, and some are writable by everyone. Unless you 521know what you are doing, you should probably leave the ones that are 522writable by root only alone. Most of the names are self explanatory. 523Vol for controlling volume, pitch for pitch, inflection for pitch range, rate 524for controlling speaking rate, etc. If you find one you aren't sure about, you 525can post a query on the Speakup list. 526 5276. Changing Synthesizers 528 529It is possible to change to a different synthesizer while speakup is 530running. In other words, it is not necessary to reboot the system 531in order to use a different synthesizer. You can simply echo the 532synthesizer keyword to the /speakup/synth sys entry. 533Depending on your situation, you may wish to echo none to the synth 534sys entry, to disable speech while one synthesizer is disconnected and 535a second one is connected in its place. Then echo the keyword for the 536new synthesizer into the synth sys entry in order to start speech 537with the newly connected synthesizer. See the list of synthesizer 538keywords in section 1 to find the keyword which matches your synth. 539 5407. Loading modules 541 542As mentioned earlier, Speakup can either be completely compiled into the 543kernel, with the exception of the help module, or it can be compiled as 544a series of modules. When compiled as modules, Speakup will only be 545able to speak some of the bootup messages if your system administrator 546has configured the system to load the modules at boot time. The modules 547can be loaded after the file systems have been checked and mounted, or 548from an initrd. There is a third possibility. Speakup can be compiled 549with some components built into the kernel, and others as modules. As 550we'll see in the next section, this is particularly useful when you are 551working with software synthesizers. 552 553If Speakup is completely compiled as modules, then you must use the 554modprobe command to load Speakup. You do this by loading the module for 555the synthesizer driver you wish to use. The driver modules are all 556named speakup_<keyword>, where <keyword> is the keyword for the 557synthesizer you want. So, in order to load the driver for the DecTalk 558Express, you would type the following command: 559 560modprobe speakup_dectlk 561 562Issuing this command would load the DecTalk Express driver and all other 563related Speakup modules necessary to get Speakup up and running. 564 565To completely unload Speakup, again presuming that it is entirely built 566as modules, you would give the command: 567 568modprobe -r speakup_dectlk 569 570The above command assumes you were running a DecTalk Express. If you 571were using a different synth, then you would substitute its keyword in 572place of dectlk. 573 574If you have multiple drivers loaded, you need to unload all of them, in 575order to completely unload Speakup. 576For example, if you have loaded both the dectlk and ltlk drivers, use the 577command: 578modprobe -r speakup_dectlk speakup_ltlk 579 580You cannot unload the driver for software synthesizers when a user-space 581daemon is using /dev/softsynth. First, kill the daemon. Next, remove 582the driver with the command: 583modprobe -r speakup_soft 584 585Now, suppose we have a situation where the main Speakup component 586is built into the kernel, and some or all of the drivers are built as 587modules. Since the main part of Speakup is compiled into the kernel, a 588partial Speakup sys system has been created which we can take advantage 589of by simply echoing the synthesizer keyword into the 590/speakup/synth sys entry. This will cause the kernel to 591automatically load the appropriate driver module, and start Speakup 592talking. To switch to another synth, just echo a new keyword to the 593synth sys entry. For example, to load the DoubleTalk LT driver, 594you would type: 595 596echo ltlk >/speakup/synth 597 598You can use the modprobe -r command to unload driver modules, regardless 599of whether the main part of Speakup has been built into the kernel or 600not. 601 6028. Using Software Synthesizers 603 604Using a software synthesizer requires that some other software be 605installed and running on your system. For this reason, software 606synthesizers are not available for use at bootup, or during a system 607installation process. 608There are two freely-available solutions for software speech: Espeakup and 609Speech Dispatcher. 610These are described in subsections 8.1 and 8.2, respectively. 611 612During the rest of this section, we assume that speakup_soft is either 613built in to your kernel, or loaded as a module. 614 615If your system does not have udev installed , before you can use a 616software synthesizer, you must have created the /dev/softsynth device. 617If you have not already done so, issue the following commands as root: 618 619cd /dev 620mknod softsynth c 10 26 621 622While we are at it, we might just as well create the /dev/synth device, 623which can be used to let user space programs send information to your 624synthesizer. To create /dev/synth, change to the /dev directory, and 625issue the following command as root: 626 627mknod synth c 10 25 628 629of both. 630 6318.1. Espeakup 632 633Espeakup is a connector between Speakup and the eSpeak software synthesizer. 634Espeakup may already be available as a package for your distribution 635of Linux. If it is not packaged, you need to install it manually. 636You can find it in the contrib/ subdirectory of the Speakup sources. 637The filename is espeakup-$VERSION.tar.bz2, where $VERSION 638depends on the current release of Espeakup. The Speakup 3.1.2 source 639ships with version 0.71 of Espeakup. 640The README file included with the Espeakup sources describes the process 641of manual installation. 642 643Assuming that Espeakup is installed, either by the user or by the distributor, 644follow these steps to use it. 645 646Tell Speakup to use the "soft driver: 647echo soft > /speakup/synth 648 649Finally, start the espeakup program. There are two ways to do it. 650Both require root privileges. 651 652If Espeakup was installed as a package for your Linux distribution, 653you probably have a distribution-specific script that controls the operation 654of the daemon. Look for a file named espeakup under /etc/init.d or 655/etc/rc.d. Execute the following command with root privileges: 656/etc/init.d/espeakup start 657Replace init.d with rc.d, if your distribution uses scripts located under 658/etc/rc.d. 659Your distribution will also have a procedure for starting daemons at 660boot-time, so it is possible to have software speech as soon as user-space 661daemons are started by the bootup scripts. 662These procedures are not described in this document. 663 664If you built Espeakup manually, the "make install" step placed the binary 665under /usr/bin. 666Run the following command as root: 667/usr/bin/espeakup 668Espeakup should start speaking. 669 6708.2. Speech Dispatcher 671 672For this option, you must have a package called 673Speech Dispatcher running on your system, and it must be configured to 674work with one of its supported software synthesizers. 675 676Two open source synthesizers you might use are Flite and Festival. You 677might also choose to purchase the Software DecTalk from Fonix Sales Inc. 678If you run a google search for Fonix, you'll find their web site. 679 680You can obtain a copy of Speech Dispatcher from free(b)soft at 681http://www.freebsoft.org/. Follow the installation instructions that 682come with Speech Dispatcher in order to install and configure Speech 683Dispatcher. You can check out the web site for your Linux distribution 684in order to get a copy of either Flite or Festival. Your Linux 685distribution may also have a precompiled Speech Dispatcher package. 686 687Once you've installed, configured, and tested Speech Dispatcher with your 688chosen software synthesizer, you still need one more piece of software 689in order to make things work. You need a package called speechd-up. 690You get it from the free(b)soft web site mentioned above. After you've 691compiled and installed speechd-up, you are almost ready to begin using 692your software synthesizer. 693 694Now you can begin using your software synthesizer. In order to do so, 695echo the soft keyword to the synth sys entry like this: 696 697echo soft >/speakup/synth 698 699Next run the speechd_up command like this: 700 701speechd_up & 702 703Your synth should now start talking, and you should be able to adjust 704the pitch, rate, etc. 705 7069. Using The DecTalk PC Card 707 708The DecTalk PC card is an ISA card that is inserted into one of the ISA 709slots in your computer. It requires that the DecTalk PC software be 710installed on your computer, and that the software be loaded onto the 711Dectalk PC card before it can be used. 712 713You can get the dec_pc.tgz file from the linux-speakup.org site. The 714dec_pc.tgz file is in the ~ftp/pub/linux/speakup directory. 715 716After you have downloaded the dec_pc.tgz file, untar it in your home 717directory, and read the Readme file in the newly created dec_pc 718directory. 719 720The easiest way to get the software working is to copy the entire dec_pc 721directory into /user/local/lib. To do this, su to root in your home 722directory, and issue the command: 723 724cp dec_pc /usr/local/lib 725 726You will need to copy the dtload command from the dec_pc directory to a 727directory in your path. Either /usr/bin or /usr/local/bin is a good 728choice. 729 730You can now run the dtload command in order to load the DecTalk PC 731software onto the card. After you have done this, echo the decpc 732keyword to the synth entry in the sys system like this: 733 734echo decpc >/speakup/synth 735 736Your DecTalk PC should start talking, and then you can adjust the pitch, 737rate, volume, voice, etc. The voice entry in the Speakup sys system 738will accept a number from 0 through 7 for the DecTalk PC synthesizer, 739which will give you access to some of the DecTalk voices. 740 74110. Using Cursor Tracking 742 743In Speakup version 2.0 and later, cursor tracking is turned on by 744default. This means that when you are using an editor, Speakup will 745automatically speak characters as you move left and right with the 746cursor keys, and lines as you move up and down with the cursor keys. 747This is the traditional sort of cursor tracking. 748Recent versions of Speakup provide two additional ways to control the 749text that is spoken when the cursor is moved: 750"highlight tracking" and "read window." 751They are described later in this section. 752Sometimes, these modes get in your way, so you can disable cursor tracking 753altogether. 754 755You may select among the various forms of cursor tracking using the keypad 756asterisk key. 757Each time you press this key, a new mode is selected, and Speakup speaks 758the name of the new mode. The names for the four possible states of cursor 759tracking are: "cursoring on", "highlight tracking", "read window", 760and "cursoring off." The keypad asterisk key moves through the list of 761modes in a circular fashion. 762 763If highlight tracking is enabled, Speakup tracks highlighted text, 764rather than the cursor itself. When you move the cursor with the arrow keys, 765Speakup speaks the currently highlighted information. 766This is useful when moving through various menus and dialog boxes. 767If cursor tracking isn't helping you while navigating a menu, 768try highlight tracking. 769 770With the "read window" variety of cursor tracking, you can limit the text 771that Speakup speaks by specifying a window of interest on the screen. 772See section 15 for a description of the process of defining windows. 773When you move the cursor via the arrow keys, Speakup only speaks 774the contents of the window. This is especially helpful when you are hearing 775superfluous speech. Consider the following example. 776 777Suppose that you are at a shell prompt. You use bash, and you want to 778explore your command history using the up and down arrow keys. If you 779have enabled cursor tracking, you will hear two pieces of information. 780Speakup speaks both your shell prompt and the current entry from the 781command history. You may not want to hear the prompt repeated 782each time you move, so you can silence it by specifying a window. Find 783the last line of text on the screen. Clear the current window by pressing 784the key combination speakup f3. Use the review cursor to find the first 785character that follows your shell prompt. Press speakup + f2 twice, to 786define a one-line window. The boundaries of the window are the 787character following the shell prompt and the end of the line. Now, cycle 788through the cursor tracking modes using keypad asterisk, until Speakup 789says "read window." Move through your history using your arrow keys. 790You will notice that Speakup no longer speaks the redundant prompt. 791 792Some folks like to turn cursor tracking off while they are using the 793lynx web browser. You definitely want to turn cursor tracking off when 794you are using the alsamixer application. Otherwise, you won't be able 795to hear your mixer settings while you are using the arrow keys. 796 79711. Cut and Paste 798 799One of Speakup's more useful features is the ability to cut and paste 800text on the screen. This means that you can capture information from a 801program, and paste that captured text into a different place in the 802program, or into an entirely different program, which may even be 803running on a different console. 804 805For example, in this manual, we have made references to several web 806sites. It would be nice if you could cut and paste these urls into your 807web browser. Speakup does this quite nicely. Suppose you wanted to 808past the following url into your browser: 809 810http://linux-speakup.org/ 811 812Use the speakup review keys to position the reading cursor on the first 813character of the above url. When the reading cursor is in position, 814press the keypad slash key once. Speakup will say, "mark". Next, 815position the reading cursor on the rightmost character of the above 816url. Press the keypad slash key once again to actually cut the text 817from the screen. Speakup will say, "cut". Although we call this 818cutting, Speakup does not actually delete the cut text from the screen. 819It makes a copy of the text in a special buffer for later pasting. 820 821Now that you have the url cut from the screen, you can paste it into 822your browser, or even paste the url on a command line as an argument to 823your browser. 824 825Suppose you want to start lynx and go to the Speakup site. 826 827You can switch to a different console with the alt left and right 828arrows, or you can switch to a specific console by typing alt and a 829function key. These are not Speakup commands, just standard Linux 830console capabilities. 831 832Once you've changed to an appropriate console, and are at a shell prompt, 833type the word lynx, followed by a space. Now press and hold the speakup 834key, while you type the keypad slash character. The url will be pasted 835onto the command line, just as though you had typed it in. Press the 836enter key to execute the command. 837 838The paste buffer will continue to hold the cut information, until a new 839mark and cut operation is carried out. This means you can paste the cut 840information as many times as you like before doing another cut 841operation. 842 843You are not limited to cutting and pasting only one line on the screen. 844You can also cut and paste rectangular regions of the screen. Just 845position the reading cursor at the top left corner of the text to be 846cut, mark it with the keypad slash key, then position the reading cursor 847at the bottom right corner of the region to be cut, and cut it with the 848keypad slash key. 849 85012. Changing the Pronunciation of Characters 851 852Through the /speakup/i18n/characters sys entry, Speakup gives you the 853ability to change how Speakup pronounces a given character. You could, 854for example, change how some punctuation characters are spoken. You can 855even change how Speakup will pronounce certain letters. 856 857You may, for example, wish to change how Speakup pronounces the z 858character. The author of Speakup, Kirk Reiser, is Canadian, and thus 859believes that the z should be pronounced zed. If you are an American, 860you might wish to use the zee pronunciation instead of zed. You can 861change the pronunciation of both the upper and lower case z with the 862following two commands: 863 864echo 90 zee >/speakup/characters 865echo 122 zee >/speakup/characters 866 867Let's examine the parts of the two previous commands. They are issued 868at the shell prompt, and could be placed in a startup script. 869 870The word echo tells the shell that you want to have it display the 871string of characters that follow the word echo. If you were to just 872type: 873 874echo hello. 875 876You would get the word hello printed on your screen as soon as you 877pressed the enter key. In this case, we are echoing strings that we 878want to be redirected into the sys system. 879 880The numbers 90 and 122 in the above echo commands are the ascii numeric 881values for the upper and lower case z, the characters we wish to change. 882 883The string zee is the pronunciation that we want Speakup to use for the 884upper and lower case z. 885 886The > symbol redirects the output of the echo command to a file, just 887like in DOS, or at the Windows command prompt. 888 889And finally, /speakup/i18n/characters is the file entry in the sys system 890where we want the output to be directed. Speakup looks at the numeric 891value of the character we want to change, and inserts the pronunciation 892string into an internal table. 893 894You can look at the whole table with the following command: 895 896cat /speakup/i18n/characters 897 898Speakup will then print out the entire character pronunciation table. I 899won't display it here, but leave you to look at it at your convenience. 900 90113. Mapping Keys 902 903Speakup has the capability of allowing you to assign or "map" keys to 904internal Speakup commands. This section necessarily assumes you have a 905Linux kernel source tree installed, and that it has been patched and 906configured with Speakup. How you do this is beyond the scope of this 907manual. For this information, visit the Speakup web site at 908http://linux-speakup.org/. The reason you'll need the kernel source 909tree patched with Speakup is that the genmap utility you'll need for 910processing keymaps is in the 911/usr/src/linux-<version_number>/drivers/char/speakup directory. The 912<version_number> in the above directory path is the version number of 913the Linux source tree you are working with. 914 915So ok, you've gone off and gotten your kernel source tree, and patched 916and configured it. Now you can start manipulating keymaps. 917 918You can either use the 919/usr/src/linux-<version_number>/drivers/char/speakup/speakupmap.map file 920included with the Speakup source, or you can cut and paste the copy in 921section 4 into a separate file. If you use the one in the Speakup 922source tree, make sure you make a backup of it before you start making 923changes. You have been warned! 924 925Suppose that you want to swap the key assignments for the Speakup 926say_last_char and the Speakup say_first_char commands. The 927speakupmap.map lists the key mappings for these two commands as follows: 928 929spk key_pageup = say_first_char 930spk key_pagedown = say_last_char 931 932You can edit your copy of the speakupmap.map file and swap the command 933names on the right side of the = (equals) sign. You did make a backup, 934right? The new keymap lines would look like this: 935 936spk key_pageup = say_last_char 937spk key_pagedown = say_first_char 938 939After you edit your copy of the speakupmap.map file, save it under a new 940file name, perhaps newmap.map. Then exit your editor and return to the 941shell prompt. 942 943You are now ready to load your keymap with your swapped key assignments. 944 Assuming that you saved your new keymap as the file newmap.map, you 945would load your keymap into the sys system like this: 946 947/usr/src/linux-<version_number>/drivers/char/speakup/genmap newmap.map 948>/speakup/keymap 949 950Remember to substitute your kernel version number for the 951<version_number> in the above command. Also note that although the 952above command wrapped onto two lines in this document, you should type 953it all on one line. 954 955Your say first and say last characters should now be swapped. Pressing 956speakup pagedown should read you the first non-whitespace character on 957the line your reading cursor is in, and pressing speakup pageup should 958read you the last character on the line your reading cursor is in. 959 960You should note that these new mappings will only stay in effect until 961you reboot, or until you load another keymap. 962 963One final warning. If you try to load a partial map, you will quickly 964find that all the mappings you didn't include in your file got deleted 965from the working map. Be extremely careful, and always make a backup! 966You have been warned! 967 96814. Internationalizing Speakup 969 970Speakup indicates various conditions to the user by speaking messages. 971For instance, when you move to the left edge of the screen with the 972review keys, Speakup says, "left." 973Prior to version 3.1.0 of Speakup, all of these messages were in English, 974and they could not be changed. If you used a non-English synthesizer, 975you still heard English messages, such as "left" and "cursoring on." 976In version 3.1.0 or higher, one may load translations for the various 977messages via the /sys filesystem. 978 979The directory /speakup/i18n contains several collections of messages. 980Each group of messages is stored in its own file. 981The following section lists all of these files, along with a brief description 982of each. 983 98414.1. Files Under the i18n Subdirectory 985 986* announcements: 987This file contains various general announcements, most of which cannot 988be categorized. You will find messages such as "You killed Speakup", 989"I'm alive", "leaving help", "parked", "unparked", and others. 990You will also find the names of the screen edges and cursor tracking modes 991here. 992 993* characters: 994See section 12 for a description of this file. 995 996* chartab: 997See section 12. Unlike the rest of the files in the i18n subdirectory, 998this one does not contain messages to be spoken. 999 1000* colors: 1001When you use the "say attributes" function, Speakup says the name of the 1002foreground and background colors. These names come from the i18n/colors 1003file. 1004 1005* ctl_keys: 1006Here, you will find names of control keys. These are used with Speakup's 1007say_control feature. 1008 1009* formatted: 1010This group of messages contains embedded formatting codes, to specify 1011the type and width of displayed data. If you change these, you must 1012preserve all of the formatting codes, and they must appear in the order 1013used by the default messages. 1014 1015* function_names: 1016Here, you will find a list of names for Speakup functions. These are used 1017by the help system. For example, suppose that you have activated help mode, 1018and you pressed keypad 3. Speakup says: 1019"keypad 3 is character, say next." 1020The message "character, say next" names a Speakup function, and it 1021comes from this function_names file. 1022 1023* key_names: 1024Again, key_names is used by Speakup's help system. In the previous 1025example, Speakup said that you pressed "keypad 3." 1026This name came from the key_names file. 1027 1028* states: 1029This file contains names for key states. 1030Again, these are part of the help system. For instance, if you had pressed 1031speakup + keypad 3, you would hear: 1032"speakup keypad 3 is go to bottom edge." 1033The speakup key is depressed, so the name of the key state is speakup. 1034This part of the message comes from the states collection. 1035 103614.2. Changing language 1037 103814.2.1. Loading Your Own Messages 1039 1040The files under the i18n subdirectory all follow the same format. 1041They consist of lines, with one message per line. 1042Each message is represented by a number, followed by the text of the message. 1043The number is the position of the message in the given collection. 1044For example, if you view the file /speakup/i18n/colors, you will see the 1045following list: 1046 10470 black 10481 blue 10492 green 10503 cyan 10514 red 10525 magenta 10536 yellow 10547 white 10558 grey 1056 1057You can change one message, or you can change a whole group. 1058To load a whole collection of messages from a new source, simply use 1059the cp command: 1060cp ~/my_colors /speakup/i18n/colors 1061You can change an individual message with the echo command, 1062as shown in the following example. 1063 1064The Spanish name for the color blue is azul. 1065Looking at the colors file, we see that the name "blue" is at position 1 1066within the colors group. Let's change blue to azul: 1067echo '1 azul' > /speakup/i18n/colors 1068The next time that Speakup says message 1 from the colors group, it will 1069say "azul", rather than "blue." 1070 107114.2.2. Choose a language 1072 1073In the future, translations into various languages will be made available, 1074and most users will just load the files necessary for their language. So far, 1075only French language is available beyond native Canadian English language. 1076 1077French is only available after you are logged in. 1078 1079Canadian English is the default language. To toggle another language, 1080download the source of Speakup and untar it in your home directory. The 1081following command should let you do this: 1082 1083tar xvjf speakup-<version>.tar.bz2 1084 1085where <version> is the version number of the application. 1086 1087Next, change to the newly created directory, then into the tools/ directory, and 1088run the script speakup_setlocale. You are asked the language that you want to 1089use. Type the number associated to your language (e.g. fr for French) then press 1090Enter. Needed files are copied in the i18n directory. 1091 1092Note: the speakupconf must be installed on your system so that settings are saved. 1093Otherwise, you will have an error: your language will be loaded but you will 1094have to run the script again every time Speakup restarts. 1095See section 16.1. for information about speakupconf. 1096 1097You will have to repeat these steps for any change of locale, i.e. if you wish 1098change the speakup's language or charset (iso-8859-15 ou UTF-8). 1099 1100If you wish store the settings, note that at your next login, you will need to 1101do: 1102 1103speakup load 1104 1105Alternatively, you can add the above line to your file 1106~/.bashrc or ~/.bash_profile. 1107 1108If your system administrator ran himself the script, all the users will be able 1109to change from English to the language choosed by root and do directly 1110speakupconf load (or add this to the ~/.bashrc or 1111~/.bash_profile file). If there are several languages to handle, the 1112administrator (or every user) will have to run the first steps until speakupconf 1113save, choosing the appropriate language, in every user's home directory. Every 1114user will then be able to do speakupconf load, Speakup will load his own settings. 1115 111614.3. No Support for Non-Western-European Languages 1117 1118As of the current release, Speakup only supports Western European languages. 1119Support for the extended characters used by languages outside of the Western 1120European family of languages is a work in progress. 1121 112215. Using Speakup's Windowing Capability 1123 1124Speakup has the capability of defining and manipulating windows on the 1125screen. Speakup uses the term "Window", to mean a user defined area of 1126the screen. The key strokes for defining and manipulating Speakup 1127windows are as follows: 1128 1129speakup + f2 -- Set the bounds of the window. 1130Speakup + f3 -- clear the current window definition. 1131speakup + f4 -- Toggle window silence on and off. 1132speakup + keypad plus -- Say the currently defined window. 1133 1134These capabilities are useful for tracking a certain part of the screen 1135without rereading the whole screen, or for silencing a part of the 1136screen that is constantly changing, such as a clock or status line. 1137 1138There is no way to save these window settings, and you can only have one 1139window defined for each virtual console. There is also no way to have 1140windows automatically defined for specific applications. 1141 1142In order to define a window, use the review keys to move your reading 1143cursor to the beginning of the area you want to define. Then press 1144speakup + f2. Speakup will tell you that the window starts at the 1145indicated row and column position. Then move the reading cursor to the 1146end of the area to be defined as a window, and press speakup + f2 again. 1147 If there is more than one line in the window, Speakup will tell you 1148that the window ends at the indicated row and column position. If there 1149is only one line in the window, then Speakup will tell you that the 1150window is the specified line on the screen. If you are only defining a 1151one line window, you can just press speakup + f2 twice after placing the 1152reading cursor on the line you want to define as a window. It is not 1153necessary to position the reading cursor at the end of the line in order 1154to define the whole line as a window. 1155 115616. Tools for Controlling Speakup 1157 1158The speakup distribution includes extra tools (in the tools directory) 1159which were written to make speakup easier to use. This section will 1160briefly describe the use of these tools. 1161 116216.1. Speakupconf 1163 1164speakupconf began life as a contribution from Steve Holmes, a member of 1165the speakup community. We would like to thank him for his work on the 1166early versions of this project. 1167 1168This script may be installed as part of your linux distribution, but if 1169it isn't, the recommended places to put it are /usr/local/bin or 1170/usr/bin. This script can be run by any user, so it does not require 1171root privileges. 1172 1173Speakupconf allows you to save and load your Speakup settings. It works 1174by reading and writing the /sys files described above. 1175 1176The directory that speakupconf uses to store your settings depends on 1177whether it is run from the root account. If you execute speakupconf as 1178root, it uses the directory /etc/speakup. Otherwise, it uses the directory 1179~/.speakup, where ~ is your home directory. 1180Anyone who needs to use Speakup from your console can load his own custom 1181settings with this script. 1182 1183speakupconf takes one required argument: load or save. 1184Use the command 1185speakupconf save 1186to save your Speakup settings, and 1187speakupconf load 1188to load them into Speakup. 1189A second argument may be specified to use an alternate directory to 1190load or save the speakup parameters. 1191 119216.2. Talkwith 1193 1194Charles Hallenbeck, another member of the speakup community, wrote the 1195initial versions of this script, and we would also like to thank him for 1196his work on it. 1197 1198This script needs root privileges to run, so if it is not installed as 1199part of your linux distribution, the recommended places to install it 1200are /usr/local/sbin or /usr/sbin. 1201 1202Talkwith allows you to switch synthesizers on the fly. It takes a synthesizer 1203name as an argument. For instance, 1204talkwith dectlk 1205causes Speakup to use the DecTalk Express. If you wish to switch to a 1206software synthesizer, you must also indicate which daemon you wish to 1207use. There are two possible choices: 1208spd and espeakup. spd is an abbreviation for speechd-up. 1209If you wish to use espeakup for software synthesis, give the command 1210talkwith soft espeakup 1211To use speechd-up, type: 1212talkwith soft spd 1213Any arguments that follow the name of the daemon are passed to the daemon 1214when it is invoked. For instance: 1215talkwith espeakup --default-voice=fr 1216causes espeakup to use the French voice. 1217Note that talkwith must always be executed with root privileges. 1218 1219Talkwith does not attempt to load your settings after the new 1220synthesizer is activated. You can use speakupconf to load your settings 1221if desired. 1222 1223 GNU Free Documentation License 1224 Version 1.2, November 2002 1225 1226 1227 Copyright (C) 2000,2001,2002 Free Software Foundation, Inc. 1228 Everyone is permitted to copy and distribute verbatim copies 1229 of this license document, but changing it is not allowed. 1230 1231 12320. PREAMBLE 1233 1234The purpose of this License is to make a manual, textbook, or other 1235functional and useful document "free" in the sense of freedom: to 1236assure everyone the effective freedom to copy and redistribute it, 1237with or without modifying it, either commercially or noncommercially. 1238Secondarily, this License preserves for the author and publisher a way 1239to get credit for their work, while not being considered responsible 1240for modifications made by others. 1241 1242This License is a kind of "copyleft", which means that derivative 1243works of the document must themselves be free in the same sense. It 1244complements the GNU General Public License, which is a copyleft 1245license designed for free software. 1246 1247We have designed this License in order to use it for manuals for free 1248software, because free software needs free documentation: a free 1249program should come with manuals providing the same freedoms that the 1250software does. But this License is not limited to software manuals; 1251it can be used for any textual work, regardless of subject matter or 1252whether it is published as a printed book. We recommend this License 1253principally for works whose purpose is instruction or reference. 1254 1255 12561. APPLICABILITY AND DEFINITIONS 1257 1258This License applies to any manual or other work, in any medium, that 1259contains a notice placed by the copyright holder saying it can be 1260distributed under the terms of this License. Such a notice grants a 1261world-wide, royalty-free license, unlimited in duration, to use that 1262work under the conditions stated herein. The "Document", below, 1263refers to any such manual or work. Any member of the public is a 1264licensee, and is addressed as "you". You accept the license if you 1265copy, modify or distribute the work in a way requiring permission 1266under copyright law. 1267 1268A "Modified Version" of the Document means any work containing the 1269Document or a portion of it, either copied verbatim, or with 1270modifications and/or translated into another language. 1271 1272A "Secondary Section" is a named appendix or a front-matter section of 1273the Document that deals exclusively with the relationship of the 1274publishers or authors of the Document to the Document's overall subject 1275(or to related matters) and contains nothing that could fall directly 1276within that overall subject. (Thus, if the Document is in part a 1277textbook of mathematics, a Secondary Section may not explain any 1278mathematics.) The relationship could be a matter of historical 1279connection with the subject or with related matters, or of legal, 1280commercial, philosophical, ethical or political position regarding 1281them. 1282 1283The "Invariant Sections" are certain Secondary Sections whose titles 1284are designated, as being those of Invariant Sections, in the notice 1285that says that the Document is released under this License. If a 1286section does not fit the above definition of Secondary then it is not 1287allowed to be designated as Invariant. The Document may contain zero 1288Invariant Sections. If the Document does not identify any Invariant 1289Sections then there are none. 1290 1291The "Cover Texts" are certain short passages of text that are listed, 1292as Front-Cover Texts or Back-Cover Texts, in the notice that says that 1293the Document is released under this License. A Front-Cover Text may 1294be at most 5 words, and a Back-Cover Text may be at most 25 words. 1295 1296A "Transparent" copy of the Document means a machine-readable copy, 1297represented in a format whose specification is available to the 1298general public, that is suitable for revising the document 1299straightforwardly with generic text editors or (for images composed of 1300pixels) generic paint programs or (for drawings) some widely available 1301drawing editor, and that is suitable for input to text formatters or 1302for automatic translation to a variety of formats suitable for input 1303to text formatters. A copy made in an otherwise Transparent file 1304format whose markup, or absence of markup, has been arranged to thwart 1305or discourage subsequent modification by readers is not Transparent. 1306An image format is not Transparent if used for any substantial amount 1307of text. A copy that is not "Transparent" is called "Opaque". 1308 1309Examples of suitable formats for Transparent copies include plain 1310ASCII without markup, Texinfo input format, LaTeX input format, SGML 1311or XML using a publicly available DTD, and standard-conforming simple 1312HTML, PostScript or PDF designed for human modification. Examples of 1313transparent image formats include PNG, XCF and JPG. Opaque formats 1314include proprietary formats that can be read and edited only by 1315proprietary word processors, SGML or XML for which the DTD and/or 1316processing tools are not generally available, and the 1317machine-generated HTML, PostScript or PDF produced by some word 1318processors for output purposes only. 1319 1320The "Title Page" means, for a printed book, the title page itself, 1321plus such following pages as are needed to hold, legibly, the material 1322this License requires to appear in the title page. For works in 1323formats which do not have any title page as such, "Title Page" means 1324the text near the most prominent appearance of the work's title, 1325preceding the beginning of the body of the text. 1326 1327A section "Entitled XYZ" means a named subunit of the Document whose 1328title either is precisely XYZ or contains XYZ in parentheses following 1329text that translates XYZ in another language. (Here XYZ stands for a 1330specific section name mentioned below, such as "Acknowledgements", 1331"Dedications", "Endorsements", or "History".) To "Preserve the Title" 1332of such a section when you modify the Document means that it remains a 1333section "Entitled XYZ" according to this definition. 1334 1335The Document may include Warranty Disclaimers next to the notice which 1336states that this License applies to the Document. These Warranty 1337Disclaimers are considered to be included by reference in this 1338License, but only as regards disclaiming warranties: any other 1339implication that these Warranty Disclaimers may have is void and has 1340no effect on the meaning of this License. 1341 1342 13432. VERBATIM COPYING 1344 1345You may copy and distribute the Document in any medium, either 1346commercially or noncommercially, provided that this License, the 1347copyright notices, and the license notice saying this License applies 1348to the Document are reproduced in all copies, and that you add no other 1349conditions whatsoever to those of this License. You may not use 1350technical measures to obstruct or control the reading or further 1351copying of the copies you make or distribute. However, you may accept 1352compensation in exchange for copies. If you distribute a large enough 1353number of copies you must also follow the conditions in section 3. 1354 1355You may also lend copies, under the same conditions stated above, and 1356you may publicly display copies. 1357 1358 13593. COPYING IN QUANTITY 1360 1361If you publish printed copies (or copies in media that commonly have 1362printed covers) of the Document, numbering more than 100, and the 1363Document's license notice requires Cover Texts, you must enclose the 1364copies in covers that carry, clearly and legibly, all these Cover 1365Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on 1366the back cover. Both covers must also clearly and legibly identify 1367you as the publisher of these copies. The front cover must present 1368the full title with all words of the title equally prominent and 1369visible. You may add other material on the covers in addition. 1370Copying with changes limited to the covers, as long as they preserve 1371the title of the Document and satisfy these conditions, can be treated 1372as verbatim copying in other respects. 1373 1374If the required texts for either cover are too voluminous to fit 1375legibly, you should put the first ones listed (as many as fit 1376reasonably) on the actual cover, and continue the rest onto adjacent 1377pages. 1378 1379If you publish or distribute Opaque copies of the Document numbering 1380more than 100, you must either include a machine-readable Transparent 1381copy along with each Opaque copy, or state in or with each Opaque copy 1382a computer-network location from which the general network-using 1383public has access to download using public-standard network protocols 1384a complete Transparent copy of the Document, free of added material. 1385If you use the latter option, you must take reasonably prudent steps, 1386when you begin distribution of Opaque copies in quantity, to ensure 1387that this Transparent copy will remain thus accessible at the stated 1388location until at least one year after the last time you distribute an 1389Opaque copy (directly or through your agents or retailers) of that 1390edition to the public. 1391 1392It is requested, but not required, that you contact the authors of the 1393Document well before redistributing any large number of copies, to give 1394them a chance to provide you with an updated version of the Document. 1395 1396 13974. MODIFICATIONS 1398 1399You may copy and distribute a Modified Version of the Document under 1400the conditions of sections 2 and 3 above, provided that you release 1401the Modified Version under precisely this License, with the Modified 1402Version filling the role of the Document, thus licensing distribution 1403and modification of the Modified Version to whoever possesses a copy 1404of it. In addition, you must do these things in the Modified Version: 1405 1406A. Use in the Title Page (and on the covers, if any) a title distinct 1407 from that of the Document, and from those of previous versions 1408 (which should, if there were any, be listed in the History section 1409 of the Document). You may use the same title as a previous version 1410 if the original publisher of that version gives permission. 1411B. List on the Title Page, as authors, one or more persons or entities 1412 responsible for authorship of the modifications in the Modified 1413 Version, together with at least five of the principal authors of the 1414 Document (all of its principal authors, if it has fewer than five), 1415 unless they release you from this requirement. 1416C. State on the Title page the name of the publisher of the 1417 Modified Version, as the publisher. 1418D. Preserve all the copyright notices of the Document. 1419E. Add an appropriate copyright notice for your modifications 1420 adjacent to the other copyright notices. 1421F. Include, immediately after the copyright notices, a license notice 1422 giving the public permission to use the Modified Version under the 1423 terms of this License, in the form shown in the Addendum below. 1424G. Preserve in that license notice the full lists of Invariant Sections 1425 and required Cover Texts given in the Document's license notice. 1426H. Include an unaltered copy of this License. 1427I. Preserve the section Entitled "History", Preserve its Title, and add 1428 to it an item stating at least the title, year, new authors, and 1429 publisher of the Modified Version as given on the Title Page. If 1430 there is no section Entitled "History" in the Document, create one 1431 stating the title, year, authors, and publisher of the Document as 1432 given on its Title Page, then add an item describing the Modified 1433 Version as stated in the previous sentence. 1434J. Preserve the network location, if any, given in the Document for 1435 public access to a Transparent copy of the Document, and likewise 1436 the network locations given in the Document for previous versions 1437 it was based on. These may be placed in the "History" section. 1438 You may omit a network location for a work that was published at 1439 least four years before the Document itself, or if the original 1440 publisher of the version it refers to gives permission. 1441K. For any section Entitled "Acknowledgements" or "Dedications", 1442 Preserve the Title of the section, and preserve in the section all 1443 the substance and tone of each of the contributor acknowledgements 1444 and/or dedications given therein. 1445L. Preserve all the Invariant Sections of the Document, 1446 unaltered in their text and in their titles. Section numbers 1447 or the equivalent are not considered part of the section titles. 1448M. Delete any section Entitled "Endorsements". Such a section 1449 may not be included in the Modified Version. 1450N. Do not retitle any existing section to be Entitled "Endorsements" 1451 or to conflict in title with any Invariant Section. 1452O. Preserve any Warranty Disclaimers. 1453 1454If the Modified Version includes new front-matter sections or 1455appendices that qualify as Secondary Sections and contain no material 1456copied from the Document, you may at your option designate some or all 1457of these sections as invariant. To do this, add their titles to the 1458list of Invariant Sections in the Modified Version's license notice. 1459These titles must be distinct from any other section titles. 1460 1461You may add a section Entitled "Endorsements", provided it contains 1462nothing but endorsements of your Modified Version by various 1463parties--for example, statements of peer review or that the text has 1464been approved by an organization as the authoritative definition of a 1465standard. 1466 1467You may add a passage of up to five words as a Front-Cover Text, and a 1468passage of up to 25 words as a Back-Cover Text, to the end of the list 1469of Cover Texts in the Modified Version. Only one passage of 1470Front-Cover Text and one of Back-Cover Text may be added by (or 1471through arrangements made by) any one entity. If the Document already 1472includes a cover text for the same cover, previously added by you or 1473by arrangement made by the same entity you are acting on behalf of, 1474you may not add another; but you may replace the old one, on explicit 1475permission from the previous publisher that added the old one. 1476 1477The author(s) and publisher(s) of the Document do not by this License 1478give permission to use their names for publicity for or to assert or 1479imply endorsement of any Modified Version. 1480 1481 14825. COMBINING DOCUMENTS 1483 1484You may combine the Document with other documents released under this 1485License, under the terms defined in section 4 above for modified 1486versions, provided that you include in the combination all of the 1487Invariant Sections of all of the original documents, unmodified, and 1488list them all as Invariant Sections of your combined work in its 1489license notice, and that you preserve all their Warranty Disclaimers. 1490 1491The combined work need only contain one copy of this License, and 1492multiple identical Invariant Sections may be replaced with a single 1493copy. If there are multiple Invariant Sections with the same name but 1494different contents, make the title of each such section unique by 1495adding at the end of it, in parentheses, the name of the original 1496author or publisher of that section if known, or else a unique number. 1497Make the same adjustment to the section titles in the list of 1498Invariant Sections in the license notice of the combined work. 1499 1500In the combination, you must combine any sections Entitled "History" 1501in the various original documents, forming one section Entitled 1502"History"; likewise combine any sections Entitled "Acknowledgements", 1503and any sections Entitled "Dedications". You must delete all sections 1504Entitled "Endorsements". 1505 1506 15076. COLLECTIONS OF DOCUMENTS 1508 1509You may make a collection consisting of the Document and other documents 1510released under this License, and replace the individual copies of this 1511License in the various documents with a single copy that is included in 1512the collection, provided that you follow the rules of this License for 1513verbatim copying of each of the documents in all other respects. 1514 1515You may extract a single document from such a collection, and distribute 1516it individually under this License, provided you insert a copy of this 1517License into the extracted document, and follow this License in all 1518other respects regarding verbatim copying of that document. 1519 1520 15217. AGGREGATION WITH INDEPENDENT WORKS 1522 1523A compilation of the Document or its derivatives with other separate 1524and independent documents or works, in or on a volume of a storage or 1525distribution medium, is called an "aggregate" if the copyright 1526resulting from the compilation is not used to limit the legal rights 1527of the compilation's users beyond what the individual works permit. 1528When the Document is included in an aggregate, this License does not 1529apply to the other works in the aggregate which are not themselves 1530derivative works of the Document. 1531 1532If the Cover Text requirement of section 3 is applicable to these 1533copies of the Document, then if the Document is less than one half of 1534the entire aggregate, the Document's Cover Texts may be placed on 1535covers that bracket the Document within the aggregate, or the 1536electronic equivalent of covers if the Document is in electronic form. 1537Otherwise they must appear on printed covers that bracket the whole 1538aggregate. 1539 1540 15418. TRANSLATION 1542 1543Translation is considered a kind of modification, so you may 1544distribute translations of the Document under the terms of section 4. 1545Replacing Invariant Sections with translations requires special 1546permission from their copyright holders, but you may include 1547translations of some or all Invariant Sections in addition to the 1548original versions of these Invariant Sections. You may include a 1549translation of this License, and all the license notices in the 1550Document, and any Warranty Disclaimers, provided that you also include 1551the original English version of this License and the original versions 1552of those notices and disclaimers. In case of a disagreement between 1553the translation and the original version of this License or a notice 1554or disclaimer, the original version will prevail. 1555 1556If a section in the Document is Entitled "Acknowledgements", 1557"Dedications", or "History", the requirement (section 4) to Preserve 1558its Title (section 1) will typically require changing the actual 1559title. 1560 1561 15629. TERMINATION 1563 1564You may not copy, modify, sublicense, or distribute the Document except 1565as expressly provided for under this License. Any other attempt to 1566copy, modify, sublicense or distribute the Document is void, and will 1567automatically terminate your rights under this License. However, 1568parties who have received copies, or rights, from you under this 1569License will not have their licenses terminated so long as such 1570parties remain in full compliance. 1571 1572 157310. FUTURE REVISIONS OF THIS LICENSE 1574 1575The Free Software Foundation may publish new, revised versions 1576of the GNU Free Documentation License from time to time. Such new 1577versions will be similar in spirit to the present version, but may 1578differ in detail to address new problems or concerns. See 1579https://www.gnu.org/copyleft/. 1580 1581Each version of the License is given a distinguishing version number. 1582If the Document specifies that a particular numbered version of this 1583License "or any later version" applies to it, you have the option of 1584following the terms and conditions either of that specified version or 1585of any later version that has been published (not as a draft) by the 1586Free Software Foundation. If the Document does not specify a version 1587number of this License, you may choose any version ever published (not 1588as a draft) by the Free Software Foundation. 1589 1590 1591ADDENDUM: How to use this License for your documents 1592 1593To use this License in a document you have written, include a copy of 1594the License in the document and put the following copyright and 1595license notices just after the title page: 1596 1597 Copyright (c) YEAR YOUR NAME. 1598 Permission is granted to copy, distribute and/or modify this document 1599 under the terms of the GNU Free Documentation License, Version 1.2 1600 or any later version published by the Free Software Foundation; 1601 with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. 1602 A copy of the license is included in the section entitled "GNU 1603 Free Documentation License". 1604 1605If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, 1606replace the "with...Texts." line with this: 1607 1608 with the Invariant Sections being LIST THEIR TITLES, with the 1609 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST. 1610 1611If you have Invariant Sections without Cover Texts, or some other 1612combination of the three, merge those two alternatives to suit the 1613situation. 1614 1615If your document contains nontrivial examples of program code, we 1616recommend releasing these examples in parallel under your choice of 1617free software license, such as the GNU General Public License, 1618to permit their use in free software. 1619 1620The End. 1621