sysfs-driver-speakup 14 KB

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