spkguide.txt 67 KB

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