1XKBCOMP(1)                  General Commands Manual                 XKBCOMP(1)
2
3
4

NAME

6       xkbcomp - compile XKB keyboard description
7

SYNOPSIS

9       xkbcomp [option] source [ destination ]
10

DESCRIPTION

12       The  xkbcomp  keymap  compiler  converts a description of an XKB keymap
13       into one of several output formats.   The most common use  for  xkbcomp
14       is  to create a compiled keymap file (.xkm extension) which can be read
15       directly by XKB-capable X servers or utilities.   The  keymap  compiler
16       can  also  produce  C  header  files or XKB source files.  The C header
17       files produced by xkbcomp can be included by  X  servers  or  utilities
18       that  need a built-in default keymap.  The XKB source files produced by
19       xkbcomp are fully resolved and can be used to  verify  that  the  files
20       which typically make up an XKB keymap are merged correctly or to create
21       a single file which contains a complete description of the keymap.
22
23       The source may specify an X display, or an .xkb or .xkm  file;   unless
24       explicitly  specified,  the format of destination depends on the format
25       of the source.   Compiling a .xkb (keymap source) file generates a .xkm
26       (compiled keymap file) by default.   If the source is a .xkm file or an
27       X display, xkbcomp generates a keymap source file by default.
28
29       If the destination is an X display, the keymap for the display  is  up‐
30       dated with the compiled keymap.
31
32       The  name  of  the destination is usually computed from the name of the
33       source, with the extension replaced as appropriate.  When  compiling  a
34       single  map from a file which contains several maps, xkbcomp constructs
35       the destination file name by appending an appropriate extension to  the
36       name of the map to be used.
37

OPTIONS

39       -a      Show  all  keyboard  information, reporting implicit or derived
40               information as a comment.  Only affects .xkb format output.
41
42       -C      Produce a C header file as output (.h extension).
43
44       -dflts  Compute defaults for any missing components, such as key names.
45
46       -em1 msg
47               Print msg before printing first error message.
48
49       -emp msg
50               Print msg at the start of each message line.
51
52       -eml msg
53               If there were any errors, print msg before exiting.
54
55       -help, -?
56               Show available options.
57
58       -Idir   Specifies top-level directories to be searched  for  files  in‐
59               cluded by the keymap description.  After all directories speci‐
60               fied by -I options have been searched,  the  current  directory
61               and  finally, the default xkb directory /usr/share/X11/xkb will
62               be searched.
63
64               To prevent the  current  and  default  directories  from  being
65               searched,  use  the -I option alone (i.e. without a directory),
66               before any -I options that specify the directories you do  want
67               searched.
68
69       -i deviceid
70               If  source or destination is a valid X display, load the keymap
71               from/into the device with the specified ID (not name).
72
73       -l      List maps that specify the map pattern in any files  listed  on
74               the command line (not implemented yet).
75
76       -m name Specifies  a  map to be compiled from an file with multiple en‐
77               tries.
78
79       -merge  Merge the compiled information with the  map  from  the  server
80               (not implemented yet).
81
82       -o name Specifies a name for the generated output file.  The default is
83               the name of the source file with an appropriate  extension  for
84               the output format.
85
86       -opt parts
87               Specifies  a list of optional parts.  Compilation errors in any
88               optional parts are not fatal.  Parts may consist of any  combi‐
89               nation  of the letters c, g,k,s,t which specify the compatibil‐
90               ity map, geometry, keycodes, symbols and types, respectively.
91
92       -Rdir   Specifies the root directory for relative path names.
93
94       -synch  Force synchronization for X requests.
95
96       -version
97               Print version number.
98
99       -w lvl  Controls the reporting of warnings during compilation.  A warn‐
100               ing level of 0 disables all warnings; a warning level of 10 en‐
101               ables them all.
102
103       -xkb    Generate a source description of the keyboard as  output  (.xkb
104               extension).
105
106       -xkm    Generate a compiled keymap file as output (.xkm extension).
107

SEE ALSO

109       X(7)
110

112       Copyright  1994,  Silicon  Graphics  Computer Systems and X Consortium,
113       Inc.
114       See X(7) for a full statement of rights and permissions.
115

AUTHOR

117       Erik Fortune, Silicon Graphics
118
119
120
121X Version 11                     xkbcomp 1.4.5                      XKBCOMP(1)
Impressum