summaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
Diffstat (limited to 'README')
-rw-r--r--README8
1 files changed, 4 insertions, 4 deletions
diff --git a/README b/README
index 95f6c9f..fa8e94c 100644
--- a/README
+++ b/README
@@ -1,5 +1,5 @@
-xkbcommon
-=========
+Overview {#mainpage}
+========
xkbcommon is a keymap compiler and support library which processes a
reduced subset of keymaps as defined by the XKB specification. Primarily,
@@ -9,9 +9,9 @@ which is the base type for all xkbcommon operations.
From an xkb_keymap, an xkb_state object is created which holds the current
state of all modifiers, groups, LEDs, etc, relating to that keymap. All
-key events must be fed into the xkb_state object using xkb_state_update_key.
+key events must be fed into the xkb_state object using xkb_state_update_key().
Once this is done, the xkb_state object will be properly updated, and the
-keysyms to use can be obtained with xkb_key_get_syms.
+keysyms to use can be obtained with xkb_state_key_get_syms().
libxkbcommon does not distribute a dataset itself, other than for testing
purposes. The most common dataset is xkeyboard-config, as used by all