[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[c3c14d12] | 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 |
|
---|
[ec2cf199] | 7 | <!ENTITY libei-download-http "https://gitlab.freedesktop.org/libinput/libei/-/archive/&libei-version;/libei-&libei-version;.tar.gz">
|
---|
[c3c14d12] | 8 | <!ENTITY libei-download-ftp " ">
|
---|
[482148e] | 9 | <!ENTITY libei-md5sum "aeaffcb5afb5ad0bb9981eb93c4cd610">
|
---|
[4a23c961] | 10 | <!ENTITY libei-size "228 KB">
|
---|
[482148e] | 11 | <!ENTITY libei-buildsize "5.4 MB">
|
---|
[4a23c961] | 12 | <!ENTITY libei-time "less than 0.1 SBU">
|
---|
[c3c14d12] | 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 |
|
---|
[f2574af5] | 32 | &lfs122_checked;
|
---|
[c3c14d12] | 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"/>,
|
---|
[3c8e262] | 80 | <xref linkend="libxml2"/>,
|
---|
| 81 | <ulink url="https://github.com/nemequ/munit">munit</ulink>, and
|
---|
| 82 | <ulink url="https://pypi.org/project/structlog/">structlog</ulink>
|
---|
[c3c14d12] | 83 | </para>
|
---|
| 84 | </sect2>
|
---|
| 85 |
|
---|
| 86 | <sect2 role="installation">
|
---|
| 87 | <title>Installation of libei</title>
|
---|
| 88 |
|
---|
| 89 | <para>
|
---|
| 90 | Install <application>libei</application> by running the following
|
---|
| 91 | commands:
|
---|
| 92 | </para>
|
---|
| 93 |
|
---|
| 94 | <screen><userinput>mkdir build &&
|
---|
| 95 | cd build &&
|
---|
| 96 |
|
---|
[6b9809b] | 97 | meson setup --prefix=/usr --buildtype=release -D tests=disabled &&
|
---|
[c3c14d12] | 98 | ninja</userinput></screen>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
| 101 | This package does come with a test suite, but it requires an external
|
---|
[3c8e262] | 102 | dependency. If you have both
|
---|
| 103 | <ulink url="https://github.com/nemequ/munit">munit</ulink> and
|
---|
| 104 | <ulink url="https://pypi.org/project/structlog/">structlog</ulink>
|
---|
| 105 | installed, and you wish to run the test suite, run the following
|
---|
| 106 | commands:
|
---|
[c3c14d12] | 107 | </para>
|
---|
| 108 |
|
---|
[2652614] | 109 | <screen remap="test"><userinput>meson configure -D tests=enabled .. &&
|
---|
[c3c14d12] | 110 | ninja test</userinput></screen>
|
---|
| 111 |
|
---|
| 112 | <para>
|
---|
| 113 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 114 | </para>
|
---|
| 115 |
|
---|
| 116 | <screen role="root"><userinput>ninja install</userinput></screen>
|
---|
| 117 |
|
---|
| 118 | </sect2>
|
---|
| 119 |
|
---|
| 120 | <sect2 role="commands">
|
---|
| 121 | <title>Command Explanations</title>
|
---|
| 122 |
|
---|
| 123 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 124 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 125 |
|
---|
| 126 | <para>
|
---|
[afd7fb5] | 127 | <parameter>-D tests=disabled</parameter>: This switch avoids a dependency
|
---|
[c3c14d12] | 128 | on <ulink url="https://github.com/nemequ/munit">munit</ulink>. Remove this
|
---|
| 129 | switch if you have <application>munit</application> installed and wish to
|
---|
| 130 | run the test suite.
|
---|
| 131 | </para>
|
---|
| 132 |
|
---|
| 133 | </sect2>
|
---|
| 134 |
|
---|
| 135 | <sect2 role="content">
|
---|
| 136 | <title>Contents</title>
|
---|
| 137 |
|
---|
| 138 | <segmentedlist>
|
---|
| 139 | <segtitle>Installed Programs</segtitle>
|
---|
| 140 | <segtitle>Installed Libraries</segtitle>
|
---|
| 141 | <segtitle>Installed Directories</segtitle>
|
---|
| 142 |
|
---|
| 143 | <seglistitem>
|
---|
| 144 | <seg>
|
---|
| 145 | None
|
---|
| 146 | </seg>
|
---|
| 147 | <seg>
|
---|
| 148 | libei.so,
|
---|
| 149 | libeis.so, and
|
---|
| 150 | liboeffis.so
|
---|
| 151 | </seg>
|
---|
| 152 | <seg>
|
---|
| 153 | /usr/include/libei-1.0
|
---|
| 154 | </seg>
|
---|
| 155 | </seglistitem>
|
---|
| 156 | </segmentedlist>
|
---|
| 157 |
|
---|
| 158 | <variablelist>
|
---|
| 159 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 160 | <?dbfo list-presentation="list"?>
|
---|
| 161 | <?dbhtml list-presentation="table"?>
|
---|
| 162 |
|
---|
| 163 | <varlistentry id="libei-lib">
|
---|
| 164 | <term><filename class="libraryfile">libei.so</filename></term>
|
---|
| 165 | <listitem>
|
---|
| 166 | <para>
|
---|
| 167 | provides a client side implementation for handling Emulated Input
|
---|
| 168 | </para>
|
---|
| 169 | <indexterm zone="libei libei-lib">
|
---|
| 170 | <primary sortas="c-libei">libei.so</primary>
|
---|
| 171 | </indexterm>
|
---|
| 172 | </listitem>
|
---|
| 173 | </varlistentry>
|
---|
| 174 |
|
---|
| 175 | <varlistentry id="libeis">
|
---|
| 176 | <term><filename class="libraryfile">libeis.so</filename></term>
|
---|
| 177 | <listitem>
|
---|
| 178 | <para>
|
---|
| 179 | provides a server side implementation for handling Emulated Input
|
---|
| 180 | </para>
|
---|
| 181 | <indexterm zone="libei libeis">
|
---|
| 182 | <primary sortas="c-libeis">libeis.so</primary>
|
---|
| 183 | </indexterm>
|
---|
| 184 | </listitem>
|
---|
| 185 | </varlistentry>
|
---|
| 186 |
|
---|
| 187 | <varlistentry id="liboffis">
|
---|
| 188 | <term><filename class="libraryfile">liboffis</filename></term>
|
---|
| 189 | <listitem>
|
---|
| 190 | <para>
|
---|
| 191 | provides DBus communication services between libei and the XDG
|
---|
| 192 | RemoteDesktop portal
|
---|
| 193 | </para>
|
---|
| 194 | <indexterm zone="libei liboffis">
|
---|
| 195 | <primary sortas="c-liboffis">liboffis.so</primary>
|
---|
| 196 | </indexterm>
|
---|
| 197 | </listitem>
|
---|
| 198 | </varlistentry>
|
---|
| 199 | </variablelist>
|
---|
| 200 | </sect2>
|
---|
| 201 | </sect1>
|
---|