1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
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 libei-download-http "https://gitlab.freedesktop.org/libinput/libei/-/archive/&libei-version;/libei-&libei-version;.tar.gz">
|
---|
8 | <!ENTITY libei-download-ftp " ">
|
---|
9 | <!ENTITY libei-md5sum "b0dcf2325c3c0cc51ebdd1aca51c4a55">
|
---|
10 | <!ENTITY libei-size "228 KB">
|
---|
11 | <!ENTITY libei-buildsize "5.2 MB">
|
---|
12 | <!ENTITY libei-time "less than 0.1 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="libei" xreflabel="libei-&libei-version;">
|
---|
16 | <?dbhtml filename="libei.html"?>
|
---|
17 |
|
---|
18 | <title>libei-&libei-version;</title>
|
---|
19 |
|
---|
20 | <indexterm zone="libei">
|
---|
21 | <primary sortas="a-libei">libei</primary>
|
---|
22 | </indexterm>
|
---|
23 |
|
---|
24 | <sect2 role="package">
|
---|
25 | <title>Introduction to libei</title>
|
---|
26 |
|
---|
27 | <para>
|
---|
28 | The <application>libei</application> package contains a set of libraries
|
---|
29 | for handling emulated inputs. It is primarily aimed at the Wayland stack.
|
---|
30 | </para>
|
---|
31 |
|
---|
32 | &lfs120_checked;
|
---|
33 |
|
---|
34 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
35 | <itemizedlist spacing="compact">
|
---|
36 | <listitem>
|
---|
37 | <para>
|
---|
38 | Download (HTTP): <ulink url="&libei-download-http;"/>
|
---|
39 | </para>
|
---|
40 | </listitem>
|
---|
41 | <listitem>
|
---|
42 | <para>
|
---|
43 | Download (FTP): <ulink url="&libei-download-ftp;"/>
|
---|
44 | </para>
|
---|
45 | </listitem>
|
---|
46 | <listitem>
|
---|
47 | <para>
|
---|
48 | Download MD5 sum: &libei-md5sum;
|
---|
49 | </para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>
|
---|
53 | Download size: &libei-size;
|
---|
54 | </para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>
|
---|
58 | Estimated disk space required: &libei-buildsize;
|
---|
59 | </para>
|
---|
60 | </listitem>
|
---|
61 | <listitem>
|
---|
62 | <para>
|
---|
63 | Estimated build time: &libei-time;
|
---|
64 | </para>
|
---|
65 | </listitem>
|
---|
66 | </itemizedlist>
|
---|
67 |
|
---|
68 | <bridgehead renderas="sect3">libei Dependencies</bridgehead>
|
---|
69 |
|
---|
70 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
71 | <para role="required">
|
---|
72 | <xref linkend="attrs"/>
|
---|
73 | </para>
|
---|
74 |
|
---|
75 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
76 | <para role="optional">
|
---|
77 | <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
|
---|
78 | <xref linkend="libevdev"/>,
|
---|
79 | <xref linkend="libxkbcommon"/>,
|
---|
80 | <xref linkend="libxml2"/>, and
|
---|
81 | <ulink url="https://github.com/nemequ/munit">munit</ulink>
|
---|
82 | </para>
|
---|
83 | </sect2>
|
---|
84 |
|
---|
85 | <sect2 role="installation">
|
---|
86 | <title>Installation of libei</title>
|
---|
87 |
|
---|
88 | <para>
|
---|
89 | Install <application>libei</application> by running the following
|
---|
90 | commands:
|
---|
91 | </para>
|
---|
92 |
|
---|
93 | <screen><userinput>mkdir build &&
|
---|
94 | cd build &&
|
---|
95 |
|
---|
96 | meson setup --prefix=/usr --buildtype=release -Dtests=disabled .. &&
|
---|
97 | ninja</userinput></screen>
|
---|
98 |
|
---|
99 | <para>
|
---|
100 | This package does come with a test suite, but it requires an external
|
---|
101 | dependency. If you have
|
---|
102 | <ulink url="https://github.com/nemequ/munit">munit</ulink> installed and
|
---|
103 | wish to run the test suite, run the following commands:
|
---|
104 | </para>
|
---|
105 |
|
---|
106 | <screen remap="test"><userinput>meson configure -Dtests=enabled .. &&
|
---|
107 | ninja test</userinput></screen>
|
---|
108 |
|
---|
109 | <para>
|
---|
110 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
111 | </para>
|
---|
112 |
|
---|
113 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
114 |
|
---|
115 | </sect2>
|
---|
116 |
|
---|
117 | <sect2 role="commands">
|
---|
118 | <title>Command Explanations</title>
|
---|
119 |
|
---|
120 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
121 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
122 |
|
---|
123 | <para>
|
---|
124 | <parameter>-Dtests=disabled</parameter>: This switch avoids a dependency
|
---|
125 | on <ulink url="https://github.com/nemequ/munit">munit</ulink>. Remove this
|
---|
126 | switch if you have <application>munit</application> installed and wish to
|
---|
127 | run the test suite.
|
---|
128 | </para>
|
---|
129 |
|
---|
130 | </sect2>
|
---|
131 |
|
---|
132 | <sect2 role="content">
|
---|
133 | <title>Contents</title>
|
---|
134 |
|
---|
135 | <segmentedlist>
|
---|
136 | <segtitle>Installed Programs</segtitle>
|
---|
137 | <segtitle>Installed Libraries</segtitle>
|
---|
138 | <segtitle>Installed Directories</segtitle>
|
---|
139 |
|
---|
140 | <seglistitem>
|
---|
141 | <seg>
|
---|
142 | None
|
---|
143 | </seg>
|
---|
144 | <seg>
|
---|
145 | libei.so,
|
---|
146 | libeis.so, and
|
---|
147 | liboeffis.so
|
---|
148 | </seg>
|
---|
149 | <seg>
|
---|
150 | /usr/include/libei-1.0
|
---|
151 | </seg>
|
---|
152 | </seglistitem>
|
---|
153 | </segmentedlist>
|
---|
154 |
|
---|
155 | <variablelist>
|
---|
156 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
157 | <?dbfo list-presentation="list"?>
|
---|
158 | <?dbhtml list-presentation="table"?>
|
---|
159 |
|
---|
160 | <varlistentry id="libei-lib">
|
---|
161 | <term><filename class="libraryfile">libei.so</filename></term>
|
---|
162 | <listitem>
|
---|
163 | <para>
|
---|
164 | provides a client side implementation for handling Emulated Input
|
---|
165 | </para>
|
---|
166 | <indexterm zone="libei libei-lib">
|
---|
167 | <primary sortas="c-libei">libei.so</primary>
|
---|
168 | </indexterm>
|
---|
169 | </listitem>
|
---|
170 | </varlistentry>
|
---|
171 |
|
---|
172 | <varlistentry id="libeis">
|
---|
173 | <term><filename class="libraryfile">libeis.so</filename></term>
|
---|
174 | <listitem>
|
---|
175 | <para>
|
---|
176 | provides a server side implementation for handling Emulated Input
|
---|
177 | </para>
|
---|
178 | <indexterm zone="libei libeis">
|
---|
179 | <primary sortas="c-libeis">libeis.so</primary>
|
---|
180 | </indexterm>
|
---|
181 | </listitem>
|
---|
182 | </varlistentry>
|
---|
183 |
|
---|
184 | <varlistentry id="liboffis">
|
---|
185 | <term><filename class="libraryfile">liboffis</filename></term>
|
---|
186 | <listitem>
|
---|
187 | <para>
|
---|
188 | provides DBus communication services between libei and the XDG
|
---|
189 | RemoteDesktop portal
|
---|
190 | </para>
|
---|
191 | <indexterm zone="libei liboffis">
|
---|
192 | <primary sortas="c-liboffis">liboffis.so</primary>
|
---|
193 | </indexterm>
|
---|
194 | </listitem>
|
---|
195 | </varlistentry>
|
---|
196 | </variablelist>
|
---|
197 | </sect2>
|
---|
198 | </sect1>
|
---|