Package version up
[platform/upstream/libxkbcommon.git] / tools / xkbcli-compile-keymap.1
1 .Dd July 27, 2020
2 .Dt XKBCLI\-COMPILE\-KEYMAP 1
3 .Os
4 .
5 .Sh NAME
6 .Nm "xkbcli compile\-keymap"
7 .Nd compile an XKB keymap
8 .
9 .Sh SYNOPSIS
10 .Nm
11 .Op Ar options
12 .
13 .Sh DESCRIPTION
14 .Nm
15 compiles and prints a keymap based on the given options.
16 .
17 .Bl -tag -width Ds
18 .It Fl \-help
19 Print help and exit
20 .
21 .It Fl \-verbose
22 Enable verbose debugging output
23 .
24 .It Fl \-rmlvo
25 Print the full RMLVO with the defaults filled in for missing elements
26 .
27 .It Fl \-from\-xkb
28 Load the XKB file from stdin, ignore RMLVO options.
29 This option must not be used with
30 .Fl \-kccgst .
31 .
32 .It Fl \-include Ar PATH
33 Add the given path to the include path list.
34 This option is order\-dependent, include paths given first are searched first.
35 If an include path is given, the default include path list is not used.
36 Use
37 .Fl -\-include\-defaults
38 to add the default include paths.
39 .
40 .It Fl \-include\-defaults
41 Add the default set of include directories.
42 This option is order-dependent, include paths given first are searched first.
43 .
44 .It Fl \-rules Ar rules
45 The XKB ruleset
46 .
47 .It Fl \-model Ar model
48 The XKB model
49 .
50 .It Fl \-layout Ar layout
51 The XKB layout
52 .
53 .It Fl \-variant Ar variant
54 The XKB layout variant
55 .
56 .It Fl \-options Ar options
57 The XKB options
58 .El
59 .
60 .Sh SEE ALSO
61 .Xr xkbcli 1 ,
62 .Lk https://xkbcommon.org "The libxkbcommon online documentation"