source: gnome/core/caribou.xml@ f41cb316

<?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 caribou-download-http "&gnome-download-http;/caribou/0.4/caribou-&caribou-version;.tar.xz">
  <!ENTITY caribou-download-ftp  "&gnome-download-ftp;/caribou/0.4/caribou-&caribou-version;.tar.xz">
  <!ENTITY caribou-md5sum        "0e3ba9db7bc9dd9dbd04a4007aac3cf3">
  <!ENTITY caribou-size          "368 KB">
  <!ENTITY caribou-buildsize     "10 MB">
  <!ENTITY caribou-time          "0.2 SBU">
]>

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

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

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

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

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

    <para><application>Caribou</application> is an input assistive technology 
    intended for switch and pointer users. </para>

    &lfs70_checked;

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

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

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="clutter"/>,
      <xref linkend="gnome-doc-utils"/>,
      <xref linkend="gtk3"/>,
      <xref linkend="libgee"/>,
      <xref linkend="libxklavier"/>,
      <xref linkend="pygobject3"/> and
      <xref linkend="vala"/>
    </para>

    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
      <xref linkend="gobject-introspection"/>
      (Required if building GNOME)
    </para>

    <bridgehead renderas="sect4">Additional Runtime Dependencies</bridgehead>
    <para role="optional">For most <application>GNOME</application> users, this
      package is only required as a compile-time dependency for other packages. If
      you intend to use its keyboard you will require
      <xref linkend="pyatspi2"/>,
      <xref linkend="dbus-python"/> and 
      <xref linkend="dconf"/> at runtime.
    </para>

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

  </sect2>

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

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

<screen><userinput>./configure --prefix=/usr \
            --sysconfdir=/etc \
            --libexecdir=/usr/lib/caribou \
            --disable-gtk2-module \
            --disable-static &amp;&amp;
make</userinput></screen>

    <para>This package's testsuite is only intended to be used by the
    maintainer to check i18n files.</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>--libexecdir=/usr/lib/caribou</parameter>: This
    parameter ensures <filename>antler-keyboard</filename> is put in a directory
    which accords with the FHS instead of
    <filename class="directory">/usr/libexec</filename>.</para>

    <para><parameter>--disable-gtk2-module</parameter>: Because
    <application>GNOME</application> now uses <application>Gtk+-3</application>,
    the module has no use in a <application>GNOME</application> desktop.</para>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
    href="../../xincludes/static-libraries.xml"/>

  </sect2>

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

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

      <seglistitem>
        <seg>
          caribou and caribou-preferences
        </seg>
        <seg>
          libcaribou.so
        </seg>
        <seg>
          /usr/include/libcaribou, /usr/lib/caribou,
          /usr/lib/python2.7/site-packages/caribou,
          /usr/share/antler and /usr/share/caribou
        </seg>
      </seglistitem>
    </segmentedlist>

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

<!--      <varlistentry id="caribou-prog">
        <term><command>caribou-prog</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="caribou caribou-prog">
            <primary sortas="b-caribou-prog">caribou-prog</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="caribou-preferences">
        <term><command>caribou-preferences</command></term>
        <listitem>
          <para>does this .....</para>
          <indexterm zone="caribou caribou-preferences">
            <primary sortas="b-caribou-preferences">caribou-preferences</primary>
          </indexterm>
        </listitem>
      </varlistentry> -->

      <varlistentry id="libcaribou">
        <term><filename class='libraryfile'>libcaribou.so</filename></term>
        <listitem>
          <para>contains the caribou API functions.</para>
          <indexterm zone="caribou libcaribou">
            <primary sortas="c-libcaribou">libcaribou.so</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>