xkbcomp/man/xkbcomp.man

   1 .\"
   2 .TH XKBCOMP 1 __xorgversion__
   3 .SH NAME
   4 xkbcomp \- compile XKB keyboard description
   5 .SH SYNOPSIS
   6 .B xkbcomp
   7 [option] source [ destination ]
   8 .SH DESCRIPTION
   9 .PP
  10 The
  11 .I xkbcomp
  12 keymap compiler converts a description of an XKB keymap into one of several
  13 output formats.   The most common use for xkbcomp is to create a compiled
  14 keymap file (.xkm extension) which can be read directly by XKB-capable X
  15 servers or utilities.   The keymap compiler can also produce C header
  16 files or XKB source files.  The C header files produced by xkbcomp can be
  17 included by X servers or utilities that need a built-in default keymap.
  18 The XKB source files produced by \fIxkbcomp\fP are fully resolved and can be
  19 used to verify that the files which typically make up an XKB keymap
  20 are merged correctly or to create a single file which contains a complete
  21 description of the keymap.
  22 .PP
  23 The \fIsource\fP may specify an X display, or an \fI.xkb\fP or \fI.xkm\fP
  24 file;  unless explicitly specified, the format of \fIdestination\fP
  25 depends on the format of the source.   Compiling a \fI.xkb\fP (keymap source)
  26 file generates a \fI.xkm\fP (compiled keymap file) by default.   If the
  27 source is a \fI.xkm\fP file or an X display, \fIxkbcomp\fP generates a
  28 keymap source file by default.
  29 .PP
  30 If the \fIdestination\fP is an X display, the keymap for the display
  31 is updated with the compiled keymap.
  32 .PP
  33 The name of the \fIdestination\fP is usually computed from the name
  34 of the source, with the extension replaced as appropriate.  When compiling
  35 a single map from a file which contains several maps, \fIxkbcomp\fP constructs
  36 the destination file name by appending an appropriate extension to the
  37 name of the map to be used.
  38 .SH OPTIONS
  39 .TP 8
  40 .B \-a
  41 Show all keyboard information, reporting implicit or derived information
  42 as a comment.  Only affects \fI.xkb\fP format output.
  43 .TP 8
  44 .B \-C
  45 Produce a C header file as output (.h extension).
  46 .TP 8
  47 .B \-dflts
  48 Compute defaults for any missing components, such as key names.
  49 .TP 8
  50 .B \-I\fIdir\fP
  51 Specifies top-level directories to be searched for files included by the
  52 keymap description.  After all directories specified by \-I options
  53 have been searched, the current directory and finally, the default
  54 xkb directory (usually __projectroot__/lib/X11/xkb) will be searched.
  55 .sp
  56 To prevent the current and default directories from being searched,
  57 use the \-I option alone (i.e. without a directory), before any \-I
  58 options that specify the directories you do want searched.
  59 .TP 8
  60 .B \-i\ \fIdeviceid\fP
  61 If \fIsource\fP or \fIdestination\fP is a valid X display, load the keymap
  62 from/into the device with the specified ID (not name).
  63 .TP 8
  64 .B \-l
  65 List maps that specify the \fImap\fP pattern in any files listed on the
  66 command line (not implemented yet).
  67 .TP 8
  68 .B \-m\ \fIname\fP
  69 Specifies a map to be compiled from an file with multiple entries.
  70 .TP 8
  71 .B \-merge
  72 Merge the compiled information with the map from the server (not implemented
  73 yet).
  74 .TP 8
  75 .B \-o\ \fIname\fP
  76 Specifies a name for the generated output file.  The default is the name of
  77 the source file with an appropriate extension for the output format.
  78 .TP 8
  79 .B \-opt\ \fIparts\fP
  80 Specifies a list of optional parts.  Compilation errors in any optional parts
  81 are not fatal.  Parts may consist of any combination of the letters \fIc\fP,
  82 \fIg\fP,\fIk\fP,\fIs\fP,\fIt\fP which specify the compatibility map, geometry,
  83 keycodes, symbols and types, respectively.
  84 .TP 8
  85 .B -R\fIdir\fP
  86 Specifies the root directory for relative path names.
  87 .TP 8
  88 .B -synch
  89 Force synchronization for X requests.
  90 .TP 8
  91 .B -version
  92 Print version number.
  93 .TP 8
  94 .B \-w\ \fIlvl\fP
  95 Controls the reporting of warnings during compilation.  A warning level
  96 of 0 disables all warnings; a warning level of 10 enables them all.
  97 .TP 8
  98 .B \-xkb
  99 Generate a source description of the keyboard as output (.xkb extension).
 100 .TP 8
 101 .B \-xkm
 102 Generate a compiled keymap file as output (.xkm extension).
 103 .SH "SEE ALSO"
 104 X(__miscmansuffix__)
 105 .SH COPYRIGHT
 106 Copyright 1994, Silicon Graphics Computer Systems and X Consortium, Inc.
 107 .br
 108 See \fIX(__miscmansuffix__)\fP for a full statement of rights and permissions.
 109 .SH AUTHOR
 110 Erik Fortune, Silicon Graphics