Skip to main content
Version: DocBook V4.5

keycode

keycode — The internal, frequently numeric, identifier for a key on a keyboard

Synopsis​

Mixed Content Model​

keycode ::=
(#PCDATA|replaceable|inlinegraphic|inlinemediaobject|indexterm|
beginpage)*

Attributes​

Common attributes

Description​

The KeyCode identifies the numeric value associated with a key on a computer keyboard. This is distinct from any scan code that it may generate (KeyCode), or any symbolic name (KeySym) that might exist for the key.

Processing expectations​

Formatted inline.

Children​

The following elements occur in keycode: beginpage, indexterm, inlinegraphic, inlinemediaobject, replaceable.

Examples​

<!DOCTYPE para PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<para>
The <keycap>F1</keycap> key on an IBM PC keyboard generates the
scan code <keycode>0x3B</keycode> when pressed. This value
is defined as <keysym>KEY_F1</keysym> in
<filename class="headerfile">keyboard.h</filename>.
</para>

The F1 key on an IBM PC keyboard generates the scan code 0x3B when pressed. This value is defined as KEY_F1 in keyboard.h.

For additional examples, see also keycap, keysym.