NAME

xkbcomp - compile XKB keyboard description

SYNOPSIS

xkbcomp [option] source [ destination ]

DESCRIPTION

The xkbcomp keymap compiler converts a description of an XKB keymap into one of several output formats. The most common use for xkbcomp is to create a compiled keymap file (.xkm extension) which can be read directly by XKB-capable X servers or utilities. The keymap compiler can also produce C header files or XKB source files. The C header files produced by xkbcomp can be included by X servers or utilities that need a built-in default keymap. The XKB source files produced by _x_k_b_c_o_m_p are fully resolved and can be used to verify that the files which typically make up an XKB keymap are merged correctly or to create a single file which contains a complete description of the keymap.

The _s_o_u_r_c_e may specify an X display, or an _._x_k_b or _._x_k_m file; unless explicitly specified, the format of _d_e_s_t_i_n_a_t_i_o_n depends on the format of the source. Compiling a _._x_k_b (keymap source) file generates a _._x_k_m (compiled keymap file) by default. If the source is a _._x_k_m file or an X display, _x_k_b_c_o_m_p generates a keymap source file by default.

If the _d_e_s_t_i_n_a_t_i_o_n is an X display, the keymap for the display is updated with the compiled keymap.

The name of the _d_e_s_t_i_n_a_t_i_o_n is usually computed from the name of the source, with the extension replaced as appropriate. When compiling a single map from a file which contains several maps, _x_k_b_c_o_m_p constructs the destination file name by appending an appropriate extension to the name of the map to be used.

OPTIONS

-a
Show all keyboard information, reporting implicit or derived information as a comment. Only affects _._x_k_b format output.
-C
Produce a C header file as output (.h extension).
-dflts
Compute defaults for any missing components, such as key names.
-I_d_i_r
Specifies top-level directories to be searched for files included by the keymap description. After all directories specified by -I options have been searched, the current directory and finally, the default xkb directory (usually /usr/X11R7/lib/X11/xkb) will be searched.

To prevent the current and default directories from being searched, use the -I option alone (i.e. without a directory), before any -I options that specify the directories you do want searched.
-i _d_e_v_i_c_e_i_d
Specifies device ID (not name) to compile for.
-l
List maps that specify the _m_a_p pattern in any files listed on the command line (not implemented yet).
-m _n_a_m_e
Specifies a map to be compiled from an file with multiple entries.
-merge
Merge the compiled information with the map from the server (not implemented yet).
-o _n_a_m_e
Specifies a name for the generated output file. The default is the name of the source file with an appropriate extension for the output format.
-opt _p_a_r_t_s
Specifies a list of optional parts. Compilation errors in any optional parts are not fatal. Parts may consist of any combination of the letters _c, _g,_k,_s,_t which specify the compatibility map, geometry, keycodes, symbols and types, respectively.
-R_d_i_r
Specifies the root directory for relative path names.
-synch
Force synchronization for X requests.
-w _l_v_l
Controls the reporting of warnings during compilation. A warning level of 0 disables all warnings; a warning level of 10 enables them all.
-xkb
Generate a source description of the keyboard as output (.xkb extension).
-xkm
Generate a compiled keymap file as output (.xkm extension).

SEE ALSO

X(7) Copyright 1994, Silicon Graphics Computer Systems and X Consortium, Inc.
See _X_(_7_) for a full statement of rights and permissions.

AUTHOR

Erik Fortune, Silicon Graphics