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