Move /var/svc/log to /var/log/svc
[unleashed/lotheac.git] / share / man / man4 / keytables.4
blobde6c0916e2e1af6b8c3b702be6e6f8a1d0c5d8ea
1 '\" te
2 .\"  Copyright (c) 2003 Sun Microsystems, Inc.  All Rights Reserved.
3 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
4 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
5 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
6 .TH KEYTABLES 4 "Feb 18, 2003"
7 .SH NAME
8 keytables \- keyboard table descriptions for loadkeys and dumpkeys
9 .SH DESCRIPTION
10 .sp
11 .LP
12 These files are used by \fBloadkeys\fR(1) to modify the translation tables used
13 by the keyboard streams module and generated from those translation tables. See
14 \fBloadkeys\fR(1).
15 .sp
16 .LP
17 Any line in the file beginning with \fB#\fR is a comment, and is ignored.
18 \fB#\fR is treated specially only at the beginning of a line.
19 .sp
20 .LP
21 Other lines specify the values to load into the tables for a particular
22 keystation.  The format is either:
23 .sp
24 .in +2
25 .nf
26 \fBkey\fR \fInumber list_of_entries\fR
27 .fi
28 .in -2
29 .sp
31 .sp
32 .LP
34 .sp
35 .in +2
36 .nf
37 \fBswap\fR \fInumber1\fR \fBwith\fR \fInumber2\fR
38 .fi
39 .in -2
40 .sp
42 .sp
43 .LP
45 .sp
46 .in +2
47 .nf
48 \fBkey\fR \fInumber1\fR \fBsame as\fR \fInumber2\fR
49 .fi
50 .in -2
51 .sp
53 .sp
54 .LP
55 or a blank line, which is ignored.
56 .sp
57 .in +2
58 .nf
59 \fBkey\fR \fInumber list_of_entries\fR
60 .fi
61 .in -2
62 .sp
64 .sp
65 .LP
66 sets the entries for keystation \fInumber\fR from the list given.  An entry in
67 that list is of the form
68 .sp
69 .in +2
70 .nf
71 \fItablename\fR \fIcode\fR
72 .fi
73 .in -2
74 .sp
76 .sp
77 .LP
78 where \fItablename\fR is the name of a particular translation table, or
79 \fBall\fR. The translation tables are:
80 .sp
81 .ne 2
82 .na
83 \fB\fBbase\fR\fR
84 .ad
85 .RS 9n
86 entry when no shifts are active
87 .RE
89 .sp
90 .ne 2
91 .na
92 \fB\fBshift\fR\fR
93 .ad
94 .RS 9n
95 entry when "Shift" key is down
96 .RE
98 .sp
99 .ne 2
101 \fB\fBcaps\fR\fR
103 .RS 9n
104 entry when "Caps Lock" is in effect
108 .ne 2
110 \fB\fBctrl\fR\fR
112 .RS 9n
113 entry when "Control" is down
117 .ne 2
119 \fB\fBaltg\fR\fR
121 .RS 9n
122 entry when "Alt Graph" is down
126 .ne 2
128 \fB\fBnuml\fR\fR
130 .RS 9n
131 entry when "Num Lock" is in effect
135 .ne 2
137 \fB\fBup\fR\fR
139 .RS 9n
140 entry when a key goes up
145 All tables other than \fBup\fR refer to the action generated when a key goes
146 down.  Entries in the \fBup\fR table are used only for shift keys, since the
147 shift in question goes away when the key goes up, except for keys such as "Caps
148 Lock" or "Num Lock"; the keyboard streams module makes the key look as if it
149 were a latching key.
152 A table name of \fBall\fR indicates that the entry for all tables should be set
153 to the specified value, with the following exception: for entries with a value
154 other than \fBhole\fR, the entry for the \fBnuml\fR table should be set to
155 \fBnonl\fR, and the entry for the \fBup\fR table should be set to \fBnop\fR.
158 The \fIcode\fR specifies the effect of the key in question when the specified
159 shift key is down. A \fIcode\fR consists of either:
160 .RS +4
162 .ie t \(bu
163 .el o
164 A character, which indicates that the key should generate the given character.
165 The character can either be a single character, a single character preceded by
166 \fB^\fR which refers to a "control character" (for instance, \fB^c\fR is
167 control-C), or a C-style character constant enclosed in single quote characters
168 (\fB\&'\fR), which can be expressed with C-style escape sequences such as \er
169 for \fBRETURN\fR or \e000 for the null character.  Note that the single
170 character may be any character in an 8-bit character set, such as ISO 8859/1.
172 .RS +4
174 .ie t \(bu
175 .el o
176 A string, consisting of a list of characters enclosed in double quote
177 characters (\fB"\fR). Note that the use of the double quote character means
178 that a \fIcode\fR of double quote must be enclosed in single quotes.
180 .RS +4
182 .ie t \(bu
183 .el o
184 One of the following expressions:
188 .ne 2
190 \fB\fBshiftkeys+leftshift\fR\fR
192 .sp .6
193 .RS 4n
194 the key is to be the left-hand "Shift" key
198 .ne 2
200 \fB\fBshiftkeys+rightshift\fR\fR
202 .sp .6
203 .RS 4n
204 the key is to be the right-hand "Shift" key
208 .ne 2
210 \fB\fBshiftkeys+leftctrl\fR\fR
212 .sp .6
213 .RS 4n
214 the key is to be the left-hand "Control" key
218 .ne 2
220 \fB\fBshiftkeys+rightctrl\fR\fR
222 .sp .6
223 .RS 4n
224 the key is to be the right-hand "Control" key
228 .ne 2
230 \fB\fBshiftkeys+alt\fR\fR
232 .sp .6
233 .RS 4n
234 the key is to be the "Alt" shift key
238 .ne 2
240 \fB\fBshiftkeys+altgraph\fR\fR
242 .sp .6
243 .RS 4n
244 the key is to be the "Alt Graph" shift key
248 .ne 2
250 \fB\fBshiftkeys+capslock\fR\fR
252 .sp .6
253 .RS 4n
254 the key is to be the "Caps Lock" key
258 .ne 2
260 \fB\fBshiftkeys+shiftlock\fR\fR
262 .sp .6
263 .RS 4n
264 the key is to be the "Shift Lock" key
268 .ne 2
270 \fB\fBshiftkeys+numlock\fR\fR
272 .sp .6
273 .RS 4n
274 the key is to be the "Num Lock" key
278 .ne 2
280 \fB\fBbuckybits+systembit\fR\fR
282 .sp .6
283 .RS 4n
284 the key is to be the "Stop" key in SunView; this is normally the L1 key, or the
285 SETUP key on the VT100 keyboard
289 .ne 2
291 \fB\fBbuckybits+metabit\fR\fR
293 .sp .6
294 .RS 4n
295 the key is to be the "meta" key. That is, the "Left" or "Right" key on a Sun-2
296 or Sun-3 keyboard or the "diamond" key on a Sun-4 keyboard
300 .ne 2
302 \fB\fBcompose\fR\fR
304 .sp .6
305 .RS 4n
306 the key is to be the "Compose" key
310 .ne 2
312 \fB\fBctrlq\fR\fR
314 .sp .6
315 .RS 4n
316 on the "VT100" keyboard, the key is to transmit the control-Q character (this
317 would be the entry for the "Q" key in the \fBctrl\fR table)
321 .ne 2
323 \fB\fBctrls\fR\fR
325 .sp .6
326 .RS 4n
327 on the "VT100" keyboard, the key is to transmit the control-S character (this
328 would be the entry for the "S" key in the \fBctrl\fR table)
332 .ne 2
334 \fB\fBnoscroll\fR\fR
336 .sp .6
337 .RS 4n
338 on the "VT100" keyboard, the key is to be the "No Scroll" key
342 .ne 2
344 \fB\fBstring+uparrow\fR\fR
346 .sp .6
347 .RS 4n
348 the key is to be the "up arrow" key
352 .ne 2
354 \fB\fBstring+downarrow\fR\fR
356 .sp .6
357 .RS 4n
358 the key is to be the "down arrow" key
362 .ne 2
364 \fB\fBstring+leftarrow\fR\fR
366 .sp .6
367 .RS 4n
368 the key is to be the "left arrow" key
372 .ne 2
374 \fB\fBstring+rightarrow\fR\fR
376 .sp .6
377 .RS 4n
378 the key is to be the "right arrow" key
382 .ne 2
384 \fB\fBstring+homearrow\fR\fR
386 .sp .6
387 .RS 4n
388 the key is to be the "home" key
392 .ne 2
394 \fB\fBfa_acute\fR\fR
396 .sp .6
397 .RS 4n
398 the key is to be the acute accent "floating accent" key
402 .ne 2
404 \fB\fBfa_cedilla\fR\fR
406 .sp .6
407 .RS 4n
408 the key is to be the cedilla "floating accent" key
412 .ne 2
414 \fB\fBfa_cflex\fR\fR
416 .sp .6
417 .RS 4n
418 the key is to be the circumflex "floating accent" key
422 .ne 2
424 \fB\fBfa_grave\fR\fR
426 .sp .6
427 .RS 4n
428 the key is to be the grave accent "floating accent" key
432 .ne 2
434 \fB\fBfa_tilde\fR\fR
436 .sp .6
437 .RS 4n
438 the key is to be the tilde "floating accent" key
442 .ne 2
444 \fB\fBfa_umlaut\fR\fR
446 .sp .6
447 .RS 4n
448 the key is to be the umlaut "floating accent" key
452 .ne 2
454 \fB\fBnonl\fR\fR
456 .sp .6
457 .RS 4n
458 this is used only in the Num Lock table; the key is not to be affected by the
459 state of Num Lock
463 .ne 2
465 \fB\fBpad0\fR\fR
467 .sp .6
468 .RS 4n
469 the key is to be the "0" key on the numeric keypad
473 .ne 2
475 \fB\fBpad1\fR\fR
477 .sp .6
478 .RS 4n
479 the key is to be the "1" key on the numeric keypad
483 .ne 2
485 \fB\fBpad2\fR\fR
487 .sp .6
488 .RS 4n
489 the key is to be the "2" key on the numeric keypad
493 .ne 2
495 \fB\fBpad3\fR\fR
497 .sp .6
498 .RS 4n
499 the key is to be the "3" key on the numeric keypad
503 .ne 2
505 \fB\fBpad4\fR\fR
507 .sp .6
508 .RS 4n
509 the key is to be the "4" key on the numeric keypad
513 .ne 2
515 \fB\fBpad5\fR\fR
517 .sp .6
518 .RS 4n
519 the key is to be the "5" key on the numeric keypad
523 .ne 2
525 \fB\fBpad6\fR\fR
527 .sp .6
528 .RS 4n
529 the key is to be the "6" key on the numeric keypad
533 .ne 2
535 \fB\fBpad7\fR\fR
537 .sp .6
538 .RS 4n
539 the key is to be the "7" key on the numeric keypad
543 .ne 2
545 \fB\fBpad8\fR\fR
547 .sp .6
548 .RS 4n
549 the key is to be the "8" key on the numeric keypad
553 .ne 2
555 \fB\fBpad9\fR\fR
557 .sp .6
558 .RS 4n
559 the key is to be the "9" key on the numeric keypad
563 .ne 2
565 \fB\fBpaddot\fR\fR
567 .sp .6
568 .RS 4n
569 the key is to be the "." key on the numeric keypad
573 .ne 2
575 \fB\fBpadenter\fR\fR
577 .sp .6
578 .RS 4n
579 the key is to be the "Enter" key on the numeric keypad
583 .ne 2
585 \fB\fBpadplus\fR\fR
587 .sp .6
588 .RS 4n
589 the key is to be the "+" key on the numeric keypad
593 .ne 2
595 \fB\fBpadminus\fR\fR
597 .sp .6
598 .RS 4n
599 the key is to be the "\(mi" key on the numeric keypad
603 .ne 2
605 \fB\fBpadstar\fR\fR
607 .sp .6
608 .RS 4n
609 the key is to be the "*" key on the numeric keypad
613 .ne 2
615 \fB\fBpadslash\fR\fR
617 .sp .6
618 .RS 4n
619 the key is to be the "/" key on the numeric keypad
623 .ne 2
625 \fB\fBpadequal\fR\fR
627 .sp .6
628 .RS 4n
629 the key is to be the "=" key on the numeric keypad
633 .ne 2
635 \fB\fBpadsep\fR\fR
637 .sp .6
638 .RS 4n
639 the key is to be the "," (separator) key on the numeric keypad
643 .ne 2
645 \fB\fBlf(\fIn\fR)\fR\fR
647 .sp .6
648 .RS 4n
649 the key is to be the left-hand function key \fIn\fR
653 .ne 2
655 \fB\fBrf(\fIn\fR)\fR\fR
657 .sp .6
658 .RS 4n
659 the key is to be the right-hand function key \fIn\fR
663 .ne 2
665 \fB\fBtf(\fIn\fR)\fR\fR
667 .sp .6
668 .RS 4n
669 the key is to be the top function key \fIn\fR
673 .ne 2
675 \fB\fBbf(\fIn\fR)\fR\fR
677 .sp .6
678 .RS 4n
679 the key is to be the "bottom" function key \fIn\fR
683 .ne 2
685 \fB\fBnop\fR\fR
687 .sp .6
688 .RS 4n
689 the key is to do nothing
693 .ne 2
695 \fB\fBerror\fR\fR
697 .sp .6
698 .RS 4n
699 this code indicates an internal error; to be used only for keystation 126, and
700 must be used there
704 .ne 2
706 \fB\fBidle\fR\fR
708 .sp .6
709 .RS 4n
710 this code indicates that the keyboard is idle (that is, has no keys down); to
711 be used only for all entries other than the \fBnuml\fR and \fBup\fR table
712 entries for keystation 127, and must be used there
716 .ne 2
718 \fB\fBoops\fR\fR
720 .sp .6
721 .RS 4n
722 this key exists, but its action is not defined; it has the same effect as
723 \fBnop\fR
727 .ne 2
729 \fB\fBreset\fR\fR
731 .sp .6
732 .RS 4n
733 this code indicates that the keyboard has just been reset; to be used only for
734 the \fBup\fR table entry for keystation 127, and must be used there.
738 .ne 2
740 \fB\fBswap\fR \fInumber1\fR with \fInumber2\fR\fR
742 .sp .6
743 .RS 4n
744 exchanges the entries for keystations \fInumber1\fR and \fInumber2\fR.
748 .ne 2
750 \fB\fBkey \fInumber1\fR\fR same as \fInumber2\fR\fR
752 .sp .6
753 .RS 4n
754 sets the entries for keystation \fInumber1\fR to be the same as those for
755 keystation \fInumber2\fR. If the file does not specify entries for keystation
756 \fInumber2\fR, the entries currently in the translation table are used; if the
757 file does specify entries for keystation \fInumber2\fR, those entries are used.
763 .SH EXAMPLES
765 \fBExample 1 \fRExample of setting multiple keystations.
768 The following entry sets keystation 15 to be a "hole" (that is, an entry
769 indicating that there is no keystation 15); sets keystation 30 to do nothing
770 when Alt Graph is down, generate "!" when Shift is down, and generate "1" under
771 all other circumstances; and sets keystation 76 to be the left-hand Control
772 key.
775 .in +2
777 key 15   all hole
778 key 30   base 1 shift ! caps 1 ctrl 1 altg nop
779 key 76   all shiftkeys+leftctrl up shiftkeys+leftctrl
781 .in -2
785 \fBExample 2 \fRExchange DELETE and BACKSPACE keys
788 The following entry exchanges the Delete and Back Space keys on the Type 4
789 keyboard:
792 .in +2
794 swap 43 with 66
796 .in -2
801 Keystation 43 is normally the Back Space key, and keystation 66 is normally the
802 Delete key.
805 \fBExample 3 \fRDisable CAPS LOCK key
808 The following entry disables the Caps Lock key on the Type 3 and U.S. Type 4
809 keyboards:
812 .in +2
814 key 119 all nop
816 .in -2
820 \fBExample 4 \fRStandard translation tables for the U.S. Type 4 keyboard
823 The following specifies the standard translation tables for the U.S. Type 4
824 keyboard:
827 .in +2
829 key 0    all hole
830 key 1    all buckybits+systembit up buckybits+systembit
831 key 2    all hole
832 key 3    all lf(2)
833 key 4    all hole
834 key 5    all tf(1)
835 key 6    all tf(2)
836 key 7    all tf(10)
837 key 8    all tf(3)
838 key 9    all tf(11)
839 key 10   all tf(4)
840 key 11   all tf(12)
841 key 12   all tf(5)
842 key 13   all shiftkeys+altgraph up shiftkeys+altgraph
843 key 14   all tf(6)
844 key 15   all hole
845 key 16   all tf(7)
846 key 17   all tf(8)
847 key 18   all tf(9)
848 key 19   all shiftkeys+alt up shiftkeys+alt
849 key 20   all hole
850 key 21   all rf(1)
851 key 22   all rf(2)
852 key 23   all rf(3)
853 key 24   all hole
854 key 25   all lf(3)
855 key 26   all lf(4)
856 key 27   all hole
857 key 28   all hole
858 key 29   all ^[
859 key 30   base 1 shift ! caps 1 ctrl 1 altg nop
860 key 31   base 2 shift @ caps 2 ctrl ^@ altg nop
861 key 32   base 3 shift # caps 3 ctrl 3 altg nop
862 key 33   base 4 shift $ caps 4 ctrl 4 altg nop
863 key 34   base 5 shift % caps 5 ctrl 5 altg nop
864 key 35   base 6 shift ^ caps 6 ctrl ^^ altg nop
865 key 36   base 7 shift & caps 7 ctrl 7 altg nop
866 key 37   base 8 shift * caps 8 ctrl 8 altg nop
867 key 38   base 9 shift ( caps 9 ctrl 9 altg nop
868 key 39   base 0 shift ) caps 0 ctrl 0 altg nop
869 key 40   base - shift _ caps - ctrl ^_ altg nop
870 key 41   base = shift + caps = ctrl = altg nop
871 key 42   base ` shift ~ caps ` ctrl ^^ altg nop
872 key 43   all '\eb'
873 key 44   all hole
874 key 45   all rf(4) numl padequal
875 key 46   all rf(5) numl padslash
876 key 47   all rf(6) numl padstar
877 key 48   all bf(13)
878 key 49   all lf(5)
879 key 50   all bf(10) numl padequal
880 key 51   all lf(6)
881 key 52   all hole
882 key 53   all '\et'
883 key 54   base q shift Q caps Q ctrl ^Q altg nop
884 key 55   base w shift W caps W ctrl ^W altg nop
885 key 56   base e shift E caps E ctrl ^E altg nop
886 key 57   base r shift R caps R ctrl ^R altg nop
887 key 58   base t shift T caps T ctrl ^T altg nop
888 key 59   base y shift Y caps Y ctrl ^Y altg nop
889 key 60   base u shift U caps U ctrl ^U altg nop
890 key 61   base i shift I caps I ctrl '\et' altg nop
891 key 62   base o shift O caps O ctrl ^O altg nop
892 key 63   base p shift P caps P ctrl ^P altg nop
893 key 64   base [ shift { caps [ ctrl ^[ altg nop
894 key 65   base ] shift } caps ] ctrl ^] altg nop
895 key 66   all '\e177'
896 key 67   all compose
897 key 68   all rf(7) numl pad7
898 key 69   all rf(8) numl pad8
899 key 70   all rf(9) numl pad9
900 key 71   all bf(15) numl padminus
901 key 72   all lf(7)
902 key 73   all lf(8)
903 key 74   all hole
904 key 75   all hole
905 key 76   all shiftkeys+leftctrl up shiftkeys+leftctrl
906 key 77   base a shift A caps A ctrl ^A altg nop
907 key 78   base s shift S caps S ctrl ^S altg nop
908 key 79   base d shift D caps D ctrl ^D altg nop
909 key 80   base f shift F caps F ctrl ^F altg nop
910 key 81   base g shift G caps G ctrl ^G altg nop
911 key 82   base h shift H caps H ctrl '\eb' altg nop
912 key 83   base j shift J caps J ctrl '\en' altg nop
913 key 84   base k shift K caps K ctrl '\ev' altg nop
914 key 85   base l shift L caps L ctrl ^L altg nop
915 key 86   base ; shift : caps ; ctrl ; altg nop
916 key 87   base '\e'' shift '"' caps '\e'' ctrl '\e'' altg nop
917 key 88   base '\e\e' shift | caps '\e\e' ctrl ^\e altg nop
918 key 89   all '\er'
919 key 90   all bf(11) numl padenter
920 key 91   all rf(10) numl pad4
921 key 92   all rf(11) numl pad5
922 key 93   all rf(12) numl pad6
923 key 94   all bf(8) numl pad0
924 key 95   all lf(9)
925 key 96   all hole
926 key 97   all lf(10)
927 key 98   all shiftkeys+numlock
928 key 99   all shiftkeys+leftshift up shiftkeys+leftshift
929 key 100  base z shift Z caps Z ctrl ^Z altg nop
930 key 101  base x shift X caps X ctrl ^X altg nop
931 key 102  base c shift C caps C ctrl ^C altg nop
932 key 103  base v shift V caps V ctrl ^V altg nop
933 key 104  base b shift B caps B ctrl ^B altg nop
934 key 105  base n shift N caps N ctrl ^N altg nop
935 key 106  base m shift M caps M ctrl '\er' altg nop
936 key 107  base , shift < caps , ctrl , altg nop
937 key 108  base . shift > caps . ctrl . altg nop
938 key 109  base / shift ? caps / ctrl ^_ altg nop
939 key 110  all shiftkeys+rightshift up shiftkeys+rightshift
940 key 111  all '\en'
941 key 112  all rf(13) numl pad1
942 key 113  all rf(14) numl pad2
943 key 114  all rf(15) numl pad3
944 key 115  all hole
945 key 116  all hole
946 key 117  all hole
947 key 118  all lf(16)
948 key 119  all shiftkeys+capslock
949 key 120  all buckybits+metabit up buckybits+metabit
950 key 121  base ' ' shift ' ' caps ' ' ctrl ^@ altg ' '
951 key 122  all buckybits+metabit up buckybits+metabit
952 key 123  all hole
953 key 124  all hole
954 key 125  all bf(14) numl padplus
955 key 126  all error numl error up hole
956 key 127  all idle numl idle up reset
958 .in -2
961 .SH SEE ALSO
964 \fBloadkeys\fR(1)