source: x/lib/libxklavier.xml@ 2a47206

<?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 libxklavier-download-http 
           "&gnome-download-http;/libxklavier/5.3/libxklavier-&libxklavier-version;.tar.xz">
  <!ENTITY libxklavier-download-ftp  
           "&gnome-download-ftp;/libxklavier/5.3/libxklavier-&libxklavier-version;.tar.xz">
  <!ENTITY libxklavier-md5sum        "290ea2a8abc40f78a3a16bdae6f02808">
  <!ENTITY libxklavier-size          "312 KB">
  <!ENTITY libxklavier-buildsize     "5.5 MB">
  <!ENTITY libxklavier-time          "less than 0.1 SBU">
]>

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

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

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

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

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

    <para>
      The <application>libxklavier</application> package contains a
      utility library for <application>X</application> keyboard.
    </para>

    &lfs72_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="glib2"/>,
      <xref linkend="iso-codes"/>,
      <xref linkend="libxml2"/> and
      <xref linkend="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
    </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;/libxklavier"/>
    </para>
  </sect2>

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

    <para>
      Install <application>libxklavier</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>

    <para>
      <parameter>--with-xkb-base=$XORG_PREFIX/share/X11/xkb</parameter>:
      Use this swithc if the $XORG_PREFIX is anything other than
      <filename class="directory">/usr</filename>.
    </para>

    <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 Library</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          libxklavier.so
        </seg>
        <seg>
          /usr/include/libxklavier and
          /usr/share/gtk-doc/html/libxklavier
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="libxklavier-lib">
        <term><filename class="libraryfile">libxklavier.so</filename></term>
        <listitem>
          <para>
            contains XKB utility functions.
          </para>
          <indexterm zone="libxklavier libxklavier-lib">
            <primary sortas="c-libxklavier">libxklavier.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>