| 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 \-em1 \fImsg\fP |
| 51 |
Print \fImsg\fP before printing first error message. |
| 52 |
.TP 8 |
| 53 |
.B \-emp \fImsg\fP |
| 54 |
Print \fImsg\fP at the start of each message line. |
| 55 |
.TP 8 |
| 56 |
.B \-eml \fImsg\fP |
| 57 |
If there were any errors, print \fImsg\fP before exiting. |
| 58 |
.TP 8 |
| 59 |
.B \-help, -? |
| 60 |
Show available options. |
| 61 |
.TP 8 |
| 62 |
.B \-I\fIdir\fP |
| 63 |
Specifies top-level directories to be searched for files included by the |
| 64 |
keymap description. After all directories specified by \-I options |
| 65 |
have been searched, the current directory and finally, the default |
| 66 |
xkb directory __xkbconfigroot__ will be searched. |
| 67 |
.sp |
| 68 |
To prevent the current and default directories from being searched, |
| 69 |
use the \-I option alone (i.e. without a directory), before any \-I |
| 70 |
options that specify the directories you do want searched. |
| 71 |
.TP 8 |
| 72 |
.B \-i\ \fIdeviceid\fP |
| 73 |
If \fIsource\fP or \fIdestination\fP is a valid X display, load the keymap |
| 74 |
from/into the device with the specified ID (not name). |
| 75 |
.TP 8 |
| 76 |
.B \-l |
| 77 |
List maps that specify the \fImap\fP pattern in any files listed on the |
| 78 |
command line (not implemented yet). |
| 79 |
.TP 8 |
| 80 |
.B \-m\ \fIname\fP |
| 81 |
Specifies a map to be compiled from an file with multiple entries. |
| 82 |
.TP 8 |
| 83 |
.B \-merge |
| 84 |
Merge the compiled information with the map from the server (not implemented |
| 85 |
yet). |
| 86 |
.TP 8 |
| 87 |
.B \-o\ \fIname\fP |
| 88 |
Specifies a name for the generated output file. The default is the name of |
| 89 |
the source file with an appropriate extension for the output format. |
| 90 |
.TP 8 |
| 91 |
.B \-opt\ \fIparts\fP |
| 92 |
Specifies a list of optional parts. Compilation errors in any optional parts |
| 93 |
are not fatal. Parts may consist of any combination of the letters \fIc\fP, |
| 94 |
\fIg\fP,\fIk\fP,\fIs\fP,\fIt\fP which specify the compatibility map, geometry, |
| 95 |
keycodes, symbols and types, respectively. |
| 96 |
.TP 8 |
| 97 |
.B -R\fIdir\fP |
| 98 |
Specifies the root directory for relative path names. |
| 99 |
.TP 8 |
| 100 |
.B -synch |
| 101 |
Force synchronization for X requests. |
| 102 |
.TP 8 |
| 103 |
.B -version |
| 104 |
Print version number. |
| 105 |
.TP 8 |
| 106 |
.B \-w\ \fIlvl\fP |
| 107 |
Controls the reporting of warnings during compilation. A warning level |
| 108 |
of 0 disables all warnings; a warning level of 10 enables them all. |
| 109 |
.TP 8 |
| 110 |
.B \-xkb |
| 111 |
Generate a source description of the keyboard as output (.xkb extension). |
| 112 |
.TP 8 |
| 113 |
.B \-xkm |
| 114 |
Generate a compiled keymap file as output (.xkm extension). |
| 115 |
.SH "SEE ALSO" |
| 116 |
X(__miscmansuffix__) |
| 117 |
.SH AUTHOR |
| 118 |
Erik Fortune, Silicon Graphics |