396 lines · plain
1What: /sys/accessibility/speakup/attrib_bleep2KernelVersion: 2.63Contact: speakup@linux-speakup.org4Description: Beeps the PC speaker when there is an attribute change such as5 foreground or background color when using speakup review6 commands. One = on, zero = off.7 8What: /sys/accessibility/speakup/bell_pos9KernelVersion: 2.610Contact: speakup@linux-speakup.org11Description: This works much like a typewriter bell. If for example 72 is12 echoed to bell_pos, it will beep the PC speaker when typing on13 a line past character 72.14 15What: /sys/accessibility/speakup/bleeps16KernelVersion: 2.617Contact: speakup@linux-speakup.org18Description: This controls whether one hears beeps through the PC speaker19 when using speakup's review commands.20 TODO: what values does it accept?21 22What: /sys/accessibility/speakup/bleep_time23KernelVersion: 2.624Contact: speakup@linux-speakup.org25Description: This controls the duration of the PC speaker beeps speakup26 produces.27 TODO: What are the units? Jiffies?28 29What: /sys/accessibility/speakup/cursor_time30KernelVersion: 2.631Contact: speakup@linux-speakup.org32Description: This controls cursor delay when using arrow keys. When a33 connection is very slow, with the default setting, when moving34 with the arrows, or backspacing etc. speakup says the incorrect35 characters. Set this to a higher value to adjust for the delay36 and better synchronisation between cursor position and speech.37 38What: /sys/accessibility/speakup/cur_phonetic39KernelVersion: 6.240Contact: speakup@linux-speakup.org41Description: This allows speakup to speak letters phoneticaly when arrowing through42 a word letter by letter. This doesn't affect the spelling when typing43 the characters. When cur_phonetic=1, speakup will speak characters44 phoneticaly when arrowing over a letter. When cur_phonetic=0, speakup45 will speak letters as normally.46 47What: /sys/accessibility/speakup/delimiters48KernelVersion: 2.649Contact: speakup@linux-speakup.org50Description: Delimit a word from speakup.51 TODO: add more info52 53What: /sys/accessibility/speakup/ex_num54KernelVersion: 2.655Contact: speakup@linux-speakup.org56Description: TODO:57 58What: /sys/accessibility/speakup/key_echo59KernelVersion: 2.660Contact: speakup@linux-speakup.org61Description: Controls if speakup speaks keys when they are typed. One = on,62 zero = off or don't echo keys.63 64What: /sys/accessibility/speakup/keymap65KernelVersion: 2.666Contact: speakup@linux-speakup.org67Description: Speakup keymap remaps keys to Speakup functions.68 It uses a binary69 format. A special program called genmap is needed to compile a70 textual keymap into the binary format which is then loaded into71 /sys/accessibility/speakup/keymap.72 73What: /sys/accessibility/speakup/no_interrupt74KernelVersion: 2.675Contact: speakup@linux-speakup.org76Description: Controls if typing interrupts output from speakup. With77 no_interrupt set to zero, typing on the keyboard will interrupt78 speakup if for example79 the say screen command is used before the80 entire screen is read.81 82 With no_interrupt set to one, if the say83 screen command is used, and one then types on the keyboard,84 speakup will continue to say the whole screen regardless until85 it finishes.86 87What: /sys/accessibility/speakup/punc_all88KernelVersion: 2.689Contact: speakup@linux-speakup.org90Description: This is a list of all the punctuation speakup should speak when91 punc_level is set to four.92 93What: /sys/accessibility/speakup/punc_level94KernelVersion: 2.695Contact: speakup@linux-speakup.org96Description: Controls the level of punctuation spoken as the screen is97 displayed, not reviewed. Levels range from zero no punctuation,98 to four, all punctuation. One corresponds to punc_some, two99 corresponds to punc_most, and three as well as four both100 correspond to punc_all. Some hardware synthesizers may have101 different levels each corresponding to three and four for102 punc_level. Also note that if punc_level is set to zero, and103 key_echo is set to one, typed punctuation is still spoken as it104 is typed.105 106What: /sys/accessibility/speakup/punc_most107KernelVersion: 2.6108Contact: speakup@linux-speakup.org109Description: This is a list of all the punctuation speakup should speak when110 punc_level is set to two.111 112What: /sys/accessibility/speakup/punc_some113KernelVersion: 2.6114Contact: speakup@linux-speakup.org115Description: This is a list of all the punctuation speakup should speak when116 punc_level is set to one.117 118What: /sys/accessibility/speakup/reading_punc119KernelVersion: 2.6120Contact: speakup@linux-speakup.org121Description: Almost the same as punc_level, the differences being that122 reading_punc controls the level of punctuation when reviewing123 the screen with speakup's screen review commands. The other124 difference is that reading_punc set to three speaks punc_all,125 and reading_punc set to four speaks all punctuation, including126 spaces.127 128What: /sys/accessibility/speakup/repeats129KernelVersion: 2.6130Contact: speakup@linux-speakup.org131Description: A list of characters speakup repeats. Normally, when there are132 more than three characters in a row, speakup133 just reads three of134 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 138What: /sys/accessibility/speakup/say_control139KernelVersion: 2.6140Contact: speakup@linux-speakup.org141Description: If set to one, speakup speaks shift, alt and control when those142 keys are pressed. If say_control is set to zero, shift, ctrl,143 and alt are not spoken when they are pressed.144 145What: /sys/accessibility/speakup/say_word_ctl146KernelVersion: 2.6147Contact: speakup@linux-speakup.org148Description: TODO:149 150What: /sys/accessibility/speakup/silent151KernelVersion: 2.6152Contact: speakup@linux-speakup.org153Description: TODO:154 155What: /sys/accessibility/speakup/spell_delay156KernelVersion: 2.6157Contact: speakup@linux-speakup.org158Description: This controls how fast a word is spelled159 when speakup's say word160 review command is pressed twice quickly to speak the current161 word being reviewed. Zero just speaks the letters one after162 another, while values one through four163 seem to introduce more of164 a pause between the spelling of each letter by speakup.165 166What: /sys/accessibility/speakup/synth167KernelVersion: 2.6168Contact: speakup@linux-speakup.org169Description: Gets or sets the synthesizer driver currently in use. Reading170 synth returns the synthesizer driver currently in use. Writing171 synth switches to the given synthesizer driver, provided it is172 either built into the kernel, or already loaded as a module.173 174What: /sys/accessibility/speakup/synth_direct175KernelVersion: 2.6176Contact: speakup@linux-speakup.org177Description: Sends whatever is written to synth_direct178 directly to the speech synthesizer in use, bypassing speakup.179 This could be used to make the synthesizer speak180 a string, or to181 send control sequences to the synthesizer to change how the182 synthesizer behaves.183 184What: /sys/accessibility/speakup/version185KernelVersion: 2.6186Contact: speakup@linux-speakup.org187Description: Reading version returns the version of speakup, and the version188 of the synthesizer driver currently in use.189 190What: /sys/accessibility/speakup/i18n/announcements191KernelVersion: 2.6192Contact: speakup@linux-speakup.org193Description: This file contains various general announcements, most of which194 cannot be categorized. You will find messages such as "You195 killed Speakup", "I'm alive", "leaving help", "parked",196 "unparked", and others. You will also find the names of the197 screen edges and cursor tracking modes here.198 199What: /sys/accessibility/speakup/i18n/chartab200KernelVersion: 2.6201Contact: speakup@linux-speakup.org202Description: TODO203 204What: /sys/accessibility/speakup/i18n/ctl_keys205KernelVersion: 2.6206Contact: speakup@linux-speakup.org207Description: Here, you will find names of control keys. These are used with208 Speakup's say_control feature.209 210What: /sys/accessibility/speakup/i18n/function_names211KernelVersion: 2.6212Contact: speakup@linux-speakup.org213Description: Here, you will find a list of names for Speakup functions.214 These are used by the help system. For example, suppose that215 you have activated help mode, and you pressed216 keypad 3. Speakup217 says: "keypad 3 is character, say next."218 The message "character, say next" names a Speakup function, and219 it comes from this function_names file.220 221What: /sys/accessibility/speakup/i18n/states222KernelVersion: 2.6223Contact: speakup@linux-speakup.org224Description: This file contains names for key states.225 Again, these are part of the help system. For instance, if you226 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 is230 speakup.231 232 This part of the message comes from the states collection.233 234What: /sys/accessibility/speakup/i18n/characters235KernelVersion: 2.6236Contact: speakup@linux-speakup.org237Description: Through this sys entry, Speakup gives you the ability to change238 how Speakup pronounces a given character. You could, for239 example, change how some punctuation characters are spoken. You240 can even change how Speakup will pronounce certain letters. For241 further details see '12. Changing the Pronunciation of242 Characters' in Speakup User's Guide (file spkguide.txt in243 source).244 245What: /sys/accessibility/speakup/i18n/colors246KernelVersion: 2.6247Contact: speakup@linux-speakup.org248Description: When you use the "say attributes" function, Speakup says the249 name of the foreground and background colors. These names come250 from the i18n/colors file.251 252What: /sys/accessibility/speakup/i18n/formatted253KernelVersion: 2.6254Contact: speakup@linux-speakup.org255Description: This group of messages contains embedded formatting codes, to256 specify the type and width of displayed data. If you change257 these, you must preserve all of the formatting codes, and they258 must appear in the order used by the default messages.259 260What: /sys/accessibility/speakup/i18n/key_names261KernelVersion: 2.6262Contact: speakup@linux-speakup.org263Description: Again, key_names is used by Speakup's help system. In the264 previous example, Speakup said that you pressed "keypad 3."265 This name came from the key_names file.266 267What: /sys/accessibility/speakup/<synth-name>/268KernelVersion: 2.6269Contact: speakup@linux-speakup.org270Description: In `/sys/accessibility/speakup` is a directory corresponding to271 the synthesizer driver currently in use (E.G) `soft` for the272 soft driver. This directory contains files which control the273 speech synthesizer itself,274 as opposed to controlling the speakup275 screen reader. The parameters in this directory have the same276 names and functions across all277 supported synthesizers. The range278 of values for freq, pitch, rate, and vol is the same for all279 supported synthesizers, with the given range being internally280 mapped by the driver to more or less fit the range of values281 supported for a given parameter by the individual synthesizer.282 Below is a description of values and parameters for soft283 synthesizer, which is currently the most commonly used.284 285What: /sys/accessibility/speakup/<synth-name>/caps_start286KernelVersion: 2.6287Contact: speakup@linux-speakup.org288Description: This is the string that is sent to the synthesizer to cause it289 to start speaking uppercase letters. For the soft synthesizer290 and most others, this causes the pitch of the voice to rise291 above the currently set pitch.292 293What: /sys/accessibility/speakup/<synth-name>/caps_stop294KernelVersion: 2.6295Contact: speakup@linux-speakup.org296Description: This is the string sent to the synthesizer to cause it to stop297 speaking uppercase letters. In the case of the soft synthesizer298 and most others, this returns the pitch of the voice299 down to the300 currently set pitch.301 302What: /sys/accessibility/speakup/<synth-name>/delay_time303KernelVersion: 2.6304Contact: speakup@linux-speakup.org305Description: TODO:306 307What: /sys/accessibility/speakup/<synth-name>/direct308KernelVersion: 2.6309Contact: speakup@linux-speakup.org310Description: Controls if punctuation is spoken by speakup, or by the311 synthesizer.312 313 For example, speakup speaks ">" as "greater", while314 the espeak synthesizer used by the soft driver speaks "greater315 than". Zero lets speakup speak the punctuation. One lets the316 synthesizer itself speak punctuation.317 318What: /sys/accessibility/speakup/<synth-name>/freq319KernelVersion: 2.6320Contact: speakup@linux-speakup.org321Description: Gets or sets the frequency of the speech synthesizer. Range is322 0-9.323 324What: /sys/accessibility/speakup/<synth-name>/flush_time325KernelVersion: 5.12326Contact: speakup@linux-speakup.org327Description: Gets or sets the timeout to wait for the synthesizer flush to328 complete. This can be used when the cable gets faulty and flush329 notifications are getting lost.330 331What: /sys/accessibility/speakup/<synth-name>/full_time332KernelVersion: 2.6333Contact: speakup@linux-speakup.org334Description: TODO:335 336What: /sys/accessibility/speakup/<synth-name>/jiffy_delta337KernelVersion: 2.6338Contact: speakup@linux-speakup.org339Description: This controls how many jiffys the kernel gives to the340 synthesizer. Setting this too high can make a system unstable,341 or even crash it.342 343What: /sys/accessibility/speakup/<synth-name>/pitch344KernelVersion: 2.6345Contact: speakup@linux-speakup.org346Description: Gets or sets the pitch of the synthesizer. The range is 0-9.347 348What: /sys/accessibility/speakup/<synth-name>/inflection349KernelVersion: 5.8350Contact: speakup@linux-speakup.org351Description: Gets or sets the inflection of the synthesizer, i.e. the pitch352 range. The range is 0-9.353 354What: /sys/accessibility/speakup/<synth-name>/punct355KernelVersion: 2.6356Contact: speakup@linux-speakup.org357Description: Gets or sets the amount of punctuation spoken by the358 synthesizer. The range for the soft driver seems to be 0-2.359 TODO: How is this related to speakup's punc_level, or360 reading_punc.361 362What: /sys/accessibility/speakup/<synth-name>/rate363KernelVersion: 2.6364Contact: speakup@linux-speakup.org365Description: Gets or sets the rate of the synthesizer. Range is from zero366 slowest, to nine fastest.367 368What: /sys/accessibility/speakup/<synth-name>/tone369KernelVersion: 2.6370Contact: speakup@linux-speakup.org371Description: Gets or sets the tone of the speech synthesizer. The range for372 the soft driver seems to be 0-2. This seems to make no373 difference if using espeak and the espeakup connector.374 TODO: does espeakup support different tonalities?375 376What: /sys/accessibility/speakup/<synth-name>/trigger_time377KernelVersion: 2.6378Contact: speakup@linux-speakup.org379Description: TODO:380 381What: /sys/accessibility/speakup/<synth-name>/voice382KernelVersion: 2.6383Contact: speakup@linux-speakup.org384Description: Gets or sets the voice used by the synthesizer if the385 synthesizer can speak in more than one voice. The range for the386 soft driver is 0-7. Note that while espeak supports multiple387 voices, this parameter will not set the voice when the espeakup388 connector is used between speakup and espeak.389 390What: /sys/accessibility/speakup/<synth-name>/vol391KernelVersion: 2.6392Contact: speakup@linux-speakup.org393Description: 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 396