1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
|
#!/bin/bash -p
###############################################################################
# BRLTTY - A background process providing access to the console screen (when in
# text mode) for a blind person using a refreshable braille display.
#
# Copyright (C) 1995-2025 by The BRLTTY Developers.
#
# BRLTTY comes with ABSOLUTELY NO WARRANTY.
#
# This is free software, placed under the terms of the
# GNU Lesser General Public License, as published by the Free Software
# Foundation; either version 2.1 of the License, or (at your option) any
# later version. Please see the file LICENSE-LGPL for details.
#
# Web Page: http://brltty.app/
#
# This software is maintained by Dave Mielke <dave@mielke.cc>.
###############################################################################
defaultOutputRoot="doc-ktb"
. "`dirname "${0}"`/brltty-prologue.sh"
addProgramOption s string.directory sourceRoot "top-level directory of source tree" "the location of this script"
addProgramOption b string.directory buildRoot "top-level directory of build tree" "the source tree"
addProgramOption o string.directory outputRoot "top-level directory of output tree" "${defaultOutputRoot}"
addProgramOption k flag keepFiles "don't remove intermediate files"
parseProgramArguments "${@}"
set -e
umask 022
shopt -s nullglob
[ -n "${sourceRoot}" ] || sourceRoot="$(dirname "${0}")"
verifyInputDirectory "${sourceRoot}"
sourceRoot="$(cd "${sourceRoot}" && pwd)"
[ -n "${buildRoot}" ] || buildRoot="${sourceRoot}"
buildRoot="$(cd "${buildRoot}" && pwd)"
[ -n "${outputRoot}" ] || outputRoot="${defaultOutputRoot}"
verifyOutputDirectory "${outputRoot}"
unset HOME
export XDG_CONFIG_HOME=/
export XDG_CONFIG_DIRS=/
readonly newLine=$'\n'
lineGroups=()
newLineGroup() {
local variable="${1}"
local group="lineGroup${#lineGroups[*]}"
lineGroups+=("${group}")
setVariable "${variable}" "${group}"
declare -g -a "${group}"
eval "${group}=()"
}
addLineToGroup() {
local group="${1}"
local line="${2}"
eval "${group}+="'("${line}")'
}
newDocLines() {
newLineGroup docLines
}
beginTocEntries() {
local variable="${1}"
newLineGroup "${variable}"
newDocLines
addLineToGroup "${!variable}" "<ul>"
}
endTocEntries() {
local group="${1}"
addLineToGroup "${group}" "</ul>"
}
addTocEntry() {
local group="${1}"
local title="${2}"
local anchor="${3}"
addLineToGroup "${group}" "<li><a href=\"#${anchor}\">${title}</a></li>"
}
addDocLine() {
local line="${1}"
addLineToGroup "${docLines}" "${line}"
}
addSectionTerminator() {
addDocLine "<hr />"
}
addAnchor() {
local anchor="${1}"
addDocLine "<a name=\"${anchor}\"></a>"
}
beginDocument() {
local title="${1}"
newDocLines
headerLevel=0
addDocLine "<?xml version=\"1.0\" encoding=\"utf-8\" ?>"
addDocLine "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">"
addDocLine "<html xmlns=\"http://www.w3.org/1999/xhtml\" lang=\"en\" xml:lang=\"en\">"
addDocLine "<head>"
addDocLine "<title>${title}</title>"
addDocLine "</head>"
addDocLine "<body>"
}
endDocument() {
local file="${1}"
addDocLine "</body>"
addDocLine "</html>"
exec 3>"${file}"
local group
for group in "${lineGroups[@]}"
do
eval set -- '"${'"${group}"'[@]}"'
local line
for line
do
echo >&3 "${line}"
done
done
exec 3>&-
}
beginSection() {
local title="${1}"
local anchor="${title,,?}"
anchor="${anchor//[^a-zA-Z_0-9]/-}"
addAnchor "${anchor}"
headerLevel=$((headerLevel + 1))
addDocLine "<h${headerLevel}>${title}</h${headerLevel}>"
if ((headerLevel == 1))
then
beginTocEntries tocSections
addSectionTerminator
else
addTocEntry "${tocSections}" "${title}" "${anchor}"
fi
}
endSection() {
if ((headerLevel == 1))
then
endTocEntries "${tocSections}"
else
addSectionTerminator
fi
headerLevel=$((headerLevel - 1))
}
beginLayoutList() {
layoutListed=false
}
endLayoutList() {
! "${layoutListed}" || {
addDocLine "</ul>"
}
}
beginLayoutEntry() {
local prefix="${1}"
local outputExtension="${2}"
local layout="${inputFile##*/}"
layout="${layout%.*}"
outputFile="${outputRoot}/${prefix}-${layout}.${outputExtension}"
}
endLayoutEntry() {
local category="${1}"
exec 4<"${outputFile%.*}.${plainTextExtension}"
local description
read -r -u 4 description
exec 4<&-
description="${description} "
description="${description#*: }"
[ -z "${category}" ] || description="${description#${category} }"
description="${description% }"
local prefix="All Models"
[ -z "${description}" ] || {
if [ "${description}" = "${description#(}" ]
then
prefix=""
else
prefix="${prefix} "
fi
}
description="${prefix}${description}"
"${layoutListed}" || {
layoutListed=true
addDocLine "<ul>"
}
addDocLine "<li><a href=\"${outputFile##*/}\">${description}</a></li>"
}
listKeyTable() {
local driver="${1}"
local input="${inputFile##*/}"
local output="${outputFile%.*}"
local name="${output##*/}"
local command=( "${keyTableLister}" -D"${buildRoot}/lib" -T"${sourceRoot}/${tablesSubdirectory}" )
[ -n "${driver}" ] && command+=( -b "${driver}" )
"${command[@]}" -l "${input}" >"${output}.${plainTextExtension}" || {
rm -f "${output}.${plainTextExtension}"
return 1
}
"${command[@]}" -r "${input}" >"${output}.${reStructuredTextExtension}"
sed -e "2a\\${newLine}* \`Help Screen Version <${name}.${plainTextExtension}>\`_" -i "${output}.${reStructuredTextExtension}"
rst2html --config "${sourceRoot}/docutils.conf" "${output}.${reStructuredTextExtension}" "${output}.${hypertextExtension}"
"${keepFiles}" || rm "${output}.${reStructuredTextExtension}"
}
listBrailleKeyTables() {
beginSection "Braille Device Key Bindings"
addDocLine "The driver automatically selects the appropriate key table for the device model being used."
addDocLine "Click on the driver's name for general information about it."
addDocLine "Click on the device model for its key bindings."
local tocDrivers
beginTocEntries tocDrivers
addDocLine "<dl>"
local driverDirectory
for driverDirectory in "${driversDirectory}/"*
do
[ -d "${driverDirectory}" ] || continue
local driverName="${driverDirectory##*/}"
local driverCode="$(sed -n '/^DRIVER_CODE *=/s/^.*= *\([^ ]*\).*$/\1/p' "${driverDirectory}/Makefile.in")"
local header="${driverName}"
local inputFile="${driverDirectory}/README"
[ ! -f "${inputFile}" ] || {
local outputFile="${outputRoot}/${braillePrefix}-${driverCode}.${plainTextExtension}"
cp -a -- "${inputFile}" "${outputFile}"
header="<a href=\"${outputFile##*/}\">${header}</a>"
}
local anchor="${braillePrefix}-${driverCode}"
addTocEntry "${tocDrivers}" "${driverName}" "${anchor}"
addDocLine "<dt>"
addAnchor "${anchor}"
addDocLine "${header}"
addDocLine "</dt><dd>"
beginLayoutList
set -- "${tablesDirectory}/${brailleSubdirectory}/${driverCode}/"*".${keyTableExtension}"
if [ "${#}" -gt 0 ]
then
for inputFile
do
beginLayoutEntry "${braillePrefix}-${driverCode}" "${hypertextExtension}"
listKeyTable "${driverCode}" || continue
endLayoutEntry "${driverName}"
done
else
set -- "${tablesDirectory}/${brailleSubdirectory}/${driverCode}/"*".${plainTextExtension}"
for inputFile
do
beginLayoutEntry "${braillePrefix}-${driverCode}" "${plainTextExtension}"
cp -a -- "${inputFile}" "${outputFile}"
endLayoutEntry "${driverName}"
done
fi
endLayoutList
addDocLine "</dd>"
done
addDocLine "</dl>"
endTocEntries "${tocDrivers}"
endSection
}
listKeyboardKeyTables() {
beginSection "Keyboard Key Tables"
addDocLine "In order to use one of these keyboard tables,"
addDocLine "you need to explicitly specify it in one of the following ways:"
addDocLine "<ul>"
addDocLine "<li>Use BRLTTY's <tt>-k</tt> (or <tt>--keyboard-table=</tt>) command line option.</li>"
addDocLine "<li>Use the <tt>keyboard-table</tt> configuration file (<tt>brltty.conf</tt>) directive.</li>"
addDocLine "</ul>"
beginLayoutList
set -- "${tablesDirectory}/${keyboardSubdirectory}/"*".${keyTableExtension}"
local inputFile
for inputFile
do
beginLayoutEntry "${keyboardPrefix}" "${hypertextExtension}"
listKeyTable || continue
endLayoutEntry
done
endLayoutList
endSection
}
driversSubdirectory="Drivers/Braille"
driversDirectory="${sourceRoot}/${driversSubdirectory}"
tablesSubdirectory="Tables"
tablesDirectory="${sourceRoot}/${tablesSubdirectory}"
brailleSubdirectory="Input"
keyboardSubdirectory="Keyboard"
braillePrefix="brl"
keyboardPrefix="kbd"
plainTextExtension="txt"
reStructuredTextExtension="rst"
hypertextExtension="html"
keyTableExtension="ktb"
keyTableLister="${buildRoot}/Programs/brltty-ktb"
make -C "${keyTableLister%/*}" -s "${keyTableLister##*/}"
documentTitle="Key Binding Lists"
beginDocument "${documentTitle}"
beginSection "${documentTitle}"
listBrailleKeyTables
listKeyboardKeyTables
endSection
endDocument "${outputRoot}/index.${hypertextExtension}"
exit 0
|
