Lines Matching full:the
2 The Speakup User's Guide
11 Copyright (c) 2009, 2010 the Speakup Team
14 under the terms of the GNU Free Documentation License, Version 1.2 or
15 any later version published by the Free Software Foundation; with no
17 copy of the license is included in the section entitled "GNU Free
22 The purpose of this document is to familiarize users with the user
24 for installing or obtaining Speakup, visit the web site at
25 http://linux-speakup.org/. Speakup is a set of patches to the standard
27 a part of a monolithic kernel. These details are beyond the scope of
28 this manual, but the user may need to be aware of the module
30 Speakup. If Speakup is built as a part of a monolithic kernel, and the
32 provide speech access from the time the kernel is loaded, until the time
33 the system is shutdown. This means that if you have obtained Linux
37 are beyond the scope of this manual, but the user should be aware of
38 them. See the web site mentioned above for further details.
49 It is possible, however, that Speakup may have been compiled into the
51 kernel has been compiled with support for some of the supported
52 synthesizers and not others. If you find that this is the case, and
53 your synthesizer is supported but not available, complain to the person
54 who compiled and installed your kernel. Or better yet, go to the web
60 the default one, then you may issue the following command at the boot
66 DoubleTalk LT at boot up. You may replace the ltlk synthesizer keyword
67 with the keyword for whatever synthesizer you wish to use. The
68 speakup.synth parameter will accept the following keywords, provided
69 that support for the related synthesizers has been built into the
87 NOT * support the internal Tripletalk!
97 See the sections on loading modules and software synthesizers later in
98 this manual for further details. It should be noted here that the
101 the boot process, such action must be configured by your system
103 the bootup messages.
107 Once you have booted the system, and if necessary, have supplied the
109 talking as soon as the kernel is loaded. In fact, it will talk a lot!
110 It will speak all the boot up messages that the kernel prints on the
111 screen during the boot process. This is because Speakup is not a
112 separate screen reader, but is actually built into the operating
113 system. Since almost all console applications must print text on the
114 screen using the kernel, and must get their keyboard input through the
118 Note: In this guide I will refer to the numeric keypad as the keypad.
119 This is done because the speakupmap.map file referred to later in this
120 manual uses the term keypad instead of numeric keypad. Also I'm lazy
123 Most of the Speakup review keys are located on the keypad at the far
124 right of the keyboard. The numlock key should be off, in order for these
125 to work. If you toggle the numlock on, the keypad will produce numbers,
126 which is exactly what you want for spreadsheets and such. For the
127 purposes of this guide, you should have the numlock turned off, which is
130 You probably won't want to listen to all the bootup messages every time
133 you during the boot process. You can always review these messages after
134 bootup with the command:
138 In order to speed the boot process, and to silence the speaking of the
139 bootup messages, just press the keypad enter key. This key is located
140 in the bottom right corner of the keypad. Speakup will shut up and stay
143 You can check to see if the boot process has completed by pressing the 8
144 key on the keypad, which reads the current line. This also has the
146 to silence it again if the boot process has not completed.
148 When the boot process is complete, you will arrive at a "login" prompt.
150 provided by your system administrator. You will hear Speakup speak the
151 letters of your user id as you type it, but not the password. This is
152 because the password is not displayed on the screen for security
161 speak new text as it arrives on the screen. You can at any time silence
162 the speech with keypad enter, or use any of the Speakup review keys.
169 the current character phonetically)
172 keypad 5 -- read current word (press twice rapidly to spell the current word)
175 keypad 8 -- read current line (press twice rapidly to hear how much the
176 text on the current line is indented)
181 It's also worth noting that the insert key on the keypad is mapped
182 as the speakup key. Instead of pressing and releasing this key, as you
185 insert, from now on called speakup, and keypad enter will toggle the
186 speaking of new text on the screen on and off. This is not the same as
187 just pressing keypad enter by itself, which just silences the speech
190 Speakup is turned off, no new text on the screen will be spoken. You
191 can still use the reading controls to review the screen however.
193 3. Using the Speakup Help System
195 In order to enter the Speakup help system, press and hold the speakup
196 key (remember that this is the keypad insert key), and press the f1 key.
197 You will hear the message:
202 When you press the spacebar to leave the help system, you will hear:
206 While you are in the Speakup help system, you can scroll up or down
207 through the list of available commands using the cursor keys. The list
209 commands in a specific part of the alphabet, you may press the letter of
210 the alphabet you wish to jump to.
213 cause Speakup to speak the command associated with that key. For
214 example, if you press the keypad 8 key, you will hear:
220 accessible through the sys system. We'll discuss the sys system later
225 for laptop users. The alternate speakup key is the caps lock key. You
226 can press and hold the caps lock key, while pressing an alternate
227 speakup command key to activate the command. On most laptops, the
228 numeric keypad is defined as the keys in the j k l area of the keyboard.
231 off, and some other key which controls the numlock state. Toggling the
239 beyond the scope of this manual. To use the caps lock for its normal
240 purpose, hold the shift key while toggling the caps lock on and off. We
241 should note here, that holding the caps lock key and pressing the z key
242 will toggle the alternate j k l keypad on and off.
246 In this section, we'll go through a list of all the speakup keys and
248 the help system.
250 The following list was taken from the speakupmap.map file. Key
251 assignments are on the left of the equal sign, and the associated
252 Speakup commands are on the right. The designation "spk" means to press
253 and hold the speakup key, a.k.a. keypad insert, a.k.a. caps lock, while
254 pressing the other specified key.
348 5. The Speakup Sys System
350 The Speakup screen reader also creates a speakup subdirectory as a part
351 of the sys system.
358 You can see these entries by typing the command:
362 If you issue the above ls command, you will get back something like
417 Notice the two subdirectories of /speakup: /speakup/i18n and
419 The i18n subdirectory is described in a later section.
420 The files under /speakup/soft represent settings that are specific to the
421 driver for the software synthesizer. If you use the LiteTalk, your
424 to the device whose keyword is KWD.
427 In addition to using the Speakup hot keys to change such things as
428 volume, pitch, and rate, you can also echo values to the appropriate
429 entry in the /speakup directory. This is very useful, since it
431 would write such scripts is somewhat beyond the scope of this manual,
435 Suppose for example, that you wanted to control both the punctuation
436 level and the reading punctuation level at the same time. For
437 simplicity, we'll call them punc0, punc1, punc2, and punc3. The scripts
469 path, perhaps /usr/local/bin, and set the permissions to 755 with the
470 chmod command, then you could change the default reading punc and
471 punctuation levels at the same time by issuing just one command. For
472 example, if you were to execute the punc3 command at your shell prompt,
473 then the reading punc and punc level would both get set to 3.
475 I should note that the above scripts were written to work with bash, but
479 The Speakup sys system also has another interesting use. You can echo
480 Speakup parameters into the sys system in a script during system
482 the system is rebooted.
484 Most of the Speakup sys parameters can be manipulated by a regular user
485 on the system. However, there are a few parameters that are dangerous
486 enough that they should only be manipulated by the root user on your
488 be written to at all. For example, the version entry in the Speakup
490 to tamper with the version number which is reported by Speakup. Doing
495 As you can see, the version entry in the Speakup sys system is read
496 only, is owned by root, and belongs to the root group. Doing a cat of
497 /speakup/version will display the Speakup version number, like
504 The display shows the Speakup version number, along with the version
505 number of the driver for the current synthesizer.
507 Looking at entries in the Speakup sys system can be useful in many
512 # Replace KWD with the keyword for your synthesizer, E.G., ltlk for LiteTalk.
515 The number five which comes back is the level at which the synthesizer
518 All the entries in the Speakup sys system are readable, some are
520 know what you are doing, you should probably leave the ones that are
521 writable by root only alone. Most of the names are self explanatory.
524 can post a query on the Speakup list.
529 running. In other words, it is not necessary to reboot the system
530 in order to use a different synthesizer. You can simply echo the
531 synthesizer keyword to the /speakup/synth sys entry.
532 Depending on your situation, you may wish to echo none to the synth
534 a second one is connected in its place. Then echo the keyword for the
535 new synthesizer into the synth sys entry in order to start speech
536 with the newly connected synthesizer. See the list of synthesizer
537 keywords in section 1 to find the keyword which matches your synth.
541 As mentioned earlier, Speakup can either be completely compiled into the
542 kernel, with the exception of the help module, or it can be compiled as
544 able to speak some of the bootup messages if your system administrator
545 has configured the system to load the modules at boo time. The modules
546 can be loaded after the file systems have been checked and mounted, or
548 with some components built into the kernel, and others as modules. As
549 we'll see in the next section, this is particularly useful when you are
552 If Speakup is completely compiled as modules, then you must use the
553 modprobe command to load Speakup. You do this by loading the module for
554 the synthesizer driver you wish to use. The driver modules are all
555 named speakup_<keyword>, where <keyword> is the keyword for the
556 synthesizer you want. So, in order to load the driver for the DecTalk
557 Express, you would type the following command:
561 Issuing this command would load the DecTalk Express driver and all other
565 as modules, you would give the command:
569 The above command assumes you were running a DecTalk Express. If you
575 For example, if you have loaded both the dectlk and ltlk drivers, use the
579 You cannot unload the driver for software synthesizers when a user-space
580 daemon is using /dev/softsynth. First, kill the daemon. Next, remove
581 the driver with the command:
584 Now, suppose we have a situation where the main Speakup component
585 is built into the kernel, and some or all of the drivers are built as
586 modules. Since the main part of Speakup is compiled into the kernel, a
588 of by simply echoing the synthesizer keyword into the
589 /speakup/synth sys entry. This will cause the kernel to
590 automatically load the appropriate driver module, and start Speakup
591 talking. To switch to another synth, just echo a new keyword to the
592 synth sys entry. For example, to load the DoubleTalk LT driver,
597 You can use the modprobe -r command to unload driver modules, regardless
598 of whether the main part of Speakup has been built into the kernel or
611 During the rest of this section, we assume that speakup_soft is either
615 software synthesizer, you must have created the /dev/softsynth device.
616 If you have not already done so, issue the following commands as root:
621 While we are at it, we might just as well create the /dev/synth device,
623 synthesizer. To create /dev/synth, change to the /dev directory, and
624 issue the following command as root:
632 Espeakup is a connector between Speakup and the eSpeak software synthesizer.
635 You can find it in the contrib/ subdirectory of the Speakup sources.
636 The filename is espeakup-$VERSION.tar.bz2, where $VERSION
637 depends on the current release of Espeakup. The Speakup 3.1.2 source
639 The README file included with the Espeakup sources describes the process
642 Assuming that Espeakup is installed, either by the user or by the distributor,
645 Tell Speakup to use the "soft driver:
648 Finally, start the espeakup program. There are two ways to do it.
652 you probably have a distribution-specific script that controls the operation
653 of the daemon. Look for a file named espeakup under /etc/init.d or
654 /etc/rc.d. Execute the following command with root privileges:
660 daemons are started by the bootup scripts.
663 If you built Espeakup manually, the "make install" step placed the binary
665 Run the following command as root:
676 might also choose to purchase the Software DecTalk from Fonix Sales Inc.
680 http://www.freebsoft.org/. Follow the installation instructions that
682 Dispatcher. You can check out the web site for your Linux distribution
689 You get it from the free(b)soft web site mentioned above. After you've
694 echo the soft keyword to the synth sys entry like this:
698 Next run the speechd_up command like this:
703 the pitch, rate, etc.
705 9. Using The DecTalk PC Card
707 The DecTalk PC card is an ISA card that is inserted into one of the ISA
708 slots in your computer. It requires that the DecTalk PC software be
709 installed on your computer, and that the software be loaded onto the
712 You can get the dec_pc.tgz file from the linux-speakup.org site. The
713 dec_pc.tgz file is in the ~ftp/pub/linux/speakup directory.
715 After you have downloaded the dec_pc.tgz file, untar it in your home
716 directory, and read the Readme file in the newly created dec_pc
719 The easiest way to get the software working is to copy the entire dec_pc
721 directory, and issue the command:
725 You will need to copy the dtload command from the dec_pc directory to a
729 You can now run the dtload command in order to load the DecTalk PC
730 software onto the card. After you have done this, echo the decpc
731 keyword to the synth entry in the sys system like this:
735 Your DecTalk PC should start talking, and then you can adjust the pitch,
736 rate, volume, voice, etc. The voice entry in the Speakup sys system
737 will accept a number from 0 through 7 for the DecTalk PC synthesizer,
738 which will give you access to some of the DecTalk voices.
744 automatically speak characters as you move left and right with the
745 cursor keys, and lines as you move up and down with the cursor keys.
746 This is the traditional sort of cursor tracking.
747 Recent versions of Speakup provide two additional ways to control the
748 text that is spoken when the cursor is moved:
754 You may select among the various forms of cursor tracking using the keypad
757 the name of the new mode. The names for the four possible states of cursor
759 and "cursoring off." The keypad asterisk key moves through the list of
763 rather than the cursor itself. When you move the cursor with the arrow keys,
764 Speakup speaks the currently highlighted information.
769 With the "read window" variety of cursor tracking, you can limit the text
770 that Speakup speaks by specifying a window of interest on the screen.
771 See section 15 for a description of the process of defining windows.
772 When you move the cursor via the arrow keys, Speakup only speaks
773 the contents of the window. This is especially helpful when you are hearing
774 superfluous speech. Consider the following example.
777 explore your command history using the up and down arrow keys. If you
779 Speakup speaks both your shell prompt and the current entry from the
780 command history. You may not want to hear the prompt repeated
782 the last line of text on the screen. Clear the current window by pressing
783 the key combination speakup f3. Use the review cursor to find the first
785 define a one-line window. The boundaries of the window are the
786 character following the shell prompt and the end of the line. Now, cycle
787 through the cursor tracking modes using keypad asterisk, until Speakup
789 You will notice that Speakup no longer speaks the redundant prompt.
791 Some folks like to turn cursor tracking off while they are using the
793 you are using the alsamixer application. Otherwise, you won't be able
794 to hear your mixer settings while you are using the arrow keys.
798 One of Speakup's more useful features is the ability to cut and paste
799 text on the screen. This means that you can capture information from a
800 program, and paste that captured text into a different place in the
807 past the following url into your browser:
811 Use the speakup review keys to position the reading cursor on the first
812 character of the above url. When the reading cursor is in position,
813 press the keypad slash key once. Speakup will say, "mark". Next,
814 position the reading cursor on the rightmost character of the above
815 url. Press the keypad slash key once again to actually cut the text
816 from the screen. Speakup will say, "cut". Although we call this
817 cutting, Speakup does not actually delete the cut text from the screen.
818 It makes a copy of the text in a special buffer for later pasting.
820 Now that you have the url cut from the screen, you can paste it into
821 your browser, or even paste the url on a command line as an argument to
824 Suppose you want to start lynx and go to the Speakup site.
826 You can switch to a different console with the alt left and right
832 type the word lynx, followed by a space. Now press and hold the speakup
833 key, while you type the keypad slash character. The url will be pasted
834 onto the command line, just as though you had typed it in. Press the
835 enter key to execute the command.
837 The paste buffer will continue to hold the cut information, until a new
838 mark and cut operation is carried out. This means you can paste the cut
842 You are not limited to cutting and pasting only one line on the screen.
843 You can also cut and paste rectangular regions of the screen. Just
844 position the reading cursor at the top left corner of the text to be
845 cut, mark it with the keypad slash key, then position the reading cursor
846 at the bottom right corner of the region to be cut, and cut it with the
849 12. Changing the Pronunciation of Characters
851 Through the /speakup/i18n/characters sys entry, Speakup gives you the
856 You may, for example, wish to change how Speakup pronounces the z
857 character. The author of Speakup, Kirk Reiser, is Canadian, and thus
858 believes that the z should be pronounced zed. If you are an American,
859 you might wish to use the zee pronunciation instead of zed. You can
860 change the pronunciation of both the upper and lower case z with the
866 Let's examine the parts of the two previous commands. They are issued
867 at the shell prompt, and could be placed in a startup script.
869 The word echo tells the shell that you want to have it display the
870 string of characters that follow the word echo. If you were to just
875 You would get the word hello printed on your screen as soon as you
876 pressed the enter key. In this case, we are echoing strings that we
877 want to be redirected into the sys system.
879 The numbers 90 and 122 in the above echo commands are the ascii numeric
880 values for the upper and lower case z, the characters we wish to change.
882 The string zee is the pronunciation that we want Speakup to use for the
885 The > symbol redirects the output of the echo command to a file, just
886 like in DOS, or at the Windows command prompt.
888 And finally, /speakup/i18n/characters is the file entry in the sys system
889 where we want the output to be directed. Speakup looks at the numeric
890 value of the character we want to change, and inserts the pronunciation
893 You can look at the whole table with the following command:
897 Speakup will then print out the entire character pronunciation table. I
902 Speakup has the capability of allowing you to assign or "map" keys to
905 configured with Speakup. How you do this is beyond the scope of this
906 manual. For this information, visit the Speakup web site at
907 http://linux-speakup.org/. The reason you'll need the kernel source
908 tree patched with Speakup is that the genmap utility you'll need for
909 processing keymaps is in the
910 /usr/src/linux-<version_number>/drivers/char/speakup directory. The
911 <version_number> in the above directory path is the version number of
912 the Linux source tree you are working with.
917 You can either use the
919 included with the Speakup source, or you can cut and paste the copy in
920 section 4 into a separate file. If you use the one in the Speakup
924 Suppose that you want to swap the key assignments for the Speakup
925 say_last_char and the Speakup say_first_char commands. The
926 speakupmap.map lists the key mappings for these two commands as follows:
931 You can edit your copy of the speakupmap.map file and swap the command
932 names on the right side of the = (equals) sign. You did make a backup,
933 right? The new keymap lines would look like this:
938 After you edit your copy of the speakupmap.map file, save it under a new
939 file name, perhaps newmap.map. Then exit your editor and return to the
943 Assuming that you saved your new keymap as the file newmap.map, you
944 would load your keymap into the sys system like this:
949 Remember to substitute your kernel version number for the
950 <version_number> in the above command. Also note that although the
955 speakup pagedown should read you the first non-whitespace character on
956 the line your reading cursor is in, and pressing speakup pageup should
957 read you the last character on the line your reading cursor is in.
963 find that all the mappings you didn't include in your file got deleted
964 from the working map. Be extremely careful, and always make a backup!
969 Speakup indicates various conditions to the user by speaking messages.
970 For instance, when you move to the left edge of the screen with the
975 In version 3.1.0 or higher, one may load translations for the various
976 messages via the /sys filesystem.
978 The directory /speakup/i18n contains several collections of messages.
980 The following section lists all of these files, along with a brief description
983 14.1. Files Under the i18n Subdirectory
989 You will also find the names of the screen edges and cursor tracking modes
996 See section 12. Unlike the rest of the files in the i18n subdirectory,
1000 When you use the "say attributes" function, Speakup says the name of the
1001 foreground and background colors. These names come from the i18n/colors
1010 the type and width of displayed data. If you change these, you must
1011 preserve all of the formatting codes, and they must appear in the order
1012 used by the default messages.
1016 by the help system. For example, suppose that you have activated help mode,
1019 The message "character, say next" names a Speakup function, and it
1023 Again, key_names is used by Speakup's help system. In the previous
1025 This name came from the key_names file.
1029 Again, these are part of the help system. For instance, if you had pressed
1032 The speakup key is depressed, so the name of the key state is speakup.
1033 This part of the message comes from the states collection.
1037 The files under the i18n subdirectory all follow the same format.
1039 Each message is represented by a number, followed by the text of the message.
1040 The number is the position of the message in the given collection.
1041 For example, if you view the file /speakup/i18n/colors, you will see the
1056 the cp command:
1058 You can change an individual message with the echo command,
1059 as shown in the following example.
1061 The Spanish name for the color blue is azul.
1062 Looking at the colors file, we see that the name "blue" is at position 1
1063 within the colors group. Let's change blue to azul:
1065 The next time that Speakup says message 1 from the colors group, it will
1068 In the future, translations into various languages will be made available,
1069 and most users will just load the files necessary for their language.
1073 As of the current release, Speakup only supports Western European languages.
1074 Support for the extended characters used by languages outside of the Western
1079 Speakup has the capability of defining and manipulating windows on the
1080 screen. Speakup uses the term "Window", to mean a user defined area of
1081 the screen. The key strokes for defining and manipulating Speakup
1084 speakup + f2 -- Set the bounds of the window.
1085 Speakup + f3 -- clear the current window definition.
1087 speakup + keypad plus -- Say the currently defined window.
1089 These capabilities are useful for tracking a certain part of the screen
1090 without rereading the whole screen, or for silencing a part of the
1097 In order to define a window, use the review keys to move your reading
1098 cursor to the beginning of the area you want to define. Then press
1099 speakup + f2. Speakup will tell you that the window starts at the
1100 indicated row and column position. Then move the reading cursor to the
1101 end of the area to be defined as a window, and press speakup + f2 again.
1102 If there is more than one line in the window, Speakup will tell you
1103 that the window ends at the indicated row and column position. If there
1104 is only one line in the window, then Speakup will tell you that the
1105 window is the specified line on the screen. If you are only defining a
1106 one line window, you can just press speakup + f2 twice after placing the
1107 reading cursor on the line you want to define as a window. It is not
1108 necessary to position the reading cursor at the end of the line in order
1109 to define the whole line as a window.
1113 The speakup distribution includes extra tools (in the tools directory)
1115 briefly describe the use of these tools.
1120 the speakup community. We would like to thank him for his work on the
1124 it isn't, the recommended places to put it are /usr/local/bin or
1129 by reading and writing the /sys files described above.
1131 The directory that speakupconf uses to store your settings depends on
1132 whether it is run from the root account. If you execute speakupconf as
1133 root, it uses the directory /etc/speakup. Otherwise, it uses the directory
1139 Use the command
1145 load or save the speakup parameters.
1149 Charles Hallenbeck, another member of the speakup community, wrote the
1154 part of your linux distribution, the recommended places to install it
1157 Talkwith allows you to switch synthesizers on the fly. It takes a synthesizer
1160 causes Speakup to use the DecTalk Express. If you wish to switch to a
1164 If you wish to use espeakup for software synthesis, give the command
1168 Any arguments that follow the name of the daemon are passed to the daemon
1171 causes espeakup to use the French voice.
1174 Talkwith does not attempt to load your settings after the new
1189 The purpose of this License is to make a manual, textbook, or other
1190 functional and useful document "free" in the sense of freedom: to
1191 assure everyone the effective freedom to copy and redistribute it,
1193 Secondarily, this License preserves for the author and publisher a way
1198 works of the document must themselves be free in the same sense. It
1199 complements the GNU General Public License, which is a copyleft
1204 program should come with manuals providing the same freedoms that the
1214 contains a notice placed by the copyright holder saying it can be
1215 distributed under the terms of this License. Such a notice grants a
1217 work under the conditions stated herein. The "Document", below,
1218 refers to any such manual or work. Any member of the public is a
1219 licensee, and is addressed as "you". You accept the license if you
1220 copy, modify or distribute the work in a way requiring permission
1223 A "Modified Version" of the Document means any work containing the
1228 the Document that deals exclusively with the relationship of the
1229 publishers or authors of the Document to the Document's overall subject
1231 within that overall subject. (Thus, if the Document is in part a
1233 mathematics.) The relationship could be a matter of historical
1234 connection with the subject or with related matters, or of legal,
1238 The "Invariant Sections" are certain Secondary Sections whose titles
1239 are designated, as being those of Invariant Sections, in the notice
1240 that says that the Document is released under this License. If a
1241 section does not fit the above definition of Secondary then it is not
1242 allowed to be designated as Invariant. The Document may contain zero
1243 Invariant Sections. If the Document does not identify any Invariant
1246 The "Cover Texts" are certain short passages of text that are listed,
1247 as Front-Cover Texts or Back-Cover Texts, in the notice that says that
1248 the Document is released under this License. A Front-Cover Text may
1251 A "Transparent" copy of the Document means a machine-readable copy,
1252 represented in a format whose specification is available to the
1253 general public, that is suitable for revising the document
1270 proprietary word processors, SGML or XML for which the DTD and/or
1271 processing tools are not generally available, and the
1275 The "Title Page" means, for a printed book, the title page itself,
1276 plus such following pages as are needed to hold, legibly, the material
1277 this License requires to appear in the title page. For works in
1279 the text near the most prominent appearance of the work's title,
1280 preceding the beginning of the body of the text.
1282 A section "Entitled XYZ" means a named subunit of the Document whose
1286 "Dedications", "Endorsements", or "History".) To "Preserve the Title"
1287 of such a section when you modify the Document means that it remains a
1290 The Document may include Warranty Disclaimers next to the notice which
1291 states that this License applies to the Document. These Warranty
1295 no effect on the meaning of this License.
1300 You may copy and distribute the Document in any medium, either
1301 commercially or noncommercially, provided that this License, the
1302 copyright notices, and the license notice saying this License applies
1303 to the Document are reproduced in all copies, and that you add no other
1305 technical measures to obstruct or control the reading or further
1306 copying of the copies you make or distribute. However, you may accept
1308 number of copies you must also follow the conditions in section 3.
1310 You may also lend copies, under the same conditions stated above, and
1317 printed covers) of the Document, numbering more than 100, and the
1318 Document's license notice requires Cover Texts, you must enclose the
1320 Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on
1321 the back cover. Both covers must also clearly and legibly identify
1322 you as the publisher of these copies. The front cover must present
1323 the full title with all words of the title equally prominent and
1324 visible. You may add other material on the covers in addition.
1325 Copying with changes limited to the covers, as long as they preserve
1326 the title of the Document and satisfy these conditions, can be treated
1329 If the required texts for either cover are too voluminous to fit
1330 legibly, you should put the first ones listed (as many as fit
1331 reasonably) on the actual cover, and continue the rest onto adjacent
1334 If you publish or distribute Opaque copies of the Document numbering
1337 a computer-network location from which the general network-using
1339 a complete Transparent copy of the Document, free of added material.
1340 If you use the latter option, you must take reasonably prudent steps,
1342 that this Transparent copy will remain thus accessible at the stated
1343 location until at least one year after the last time you distribute an
1345 edition to the public.
1347 It is requested, but not required, that you contact the authors of the
1349 them a chance to provide you with an updated version of the Document.
1354 You may copy and distribute a Modified Version of the Document under
1355 the conditions of sections 2 and 3 above, provided that you release
1356 the Modified Version under precisely this License, with the Modified
1357 Version filling the role of the Document, thus licensing distribution
1358 and modification of the Modified Version to whoever possesses a copy
1359 of it. In addition, you must do these things in the Modified Version:
1361 A. Use in the Title Page (and on the covers, if any) a title distinct
1362 from that of the Document, and from those of previous versions
1363 (which should, if there were any, be listed in the History section
1364 of the Document). You may use the same title as a previous version
1365 if the original publisher of that version gives permission.
1366 B. List on the Title Page, as authors, one or more persons or entities
1367 responsible for authorship of the modifications in the Modified
1368 Version, together with at least five of the principal authors of the
1371 C. State on the Title page the name of the publisher of the
1372 Modified Version, as the publisher.
1373 D. Preserve all the copyright notices of the Document.
1375 adjacent to the other copyright notices.
1376 F. Include, immediately after the copyright notices, a license notice
1377 giving the public permission to use the Modified Version under the
1378 terms of this License, in the form shown in the Addendum below.
1379 G. Preserve in that license notice the full lists of Invariant Sections
1380 and required Cover Texts given in the Document's license notice.
1382 I. Preserve the section Entitled "History", Preserve its Title, and add
1383 to it an item stating at least the title, year, new authors, and
1384 publisher of the Modified Version as given on the Title Page. If
1385 there is no section Entitled "History" in the Document, create one
1386 stating the title, year, authors, and publisher of the Document as
1387 given on its Title Page, then add an item describing the Modified
1388 Version as stated in the previous sentence.
1389 J. Preserve the network location, if any, given in the Document for
1390 public access to a Transparent copy of the Document, and likewise
1391 the network locations given in the Document for previous versions
1392 it was based on. These may be placed in the "History" section.
1394 least four years before the Document itself, or if the original
1395 publisher of the version it refers to gives permission.
1397 Preserve the Title of the section, and preserve in the section all
1398 the substance and tone of each of the contributor acknowledgements
1400 L. Preserve all the Invariant Sections of the Document,
1402 or the equivalent are not considered part of the section titles.
1404 may not be included in the Modified Version.
1409 If the Modified Version includes new front-matter sections or
1411 copied from the Document, you may at your option designate some or all
1412 of these sections as invariant. To do this, add their titles to the
1413 list of Invariant Sections in the Modified Version's license notice.
1418 parties--for example, statements of peer review or that the text has
1419 been approved by an organization as the authoritative definition of a
1423 passage of up to 25 words as a Back-Cover Text, to the end of the list
1424 of Cover Texts in the Modified Version. Only one passage of
1426 through arrangements made by) any one entity. If the Document already
1427 includes a cover text for the same cover, previously added by you or
1428 by arrangement made by the same entity you are acting on behalf of,
1429 you may not add another; but you may replace the old one, on explicit
1430 permission from the previous publisher that added the old one.
1432 The author(s) and publisher(s) of the Document do not by this License
1439 You may combine the Document with other documents released under this
1440 License, under the terms defined in section 4 above for modified
1441 versions, provided that you include in the combination all of the
1442 Invariant Sections of all of the original documents, unmodified, and
1446 The combined work need only contain one copy of this License, and
1448 copy. If there are multiple Invariant Sections with the same name but
1449 different contents, make the title of each such section unique by
1450 adding at the end of it, in parentheses, the name of the original
1452 Make the same adjustment to the section titles in the list of
1453 Invariant Sections in the license notice of the combined work.
1455 In the combination, you must combine any sections Entitled "History"
1456 in the various original documents, forming one section Entitled
1464 You may make a collection consisting of the Document and other documents
1465 released under this License, and replace the individual copies of this
1466 License in the various documents with a single copy that is included in
1467 the collection, provided that you follow the rules of this License for
1468 verbatim copying of each of the documents in all other respects.
1472 License into the extracted document, and follow this License in all
1478 A compilation of the Document or its derivatives with other separate
1480 distribution medium, is called an "aggregate" if the copyright
1481 resulting from the compilation is not used to limit the legal rights
1482 of the compilation's users beyond what the individual works permit.
1483 When the Document is included in an aggregate, this License does not
1484 apply to the other works in the aggregate which are not themselves
1485 derivative works of the Document.
1487 If the Cover Text requirement of section 3 is applicable to these
1488 copies of the Document, then if the Document is less than one half of
1489 the entire aggregate, the Document's Cover Texts may be placed on
1490 covers that bracket the Document within the aggregate, or the
1491 electronic equivalent of covers if the Document is in electronic form.
1492 Otherwise they must appear on printed covers that bracket the whole
1499 distribute translations of the Document under the terms of section 4.
1502 translations of some or all Invariant Sections in addition to the
1504 translation of this License, and all the license notices in the
1506 the original English version of this License and the original versions
1508 the translation and the original version of this License or a notice
1509 or disclaimer, the original version will prevail.
1511 If a section in the Document is Entitled "Acknowledgements",
1512 "Dedications", or "History", the requirement (section 4) to Preserve
1513 its Title (section 1) will typically require changing the actual
1519 You may not copy, modify, sublicense, or distribute the Document except
1521 copy, modify, sublicense or distribute the Document is void, and will
1530 The Free Software Foundation may publish new, revised versions
1531 of the GNU Free Documentation License from time to time. Such new
1532 versions will be similar in spirit to the present version, but may
1536 Each version of the License is given a distinguishing version number.
1537 If the Document specifies that a particular numbered version of this
1538 License "or any later version" applies to it, you have the option of
1539 following the terms and conditions either of that specified version or
1540 of any later version that has been published (not as a draft) by the
1541 Free Software Foundation. If the Document does not specify a version
1543 as a draft) by the Free Software Foundation.
1549 the License in the document and put the following copyright and
1550 license notices just after the title page:
1554 under the terms of the GNU Free Documentation License, Version 1.2
1555 or any later version published by the Free Software Foundation;
1557 A copy of the license is included in the section entitled "GNU
1561 replace the "with...Texts." line with this:
1563 with the Invariant Sections being LIST THEIR TITLES, with the
1564 Front-Cover Texts being LIST, and with the Back-Cover Texts being LIST.
1567 combination of the three, merge those two alternatives to suit the
1572 free software license, such as the GNU General Public License,
1575 The End.