source: archive/keybinder2.xml

<?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 keybinder2-download-http
           "https://github.com/kupferlauncher/keybinder/releases/download/v&keybinder2-version;/keybinder-&keybinder2-version;.tar.gz">
  <!ENTITY keybinder2-download-ftp " ">
  <!ENTITY keybinder2-md5sum        "a6d7caae0dcb040b08692b008a68a507">
  <!ENTITY keybinder2-size          "384 KB">
  <!ENTITY keybinder2-buildsize     "2.8 MB">
  <!ENTITY keybinder2-time          "less than 0.1 SBU">
]>

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


  <title>keybinder-&keybinder2-version;</title>

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

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

    <para>
      The <application>keybinder</application> package contains a utility
      library registering global <application>X</application> keyboard
      shortcuts.
    </para>

    &lfs120_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="gtk2"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/> and
      <xref linkend="pygtk"/>
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
      <xref linkend="gtk-doc"/> and
      <xref linkend="lua"/> (currently broken because an older lua version
      is required)
    </para>

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr --disable-lua &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>--disable-lua</parameter>: Use this switch to disable <xref
      linkend="lua"/> bindings (currently broken, because older lua version is
      required).
    </para>

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

      <seglistitem>
        <seg>
          None
        </seg>
        <seg>
          libkeybinder.so and
          /usr/lib/python&python2-majorver;/site-packages/keybinder/_keybinder.so
        </seg>
        <seg>
          /usr/lib/python&python2-majorver;/site-packages/keybinder and
          /usr/share/gtk-doc/html/keybinder
        </seg>
      </seglistitem>
    </segmentedlist>

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

      <varlistentry id="keybinder2-lib">
        <term><filename class="libraryfile">libkeybinder.so</filename></term>
        <listitem>
          <para>
            is the library that registers global <application>X</application>
            keyboard shortcuts
          </para>
          <indexterm zone="keybinder2 keybinder2-lib">
            <primary sortas="c-keybinder2">libkeybinder.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>