[9199306] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY caribou-download-http "&gnome-download-http;/caribou/0.4/caribou-&caribou-version;.tar.xz">
|
---|
| 8 | <!ENTITY caribou-download-ftp "&gnome-download-ftp;/caribou/0.4/caribou-&caribou-version;.tar.xz">
|
---|
[40273c46] | 9 | <!ENTITY caribou-md5sum "16b76cd7453b99e2871e8d4da88bf976">
|
---|
| 10 | <!ENTITY caribou-size "420 KB">
|
---|
[9199306] | 11 | <!ENTITY caribou-buildsize "13 MB">
|
---|
| 12 | <!ENTITY caribou-time "less than 0.1 SBU">
|
---|
| 13 | ]>
|
---|
| 14 |
|
---|
[51dfb3e] | 15 | <sect1 id="caribou" xreflabel="Caribou-&caribou-version;">
|
---|
[9199306] | 16 | <?dbhtml filename="caribou.html"?>
|
---|
| 17 |
|
---|
| 18 | <sect1info>
|
---|
| 19 | <date>$Date$</date>
|
---|
| 20 | </sect1info>
|
---|
| 21 |
|
---|
| 22 | <title>Caribou-&caribou-version;</title>
|
---|
| 23 |
|
---|
| 24 | <indexterm zone="caribou">
|
---|
| 25 | <primary sortas="a-Caribou">Caribou</primary>
|
---|
| 26 | </indexterm>
|
---|
| 27 |
|
---|
| 28 | <sect2 role="package">
|
---|
| 29 | <title>Introduction to Caribou</title>
|
---|
| 30 |
|
---|
| 31 | <para>
|
---|
| 32 | <application>Caribou</application> is an input assistive technology
|
---|
| 33 | intended for switch and pointer users.
|
---|
| 34 | </para>
|
---|
| 35 |
|
---|
[dbea07b] | 36 | &lfs84_checked;
|
---|
[9199306] | 37 |
|
---|
| 38 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 39 | <itemizedlist spacing="compact">
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (HTTP): <ulink url="&caribou-download-http;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download (FTP): <ulink url="&caribou-download-ftp;"/>
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download MD5 sum: &caribou-md5sum;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Download size: &caribou-size;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated disk space required: &caribou-buildsize;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | <listitem>
|
---|
| 66 | <para>
|
---|
| 67 | Estimated build time: &caribou-time;
|
---|
| 68 | </para>
|
---|
| 69 | </listitem>
|
---|
| 70 | </itemizedlist>
|
---|
| 71 |
|
---|
| 72 | <bridgehead renderas="sect3">Caribou Dependencies</bridgehead>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 75 | <para role="required">
|
---|
| 76 | <xref linkend="clutter"/>,
|
---|
| 77 | <xref linkend="gtk3"/>,
|
---|
| 78 | <xref linkend="libgee"/>,
|
---|
[39bc211] | 79 | <xref linkend="libxklavier"/>,
|
---|
| 80 | <xref linkend="pygobject2"/>, and
|
---|
| 81 | <xref linkend="pygobject3"/> (needed regardless of what version of GTK is in use)
|
---|
[9199306] | 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
| 85 | <para role="recommended">
|
---|
| 86 | <xref linkend="vala"/>
|
---|
| 87 | </para>
|
---|
| 88 |
|
---|
| 89 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 90 | <para role="optional">
|
---|
| 91 | <xref linkend="gtk2"/> and
|
---|
[22062586] | 92 | <xref linkend="vala"/> (with Valadoc installed)
|
---|
[9199306] | 93 | </para>
|
---|
| 94 |
|
---|
| 95 | <bridgehead renderas="sect4">Additional Runtime Dependencies</bridgehead>
|
---|
| 96 | <para role="optional">
|
---|
| 97 | For most <application>GNOME</application> users, this package is only
|
---|
| 98 | required as a compile-time dependency for other packages. If
|
---|
| 99 | you intend to use its keyboard you will require
|
---|
[9b1042fd] | 100 | <xref role="runtime" linkend="dbus-python"/>,
|
---|
| 101 | <xref role="runtime" linkend="dconf"/> and
|
---|
| 102 | <xref role="runtime" linkend="pyatspi2"/> at runtime.
|
---|
[9199306] | 103 | </para>
|
---|
| 104 |
|
---|
| 105 | <para condition="html" role="usernotes">User Notes:
|
---|
| 106 | <ulink url="&blfs-wiki;/caribou"/>
|
---|
| 107 | </para>
|
---|
| 108 | </sect2>
|
---|
| 109 |
|
---|
| 110 | <sect2 role="installation">
|
---|
| 111 | <title>Installation of Caribou</title>
|
---|
| 112 |
|
---|
| 113 | <para>
|
---|
| 114 | Install <application>Caribou</application> by running the following
|
---|
| 115 | commands:
|
---|
| 116 | </para>
|
---|
| 117 |
|
---|
[585aee4e] | 118 | <screen><userinput>PYTHON=python3 ./configure --prefix=/usr \
|
---|
[9199306] | 119 | --sysconfdir=/etc \
|
---|
| 120 | --disable-gtk2-module \
|
---|
| 121 | --disable-static &&
|
---|
| 122 | make</userinput></screen>
|
---|
| 123 |
|
---|
| 124 | <para>
|
---|
| 125 | This package does not come with a testsuite.
|
---|
| 126 | </para>
|
---|
| 127 |
|
---|
| 128 | <para>
|
---|
| 129 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 130 | </para>
|
---|
| 131 |
|
---|
| 132 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 133 |
|
---|
| 134 | </sect2>
|
---|
| 135 |
|
---|
| 136 | <sect2 role="commands">
|
---|
| 137 | <title>Command Explanations</title>
|
---|
| 138 |
|
---|
| 139 | <para>
|
---|
| 140 | <parameter>--disable-gtk2-module</parameter>: Because
|
---|
| 141 | <application>GNOME</application> now uses
|
---|
| 142 | <application>GTK+-3</application>, this module has no use
|
---|
| 143 | on a <application>GNOME</application> desktop. Remove
|
---|
| 144 | this switch if you still want to build the
|
---|
| 145 | <application>GTK+-2</application> module.
|
---|
| 146 | </para>
|
---|
| 147 |
|
---|
| 148 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 149 | href="../../xincludes/static-libraries.xml"/>
|
---|
| 150 |
|
---|
| 151 | </sect2>
|
---|
| 152 |
|
---|
| 153 | <sect2 role="content">
|
---|
| 154 | <title>Contents</title>
|
---|
| 155 |
|
---|
| 156 | <segmentedlist>
|
---|
| 157 | <segtitle>Installed Programs</segtitle>
|
---|
| 158 | <segtitle>Installed Libraries</segtitle>
|
---|
| 159 | <segtitle>Installed Directories</segtitle>
|
---|
| 160 |
|
---|
| 161 | <seglistitem>
|
---|
| 162 | <seg>
|
---|
| 163 | caribou (library executable),
|
---|
| 164 | antler (library executable),
|
---|
| 165 | and caribou-preferences
|
---|
| 166 | </seg>
|
---|
| 167 | <seg>
|
---|
| 168 | libcaribou.so
|
---|
| 169 | </seg>
|
---|
| 170 | <seg>
|
---|
| 171 | /usr/include/libcaribou,
|
---|
| 172 | /usr/lib/python&python2-majorver;/site-packages/caribou,
|
---|
| 173 | /usr/share/antler and
|
---|
| 174 | /usr/share/caribou
|
---|
| 175 | </seg>
|
---|
| 176 | </seglistitem>
|
---|
| 177 | </segmentedlist>
|
---|
| 178 |
|
---|
| 179 | <variablelist>
|
---|
| 180 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 181 | <?dbfo list-presentation="list"?>
|
---|
| 182 | <?dbhtml list-presentation="table"?>
|
---|
| 183 |
|
---|
| 184 | <varlistentry id="libcaribou">
|
---|
| 185 | <term><filename class="libraryfile">libcaribou.so</filename></term>
|
---|
| 186 | <listitem>
|
---|
| 187 | <para>
|
---|
| 188 | contains the <application>Caribou</application> API functions.
|
---|
| 189 | </para>
|
---|
| 190 | <indexterm zone="caribou libcaribou">
|
---|
| 191 | <primary sortas="c-libcaribou">libcaribou.so</primary>
|
---|
| 192 | </indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
| 196 | </variablelist>
|
---|
| 197 |
|
---|
| 198 | </sect2>
|
---|
| 199 |
|
---|
| 200 | </sect1>
|
---|