source: gnome/platform/libxkbcommon.xml@ 1840044

<?xml version="1.0" encoding="ISO-8859-1"?>
<!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 libxkbcommon-download-http "https://github.com/xkbcommon/libxkbcommon/archive/xkbcommon-&libxkbcommon-version;.tar.xz">
  <!ENTITY libxkbcommon-download-ftp  " ">
  <!ENTITY libxkbcommon-md5sum        "2a7e74c3cbffb06e7b3c6a7581d39297">
  <!ENTITY libxkbcommon-size          "464 KB">
  <!ENTITY libxkbcommon-buildsize     "8.5 MB">
  <!ENTITY libxkbcommon-time          "0.2 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

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

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

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

    <para>
     The <application>libxkbcommon</application> is a keymap compiler and support library which 
     processes a reduced subset of keymaps as defined by the XKB specification. 
     Primarily, a keymap is created from a set of Rules/Model/Layout/Variant/Options names, 
     processed through an XKB ruleset, and compiled into a struct xkb_keymap, which is 
     the base type for all xkbcommon operations.
    </para>

    &lfs75_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libevdev"/>, and
      <xref linkend="mtdev"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/libxkbcommon"/>
    </para>
  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --disable-static &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

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

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

  </sect2>

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

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

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/gtk-doc-rebuild.xml"/>

  </sect2>

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

    <segmentedlist>
      <segtitle>Installed Program</segtitle>
      <segtitle>Installed Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          libxkbcommon-binding-tool
        </seg>
        <seg>
          liblibxkbcommon-1.0.so
        </seg>
        <seg>
          /usr/include/libxkbcommon-1.0 and
          /usr/share/gtk-doc/html/libxkbcommon
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libxkbcommon-binding-tool">
        <term><command>libxkbcommon-binding-tool</command></term>
        <listitem>
          <para>
            creates C convenience wrappers for UPnP services.
          </para>
          <indexterm zone="libxkbcommon libxkbcommon-binding-tool">
            <primary sortas="b-libxkbcommon-binding-tool">libxkbcommon-binding-tool</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="liblibxkbcommon-1">
        <term><filename class='libraryfile'>liblibxkbcommon-1.0.so</filename></term>
        <listitem>
          <para>
            contains the <application>libxkbcommon</application> API functions.
          </para>
          <indexterm zone="libxkbcommon liblibxkbcommon-1">
            <primary sortas="c-liblibxkbcommon-1">liblibxkbcommon-1.0.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>