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