1.\"
2.\" Copyright (c) 1999
3.\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\" notice, this list of conditions and the following disclaimer as
11.\" the first lines of this file unmodified.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\" notice, this list of conditions and the following disclaimer in the
14.\" documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
| 1.\"
2.\" Copyright (c) 1999
3.\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\" notice, this list of conditions and the following disclaimer as
11.\" the first lines of this file unmodified.
12.\" 2. Redistributions in binary form must reproduce the above copyright
13.\" notice, this list of conditions and the following disclaimer in the
14.\" documentation and/or other materials provided with the distribution.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26.\"
|
27.\" $FreeBSD: head/share/man/man4/atkbd.4 69027 2000-11-22 09:35:58Z ru $
| 27.\" $FreeBSD: head/share/man/man4/atkbd.4 70466 2000-12-29 09:18:45Z ru $
|
28.\"
29.Dd May 21, 1999
30.Dt ATKBD 4
31.Os FreeBSD
32.Sh NAME
33.Nm atkbd
34.Nd the AT keyboard interface
35.Sh SYNOPSIS
36.Cd "options ATKBD_DFLT_KEYMAP"
37.Cd "makeoptions ATKBD_DFLT_KEYMAP=_keymap_name_"
38.Cd "options KBD_DISABLE_KEYMAP_LOAD"
39.Cd "device atkbd0 at atkbdc? irq 1"
40.Sh DESCRIPTION
41The
42.Nm
43driver, together with the
44.Nm atkbdc
45driver, provides access to the AT 84 keyboard or the AT enhanced keyboard
46which is connected to the AT keyboard controller.
47.Pp
48This driver is required for the console drivers
49.Xr syscons 4
50and
51.Xr pcvt 4 .
52.Pp
53There can be only one
54.Nm
55device defined in the kernel configuration file. This device also
56requires the
57.Nm atkbdc
58keyboard controller to be present.
59The
60.Em irq
61number must always be 1; there is no provision of changing the number.
62.Ss Function Keys
63The AT keyboard has a number of function keys.
64They are numbered as follows and can be associated with strings
65by the
66.Xr kbdcontrol 1
67command.
68.Pp
| 28.\"
29.Dd May 21, 1999
30.Dt ATKBD 4
31.Os FreeBSD
32.Sh NAME
33.Nm atkbd
34.Nd the AT keyboard interface
35.Sh SYNOPSIS
36.Cd "options ATKBD_DFLT_KEYMAP"
37.Cd "makeoptions ATKBD_DFLT_KEYMAP=_keymap_name_"
38.Cd "options KBD_DISABLE_KEYMAP_LOAD"
39.Cd "device atkbd0 at atkbdc? irq 1"
40.Sh DESCRIPTION
41The
42.Nm
43driver, together with the
44.Nm atkbdc
45driver, provides access to the AT 84 keyboard or the AT enhanced keyboard
46which is connected to the AT keyboard controller.
47.Pp
48This driver is required for the console drivers
49.Xr syscons 4
50and
51.Xr pcvt 4 .
52.Pp
53There can be only one
54.Nm
55device defined in the kernel configuration file. This device also
56requires the
57.Nm atkbdc
58keyboard controller to be present.
59The
60.Em irq
61number must always be 1; there is no provision of changing the number.
62.Ss Function Keys
63The AT keyboard has a number of function keys.
64They are numbered as follows and can be associated with strings
65by the
66.Xr kbdcontrol 1
67command.
68.Pp
|
69.Bl -tag -width "Function Key Number" -compact -offset
| 69.Bl -tag -width "Function Key Number" -compact
|
70.It "Function Key number"
71Function Key
72.It "1, 2,...12"
73F1, F2,... F12
74.It "13, 14,...24"
75Shift+F1, Shift+F2,... Shift+F12
76.It "25, 26,...36"
77Ctl+F1, Ctl+F2,... Ctl+F12
78.It "37, 38,...48"
79Shift+Ctl+F1, Shift+Ctl+F2,... Shift+Ctl+F12
80.It 49
81Home and Numpad 7 (without NumLock)
82.It 50
83Up Arrow and Numpad 8 (without NumLock)
84.It 51
85Page Up and Numpad 9 (without NumLock)
86.It 52
87Numpad -
88.It 53
89Left Arrow and Numpad 4 (without NumLock)
90.It 54
91Numpad 5 (without NumLock)
92.It 55
93Right Arrow and Numpad 6 (without NumLock)
94.It 56
95Numpad +
96.It 57
97End and Numpad 1 (without NumLock)
98.It 58
99Down Arrow and Numpad 2 (without NumLock)
100.It 59
101Page Down and Numpad 3 (without NumLock)
102.It 60
103Ins and Numpad 0 (without NumLock)
104.It 61
105Del
106.It 62
107Left GUI Key
108.It 63
109Right GUI Key
110.It 64
111Menu
112.El
113.Pp
114See the man page for the
115.Xr kbdcontrol 1
116command for how to assign a string to the function key.
117.Sh DRIVER CONFIGURATION
118.Ss Kernel Configuration Options
119The following kernel configuration options control the
120.Nm
121driver.
122.Bl -tag -width ATKBD_DFLT
123.It Em ATKBD_DFLT_KEYMAP
124This option sets the defauilt, built-in keymap of the
125.Nm
126driver to the named keymap.
127See
128.Sx EXAMPLES
129below.
130.It Em KBD_DISABLE_KEYMAP_LOAD
131The keymap can be modified by the
132.Xr kbdcontrol 1
133command.
134This option will disable this feature and prevent the user from
135changing key assignment.
136.El
137.Pp
138.Ss Driver Flags
139The
140.Nm
141driver accepts the following driver flags. They can be set either in the
142kernel configuration file
143.Pq see Xr config 8 ,
144or else in the User Configuration Menu at boot time
145.Pq see Xr boot 8 .
146.Bl -tag -width FAIL
147.It bit 0 (FAIL_IF_NO_KBD)
148By default the
149.Nm
150driver will install even if a keyboard is not actually connected to the
151system.
152This option prevents the driver from being installed in this situation.
153.It bit 1 (NO_RESET)
154When this option is given, the
155.Nm
156driver will not reset the keyboard when initializing it.
157It may be useful for laptop computers whose function keys
158have special functions and these functions are forgotten when the
159keyboard is reset.
160.It bit 2 (ALT_SCANCODESET)
161Certain keyboards, such as those on some ThinkPad models, behave
162like the old XT keyboard and require this option.
163.El
164.\".Sh FILES
165.Sh EXAMPLES
166The
167.Nm
168driver requires the keyboard controller
169.Nm atkbdc .
170Thus, the kernel configuration file should contain the following lines.
171.Pp
172.Dl "device atkbdc0 at isa"
173.Dl "device atkbd0 at atkbdc? irq 1"
174.Pp
175The following example shows how to set the default, built-in keymap
176to
177.Pa jp.106.kbd .
178.Pp
179.Dl "options ATKBD_DFLT_KEYMAP"
180.Dl "makeoptions ATKBD_DFLT_KEYMAP=jp.106"
181.Dl "device atkbd0 at atkbdc? irq 1"
182.Pp
183.\".Sh DIAGNOSTICS
184.\".Sh CAVEATS
185.\".Sh BUGS
186.Sh SEE ALSO
187.Xr kbdcontrol 1 ,
188.Xr atkbdc 4 ,
189.Xr pcvt 4 ,
190.Xr psm 4 ,
191.Xr syscons 4 ,
192.Xr boot 8 ,
193.Xr config 8
194.Sh HISTORY
195The
196.Nm
197driver first appeared in
198.Fx 3.1 .
199.Sh AUTHORS
200.An -nosplit
201The
202.Nm
203driver was written by
204.An S\(/oren Schmidt Aq sos@FreeBSD.org
205and
206.An Kazutaka Yokota Aq yokota@FreeBSD.org .
207This manual page was written by
208.An Kazutaka Yokota .
| 70.It "Function Key number"
71Function Key
72.It "1, 2,...12"
73F1, F2,... F12
74.It "13, 14,...24"
75Shift+F1, Shift+F2,... Shift+F12
76.It "25, 26,...36"
77Ctl+F1, Ctl+F2,... Ctl+F12
78.It "37, 38,...48"
79Shift+Ctl+F1, Shift+Ctl+F2,... Shift+Ctl+F12
80.It 49
81Home and Numpad 7 (without NumLock)
82.It 50
83Up Arrow and Numpad 8 (without NumLock)
84.It 51
85Page Up and Numpad 9 (without NumLock)
86.It 52
87Numpad -
88.It 53
89Left Arrow and Numpad 4 (without NumLock)
90.It 54
91Numpad 5 (without NumLock)
92.It 55
93Right Arrow and Numpad 6 (without NumLock)
94.It 56
95Numpad +
96.It 57
97End and Numpad 1 (without NumLock)
98.It 58
99Down Arrow and Numpad 2 (without NumLock)
100.It 59
101Page Down and Numpad 3 (without NumLock)
102.It 60
103Ins and Numpad 0 (without NumLock)
104.It 61
105Del
106.It 62
107Left GUI Key
108.It 63
109Right GUI Key
110.It 64
111Menu
112.El
113.Pp
114See the man page for the
115.Xr kbdcontrol 1
116command for how to assign a string to the function key.
117.Sh DRIVER CONFIGURATION
118.Ss Kernel Configuration Options
119The following kernel configuration options control the
120.Nm
121driver.
122.Bl -tag -width ATKBD_DFLT
123.It Em ATKBD_DFLT_KEYMAP
124This option sets the defauilt, built-in keymap of the
125.Nm
126driver to the named keymap.
127See
128.Sx EXAMPLES
129below.
130.It Em KBD_DISABLE_KEYMAP_LOAD
131The keymap can be modified by the
132.Xr kbdcontrol 1
133command.
134This option will disable this feature and prevent the user from
135changing key assignment.
136.El
137.Pp
138.Ss Driver Flags
139The
140.Nm
141driver accepts the following driver flags. They can be set either in the
142kernel configuration file
143.Pq see Xr config 8 ,
144or else in the User Configuration Menu at boot time
145.Pq see Xr boot 8 .
146.Bl -tag -width FAIL
147.It bit 0 (FAIL_IF_NO_KBD)
148By default the
149.Nm
150driver will install even if a keyboard is not actually connected to the
151system.
152This option prevents the driver from being installed in this situation.
153.It bit 1 (NO_RESET)
154When this option is given, the
155.Nm
156driver will not reset the keyboard when initializing it.
157It may be useful for laptop computers whose function keys
158have special functions and these functions are forgotten when the
159keyboard is reset.
160.It bit 2 (ALT_SCANCODESET)
161Certain keyboards, such as those on some ThinkPad models, behave
162like the old XT keyboard and require this option.
163.El
164.\".Sh FILES
165.Sh EXAMPLES
166The
167.Nm
168driver requires the keyboard controller
169.Nm atkbdc .
170Thus, the kernel configuration file should contain the following lines.
171.Pp
172.Dl "device atkbdc0 at isa"
173.Dl "device atkbd0 at atkbdc? irq 1"
174.Pp
175The following example shows how to set the default, built-in keymap
176to
177.Pa jp.106.kbd .
178.Pp
179.Dl "options ATKBD_DFLT_KEYMAP"
180.Dl "makeoptions ATKBD_DFLT_KEYMAP=jp.106"
181.Dl "device atkbd0 at atkbdc? irq 1"
182.Pp
183.\".Sh DIAGNOSTICS
184.\".Sh CAVEATS
185.\".Sh BUGS
186.Sh SEE ALSO
187.Xr kbdcontrol 1 ,
188.Xr atkbdc 4 ,
189.Xr pcvt 4 ,
190.Xr psm 4 ,
191.Xr syscons 4 ,
192.Xr boot 8 ,
193.Xr config 8
194.Sh HISTORY
195The
196.Nm
197driver first appeared in
198.Fx 3.1 .
199.Sh AUTHORS
200.An -nosplit
201The
202.Nm
203driver was written by
204.An S\(/oren Schmidt Aq sos@FreeBSD.org
205and
206.An Kazutaka Yokota Aq yokota@FreeBSD.org .
207This manual page was written by
208.An Kazutaka Yokota .
|