|
1 | | -# libxkbcommon |
| 1 | +# To BLFS Editors |
2 | 2 |
|
3 | | -**libxkbcommon** is a keyboard keymap compiler and support library which |
4 | | -processes a reduced subset of keymaps as defined by the [XKB] \(X Keyboard |
5 | | -Extension) specification. It also contains a module for handling *Compose* |
6 | | -and dead keys and a separate *registry* library for listing available keyboard |
7 | | -layouts. |
8 | | - |
9 | | -[XKB]: doc/introduction-to-xkb.md |
10 | | - |
11 | | -## Quick Guide |
12 | | - |
13 | | -- [Introduction to XKB][XKB]: to learn the essentials of XKB. |
14 | | -- [User-configuration](doc/user-configuration.md): instructions to add |
15 | | - a *custom layout* or option. |
16 | | -- [Quick Guide](doc/quick-guide.md): introduction on how to use this library. |
17 | | - |
18 | | -## Building |
19 | | - |
20 | | -libxkbcommon is built with [Meson](http://mesonbuild.com/): |
21 | | - |
22 | | -```bash |
23 | | -meson setup build |
24 | | -meson compile -C build |
25 | | -meson test -C build # Run the tests. |
26 | | -``` |
27 | | - |
28 | | -To build for use with Wayland, you can disable X11 support while still |
29 | | -using the X11 keyboard configuration resource files thusly: |
30 | | - |
31 | | -```bash |
32 | | -meson setup build \ |
33 | | - -Denable-x11=false \ |
34 | | - -Dxkb-config-root=/usr/share/X11/xkb \ |
35 | | - -Dx-locale-root=/usr/share/X11/locale |
36 | | -meson compile -C build |
37 | | -``` |
38 | | - |
39 | | -<details> |
40 | | -<summary>Complete list of user options</summary> |
41 | | -@include meson_options.txt |
42 | | -</details> |
43 | | - |
44 | | -## API |
45 | | - |
46 | | -While libxkbcommon’s API is somewhat derived from the classic XKB API as found |
47 | | -in `X11/extensions/XKB.h` and friends, it has been substantially reworked to |
48 | | -expose fewer internal details to clients. |
49 | | - |
50 | | -See the [API Documentation](https://xkbcommon.org/doc/current/topics.html). |
51 | | - |
52 | | -## Dataset |
53 | | - |
54 | | -libxkbcommon *does not distribute a keyboard layout dataset itself*, other than |
55 | | -for testing purposes. The most common dataset is **xkeyboard-config**, which is |
56 | | -used by all current distributions for their X11 XKB data. Further information |
57 | | -on xkeyboard-config is available at its [homepage][xkeyboard-config-home] and at |
58 | | -its [repository][xkeyboard-config-repo]. |
59 | | - |
60 | | -The dataset for *Compose* is distributed in [libX11], as part of the X locale |
61 | | -data. |
62 | | - |
63 | | -[xkeyboard-config-home]: https://www.freedesktop.org/wiki/Software/XKeyboardConfig |
64 | | -[xkeyboard-config-repo]: https://gitlab.freedesktop.org/xkeyboard-config/xkeyboard-config |
65 | | -[libX11]: https://gitlab.freedesktop.org/xorg/lib/libx11 |
66 | | - |
67 | | -## Relation to X11 |
68 | | - |
69 | | -See [Compatibility](doc/compatibility.md) notes. |
70 | | - |
71 | | -## Development |
72 | | - |
73 | | -An extremely rudimentary homepage can be found at |
74 | | - https://xkbcommon.org |
75 | | - |
76 | | -xkbcommon is maintained in git at |
77 | | - https://github.com/xkbcommon/libxkbcommon |
78 | | - |
79 | | -Patches are always welcome, and may be sent to either |
80 | | -<xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org> |
81 | | -or in a [GitHub](https://github.com/xkbcommon/libxkbcommon) pull request. |
82 | | - |
83 | | -Bug reports (and usage questions) are also welcome, and may be filed at |
84 | | -[GitHub](https://github.com/xkbcommon/libxkbcommon/issues). |
85 | | - |
86 | | -The maintainers are: |
87 | | -- [Daniel Stone](mailto:daniel@fooishbar.org) |
88 | | -- [Ran Benita](mailto:ran@unusedvar.com) |
89 | | -- [Pierre Le Marre](mailto:dev@wismill.eu) |
90 | | - |
91 | | -## Credits |
92 | | - |
93 | | -Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon |
94 | | -off the ground initially. |
| 3 | +In case the latest release doesn't show up in this fork, press |
| 4 | +"Run workflow" at |
| 5 | +https://github.com/lfs-book/libxkbcommon/actions/workflows/lfs-retag.yml. |
| 6 | +If the workflow is disabled due to inactivity, enable it first. |
0 commit comments