0001 What: /sys/accessibility/speakup/attrib_bleep
0002 KernelVersion: 2.6
0003 Contact: speakup@linux-speakup.org
0004 Description: Beeps the PC speaker when there is an attribute change such as
0005 foreground or background color when using speakup review
0006 commands. One = on, zero = off.
0007
0008 What: /sys/accessibility/speakup/bell_pos
0009 KernelVersion: 2.6
0010 Contact: speakup@linux-speakup.org
0011 Description: This works much like a typewriter bell. If for example 72 is
0012 echoed to bell_pos, it will beep the PC speaker when typing on
0013 a line past character 72.
0014
0015 What: /sys/accessibility/speakup/bleeps
0016 KernelVersion: 2.6
0017 Contact: speakup@linux-speakup.org
0018 Description: This controls whether one hears beeps through the PC speaker
0019 when using speakup's review commands.
0020 TODO: what values does it accept?
0021
0022 What: /sys/accessibility/speakup/bleep_time
0023 KernelVersion: 2.6
0024 Contact: speakup@linux-speakup.org
0025 Description: This controls the duration of the PC speaker beeps speakup
0026 produces.
0027 TODO: What are the units? Jiffies?
0028
0029 What: /sys/accessibility/speakup/cursor_time
0030 KernelVersion: 2.6
0031 Contact: speakup@linux-speakup.org
0032 Description: This controls cursor delay when using arrow keys. When a
0033 connection is very slow, with the default setting, when moving
0034 with the arrows, or backspacing etc. speakup says the incorrect
0035 characters. Set this to a higher value to adjust for the delay
0036 and better synchronisation between cursor position and speech.
0037
0038 What: /sys/accessibility/speakup/delimiters
0039 KernelVersion: 2.6
0040 Contact: speakup@linux-speakup.org
0041 Description: Delimit a word from speakup.
0042 TODO: add more info
0043
0044 What: /sys/accessibility/speakup/ex_num
0045 KernelVersion: 2.6
0046 Contact: speakup@linux-speakup.org
0047 Description: TODO:
0048
0049 What: /sys/accessibility/speakup/key_echo
0050 KernelVersion: 2.6
0051 Contact: speakup@linux-speakup.org
0052 Description: Controls if speakup speaks keys when they are typed. One = on,
0053 zero = off or don't echo keys.
0054
0055 What: /sys/accessibility/speakup/keymap
0056 KernelVersion: 2.6
0057 Contact: speakup@linux-speakup.org
0058 Description: Speakup keymap remaps keys to Speakup functions.
0059 It uses a binary
0060 format. A special program called genmap is needed to compile a
0061 textual keymap into the binary format which is then loaded into
0062 /sys/accessibility/speakup/keymap.
0063
0064 What: /sys/accessibility/speakup/no_interrupt
0065 KernelVersion: 2.6
0066 Contact: speakup@linux-speakup.org
0067 Description: Controls if typing interrupts output from speakup. With
0068 no_interrupt set to zero, typing on the keyboard will interrupt
0069 speakup if for example
0070 the say screen command is used before the
0071 entire screen is read.
0072
0073 With no_interrupt set to one, if the say
0074 screen command is used, and one then types on the keyboard,
0075 speakup will continue to say the whole screen regardless until
0076 it finishes.
0077
0078 What: /sys/accessibility/speakup/punc_all
0079 KernelVersion: 2.6
0080 Contact: speakup@linux-speakup.org
0081 Description: This is a list of all the punctuation speakup should speak when
0082 punc_level is set to four.
0083
0084 What: /sys/accessibility/speakup/punc_level
0085 KernelVersion: 2.6
0086 Contact: speakup@linux-speakup.org
0087 Description: Controls the level of punctuation spoken as the screen is
0088 displayed, not reviewed. Levels range from zero no punctuation,
0089 to four, all punctuation. One corresponds to punc_some, two
0090 corresponds to punc_most, and three as well as four both
0091 correspond to punc_all. Some hardware synthesizers may have
0092 different levels each corresponding to three and four for
0093 punc_level. Also note that if punc_level is set to zero, and
0094 key_echo is set to one, typed punctuation is still spoken as it
0095 is typed.
0096
0097 What: /sys/accessibility/speakup/punc_most
0098 KernelVersion: 2.6
0099 Contact: speakup@linux-speakup.org
0100 Description: This is a list of all the punctuation speakup should speak when
0101 punc_level is set to two.
0102
0103 What: /sys/accessibility/speakup/punc_some
0104 KernelVersion: 2.6
0105 Contact: speakup@linux-speakup.org
0106 Description: This is a list of all the punctuation speakup should speak when
0107 punc_level is set to one.
0108
0109 What: /sys/accessibility/speakup/reading_punc
0110 KernelVersion: 2.6
0111 Contact: speakup@linux-speakup.org
0112 Description: Almost the same as punc_level, the differences being that
0113 reading_punc controls the level of punctuation when reviewing
0114 the screen with speakup's screen review commands. The other
0115 difference is that reading_punc set to three speaks punc_all,
0116 and reading_punc set to four speaks all punctuation, including
0117 spaces.
0118
0119 What: /sys/accessibility/speakup/repeats
0120 KernelVersion: 2.6
0121 Contact: speakup@linux-speakup.org
0122 Description: A list of characters speakup repeats. Normally, when there are
0123 more than three characters in a row, speakup
0124 just reads three of
0125 those characters. For example, "......" would be read as dot,
0126 dot, dot. If a . is added to the list of characters in repeats,
0127 "......" would be read as dot, dot, dot, times six.
0128
0129 What: /sys/accessibility/speakup/say_control
0130 KernelVersion: 2.6
0131 Contact: speakup@linux-speakup.org
0132 Description: If set to one, speakup speaks shift, alt and control when those
0133 keys are pressed. If say_control is set to zero, shift, ctrl,
0134 and alt are not spoken when they are pressed.
0135
0136 What: /sys/accessibility/speakup/say_word_ctl
0137 KernelVersion: 2.6
0138 Contact: speakup@linux-speakup.org
0139 Description: TODO:
0140
0141 What: /sys/accessibility/speakup/silent
0142 KernelVersion: 2.6
0143 Contact: speakup@linux-speakup.org
0144 Description: TODO:
0145
0146 What: /sys/accessibility/speakup/spell_delay
0147 KernelVersion: 2.6
0148 Contact: speakup@linux-speakup.org
0149 Description: This controls how fast a word is spelled
0150 when speakup's say word
0151 review command is pressed twice quickly to speak the current
0152 word being reviewed. Zero just speaks the letters one after
0153 another, while values one through four
0154 seem to introduce more of
0155 a pause between the spelling of each letter by speakup.
0156
0157 What: /sys/accessibility/speakup/synth
0158 KernelVersion: 2.6
0159 Contact: speakup@linux-speakup.org
0160 Description: Gets or sets the synthesizer driver currently in use. Reading
0161 synth returns the synthesizer driver currently in use. Writing
0162 synth switches to the given synthesizer driver, provided it is
0163 either built into the kernel, or already loaded as a module.
0164
0165 What: /sys/accessibility/speakup/synth_direct
0166 KernelVersion: 2.6
0167 Contact: speakup@linux-speakup.org
0168 Description: Sends whatever is written to synth_direct
0169 directly to the speech synthesizer in use, bypassing speakup.
0170 This could be used to make the synthesizer speak
0171 a string, or to
0172 send control sequences to the synthesizer to change how the
0173 synthesizer behaves.
0174
0175 What: /sys/accessibility/speakup/version
0176 KernelVersion: 2.6
0177 Contact: speakup@linux-speakup.org
0178 Description: Reading version returns the version of speakup, and the version
0179 of the synthesizer driver currently in use.
0180
0181 What: /sys/accessibility/speakup/i18n/announcements
0182 KernelVersion: 2.6
0183 Contact: speakup@linux-speakup.org
0184 Description: This file contains various general announcements, most of which
0185 cannot be categorized. You will find messages such as "You
0186 killed Speakup", "I'm alive", "leaving help", "parked",
0187 "unparked", and others. You will also find the names of the
0188 screen edges and cursor tracking modes here.
0189
0190 What: /sys/accessibility/speakup/i18n/chartab
0191 KernelVersion: 2.6
0192 Contact: speakup@linux-speakup.org
0193 Description: TODO
0194
0195 What: /sys/accessibility/speakup/i18n/ctl_keys
0196 KernelVersion: 2.6
0197 Contact: speakup@linux-speakup.org
0198 Description: Here, you will find names of control keys. These are used with
0199 Speakup's say_control feature.
0200
0201 What: /sys/accessibility/speakup/i18n/function_names
0202 KernelVersion: 2.6
0203 Contact: speakup@linux-speakup.org
0204 Description: Here, you will find a list of names for Speakup functions.
0205 These are used by the help system. For example, suppose that
0206 you have activated help mode, and you pressed
0207 keypad 3. Speakup
0208 says: "keypad 3 is character, say next."
0209 The message "character, say next" names a Speakup function, and
0210 it comes from this function_names file.
0211
0212 What: /sys/accessibility/speakup/i18n/states
0213 KernelVersion: 2.6
0214 Contact: speakup@linux-speakup.org
0215 Description: This file contains names for key states.
0216 Again, these are part of the help system. For instance, if you
0217 had pressed speakup + keypad 3, you would hear:
0218 "speakup keypad 3 is go to bottom edge."
0219
0220 The speakup key is depressed, so the name of the key state is
0221 speakup.
0222
0223 This part of the message comes from the states collection.
0224
0225 What: /sys/accessibility/speakup/i18n/characters
0226 KernelVersion: 2.6
0227 Contact: speakup@linux-speakup.org
0228 Description: Through this sys entry, Speakup gives you the ability to change
0229 how Speakup pronounces a given character. You could, for
0230 example, change how some punctuation characters are spoken. You
0231 can even change how Speakup will pronounce certain letters. For
0232 further details see '12. Changing the Pronunciation of
0233 Characters' in Speakup User's Guide (file spkguide.txt in
0234 source).
0235
0236 What: /sys/accessibility/speakup/i18n/colors
0237 KernelVersion: 2.6
0238 Contact: speakup@linux-speakup.org
0239 Description: When you use the "say attributes" function, Speakup says the
0240 name of the foreground and background colors. These names come
0241 from the i18n/colors file.
0242
0243 What: /sys/accessibility/speakup/i18n/formatted
0244 KernelVersion: 2.6
0245 Contact: speakup@linux-speakup.org
0246 Description: This group of messages contains embedded formatting codes, to
0247 specify the type and width of displayed data. If you change
0248 these, you must preserve all of the formatting codes, and they
0249 must appear in the order used by the default messages.
0250
0251 What: /sys/accessibility/speakup/i18n/key_names
0252 KernelVersion: 2.6
0253 Contact: speakup@linux-speakup.org
0254 Description: Again, key_names is used by Speakup's help system. In the
0255 previous example, Speakup said that you pressed "keypad 3."
0256 This name came from the key_names file.
0257
0258 What: /sys/accessibility/speakup/<synth-name>/
0259 KernelVersion: 2.6
0260 Contact: speakup@linux-speakup.org
0261 Description: In `/sys/accessibility/speakup` is a directory corresponding to
0262 the synthesizer driver currently in use (E.G) `soft` for the
0263 soft driver. This directory contains files which control the
0264 speech synthesizer itself,
0265 as opposed to controlling the speakup
0266 screen reader. The parameters in this directory have the same
0267 names and functions across all
0268 supported synthesizers. The range
0269 of values for freq, pitch, rate, and vol is the same for all
0270 supported synthesizers, with the given range being internally
0271 mapped by the driver to more or less fit the range of values
0272 supported for a given parameter by the individual synthesizer.
0273 Below is a description of values and parameters for soft
0274 synthesizer, which is currently the most commonly used.
0275
0276 What: /sys/accessibility/speakup/<synth-name>/caps_start
0277 KernelVersion: 2.6
0278 Contact: speakup@linux-speakup.org
0279 Description: This is the string that is sent to the synthesizer to cause it
0280 to start speaking uppercase letters. For the soft synthesizer
0281 and most others, this causes the pitch of the voice to rise
0282 above the currently set pitch.
0283
0284 What: /sys/accessibility/speakup/<synth-name>/caps_stop
0285 KernelVersion: 2.6
0286 Contact: speakup@linux-speakup.org
0287 Description: This is the string sent to the synthesizer to cause it to stop
0288 speaking uppercase letters. In the case of the soft synthesizer
0289 and most others, this returns the pitch of the voice
0290 down to the
0291 currently set pitch.
0292
0293 What: /sys/accessibility/speakup/<synth-name>/delay_time
0294 KernelVersion: 2.6
0295 Contact: speakup@linux-speakup.org
0296 Description: TODO:
0297
0298 What: /sys/accessibility/speakup/<synth-name>/direct
0299 KernelVersion: 2.6
0300 Contact: speakup@linux-speakup.org
0301 Description: Controls if punctuation is spoken by speakup, or by the
0302 synthesizer.
0303
0304 For example, speakup speaks ">" as "greater", while
0305 the espeak synthesizer used by the soft driver speaks "greater
0306 than". Zero lets speakup speak the punctuation. One lets the
0307 synthesizer itself speak punctuation.
0308
0309 What: /sys/accessibility/speakup/<synth-name>/freq
0310 KernelVersion: 2.6
0311 Contact: speakup@linux-speakup.org
0312 Description: Gets or sets the frequency of the speech synthesizer. Range is
0313 0-9.
0314
0315 What: /sys/accessibility/speakup/<synth-name>/flush_time
0316 KernelVersion: 5.12
0317 Contact: speakup@linux-speakup.org
0318 Description: Gets or sets the timeout to wait for the synthesizer flush to
0319 complete. This can be used when the cable gets faulty and flush
0320 notifications are getting lost.
0321
0322 What: /sys/accessibility/speakup/<synth-name>/full_time
0323 KernelVersion: 2.6
0324 Contact: speakup@linux-speakup.org
0325 Description: TODO:
0326
0327 What: /sys/accessibility/speakup/<synth-name>/jiffy_delta
0328 KernelVersion: 2.6
0329 Contact: speakup@linux-speakup.org
0330 Description: This controls how many jiffys the kernel gives to the
0331 synthesizer. Setting this too high can make a system unstable,
0332 or even crash it.
0333
0334 What: /sys/accessibility/speakup/<synth-name>/pitch
0335 KernelVersion: 2.6
0336 Contact: speakup@linux-speakup.org
0337 Description: Gets or sets the pitch of the synthesizer. The range is 0-9.
0338
0339 What: /sys/accessibility/speakup/<synth-name>/inflection
0340 KernelVersion: 5.8
0341 Contact: speakup@linux-speakup.org
0342 Description: Gets or sets the inflection of the synthesizer, i.e. the pitch
0343 range. The range is 0-9.
0344
0345 What: /sys/accessibility/speakup/<synth-name>/punct
0346 KernelVersion: 2.6
0347 Contact: speakup@linux-speakup.org
0348 Description: Gets or sets the amount of punctuation spoken by the
0349 synthesizer. The range for the soft driver seems to be 0-2.
0350 TODO: How is this related to speakup's punc_level, or
0351 reading_punc.
0352
0353 What: /sys/accessibility/speakup/<synth-name>/rate
0354 KernelVersion: 2.6
0355 Contact: speakup@linux-speakup.org
0356 Description: Gets or sets the rate of the synthesizer. Range is from zero
0357 slowest, to nine fastest.
0358
0359 What: /sys/accessibility/speakup/<synth-name>/tone
0360 KernelVersion: 2.6
0361 Contact: speakup@linux-speakup.org
0362 Description: Gets or sets the tone of the speech synthesizer. The range for
0363 the soft driver seems to be 0-2. This seems to make no
0364 difference if using espeak and the espeakup connector.
0365 TODO: does espeakup support different tonalities?
0366
0367 What: /sys/accessibility/speakup/<synth-name>/trigger_time
0368 KernelVersion: 2.6
0369 Contact: speakup@linux-speakup.org
0370 Description: TODO:
0371
0372 What: /sys/accessibility/speakup/<synth-name>/voice
0373 KernelVersion: 2.6
0374 Contact: speakup@linux-speakup.org
0375 Description: Gets or sets the voice used by the synthesizer if the
0376 synthesizer can speak in more than one voice. The range for the
0377 soft driver is 0-7. Note that while espeak supports multiple
0378 voices, this parameter will not set the voice when the espeakup
0379 connector is used between speakup and espeak.
0380
0381 What: /sys/accessibility/speakup/<synth-name>/vol
0382 KernelVersion: 2.6
0383 Contact: speakup@linux-speakup.org
0384 Description: Gets or sets the volume of the speech synthesizer. Range is 0-9,
0385 with zero being the softest, and nine being the loudest.
0386
