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 "c03cb3e121547222e9c4fe7bf527fee0">
|
---|
10 | <!ENTITY caribou-size "353 KB">
|
---|
11 | <!ENTITY caribou-buildsize "13 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 on screen keyboard, and
|
---|
33 | a shared library for other on screen keyboards
|
---|
34 |
|
---|
35 | </para>
|
---|
36 |
|
---|
37 | &lfs70_built;
|
---|
38 |
|
---|
39 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
40 | <itemizedlist spacing="compact">
|
---|
41 | <listitem>
|
---|
42 | <para>Download (HTTP): <ulink url="&caribou-download-http;"/></para>
|
---|
43 | </listitem>
|
---|
44 | <listitem>
|
---|
45 | <para>Download (FTP): <ulink url="&caribou-download-ftp;"/></para>
|
---|
46 | </listitem>
|
---|
47 | <listitem>
|
---|
48 | <para>Download MD5 sum: &caribou-md5sum;</para>
|
---|
49 | </listitem>
|
---|
50 | <listitem>
|
---|
51 | <para>Download size: &caribou-size;</para>
|
---|
52 | </listitem>
|
---|
53 | <listitem>
|
---|
54 | <para>Estimated disk space required: &caribou-buildsize;</para>
|
---|
55 | </listitem>
|
---|
56 | <listitem>
|
---|
57 | <para>Estimated build time: &caribou-time;</para>
|
---|
58 | </listitem>
|
---|
59 | </itemizedlist>
|
---|
60 |
|
---|
61 | <bridgehead renderas="sect3">caribou Dependencies</bridgehead>
|
---|
62 |
|
---|
63 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
64 | <para role="required"><xref linkend="pygobject3"/>,
|
---|
65 | <xref linkend="gtk3"/>,
|
---|
66 | <xref linkend="clutter"/>,
|
---|
67 | <xref linkend="libgee"/>,
|
---|
68 | <xref linkend="libxklavier"/>, and
|
---|
69 | <xref linkend="vala"/></para>
|
---|
70 |
|
---|
71 | <bridgehead renderas="sect4">Additional Runtime Dependencies</bridgehead>
|
---|
72 | <para role="optional">For most <application>GNOME</application> users, this
|
---|
73 | package is only required as a compile-time dependency for other packages. If
|
---|
74 | you intend to use its keyboard you will require
|
---|
75 | <!-- FIXME:ken 1
|
---|
76 | <xref linkend="pyatspi"/>, -->
|
---|
77 | pyatspi2-2.2.1,
|
---|
78 | <xref linkend="dbus-python"/>
|
---|
79 | and <xref linkend="dconf"/> at runtime.</para>
|
---|
80 |
|
---|
81 | <para condition="html" role="usernotes">User Notes:
|
---|
82 | <ulink url="&blfs-wiki;/caribou"/></para>
|
---|
83 |
|
---|
84 | </sect2>
|
---|
85 |
|
---|
86 | <sect2 role="installation">
|
---|
87 | <title>Installation of caribou</title>
|
---|
88 |
|
---|
89 | <para>Install <application>caribou</application> by running the following
|
---|
90 | commands:</para>
|
---|
91 |
|
---|
92 | <screen><userinput>./configure --prefix=$GNOME_PREFIX \
|
---|
93 | --sysconfdir=$GNOME_SYSCONFDIR \
|
---|
94 | --libexecdir=$GNOME_PREFIX/lib/caribou \
|
---|
95 | --disable-gtk2-module &&
|
---|
96 | make</userinput></screen>
|
---|
97 |
|
---|
98 | <para>This package's testsuite is only intended to be used by the
|
---|
99 | maintainer to check i18n files.</para>
|
---|
100 |
|
---|
101 | <para>Now, as the <systemitem class="username">root</systemitem> user:</para>
|
---|
102 |
|
---|
103 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
104 |
|
---|
105 | </sect2>
|
---|
106 |
|
---|
107 | <sect2 role="commands">
|
---|
108 | <title>Command Explanations</title>
|
---|
109 |
|
---|
110 | <para><parameter>--sysconfdir=$GNOME_SYSCONFDIR</parameter>: This parameter puts
|
---|
111 | the gconf schemas in the correct location, instead of
|
---|
112 | <filename class="directory">/usr/libexec</filename></para>
|
---|
113 |
|
---|
114 | <para><parameter>--libexecdir=$GNOME_PREFIX/lib/caribou</parameter>: This
|
---|
115 | parameter ensures <filename>antler-keyboard</filename> is put in a directory
|
---|
116 | which accords with the FHS, instead of
|
---|
117 | <filename class="directory">/usr/libexec</filename>.</para>
|
---|
118 |
|
---|
119 | <para><parameter>--disable-gtk2-module</parameter>: Because
|
---|
120 | <application>GNOME</application> now uses <application>Gtk+-3</application>,
|
---|
121 | the module has no use in a <application>GNOME</application> desktop.</para>
|
---|
122 |
|
---|
123 | <para><option>--enable-static=no</option>: This switch prevents the static
|
---|
124 | libraries being installed.</para>
|
---|
125 |
|
---|
126 | </sect2>
|
---|
127 |
|
---|
128 | <sect2 role="content">
|
---|
129 | <title>Contents</title>
|
---|
130 |
|
---|
131 | <segmentedlist>
|
---|
132 | <segtitle>Installed Programs</segtitle>
|
---|
133 | <segtitle>Installed Libraries</segtitle>
|
---|
134 | <segtitle>Installed Directories</segtitle>
|
---|
135 |
|
---|
136 | <seglistitem>
|
---|
137 | <seg>antler-keyboard, caribou, and caribou-preferences</seg>
|
---|
138 | <seg>libcaribou-gtk-module.{so,a} and libcaribou.{so,a}</seg>
|
---|
139 | <seg><envar>$GNOME_PREFIX</envar>/{include/libcaribou,lib/{caribou,python2.7/site-packages/caribou/{antler,daemon,settings}},share/{antler,caribou/layouts/{fullscale,scan,touch}}}</seg>
|
---|
140 | </seglistitem>
|
---|
141 | </segmentedlist>
|
---|
142 |
|
---|
143 | <variablelist>
|
---|
144 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
145 | <?dbfo list-presentation="list"?>
|
---|
146 | <?dbhtml list-presentation="table"?>
|
---|
147 |
|
---|
148 | <varlistentry id="antler-keyboard">
|
---|
149 | <term><command>antler-keyboard</command></term>
|
---|
150 | <listitem>
|
---|
151 | <para>does this .....</para>
|
---|
152 | <indexterm zone="caribou antler-keyboard">
|
---|
153 | <primary sortas="b-antler-keyboard">antler-keyboard</primary>
|
---|
154 | </indexterm>
|
---|
155 | </listitem>
|
---|
156 | </varlistentry>
|
---|
157 |
|
---|
158 | <varlistentry id="caribou-prog">
|
---|
159 | <term><command>caribou-prog</command></term>
|
---|
160 | <listitem>
|
---|
161 | <para>does this .....</para>
|
---|
162 | <indexterm zone="caribou caribou-prog">
|
---|
163 | <primary sortas="b-caribou-prog">caribou-prog</primary>
|
---|
164 | </indexterm>
|
---|
165 | </listitem>
|
---|
166 | </varlistentry>
|
---|
167 |
|
---|
168 | <varlistentry id="caribou-preferences">
|
---|
169 | <term><command>caribou-preferences</command></term>
|
---|
170 | <listitem>
|
---|
171 | <para>does this .....</para>
|
---|
172 | <indexterm zone="caribou caribou-preferences">
|
---|
173 | <primary sortas="b-caribou-preferences">caribou-preferences</primary>
|
---|
174 | </indexterm>
|
---|
175 | </listitem>
|
---|
176 | </varlistentry>
|
---|
177 |
|
---|
178 | <varlistentry id="libcaribou-gtk-module">
|
---|
179 | <term><filename class='libraryfile'>libcaribou-gtk-module.{so,a}</filename></term>
|
---|
180 | <listitem>
|
---|
181 | <para>contains functions that .....</para>
|
---|
182 | <indexterm zone="caribou libcaribou-gtk-module">
|
---|
183 | <primary sortas="c-libcaribou-gtk-module">libcaribou-gtk-module.{so,a}</primary>
|
---|
184 | </indexterm>
|
---|
185 | </listitem>
|
---|
186 | </varlistentry>
|
---|
187 |
|
---|
188 | <varlistentry id="libcaribou">
|
---|
189 | <term><filename class='libraryfile'>libcaribou.{so,a}</filename></term>
|
---|
190 | <listitem>
|
---|
191 | <para>contains functions that .....</para>
|
---|
192 | <indexterm zone="caribou libcaribou">
|
---|
193 | <primary sortas="c-libcaribou">libcaribou.{so,a}</primary>
|
---|
194 | </indexterm>
|
---|
195 | </listitem>
|
---|
196 | </varlistentry>
|
---|
197 |
|
---|
198 | </variablelist>
|
---|
199 |
|
---|
200 | </sect2>
|
---|
201 |
|
---|
202 | </sect1>
|
---|