source: general/genlib/libxkbcommon.xml@ 45ab6c7

11.0 qt5new trunk
Last change on this file since 45ab6c7 was 45ab6c7, checked in by Xi Ruoyao <xry111@…>, 5 months ago

more SVN prop clean up

Remove "$LastChanged$" everywhere, and also some unused $Date$

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