[1c8d0ff] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
[8dfc5c3] | 7 | <!ENTITY libxkbcommon-download-http "https://xkbcommon.org/download/libxkbcommon-&libxkbcommon-version;.tar.xz">
|
---|
[1c8d0ff] | 8 | <!ENTITY libxkbcommon-download-ftp " ">
|
---|
[db18e97] | 9 | <!ENTITY libxkbcommon-md5sum "40f0486b4eb491928ec6616c2ff85120">
|
---|
[5ff076a6] | 10 | <!ENTITY libxkbcommon-size "464 KB">
|
---|
[db18e97] | 11 | <!ENTITY libxkbcommon-buildsize "19 MB (with tests)">
|
---|
| 12 | <!ENTITY libxkbcommon-time "0.2 SBU (with tests)">
|
---|
[1c8d0ff] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect1 id="libxkbcommon" xreflabel="libxkbcommon-&libxkbcommon-version;">
|
---|
| 16 | <?dbhtml filename="libxkbcommon.html"?>
|
---|
| 17 |
|
---|
| 18 |
|
---|
| 19 | <title>libxkbcommon-&libxkbcommon-version;</title>
|
---|
| 20 |
|
---|
| 21 | <indexterm zone="libxkbcommon">
|
---|
| 22 | <primary sortas="a-libxkbcommon">libxkbcommon</primary>
|
---|
| 23 | </indexterm>
|
---|
| 24 |
|
---|
| 25 | <sect2 role="package">
|
---|
| 26 | <title>Introduction to libxkbcommon</title>
|
---|
| 27 |
|
---|
| 28 | <para>
|
---|
| 29 | <application>libxkbcommon</application> is a keymap compiler and
|
---|
| 30 | support library which processes a reduced subset of keymaps as
|
---|
| 31 | defined by the XKB specification.
|
---|
| 32 | </para>
|
---|
| 33 |
|
---|
[aa0b625] | 34 | &lfs112_checked;
|
---|
[1c8d0ff] | 35 |
|
---|
| 36 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 37 | <itemizedlist spacing="compact">
|
---|
| 38 | <listitem>
|
---|
| 39 | <para>
|
---|
| 40 | Download (HTTP): <ulink url="&libxkbcommon-download-http;"/>
|
---|
| 41 | </para>
|
---|
| 42 | </listitem>
|
---|
| 43 | <listitem>
|
---|
| 44 | <para>
|
---|
| 45 | Download (FTP): <ulink url="&libxkbcommon-download-ftp;"/>
|
---|
| 46 | </para>
|
---|
| 47 | </listitem>
|
---|
| 48 | <listitem>
|
---|
| 49 | <para>
|
---|
| 50 | Download MD5 sum: &libxkbcommon-md5sum;
|
---|
| 51 | </para>
|
---|
| 52 | </listitem>
|
---|
| 53 | <listitem>
|
---|
| 54 | <para>
|
---|
| 55 | Download size: &libxkbcommon-size;
|
---|
| 56 | </para>
|
---|
| 57 | </listitem>
|
---|
| 58 | <listitem>
|
---|
| 59 | <para>
|
---|
| 60 | Estimated disk space required: &libxkbcommon-buildsize;
|
---|
| 61 | </para>
|
---|
| 62 | </listitem>
|
---|
| 63 | <listitem>
|
---|
| 64 | <para>
|
---|
| 65 | Estimated build time: &libxkbcommon-time;
|
---|
| 66 | </para>
|
---|
| 67 | </listitem>
|
---|
| 68 | </itemizedlist>
|
---|
| 69 |
|
---|
| 70 | <bridgehead renderas="sect3">libxkbcommon Dependencies</bridgehead>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 73 | <para role="required">
|
---|
[0af463c] | 74 | <xref role="runtime" linkend="xkeyboard-config"/> (runtime)
|
---|
[1c8d0ff] | 75 | </para>
|
---|
| 76 |
|
---|
| 77 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 78 | <para role="recommended">
|
---|
[927658a5] | 79 | <xref linkend="libxcb"/>,
|
---|
| 80 | <xref linkend="wayland"/>, and
|
---|
| 81 | <xref linkend="wayland-protocols"/>
|
---|
[1c8d0ff] | 82 | </para>
|
---|
| 83 |
|
---|
[d4ef6ae] | 84 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 85 | <para role="optional">
|
---|
| 86 | <xref linkend="doxygen"/>
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
[1c8d0ff] | 89 | <para condition="html" role="usernotes">User Notes:
|
---|
| 90 | <ulink url="&blfs-wiki;/libxkbcommon"/>
|
---|
| 91 | </para>
|
---|
| 92 | </sect2>
|
---|
| 93 |
|
---|
| 94 | <sect2 role="installation">
|
---|
| 95 | <title>Installation of libxkbcommon</title>
|
---|
| 96 |
|
---|
| 97 | <para>
|
---|
| 98 | Install <application>libxkbcommon</application> by running the following
|
---|
| 99 | commands:
|
---|
| 100 | </para>
|
---|
| 101 |
|
---|
[8d5da52a] | 102 | <screen><userinput>mkdir build &&
|
---|
| 103 | cd build &&
|
---|
| 104 |
|
---|
[0af463c] | 105 | meson --prefix=/usr \
|
---|
| 106 | --buildtype=release \
|
---|
[c35a6f2] | 107 | -Denable-docs=false .. &&
|
---|
[8d5da52a] | 108 | ninja</userinput></screen>
|
---|
[1c8d0ff] | 109 |
|
---|
| 110 | <para>
|
---|
[8d5da52a] | 111 | To test the results, issue: <command>ninja test</command>.
|
---|
[1c8d0ff] | 112 | </para>
|
---|
| 113 |
|
---|
| 114 | <para>
|
---|
| 115 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
[d4ef6ae] | 118 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[1c8d0ff] | 119 |
|
---|
| 120 | </sect2>
|
---|
[d4ef6ae] | 121 |
|
---|
[1c8d0ff] | 122 | <sect2 role="commands">
|
---|
| 123 | <title>Command Explanations</title>
|
---|
[8558044] | 124 |
|
---|
[20f070d8] | 125 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 126 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 127 |
|
---|
[d4ef6ae] | 128 | <!--
|
---|
[1c8d0ff] | 129 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 130 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 131 |
|
---|
| 132 | <para>
|
---|
[d4ef6ae] | 133 | <option>- -disable-x11</option>: Use this switch if you
|
---|
[1c8d0ff] | 134 | have not installed <xref linkend="libxcb"/> and
|
---|
| 135 | don't need the <filename>libxkbcommon-x11.so</filename>
|
---|
| 136 | library.
|
---|
| 137 | </para>
|
---|
[d4ef6ae] | 138 | -->
|
---|
| 139 |
|
---|
| 140 | <para>
|
---|
| 141 | <parameter>-Denable-docs=false</parameter>: This switch disables
|
---|
| 142 | documentation generation. Remove it if <xref linkend="doxygen"/> is
|
---|
| 143 | installed.
|
---|
| 144 | </para>
|
---|
[1c8d0ff] | 145 |
|
---|
[d4ef6ae] | 146 | <para>
|
---|
| 147 | <command>mv -v /usr/share/doc/libxkbcommon{,-&libxkbcommon-version;}</command>:
|
---|
| 148 | If you removed -Denable-docs=false, use this command to install the
|
---|
| 149 | documentation in a versioned directory.
|
---|
| 150 | </para>
|
---|
[8558044] | 151 |
|
---|
[1c8d0ff] | 152 | </sect2>
|
---|
[d4ef6ae] | 153 |
|
---|
[1c8d0ff] | 154 | <sect2 role="content">
|
---|
| 155 | <title>Contents</title>
|
---|
| 156 |
|
---|
| 157 | <segmentedlist>
|
---|
| 158 | <segtitle>Installed Programs</segtitle>
|
---|
| 159 | <segtitle>Installed Libraries</segtitle>
|
---|
| 160 | <segtitle>Installed Directories</segtitle>
|
---|
| 161 |
|
---|
| 162 | <seglistitem>
|
---|
| 163 | <seg>
|
---|
[572618ad] | 164 | xkbcli
|
---|
[1c8d0ff] | 165 | </seg>
|
---|
| 166 | <seg>
|
---|
[572618ad] | 167 | libxkbcommon.so,
|
---|
| 168 | libxkbcommon-x11.so, and
|
---|
| 169 | libxkbregistry.so
|
---|
[1c8d0ff] | 170 | </seg>
|
---|
| 171 | <seg>
|
---|
[572618ad] | 172 | /usr/include/xkbcommon,
|
---|
| 173 | /usr/libexec/xkbcommon, and
|
---|
[1c8d0ff] | 174 | /usr/share/doc/libxkbcommon-&libxkbcommon-version;
|
---|
| 175 | </seg>
|
---|
| 176 | </seglistitem>
|
---|
| 177 | </segmentedlist>
|
---|
| 178 |
|
---|
| 179 | <variablelist>
|
---|
| 180 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 181 | <?dbfo list-presentation="list"?>
|
---|
| 182 | <?dbhtml list-presentation="table"?>
|
---|
| 183 |
|
---|
[572618ad] | 184 | <varlistentry id="xkbcli">
|
---|
| 185 | <term><command>xkbcli</command></term>
|
---|
| 186 | <listitem>
|
---|
| 187 | <para>
|
---|
[4c24eb0a] | 188 | provides a debugger and compiler for XKB keymaps
|
---|
[572618ad] | 189 | </para>
|
---|
| 190 | <indexterm zone="libxkbcommon xkbcli">
|
---|
| 191 | <primary sortas="b-xkbcli">xkbcli</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
[1c8d0ff] | 196 | <varlistentry id="libxkbcommon-lib">
|
---|
| 197 | <term><filename class="libraryfile">libxkbcommon.so</filename></term>
|
---|
| 198 | <listitem>
|
---|
| 199 | <para>
|
---|
[4c24eb0a] | 200 | contains the <application>libxkbcommon</application> API functions
|
---|
[1c8d0ff] | 201 | </para>
|
---|
| 202 | <indexterm zone="libxkbcommon libxkbcommon-lib">
|
---|
| 203 | <primary sortas="c-libxkbcommon">libxkbcommon.so</primary>
|
---|
| 204 | </indexterm>
|
---|
| 205 | </listitem>
|
---|
| 206 | </varlistentry>
|
---|
| 207 |
|
---|
| 208 | <varlistentry id="libxkbcommon-x11">
|
---|
| 209 | <term><filename class="libraryfile">libxkbcommon-x11.so</filename></term>
|
---|
| 210 | <listitem>
|
---|
| 211 | <para>
|
---|
| 212 | contains the <application>libxkbcommon</application> X11 specific API
|
---|
[4c24eb0a] | 213 | functions
|
---|
[1c8d0ff] | 214 | </para>
|
---|
| 215 | <indexterm zone="libxkbcommon libxkbcommon-x11">
|
---|
| 216 | <primary sortas="c-libxkbcommon-x11">libxkbcommon-x11.so</primary>
|
---|
| 217 | </indexterm>
|
---|
| 218 | </listitem>
|
---|
[572618ad] | 219 | </varlistentry>
|
---|
| 220 |
|
---|
| 221 | <varlistentry id="libxkbregistry">
|
---|
| 222 | <term><filename class="libraryfile">libxkbregistry.so</filename></term>
|
---|
| 223 | <listitem>
|
---|
| 224 | <para>
|
---|
| 225 | contains a list of available XKB models, layouts, and variants for a
|
---|
[4c24eb0a] | 226 | given ruleset
|
---|
[572618ad] | 227 | </para>
|
---|
| 228 | <indexterm zone="libxkbcommon libxkbregistry">
|
---|
| 229 | <primary sortas="c-libxkbregistry">libxkbregistry.so</primary>
|
---|
| 230 | </indexterm>
|
---|
| 231 | </listitem>
|
---|
| 232 | </varlistentry>
|
---|
[1c8d0ff] | 233 |
|
---|
| 234 | </variablelist>
|
---|
| 235 |
|
---|
| 236 | </sect2>
|
---|
| 237 |
|
---|
| 238 | </sect1>
|
---|