source: x/lib/libei.xml@ 5a8fde2a

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY libei-download-http "https://gitlab.freedesktop.org/libinput/libei/-/archive/&libei-version;/libei-&libei-version;.tar.gz">
  <!ENTITY libei-download-ftp  " ">
  <!ENTITY libei-md5sum        "aeaffcb5afb5ad0bb9981eb93c4cd610">
  <!ENTITY libei-size          "228 KB">
  <!ENTITY libei-buildsize     "5.4 MB">
  <!ENTITY libei-time          "less than 0.1 SBU">
]>

<sect1 id="libei" xreflabel="libei-&libei-version;">
  <?dbhtml filename="libei.html"?>

  <title>libei-&libei-version;</title>

  <indexterm zone="libei">
    <primary sortas="a-libei">libei</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to libei</title>

    <para>
      The <application>libei</application> package contains a set of libraries
      for handling emulated inputs. It is primarily aimed at the Wayland stack.
    </para>

    &lfs122_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&libei-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&libei-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &libei-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &libei-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &libei-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &libei-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">libei Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="attrs"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <phrase revision="sysv"><xref linkend="elogind"/>,</phrase>
      <xref linkend="libevdev"/>,
      <xref linkend="libxkbcommon"/>,
      <xref linkend="libxml2"/>,
      <ulink url="https://github.com/nemequ/munit">munit</ulink>, and
      <ulink url="https://pypi.org/project/structlog/">structlog</ulink>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of libei</title>

    <para>
      Install <application>libei</application> by running the following
      commands:
    </para>

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

meson setup --prefix=/usr --buildtype=release -D tests=disabled &amp;&amp;
ninja</userinput></screen>

    <para>
      This package does come with a test suite, but it requires an external
      dependency. If you have both
      <ulink url="https://github.com/nemequ/munit">munit</ulink> and
      <ulink url="https://pypi.org/project/structlog/">structlog</ulink>
      installed, and you wish to run the test suite, run the following
      commands:
    </para>

<screen remap="test"><userinput>meson configure -D tests=enabled .. &amp;&amp;
ninja test</userinput></screen>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>ninja install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/meson-buildtype-release.xml"/>

    <para>
      <parameter>-D tests=disabled</parameter>: This switch avoids a dependency
      on <ulink url="https://github.com/nemequ/munit">munit</ulink>. Remove this
      switch if you have <application>munit</application> installed and wish to
      run the test suite.
    </para>
    
  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libei.so,
          libeis.so, and
          liboeffis.so
        </seg>
        <seg>
          /usr/include/libei-1.0
        </seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="libei-lib">
        <term><filename class="libraryfile">libei.so</filename></term>
        <listitem>
          <para>
            provides a client side implementation for handling Emulated Input
          </para>
          <indexterm zone="libei libei-lib">
            <primary sortas="c-libei">libei.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      
      <varlistentry id="libeis">
        <term><filename class="libraryfile">libeis.so</filename></term>
        <listitem>
          <para>
            provides a server side implementation for handling Emulated Input
          </para>
          <indexterm zone="libei libeis">
            <primary sortas="c-libeis">libeis.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
      
      <varlistentry id="liboffis">
        <term><filename class="libraryfile">liboffis</filename></term>
        <listitem>
          <para>
            provides DBus communication services between libei and the XDG
            RemoteDesktop portal
          </para>
          <indexterm zone="libei liboffis">
            <primary sortas="c-liboffis">liboffis.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>
    </variablelist>
  </sect2>
</sect1>