source: x/lib/libxklavier.xml@ 3f5f915

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

  <!ENTITY libxklavier-download-http "http://prdownloads.sourceforge.net/gswitchit/libxklavier-&libxklavier-version;.tar.gz">
  <!ENTITY libxklavier-download-ftp  " ">
  <!ENTITY libxklavier-md5sum        "9257653ee3d194d9c8d669e969fe4332">
  <!ENTITY libxklavier-size          "435 KB">
  <!ENTITY libxklavier-buildsize     "7.0 MB">
  <!ENTITY libxklavier-time          "0.12 SBU">
]>

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

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
    <keywordset>
      <keyword role="package">libxklavier-&libxklavier-version;.tar</keyword>
      <keyword role="ftpdir">libxklavier</keyword>
    </keywordset>
  </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>

    <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">X (<xref linkend="xfree86"/> or <xref linkend="xorg"/>),
    <xref linkend="pkgconfig"/> and
    <xref linkend="libxml2"/></para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional"><xref linkend="doxygen"/></para>

  </sect2>

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

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

<screen><userinput>sed -i "s/-Wall -Werror/-Wall/" libxklavier/Makefile.{am,in} &amp;&amp;
./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <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><command>sed -i "..." libxklavier/Makefile.{am,in}</command>: Using
    <application>GCC</application>-4.x to compile this package will create
    warnings which are treated as errors and the build fails. This command
    removes the flags that cause the warnings to be treated as errors.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>libxklavier.[so,a]</seg>
        <seg>/usr/include/libxklavier, /usr/share/doc/libxklavier-2.0, and
        /usr/share/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,a]</filename></term>
        <listitem>
          <para>contains XKB utility functions.</para>
          <indexterm zone="libxklavier libxklavier-lib">
            <primary sortas="c-libxklavier">libxklavier.[so,a]</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>