keysym

keysym — The symbolic name of a key on a keyboard.

Synopsis

Zero or more of:
- text
- phrase (db._phrase)
- replaceable
- Graphic inlines
  inlinemediaobject
- Indexing inlines
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
- Linking inlines
  anchor
  biblioref
  link
  olink
  xref
- Ubiquitous inlines
  alt
  anchor
  annotation
  biblioref
  indexterm (db.indexterm.endofrange)
  indexterm (db.indexterm.singular)
  indexterm (db.indexterm.startofrange)
  inlinemediaobject
  link
  olink
  remark
  subscript
  superscript
  xref

Attributes

Common attributes and common linking attributes.

Description

The keysym identifies the symbolic name of 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.

Parents

This element occurs in 52 elements.

Children

This element contains 16 elements.

Examples

  1 <article xmlns='http://docbook.org/ns/docbook'>
  2 <title>Example keysym</title>
    
  4 <para>The <keycap>F1</keycap> key on an IBM PC keyboard generates the
    scan code <keycode>0x3B</keycode> when pressed.  This value
  6 is defined as <keysym>KEY_F1</keysym> in 
    <filename class="headerfile">keyboard.h</filename>.
  8 </para>
    
 10 </article>

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.


keycombo		keyword