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