source: gnome/platform/caribou.xml@ 425f19af

elogind
Last change on this file since 425f19af was 425f19af, checked in by DJ Lucas <dj@…>, 3 years ago

Merge to HEAD 21241.

git-svn-id: svn://svn.linuxfromscratch.org/BLFS/branches/BOOK-elogind@21243 af4574ff-66df-0310-9fd7-8a98e5e911e0

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