source: x/installing/xkeyboard-config.xml@ 1c96292

<?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 xkeyboard-config-download-http "http://xlibs.freedesktop.org/xkbdesc/xkeyboard-config-&xkeyboard-config-version;.tar.bz2">
  <!-- x.org FTP link only points to xkeyboard-config from xorg release
  <!ENTITY xkeyboard-config-download-ftp  "ftp://ftp.x.org/pub/current/src/extras/xkeyboard-config-&xkeyboard-config-version;.tar.bz2">
  -->
  <!ENTITY xkeyboard-config-download-ftp  " ">
  <!ENTITY xkeyboard-config-md5sum        "d351c0109fac166edcedad32d1b0e38e">
  <!ENTITY xkeyboard-config-size          "624 KB">
  <!ENTITY xkeyboard-config-buildsize     "9.5 MB">
  <!ENTITY xkeyboard-config-time          "less than 0.1 SBU">
]>

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

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

  <title>XKeyboardConfig-&xkeyboard-config-version;</title>

  <indexterm zone="xkeyboard-config">
    <primary sortas="a-XKeyboardConfig">XKeyboardConfig</primary>
  </indexterm>

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

    <para>The <application>XKeyboardConfig</application> package contains
    the keyboard configuration database for the X Window System.</para>

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required"><xref linkend="intltool"/>,
    <xref linkend="xorg7-app"/>, and
    <xref linkend="perl-xml-parser"/></para>

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

  </sect2>

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

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

<screen><userinput>./configure $XORG_CONFIG --with-xkb-rules-symlink=xorg &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 &amp;&amp;
install -dv -m755 $XORG_PREFIX/share/doc/xkeyboard-config-&xkeyboard-config-version; &amp;&amp;
install -v -m644 docs/{README,HOWTO}* \
    $XORG_PREFIX/share/doc/xkeyboard-config-&xkeyboard-config-version;</userinput></screen>

  </sect2>

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

    <para><parameter>--with-xkb-rules-symlink=xorg</parameter>: By default,
    the XKB rules installed are named "base". This creates symlinks named
    "xorg" to those rules, which is the default name used by Xorg.</para>

  </sect2>

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

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

      <seglistitem>
        <seg>None</seg>
        <seg>None</seg>
        <seg><envar>$XORG_PREFIX</envar>/share/X11/xkb,
        <envar>$XORG_PREFIX</envar>/share/doc/xkeyboard-config-&xkeyboard-config-version;</seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>