StreetLight
/
libxkbcommon
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
libxkbcommon/README.md

76 lines
2.2 KiB
Markdown
Raw Normal View History

Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
# libxkbcommon
README: add notes about Compose support Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 05:29:37 -06:00
libxkbcommon is a keyboard keymap compiler and support library which
processes a reduced subset of keymaps as defined by the XKB (X Keyboard
Extension) specification. It also contains a module for handling Compose
and dead keys.
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
## Quick Guide
See [Quick Guide](doc/quick-guide.md).
README: Add basic build directions In particular, highlight the use of configure flags to control locating X11 keyboard stuff when building for Wayland. Of particular note, if the locale root is not specified, then xkbcommon will look for them under $prefix (i.e. /usr/local/share/X11/locale). But unless the user has specifically installed them there, it is better to look in the standard system location, /usr/share/X11/locale. Otherwise, xkbcommon will error when it can't find them, e.g.: xkbcommon: ERROR: ~/.XCompose:4:9: failed to expand %L to the locale Compose file xkbcommon: ERROR: ~/.XCompose:4:12: unterminated string literal Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Ran Benita <ran234@gmail.com>
2016-09-15 15:31:55 -06:00
## Building
build: add meson build system Meson is easier to maintain, much faster, encourages better practices, and is not built on a pile of shell scripts. The autotools build system is kept intact for now, in order to ease the migration. The intention is to remove it sooner rather than later, if all goes well. Run `meson build && mesonconf build` to see the configuration options for the new system. Conversion should be straightforward. Environment variables like CFLAGS work the same. If meson is used, xorg-util-macros is not required. In terms of functionality the two systems have about the same capabilities. Here are some differences I noticed: - Meson uses `-g` by default, autotools uses `-g -O2`. - In autotools the default behavior is to install both static and shared versions of the libraries. In meson the user must choose exactly one (using -Ddefault_library=static/shared). It is possible to workaround if needed (install twice...), but hopefully meson will add the option in the future. - Autotools has builtin ctags/cscope targets, meson doesn't. Easy to run the tools directly. - Meson has builtin benchmarks target. Handy. - Meson has builtin support for sanitizers/clang-analyzer/lto/pgo/ coverage etc. Also handy. Signed-off-by: Ran Benita <ran234@gmail.com>
2017-07-25 12:57:42 -06:00
libxkbcommon is built with [Meson](http://mesonbuild.com/):
README: Add basic build directions In particular, highlight the use of configure flags to control locating X11 keyboard stuff when building for Wayland. Of particular note, if the locale root is not specified, then xkbcommon will look for them under $prefix (i.e. /usr/local/share/X11/locale). But unless the user has specifically installed them there, it is better to look in the standard system location, /usr/share/X11/locale. Otherwise, xkbcommon will error when it can't find them, e.g.: xkbcommon: ERROR: ~/.XCompose:4:9: failed to expand %L to the locale Compose file xkbcommon: ERROR: ~/.XCompose:4:12: unterminated string literal Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Ran Benita <ran234@gmail.com>
2016-09-15 15:31:55 -06:00
README,PACKAGING: use the new meson unified command format Signed-off-by: Ran Benita <ran234@gmail.com>
2017-12-15 07:17:45 -07:00
meson setup build
build: add meson build system Meson is easier to maintain, much faster, encourages better practices, and is not built on a pile of shell scripts. The autotools build system is kept intact for now, in order to ease the migration. The intention is to remove it sooner rather than later, if all goes well. Run `meson build && mesonconf build` to see the configuration options for the new system. Conversion should be straightforward. Environment variables like CFLAGS work the same. If meson is used, xorg-util-macros is not required. In terms of functionality the two systems have about the same capabilities. Here are some differences I noticed: - Meson uses `-g` by default, autotools uses `-g -O2`. - In autotools the default behavior is to install both static and shared versions of the libraries. In meson the user must choose exactly one (using -Ddefault_library=static/shared). It is possible to workaround if needed (install twice...), but hopefully meson will add the option in the future. - Autotools has builtin ctags/cscope targets, meson doesn't. Easy to run the tools directly. - Meson has builtin benchmarks target. Handy. - Meson has builtin support for sanitizers/clang-analyzer/lto/pgo/ coverage etc. Also handy. Signed-off-by: Ran Benita <ran234@gmail.com>
2017-07-25 12:57:42 -06:00
ninja -C build
README: Add basic build directions In particular, highlight the use of configure flags to control locating X11 keyboard stuff when building for Wayland. Of particular note, if the locale root is not specified, then xkbcommon will look for them under $prefix (i.e. /usr/local/share/X11/locale). But unless the user has specifically installed them there, it is better to look in the standard system location, /usr/share/X11/locale. Otherwise, xkbcommon will error when it can't find them, e.g.: xkbcommon: ERROR: ~/.XCompose:4:9: failed to expand %L to the locale Compose file xkbcommon: ERROR: ~/.XCompose:4:12: unterminated string literal Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Ran Benita <ran234@gmail.com>
2016-09-15 15:31:55 -06:00
To build for use with Wayland, you can disable X11 support while still
using the X11 keyboard configuration resource files thusly:
README,PACKAGING: use the new meson unified command format Signed-off-by: Ran Benita <ran234@gmail.com>
2017-12-15 07:17:45 -07:00
meson setup build \
build: add meson build system Meson is easier to maintain, much faster, encourages better practices, and is not built on a pile of shell scripts. The autotools build system is kept intact for now, in order to ease the migration. The intention is to remove it sooner rather than later, if all goes well. Run `meson build && mesonconf build` to see the configuration options for the new system. Conversion should be straightforward. Environment variables like CFLAGS work the same. If meson is used, xorg-util-macros is not required. In terms of functionality the two systems have about the same capabilities. Here are some differences I noticed: - Meson uses `-g` by default, autotools uses `-g -O2`. - In autotools the default behavior is to install both static and shared versions of the libraries. In meson the user must choose exactly one (using -Ddefault_library=static/shared). It is possible to workaround if needed (install twice...), but hopefully meson will add the option in the future. - Autotools has builtin ctags/cscope targets, meson doesn't. Easy to run the tools directly. - Meson has builtin benchmarks target. Handy. - Meson has builtin support for sanitizers/clang-analyzer/lto/pgo/ coverage etc. Also handy. Signed-off-by: Ran Benita <ran234@gmail.com>
2017-07-25 12:57:42 -06:00
-Denable-x11=false \
-Dxkb-config-root=/usr/share/X11/xkb \
-Dx-locale-root=/usr/share/X11/locale
ninja -C build
README: Add basic build directions In particular, highlight the use of configure flags to control locating X11 keyboard stuff when building for Wayland. Of particular note, if the locale root is not specified, then xkbcommon will look for them under $prefix (i.e. /usr/local/share/X11/locale). But unless the user has specifically installed them there, it is better to look in the standard system location, /usr/share/X11/locale. Otherwise, xkbcommon will error when it can't find them, e.g.: xkbcommon: ERROR: ~/.XCompose:4:9: failed to expand %L to the locale Compose file xkbcommon: ERROR: ~/.XCompose:4:12: unterminated string literal Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Signed-off-by: Ran Benita <ran234@gmail.com>
2016-09-15 15:31:55 -06:00
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
## API
README: link to online API docs Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 04:44:02 -06:00
While libxkbcommon's API is somewhat derived from the classic XKB API as found
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
in X11/extensions/XKB.h and friends, it has been substantially reworked to
README: link to online API docs Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 04:44:02 -06:00
expose fewer internal details to clients.
Convert http:// -> https:// where possible Signed-off-by: Ran Benita <ran234@gmail.com>
2017-12-21 05:18:07 -07:00
See the [API Documentation](https://xkbcommon.org/doc/current/modules.html).
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
README: move note about xkeyboard-config to its own section Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 04:34:15 -06:00
## Dataset
libxkbcommon does not distribute a keymap dataset itself, other than for
testing purposes. The most common dataset is xkeyboard-config, which is used
by all current distributions for their X11 XKB data. More information on
xkeyboard-config is available here:
Convert http:// -> https:// where possible Signed-off-by: Ran Benita <ran234@gmail.com>
2017-12-21 05:18:07 -07:00
https://www.freedesktop.org/wiki/Software/XKeyboardConfig
README: move note about xkeyboard-config to its own section Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 04:34:15 -06:00
README: add notes about Compose support Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 05:29:37 -06:00
The dataset for Compose is distributed in libX11, as part of the X locale
data.
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
## Relation to X11
README: move compatibility notes to their own page Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 04:50:54 -06:00
See [Compatibility](doc/compat.md) notes.
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
## Development
An extremely rudimentary homepage can be found at
Convert http:// -> https:// where possible Signed-off-by: Ran Benita <ran234@gmail.com>
2017-12-21 05:18:07 -07:00
https://xkbcommon.org
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
xkbcommon is maintained in git at
https://github.com/xkbcommon/libxkbcommon
Patches are always welcome, and may be sent to either
<xorg-devel@lists.x.org> or <wayland-devel@lists.freedesktop.org>
README: we also accepts patches through github Signed-off-by: Ran Benita <ran234@gmail.com>
2014-10-18 05:52:54 -06:00
or through github.
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
README: Bug *reports* are welcome Signed-off-by: Bryce Harrington <bryce@osg.samsung.com> Reviewed-by: Yong Bakos <ybakos@humanoriented.com> Signed-off-by: Ran Benita <ran234@gmail.com>
2016-09-15 15:31:54 -06:00
Bug reports are also welcome, and may be filed either at
Reformat README markdown So that github displays it as markdown, and correctly. Signed-off-by: Ran Benita <ran234@gmail.com>
2014-03-23 07:04:51 -06:00
Bugzilla https://bugs.freedesktop.org/describecomponents.cgi?product=libxkbcommon
or
Github https://github.com/xkbcommon/libxkbcommon/issues
The maintainers are
- Daniel Stone <daniel@fooishbar.org>
- Ran Benita <ran234@gmail.com>
## Credits
Many thanks are due to Dan Nicholson for his heroic work in getting xkbcommon
off the ground initially.