[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[1c8d0ff] | 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 " ">
|
---|
[7a7b390] | 9 | <!ENTITY libxkbcommon-md5sum "b05b1a0d473189efb2dd995dd944f152">
|
---|
| 10 | <!ENTITY libxkbcommon-size "524 KB">
|
---|
| 11 | <!ENTITY libxkbcommon-buildsize "26 MB (with tests)">
|
---|
| 12 | <!ENTITY libxkbcommon-time "0.5 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 |
|
---|
[f2574af5] | 34 | &lfs122_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">
|
---|
[ac4f67e] | 86 | <xref linkend="doxygen"/> (for generating the documentation) and
|
---|
| 87 | <command>Xvfb</command> (from
|
---|
| 88 | <xref linkend='xorg-server'/> or
|
---|
| 89 | <xref role='nodep' linkend='xwayland'/>)
|
---|
[d4ef6ae] | 90 | </para>
|
---|
| 91 |
|
---|
[1c8d0ff] | 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 |
|
---|
[7c83169b] | 105 | meson setup .. \
|
---|
| 106 | --prefix=/usr \
|
---|
| 107 | --buildtype=release \
|
---|
| 108 | -D enable-docs=false &&
|
---|
[8d5da52a] | 109 | ninja</userinput></screen>
|
---|
[1c8d0ff] | 110 |
|
---|
| 111 | <para>
|
---|
[ac4f67e] | 112 | To test the results, ensure <command>Xvfb</command> and
|
---|
| 113 | <xref linkend='xkeyboard-config'/> are available, then issue:
|
---|
| 114 | <command>ninja test</command>.
|
---|
[1c8d0ff] | 115 | </para>
|
---|
| 116 |
|
---|
| 117 | <para>
|
---|
| 118 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 119 | </para>
|
---|
| 120 |
|
---|
[d4ef6ae] | 121 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
[1c8d0ff] | 122 |
|
---|
| 123 | </sect2>
|
---|
[d4ef6ae] | 124 |
|
---|
[1c8d0ff] | 125 | <sect2 role="commands">
|
---|
| 126 | <title>Command Explanations</title>
|
---|
[8558044] | 127 |
|
---|
[20f070d8] | 128 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 129 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 130 |
|
---|
[d4ef6ae] | 131 | <!--
|
---|
[1c8d0ff] | 132 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 133 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 134 |
|
---|
| 135 | <para>
|
---|
[d4ef6ae] | 136 | <option>- -disable-x11</option>: Use this switch if you
|
---|
[1c8d0ff] | 137 | have not installed <xref linkend="libxcb"/> and
|
---|
| 138 | don't need the <filename>libxkbcommon-x11.so</filename>
|
---|
| 139 | library.
|
---|
| 140 | </para>
|
---|
[d4ef6ae] | 141 | -->
|
---|
| 142 |
|
---|
| 143 | <para>
|
---|
[7c83169b] | 144 | <parameter>-D enable-docs=true</parameter>: This switch enables
|
---|
[7a7b390] | 145 | documentation generation. The <xref linkend="doxygen"/> is
|
---|
| 146 | required.
|
---|
[d4ef6ae] | 147 | </para>
|
---|
[1c8d0ff] | 148 |
|
---|
[d4ef6ae] | 149 | <para>
|
---|
| 150 | <command>mv -v /usr/share/doc/libxkbcommon{,-&libxkbcommon-version;}</command>:
|
---|
[cf063edb] | 151 | If you built the documentation, use this command to install
|
---|
[7a7b390] | 152 | it in a versioned directory.
|
---|
[d4ef6ae] | 153 | </para>
|
---|
[8558044] | 154 |
|
---|
[1c8d0ff] | 155 | </sect2>
|
---|
[d4ef6ae] | 156 |
|
---|
[1c8d0ff] | 157 | <sect2 role="content">
|
---|
| 158 | <title>Contents</title>
|
---|
| 159 |
|
---|
| 160 | <segmentedlist>
|
---|
| 161 | <segtitle>Installed Programs</segtitle>
|
---|
| 162 | <segtitle>Installed Libraries</segtitle>
|
---|
| 163 | <segtitle>Installed Directories</segtitle>
|
---|
| 164 |
|
---|
| 165 | <seglistitem>
|
---|
| 166 | <seg>
|
---|
[572618ad] | 167 | xkbcli
|
---|
[1c8d0ff] | 168 | </seg>
|
---|
| 169 | <seg>
|
---|
[572618ad] | 170 | libxkbcommon.so,
|
---|
| 171 | libxkbcommon-x11.so, and
|
---|
| 172 | libxkbregistry.so
|
---|
[1c8d0ff] | 173 | </seg>
|
---|
| 174 | <seg>
|
---|
[572618ad] | 175 | /usr/include/xkbcommon,
|
---|
| 176 | /usr/libexec/xkbcommon, and
|
---|
[1c8d0ff] | 177 | /usr/share/doc/libxkbcommon-&libxkbcommon-version;
|
---|
| 178 | </seg>
|
---|
| 179 | </seglistitem>
|
---|
| 180 | </segmentedlist>
|
---|
| 181 |
|
---|
| 182 | <variablelist>
|
---|
| 183 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 184 | <?dbfo list-presentation="list"?>
|
---|
| 185 | <?dbhtml list-presentation="table"?>
|
---|
| 186 |
|
---|
[572618ad] | 187 | <varlistentry id="xkbcli">
|
---|
| 188 | <term><command>xkbcli</command></term>
|
---|
| 189 | <listitem>
|
---|
| 190 | <para>
|
---|
[4c24eb0a] | 191 | provides a debugger and compiler for XKB keymaps
|
---|
[572618ad] | 192 | </para>
|
---|
| 193 | <indexterm zone="libxkbcommon xkbcli">
|
---|
| 194 | <primary sortas="b-xkbcli">xkbcli</primary>
|
---|
| 195 | </indexterm>
|
---|
| 196 | </listitem>
|
---|
| 197 | </varlistentry>
|
---|
| 198 |
|
---|
[1c8d0ff] | 199 | <varlistentry id="libxkbcommon-lib">
|
---|
| 200 | <term><filename class="libraryfile">libxkbcommon.so</filename></term>
|
---|
| 201 | <listitem>
|
---|
| 202 | <para>
|
---|
[4c24eb0a] | 203 | contains the <application>libxkbcommon</application> API functions
|
---|
[1c8d0ff] | 204 | </para>
|
---|
| 205 | <indexterm zone="libxkbcommon libxkbcommon-lib">
|
---|
| 206 | <primary sortas="c-libxkbcommon">libxkbcommon.so</primary>
|
---|
| 207 | </indexterm>
|
---|
| 208 | </listitem>
|
---|
| 209 | </varlistentry>
|
---|
| 210 |
|
---|
| 211 | <varlistentry id="libxkbcommon-x11">
|
---|
| 212 | <term><filename class="libraryfile">libxkbcommon-x11.so</filename></term>
|
---|
| 213 | <listitem>
|
---|
| 214 | <para>
|
---|
| 215 | contains the <application>libxkbcommon</application> X11 specific API
|
---|
[4c24eb0a] | 216 | functions
|
---|
[1c8d0ff] | 217 | </para>
|
---|
| 218 | <indexterm zone="libxkbcommon libxkbcommon-x11">
|
---|
| 219 | <primary sortas="c-libxkbcommon-x11">libxkbcommon-x11.so</primary>
|
---|
| 220 | </indexterm>
|
---|
| 221 | </listitem>
|
---|
[572618ad] | 222 | </varlistentry>
|
---|
| 223 |
|
---|
| 224 | <varlistentry id="libxkbregistry">
|
---|
| 225 | <term><filename class="libraryfile">libxkbregistry.so</filename></term>
|
---|
| 226 | <listitem>
|
---|
| 227 | <para>
|
---|
| 228 | contains a list of available XKB models, layouts, and variants for a
|
---|
[4c24eb0a] | 229 | given ruleset
|
---|
[572618ad] | 230 | </para>
|
---|
| 231 | <indexterm zone="libxkbcommon libxkbregistry">
|
---|
| 232 | <primary sortas="c-libxkbregistry">libxkbregistry.so</primary>
|
---|
| 233 | </indexterm>
|
---|
| 234 | </listitem>
|
---|
| 235 | </varlistentry>
|
---|
[1c8d0ff] | 236 |
|
---|
| 237 | </variablelist>
|
---|
| 238 |
|
---|
| 239 | </sect2>
|
---|
| 240 |
|
---|
| 241 | </sect1>
|
---|