Debian Codegraph @

Drivers/Braille/Papenmeier/README

raw
1 README file for the Papenmeier Driver
2 =====================================
3
4 Version 2.1 (October 2001)
5
6 Copyright
7 =========
8
9 This driver is copyrighted under the GNU Lesser General Public License.
10 It is free software. See the file 'LICENSE-LGPL' for more details.
11 Feel free to send your comments and to report bugs (if any :)) to us at
12 [email protected] or [email protected]
13
14 Supported Hardware
15 ==================
16 This driver is supposed to work with all the Papenmeier Terminals.
17 The driver is able to autodetect the connected terminal.
18
19 Connection
20 ==========
21 This driver supports serial and USB communication.
22
23 Running the Driver
24 ==================
25 To compile and run BRLTTY, please refer to the documentation about
26 BRLTTY itself. One note though: when BRLTTY starts, it will display
27 on the screen some copyright stuff, current configuration (model and
28 firmware version setup) and the device in use. That information
29 may be useful if nothing happens with the braille terminal.
30
31
32 Key Bindings and Status Cells
33 =============================
34 The driver is fully configurable - all key bindings and the status cells
35 can be fully programmed:
36
37 The configuration can be done by
38 - changing the default configuration in the source file brl-cfg.h
39 any changes will be distributed to the online help during compile
40 - edit the config file /etc/brltty/brltty-pm.conf; don't forget to supply
41 a fitting help file
42
43 If you don't want to use the config file you can safely remove the
44 config file /etc/brltty/brltty-pm.conf and use the compiled in
45 defaults. By default the driver is compiled with the READ_CONFIG
46 symbol defined. Without this symbols the code to read the config file
47 won't be compiled into the driver which yields a driver with a much
48 smaller size.
49
50 Help File:
51 ==========
52 The online help is generated from the compiled in defaults - it uses
53 the same syntax as the config file to give the user a short overview of
54 the status cells and the keymapping.
55 By default the help command is mapped to the key on the first status cell.
56
57 Config File
58 ===========
59 The configuration file may include the definitions for several terminals.
60 Look at Papenmeier/brltty-pm.conf and the Papenmeier/*.hlp files for
61 examples.
62
63 Syntax:
64 # Comment to the end of line
65 name = value you can use 'is' instead of '='; actually you don't have to
66 write '=', 'is' or 'and' at all. The following lines are equivalent:
67 name = val
68 name is val
69 name val
70
71 Start a new terminal definition:
72 identification = NUMBER
73 the number is the code returned by the terminal on identification
74 request; this starts a new terminal definition - no need to change this info
75
76 Info about the terminal - Name and size of the terminal:
77 terminal = "String to describe the Terminal"
78 helpfile = "brltty-pm1.hlp" # name of the helpfile
79 displaysize = 40 # number of cells
80 statuscells = 0 # number of status cells (horizontal or vertical)
81 frontkeys = 9 # number of keys on the front of the terminal
82 haseasybar # terminal has an easybar (EL types)
83
84 Terminal settings:
85 Statusdisplay settings:
86 there are different display modes:
87 flag: left half: line number, right half: no/all bits set - used with
88 vertical status cells
89 horiz: two digits on the vertical status-display
90 number: display two digits in one cell (status on horiz.display)
91 example:
92 status 4 = horiz cursorcol
93 status 6 = flag tracking
94 a list of the possible info to display (see brl.h and/or Papenmeier/hlp.auto.h)
95 current - current line number
96 row - cursor position - row
97 col - cursor position - column
98 tracking - cursor tracking
99 dispmode - dispmode (text / attribute)
100 frozen - screen frozen
101 visible - cursor visible
102 size - cursor size
103 blink - cursor blink
104 capitalblink - capital letter blink
105 dots - 6 or 8 dots
106 sound - sound
107 skip - skip identical lines
108 underline - attribute underlining
109 blinkattr - blinking of attribute underlining
110
111 Key definition:
112 status NUMBER - key on status cell
113 front NUMBER - key on the front side of the terminal
114 routing - one of the routing keys is pressed
115 easy DESCR - easy bar key
116 DESCR may be: left, left2, up, up2, down, down2, right, right2
117 switch NUMBER - switches on the left and right side of the
118 display; numbered from 1 (leftmost switch up) to 8 (rightmost switch down)
119
120 Modifier key settings:
121 any key can be defined as a modifier (like the shift or alt key on the
122 standard keyboard).
123
124 Input mode:
125 during inputmode the modifier keys are used to input the 8 dots of a
126 character. Attention: the modifiers keys are used to simulate
127 the different dots, so INPUTMODE or INPUTMODE OFF should be
128 mapped to a single key.
129
130 Commandkey settings:
131 list of definitions:
132 command = key
133 command = modifier and key
134 The command is executed on keypress; if you specify only modifiers
135 the command is executed when the first modifier is released.
136 For commands which toggle a setting it is possible to add ON or OFF to
137 the command to define a predictable state change
138 command ON = <as above>
139 command OFF = <as above>
140 A list of the possible commands (the following list is sometimes out of
141 date - see brldefs.h and/or Papenmeier/hlp.auto.h for the actual values), the names
142 may be used with or without the leading CMD_:
143 NOOP - do nothing
144 LNUP - go up one line
145 LNDN - go down one line
146 WINUP - go up several lines
147 WINDN - go down several lines
148 PRDIFLN - go up to line with different content
149 NXDIFLN - go down to line with different content
150 ATTRUP - go up to line with different attributes
151 ATTRDN - go down to line with different attributes
152 PRBLNKLN - go to last line of previous paragraph
153 NXBLNKLN - go to first line of next paragraph
154 PRSEARCH - search up for content of cut buffer
155 NXSEARCH - search down for content of cut buffer
156 TOP - go to top line
157 BOT - go to bottom line
158 TOP_LEFT - go to top-left corner
159 BOT_LEFT - go to bottom-left corner
160 CHRLT - go left one character
161 CHRRT - go right one character
162 HWINLT - go left one half window
163 HWINRT - go right one half window
164 FWINLT - go left one full window
165 FWINRT - go right one full window
166 FWINLTSKIP - go left to non-blank window
167 FWINRTSKIP - go right to non-blank window
168 LNBEG - go to beginning of line
169 LNEND - go to end of line
170 HOME - go to cursor
171 BACK - go to last motion
172 CSRJMP - route cursor to top-left corner of braille window
173 CSRJMP_VERT - route cursor to top line of window
174 CUT_BEG - cut text from top-left corner of braille window
175 CUT_END - cut text to bottom-right corner of braille window
176 PASTE - insert cut buffer at cursor
177 FREEZE - freeze/unfreeze screen
178 DISPMD - toggle display attributes/text
179 SIXDOTS - toggle text style 6-dot/8-dot
180 SLIDEWIN - toggle sliding window on/off
181 SKPIDLNS - toggle skipping of identical lines on/off
182 SKPBLNKWINS - toggle skipping of blank windows on/off
183 CSRVIS - toggle cursor visibility on/off
184 CSRHIDE_QK - toggle quick hide of cursor
185 CSRTRK - toggle cursor tracking on/off
186 CSRSIZE - toggle cursor style underline/block
187 CSRBLINK - toggle cursor blinking on/off
188 ATTRVIS - toggle attribute underlining on/off
189 ATTRBLINK - toggle attribute blinking on/off
190 CAPBLINK - toggle capital letter blinking on/off
191 SND - toggle sound on/off
192 HELP - display driver help
193 INFO - display status summary
194 PREFMENU - present preferences menu
195 PREFSAVE - save preferences
196 PREFLOAD - reload preferences
197 SAY - speak current line
198 SAYALL - speak rest of screen
199 MUTE - stop speaking immediately
200 SPKHOME - goto current/last speech position
201 SWITCHVT_PREV - switch to previous virtual terminal
202 SWITCHVT_NEXT - switch to next virtual terminal
203 RESTARTBRL - reinitialize braille driver
204 RESTARTSPEECH - reinitialize speech driver
205 INPUTMODE - toggle input mode
206 Values to be used in combination with "routing":
207 names may be used with or without the leading CR_:
208 ROUTEOFFSET - route cursor to character
209 BEGBLKOFFSET - define the beginning of a block
210 ENDBLKOFFSET - define the end of a block
211 SWITCHVT - switch virtual terminal
212 NXINDENT - find next line not more indented than routing key indicates
213 PRINDENT - find previous line not more indented than routing key indicates
214 MSGATTRIB - message attributes of character
215 Special commands to send keystrokes,
216 the names may be used with or without the leading VPK_:
217 RETURN - send RETURN key
218 TAB - send TAB key
219 BACKSPACE - send BACKSPACE key
220 ESCAPE - send ESCAPE key
221 CURSOR_LEFT - send CURSOR_LEFT key
222 CURSOR_RIGHT - send CURSOR_RIGHT key
223 CURSOR_UP - send CURSOR_UP key
224 CURSOR_DOWN - send CURSOR_DOWN key
225 PAGE_UP - send PAGE_UP key
226 PAGE_DOWN - send PAGE_DOWN key
227 HOME - send HOME key
228 END - send END key
229 INSERT - send INSERT key
230 DELETE - send DELETE key
231 FUNCTION - send FUNCTION key