Documentation/ABI/stable/sysfs-driver-speakup

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