1 What: /sys/accessibility/speakup/attrib_bleep 2 KernelVersion: 2.6 3 Contact: speakup@linux-speakup.org 4 Description: Beeps the PC speaker when there is an attribute change such as 5 foreground or background color when using speakup review 6 commands. One = on, zero = off. 7 8 What: /sys/accessibility/speakup/bell_pos 9 KernelVersion: 2.6 10 Contact: speakup@linux-speakup.org 11 Description: This works much like a typewriter bell. If for example 72 is 12 echoed to bell_pos, it will beep the PC speaker when typing on 13 a line past character 72. 14 15 What: /sys/accessibility/speakup/bleeps 16 KernelVersion: 2.6 17 Contact: speakup@linux-speakup.org 18 Description: This controls whether one hears beeps through the PC speaker 19 when using speakup's review commands. 20 TODO: what values does it accept? 21 22 What: /sys/accessibility/speakup/bleep_time 23 KernelVersion: 2.6 24 Contact: speakup@linux-speakup.org 25 Description: This controls the duration of the PC speaker beeps speakup 26 produces. 27 TODO: What are the units? Jiffies? 28 29 What: /sys/accessibility/speakup/cursor_time 30 KernelVersion: 2.6 31 Contact: speakup@linux-speakup.org 32 Description: This controls cursor delay when using arrow keys. When a 33 connection is very slow, with the default setting, when moving 34 with the arrows, or backspacing etc. speakup says the incorrect 35 characters. Set this to a higher value to adjust for the delay 36 and better synchronisation between cursor position and speech. 37 38 What: /sys/accessibility/speakup/cur_phonetic 39 KernelVersion: 6.2 40 Contact: speakup@linux-speakup.org 41 Description: This allows speakup to speak letters phoneticaly when arrowing through 42 a word letter by letter. This doesn't affect the spelling when typing 43 the characters. When cur_phonetic=1, speakup will speak characters 44 phoneticaly when arrowing over a letter. When cur_phonetic=0, speakup 45 will speak letters as normally. 46 47 What: /sys/accessibility/speakup/delimiters 48 KernelVersion: 2.6 49 Contact: speakup@linux-speakup.org 50 Description: Delimit a word from speakup. 51 TODO: add more info 52 53 What: /sys/accessibility/speakup/ex_num 54 KernelVersion: 2.6 55 Contact: speakup@linux-speakup.org 56 Description: TODO: 57 58 What: /sys/accessibility/speakup/key_echo 59 KernelVersion: 2.6 60 Contact: speakup@linux-speakup.org 61 Description: Controls if speakup speaks keys when they are typed. One = on, 62 zero = off or don't echo keys. 63 64 What: /sys/accessibility/speakup/keymap 65 KernelVersion: 2.6 66 Contact: speakup@linux-speakup.org 67 Description: Speakup keymap remaps keys to Speakup functions. 68 It uses a binary 69 format. A special program called genmap is needed to compile a 70 textual keymap into the binary format which is then loaded into 71 /sys/accessibility/speakup/keymap. 72 73 What: /sys/accessibility/speakup/no_interrupt 74 KernelVersion: 2.6 75 Contact: speakup@linux-speakup.org 76 Description: Controls if typing interrupts output from speakup. With 77 no_interrupt set to zero, typing on the keyboard will interrupt 78 speakup if for example 79 the say screen command is used before the 80 entire screen is read. 81 82 With no_interrupt set to one, if the say 83 screen command is used, and one then types on the keyboard, 84 speakup will continue to say the whole screen regardless until 85 it finishes. 86 87 What: /sys/accessibility/speakup/punc_all 88 KernelVersion: 2.6 89 Contact: speakup@linux-speakup.org 90 Description: This is a list of all the punctuation speakup should speak when 91 punc_level is set to four. 92 93 What: /sys/accessibility/speakup/punc_level 94 KernelVersion: 2.6 95 Contact: speakup@linux-speakup.org 96 Description: Controls the level of punctuation spoken as the screen is 97 displayed, not reviewed. Levels range from zero no punctuation, 98 to four, all punctuation. One corresponds to punc_some, two 99 corresponds to punc_most, and three as well as four both 100 correspond to punc_all. Some hardware synthesizers may have 101 different levels each corresponding to three and four for 102 punc_level. Also note that if punc_level is set to zero, and 103 key_echo is set to one, typed punctuation is still spoken as it 104 is typed. 105 106 What: /sys/accessibility/speakup/punc_most 107 KernelVersion: 2.6 108 Contact: speakup@linux-speakup.org 109 Description: This is a list of all the punctuation speakup should speak when 110 punc_level is set to two. 111 112 What: /sys/accessibility/speakup/punc_some 113 KernelVersion: 2.6 114 Contact: speakup@linux-speakup.org 115 Description: This is a list of all the punctuation speakup should speak when 116 punc_level is set to one. 117 118 What: /sys/accessibility/speakup/reading_punc 119 KernelVersion: 2.6 120 Contact: speakup@linux-speakup.org 121 Description: Almost the same as punc_level, the differences being that 122 reading_punc controls the level of punctuation when reviewing 123 the screen with speakup's screen review commands. The other 124 difference is that reading_punc set to three speaks punc_all, 125 and reading_punc set to four speaks all punctuation, including 126 spaces. 127 128 What: /sys/accessibility/speakup/repeats 129 KernelVersion: 2.6 130 Contact: speakup@linux-speakup.org 131 Description: A list of characters speakup repeats. Normally, when there are 132 more than three characters in a row, speakup 133 just reads three of 134 those characters. For example, "......" would be read as dot, 135 dot, dot. If a . is added to the list of characters in repeats, 136 "......" would be read as dot, dot, dot, times six. 137 138 What: /sys/accessibility/speakup/say_control 139 KernelVersion: 2.6 140 Contact: speakup@linux-speakup.org 141 Description: If set to one, speakup speaks shift, alt and control when those 142 keys are pressed. If say_control is set to zero, shift, ctrl, 143 and alt are not spoken when they are pressed. 144 145 What: /sys/accessibility/speakup/say_word_ctl 146 KernelVersion: 2.6 147 Contact: speakup@linux-speakup.org 148 Description: TODO: 149 150 What: /sys/accessibility/speakup/silent 151 KernelVersion: 2.6 152 Contact: speakup@linux-speakup.org 153 Description: TODO: 154 155 What: /sys/accessibility/speakup/spell_delay 156 KernelVersion: 2.6 157 Contact: speakup@linux-speakup.org 158 Description: This controls how fast a word is spelled 159 when speakup's say word 160 review command is pressed twice quickly to speak the current 161 word being reviewed. Zero just speaks the letters one after 162 another, while values one through four 163 seem to introduce more of 164 a pause between the spelling of each letter by speakup. 165 166 What: /sys/accessibility/speakup/synth 167 KernelVersion: 2.6 168 Contact: speakup@linux-speakup.org 169 Description: Gets or sets the synthesizer driver currently in use. Reading 170 synth returns the synthesizer driver currently in use. Writing 171 synth switches to the given synthesizer driver, provided it is 172 either built into the kernel, or already loaded as a module. 173 174 What: /sys/accessibility/speakup/synth_direct 175 KernelVersion: 2.6 176 Contact: speakup@linux-speakup.org 177 Description: Sends whatever is written to synth_direct 178 directly to the speech synthesizer in use, bypassing speakup. 179 This could be used to make the synthesizer speak 180 a string, or to 181 send control sequences to the synthesizer to change how the 182 synthesizer behaves. 183 184 What: /sys/accessibility/speakup/version 185 KernelVersion: 2.6 186 Contact: speakup@linux-speakup.org 187 Description: Reading version returns the version of speakup, and the version 188 of the synthesizer driver currently in use. 189 190 What: /sys/accessibility/speakup/i18n/announcements 191 KernelVersion: 2.6 192 Contact: speakup@linux-speakup.org 193 Description: This file contains various general announcements, most of which 194 cannot be categorized. You will find messages such as "You 195 killed Speakup", "I'm alive", "leaving help", "parked", 196 "unparked", and others. You will also find the names of the 197 screen edges and cursor tracking modes here. 198 199 What: /sys/accessibility/speakup/i18n/chartab 200 KernelVersion: 2.6 201 Contact: speakup@linux-speakup.org 202 Description: TODO 203 204 What: /sys/accessibility/speakup/i18n/ctl_keys 205 KernelVersion: 2.6 206 Contact: speakup@linux-speakup.org 207 Description: Here, you will find names of control keys. These are used with 208 Speakup's say_control feature. 209 210 What: /sys/accessibility/speakup/i18n/function_names 211 KernelVersion: 2.6 212 Contact: speakup@linux-speakup.org 213 Description: Here, you will find a list of names for Speakup functions. 214 These are used by the help system. For example, suppose that 215 you have activated help mode, and you pressed 216 keypad 3. Speakup 217 says: "keypad 3 is character, say next." 218 The message "character, say next" names a Speakup function, and 219 it comes from this function_names file. 220 221 What: /sys/accessibility/speakup/i18n/states 222 KernelVersion: 2.6 223 Contact: speakup@linux-speakup.org 224 Description: This file contains names for key states. 225 Again, these are part of the help system. For instance, if you 226 had pressed speakup + keypad 3, you would hear: 227 "speakup keypad 3 is go to bottom edge." 228 229 The speakup key is depressed, so the name of the key state is 230 speakup. 231 232 This part of the message comes from the states collection. 233 234 What: /sys/accessibility/speakup/i18n/characters 235 KernelVersion: 2.6 236 Contact: speakup@linux-speakup.org 237 Description: Through this sys entry, Speakup gives you the ability to change 238 how Speakup pronounces a given character. You could, for 239 example, change how some punctuation characters are spoken. You 240 can even change how Speakup will pronounce certain letters. For 241 further details see '12. Changing the Pronunciation of 242 Characters' in Speakup User's Guide (file spkguide.txt in 243 source). 244 245 What: /sys/accessibility/speakup/i18n/colors 246 KernelVersion: 2.6 247 Contact: speakup@linux-speakup.org 248 Description: When you use the "say attributes" function, Speakup says the 249 name of the foreground and background colors. These names come 250 from the i18n/colors file. 251 252 What: /sys/accessibility/speakup/i18n/formatted 253 KernelVersion: 2.6 254 Contact: speakup@linux-speakup.org 255 Description: This group of messages contains embedded formatting codes, to 256 specify the type and width of displayed data. If you change 257 these, you must preserve all of the formatting codes, and they 258 must appear in the order used by the default messages. 259 260 What: /sys/accessibility/speakup/i18n/key_names 261 KernelVersion: 2.6 262 Contact: speakup@linux-speakup.org 263 Description: Again, key_names is used by Speakup's help system. In the 264 previous example, Speakup said that you pressed "keypad 3." 265 This name came from the key_names file. 266 267 What: /sys/accessibility/speakup/<synth-name>/ 268 KernelVersion: 2.6 269 Contact: speakup@linux-speakup.org 270 Description: In `/sys/accessibility/speakup` is a directory corresponding to 271 the synthesizer driver currently in use (E.G) `soft` for the 272 soft driver. This directory contains files which control the 273 speech synthesizer itself, 274 as opposed to controlling the speakup 275 screen reader. The parameters in this directory have the same 276 names and functions across all 277 supported synthesizers. The range 278 of values for freq, pitch, rate, and vol is the same for all 279 supported synthesizers, with the given range being internally 280 mapped by the driver to more or less fit the range of values 281 supported for a given parameter by the individual synthesizer. 282 Below is a description of values and parameters for soft 283 synthesizer, which is currently the most commonly used. 284 285 What: /sys/accessibility/speakup/<synth-name>/caps_start 286 KernelVersion: 2.6 287 Contact: speakup@linux-speakup.org 288 Description: This is the string that is sent to the synthesizer to cause it 289 to start speaking uppercase letters. For the soft synthesizer 290 and most others, this causes the pitch of the voice to rise 291 above the currently set pitch. 292 293 What: /sys/accessibility/speakup/<synth-name>/caps_stop 294 KernelVersion: 2.6 295 Contact: speakup@linux-speakup.org 296 Description: This is the string sent to the synthesizer to cause it to stop 297 speaking uppercase letters. In the case of the soft synthesizer 298 and most others, this returns the pitch of the voice 299 down to the 300 currently set pitch. 301 302 What: /sys/accessibility/speakup/<synth-name>/delay_time 303 KernelVersion: 2.6 304 Contact: speakup@linux-speakup.org 305 Description: TODO: 306 307 What: /sys/accessibility/speakup/<synth-name>/direct 308 KernelVersion: 2.6 309 Contact: speakup@linux-speakup.org 310 Description: Controls if punctuation is spoken by speakup, or by the 311 synthesizer. 312 313 For example, speakup speaks ">" as "greater", while 314 the espeak synthesizer used by the soft driver speaks "greater 315 than". Zero lets speakup speak the punctuation. One lets the 316 synthesizer itself speak punctuation. 317 318 What: /sys/accessibility/speakup/<synth-name>/freq 319 KernelVersion: 2.6 320 Contact: speakup@linux-speakup.org 321 Description: Gets or sets the frequency of the speech synthesizer. Range is 322 0-9. 323 324 What: /sys/accessibility/speakup/<synth-name>/flush_time 325 KernelVersion: 5.12 326 Contact: speakup@linux-speakup.org 327 Description: Gets or sets the timeout to wait for the synthesizer flush to 328 complete. This can be used when the cable gets faulty and flush 329 notifications are getting lost. 330 331 What: /sys/accessibility/speakup/<synth-name>/full_time 332 KernelVersion: 2.6 333 Contact: speakup@linux-speakup.org 334 Description: TODO: 335 336 What: /sys/accessibility/speakup/<synth-name>/jiffy_delta 337 KernelVersion: 2.6 338 Contact: speakup@linux-speakup.org 339 Description: This controls how many jiffys the kernel gives to the 340 synthesizer. Setting this too high can make a system unstable, 341 or even crash it. 342 343 What: /sys/accessibility/speakup/<synth-name>/pitch 344 KernelVersion: 2.6 345 Contact: speakup@linux-speakup.org 346 Description: Gets or sets the pitch of the synthesizer. The range is 0-9. 347 348 What: /sys/accessibility/speakup/<synth-name>/inflection 349 KernelVersion: 5.8 350 Contact: speakup@linux-speakup.org 351 Description: Gets or sets the inflection of the synthesizer, i.e. the pitch 352 range. The range is 0-9. 353 354 What: /sys/accessibility/speakup/<synth-name>/punct 355 KernelVersion: 2.6 356 Contact: speakup@linux-speakup.org 357 Description: Gets or sets the amount of punctuation spoken by the 358 synthesizer. The range for the soft driver seems to be 0-2. 359 TODO: How is this related to speakup's punc_level, or 360 reading_punc. 361 362 What: /sys/accessibility/speakup/<synth-name>/rate 363 KernelVersion: 2.6 364 Contact: speakup@linux-speakup.org 365 Description: Gets or sets the rate of the synthesizer. Range is from zero 366 slowest, to nine fastest. 367 368 What: /sys/accessibility/speakup/<synth-name>/tone 369 KernelVersion: 2.6 370 Contact: speakup@linux-speakup.org 371 Description: Gets or sets the tone of the speech synthesizer. The range for 372 the soft driver seems to be 0-2. This seems to make no 373 difference if using espeak and the espeakup connector. 374 TODO: does espeakup support different tonalities? 375 376 What: /sys/accessibility/speakup/<synth-name>/trigger_time 377 KernelVersion: 2.6 378 Contact: speakup@linux-speakup.org 379 Description: TODO: 380 381 What: /sys/accessibility/speakup/<synth-name>/voice 382 KernelVersion: 2.6 383 Contact: speakup@linux-speakup.org 384 Description: Gets or sets the voice used by the synthesizer if the 385 synthesizer can speak in more than one voice. The range for the 386 soft driver is 0-7. Note that while espeak supports multiple 387 voices, this parameter will not set the voice when the espeakup 388 connector is used between speakup and espeak. 389 390 What: /sys/accessibility/speakup/<synth-name>/vol 391 KernelVersion: 2.6 392 Contact: speakup@linux-speakup.org 393 Description: Gets or sets the volume of the speech synthesizer. Range is 0-9, 394 with zero being the softest, and nine being the loudest. 395
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.