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">
|
---|
9 | <!ENTITY caribou-md5sum "0e3ba9db7bc9dd9dbd04a4007aac3cf3">
|
---|
10 | <!ENTITY caribou-size "368 KB">
|
---|
11 | <!ENTITY caribou-buildsize "10 MB">
|
---|
12 | <!ENTITY caribou-time "0.2 SBU">
|
---|
13 | ]>
|
---|
14 |
|
---|
15 | <sect1 id="caribou" xreflabel="caribou-&caribou-version;">
|
---|
16 | <?dbhtml filename="caribou.html"?>
|
---|
17 |
|
---|
18 | <sect1info>
|
---|
19 | <othername>$LastChangedBy$</othername>
|
---|
20 | <date>$Date$</date>
|
---|
21 | </sect1info>
|
---|
22 |
|
---|
23 | <title>caribou-&caribou-version;</title>
|
---|
24 |
|
---|
25 | <indexterm zone="caribou">
|
---|
26 | <primary sortas="a-caribou">caribou</primary>
|
---|
27 | </indexterm>
|
---|
28 |
|
---|
29 | <sect2 role="package">
|
---|
30 | <title>Introduction to caribou</title>
|
---|
31 |
|
---|
32 | <para><application>Caribou</application> is an input assistive technology
|
---|
33 | intended for switch and pointer users. </para>
|
---|
34 |
|
---|
35 | &lfs70_checked;
|
---|
36 |
|
---|
37 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
38 | <itemizedlist spacing="compact">
|
---|
39 | <listitem>
|
---|
40 | <para>Download (HTTP): <ulink url="&caribou-download-http;"/></para>
|
---|
41 | </listitem>
|
---|
42 | <listitem>
|
---|
43 | <para>Download (FTP): <ulink url="&caribou-download-ftp;"/></para>
|
---|
44 | </listitem>
|
---|
45 | <listitem>
|
---|
46 | <para>Download MD5 sum: &caribou-md5sum;</para>
|
---|
47 | </listitem>
|
---|
48 | <listitem>
|
---|
49 | <para>Download size: &caribou-size;</para>
|
---|
50 | </listitem>
|
---|
51 | <listitem>
|
---|
52 | <para>Estimated disk space required: &caribou-buildsize;</para>
|
---|
53 | </listitem>
|
---|
54 | <listitem>
|
---|
55 | <para>Estimated build time: &caribou-time;</para>
|
---|
56 | </listitem>
|
---|
57 | </itemizedlist>
|
---|
58 |
|
---|
59 | <bridgehead renderas="sect3">caribou Dependencies</bridgehead>
|
---|
60 |
|
---|
61 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
62 | <para role="required">
|
---|
63 | <xref linkend="clutter"/>,
|
---|
64 | <xref linkend="gnome-doc-utils"/>,
|
---|
65 | <xref linkend="gtk3"/>,
|
---|
66 | <xref linkend="libgee"/>,
|
---|
67 | <xref linkend="libxklavier"/>,
|
---|
68 | <xref linkend="pygobject3"/> and
|
---|
69 | <xref linkend="vala"/>
|
---|
70 | </para>
|
---|
71 |
|
---|
72 | <bridgehead renderas="sect4">Recommended</bridgehead>
|
---|
73 | <para role="recommended">
|
---|
74 | <xref linkend="gobject-introspection"/>
|
---|
75 | (Required if building GNOME)
|
---|
76 | </para>
|
---|
77 |
|
---|
78 | <bridgehead renderas="sect4">Additional Runtime Dependencies</bridgehead>
|
---|
79 | <para role="optional">For most <application>GNOME</application> users, this
|
---|
80 | package is only required as a compile-time dependency for other packages. If
|
---|
81 | you intend to use its keyboard you will require
|
---|
82 | <xref linkend="pyatspi2"/>,
|
---|
83 | <xref linkend="dbus-python"/> and
|
---|
84 | <xref linkend="dconf"/> at runtime.
|
---|
85 | </para>
|
---|
86 |
|
---|
87 | <para condition="html" role="usernotes">User Notes:
|
---|
88 | <ulink url="&blfs-wiki;/caribou"/></para>
|
---|
89 |
|
---|
90 | </sect2>
|
---|
91 |
|
---|
92 | <sect2 role="installation">
|
---|
93 | <title>Installation of caribou</title>
|
---|
94 |
|
---|
95 | <para>Install <application>caribou</application> by running the following
|
---|
96 | commands:</para>
|
---|
97 |
|
---|
98 | <screen><userinput>./configure --prefix=/usr \
|
---|
99 | --sysconfdir=/etc \
|
---|
100 | --libexecdir=/usr/lib/caribou \
|
---|
101 | --disable-gtk2-module \
|
---|
102 | --disable-static &&
|
---|
103 | make</userinput></screen>
|
---|
104 |
|
---|
105 | <para>This package's testsuite is only intended to be used by the
|
---|
106 | maintainer to check i18n files.</para>
|
---|
107 |
|
---|
108 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
109 |
|
---|
110 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
111 |
|
---|
112 | </sect2>
|
---|
113 |
|
---|
114 | <sect2 role="commands">
|
---|
115 | <title>Command Explanations</title>
|
---|
116 |
|
---|
117 | <para><parameter>--libexecdir=/usr/lib/caribou</parameter>: This
|
---|
118 | parameter ensures <filename>antler-keyboard</filename> is put in a directory
|
---|
119 | which accords with the FHS instead of
|
---|
120 | <filename class="directory">/usr/libexec</filename>.</para>
|
---|
121 |
|
---|
122 | <para><parameter>--disable-gtk2-module</parameter>: Because
|
---|
123 | <application>GNOME</application> now uses <application>Gtk+-3</application>,
|
---|
124 | the module has no use in a <application>GNOME</application> desktop.</para>
|
---|
125 |
|
---|
126 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
127 | href="../../xincludes/static-libraries.xml"/>
|
---|
128 |
|
---|
129 | </sect2>
|
---|
130 |
|
---|
131 | <sect2 role="content">
|
---|
132 | <title>Contents</title>
|
---|
133 |
|
---|
134 | <segmentedlist>
|
---|
135 | <segtitle>Installed Programs</segtitle>
|
---|
136 | <segtitle>Installed Library</segtitle>
|
---|
137 | <segtitle>Installed Directories</segtitle>
|
---|
138 |
|
---|
139 | <seglistitem>
|
---|
140 | <seg>
|
---|
141 | caribou and caribou-preferences
|
---|
142 | </seg>
|
---|
143 | <seg>
|
---|
144 | libcaribou.so
|
---|
145 | </seg>
|
---|
146 | <seg>
|
---|
147 | /usr/include/libcaribou, /usr/lib/caribou,
|
---|
148 | /usr/lib/python2.7/site-packages/caribou,
|
---|
149 | /usr/share/antler and /usr/share/caribou
|
---|
150 | </seg>
|
---|
151 | </seglistitem>
|
---|
152 | </segmentedlist>
|
---|
153 |
|
---|
154 | <variablelist>
|
---|
155 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
156 | <?dbfo list-presentation="list"?>
|
---|
157 | <?dbhtml list-presentation="table"?>
|
---|
158 |
|
---|
159 | <!-- <varlistentry id="caribou-prog">
|
---|
160 | <term><command>caribou-prog</command></term>
|
---|
161 | <listitem>
|
---|
162 | <para>does this .....</para>
|
---|
163 | <indexterm zone="caribou caribou-prog">
|
---|
164 | <primary sortas="b-caribou-prog">caribou-prog</primary>
|
---|
165 | </indexterm>
|
---|
166 | </listitem>
|
---|
167 | </varlistentry>
|
---|
168 |
|
---|
169 | <varlistentry id="caribou-preferences">
|
---|
170 | <term><command>caribou-preferences</command></term>
|
---|
171 | <listitem>
|
---|
172 | <para>does this .....</para>
|
---|
173 | <indexterm zone="caribou caribou-preferences">
|
---|
174 | <primary sortas="b-caribou-preferences">caribou-preferences</primary>
|
---|
175 | </indexterm>
|
---|
176 | </listitem>
|
---|
177 | </varlistentry> -->
|
---|
178 |
|
---|
179 | <varlistentry id="libcaribou">
|
---|
180 | <term><filename class='libraryfile'>libcaribou.so</filename></term>
|
---|
181 | <listitem>
|
---|
182 | <para>contains the caribou API functions.</para>
|
---|
183 | <indexterm zone="caribou libcaribou">
|
---|
184 | <primary sortas="c-libcaribou">libcaribou.so</primary>
|
---|
185 | </indexterm>
|
---|
186 | </listitem>
|
---|
187 | </varlistentry>
|
---|
188 |
|
---|
189 | </variablelist>
|
---|
190 |
|
---|
191 | </sect2>
|
---|
192 |
|
---|
193 | </sect1>
|
---|