source: x/installing/xkeyboard-config.xml@ 6d8eeb9

<?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 xkeyboard-config-download-http
  "&xorg-download-http;/data/xkeyboard-config/xkeyboard-config-&xkeyboard-config-version;.tar.xz">
  <!ENTITY xkeyboard-config-download-ftp  " ">
  <!ENTITY xkeyboard-config-md5sum        "2f0b843b5283b82cae0402cbc4f374b4">
  <!ENTITY xkeyboard-config-size          "880 KB">
  <!ENTITY xkeyboard-config-buildsize     "20 MB">
  <!ENTITY xkeyboard-config-time          "0.1 SBU (with tests)">
]>

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


  <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>

    &lfs121_checked;

    <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="xorg7-lib"/>
    </para>

    <bridgehead renderas="sect4">Optional (required for tests)</bridgehead>
    <para role="optional">
      <xref linkend="libxkbcommon"/>,
      <xref linkend="pytest"/>, and
      <xref linkend="xorg7-app"/>
    </para>

  </sect2>

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

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

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

meson setup --prefix=$XORG_PREFIX --buildtype=release .. &amp;&amp;
ninja</userinput></screen>

    <para>
      To test the results, issue: <command>ninja test</command>.
    </para>

    <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"/>
<!-- the default for the xorg symlinks is false. So the change to
     the symlink command is not needed. Note that those symlinks have
     been deprecated since 2005...
    <para>
      <command>sed ... rules/meson.build</command>: Make sure
      a symlink is created even if it already exists.
    </para>
    <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
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>