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