OS Manuals

/usr/bin/xkbcomp

XKB keyboard description compiler

From xkbcomp 1.5.0-r4 (os), captured 2026-11-05 by running xkbcomp --help (exit 0). permalink

Usage: /usr/bin/xkbcomp [options] input-file [ output-file ]
Legal options:
-?,-help             Print this message
-version             Print the version number
-a                   Show all actions
-C                   Create a C header file
-em1 <msg>           Print <msg> before printing first error message
-emp <msg>           Print <msg> at the start of each message line
-eml <msg>           If there were any errors, print <msg> before exiting
-dflts               Compute defaults for missing parts
-I[<dir>]            Specifies a top level directory for include
                     directives. Multiple directories are legal.
-l [flags]           List matching maps in the specified files
                     f: list fully specified names
                     h: also list hidden maps
                     l: long listing (show flags)
                     p: also list partial maps
                     R: recursively list subdirectories
                     default is all options off
-i <deviceid>        Specifies device ID (not name) to compile for
-m[ap] <map>         Specifies map to compile
-o <file>            Specifies output file name
-opt[ional] <parts>  Specifies optional components of keymap
                     Errors in optional parts are not fatal
                     <parts> can be any combination of:
                     c: compat map         g: geometry
                     k: keycodes           s: symbols
                     t: types
-R[<DIR>]            Specifies the root directory for
                     relative path names
-synch               Force synchronization
-w [<lvl>]           Set warning level (0=none, 10=all)
-xkb                 Create an XKB source (.xkb) file
-xkm                 Create a compiled key map (.xkm) file
Options (22)
OptionDescriptionSource
-?, -helpShow available options.help + man
-versionPrint the version numberhelp + man
-aShow all keyboard information, reporting implicit or derived information as a comment.help + man
-CProduce a C header file as output (.h extension).help + man
-em1 msgPrint <msg> before printing first error messagehelp + man
-emp msgPrint <msg> at the start of each message linehelp + man
-eml msgIf there were any errors, print <msg> before exitinghelp + man
-dfltsCompute defaults for any missing components, such as key names.help + man
-I dirSpecifies a top level directory for include directives.help
-l flagsList matching maps in the specified files f: list fully specified names h: also list hidden maps l: long listing (show flags) p: also list partial maps R: recursively list subdirectories default is…help + man
-i deviceidSpecifies device ID (not name) to compile forhelp
-m apSpecifies map to compilehelp
-o fileSpecifies output file namehelp
-opt ionalSpecifies optional components of keymap Errors in optional parts are not fatal <parts> can be any combination of: c: compat map g: geometry k: keycodes s: symbols t: typeshelp
-R DIRSpecifies the root directory for relative path nameshelp
-synchForce synchronization for X requests.help + man
-w lvlSet warning level (0=none, 10=all)help
-xkbGenerate a source description of the keyboard as output (.xkb extension).help + man
-xkmGenerate a compiled keymap file as output (.xkm extension).help + man
-IdirSpecifies top-level directories to be searched for files included by the keymap description. (in the manual page but not in --help)man
-mergeMerge the compiled information with the map from the server (not implemented yet). (in the manual page but not in --help)man
-RdirSpecifies the root directory for relative path names. (in the manual page but not in --help)man

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.