source: x/lib/at-spi2-core.xml

trunk
Last change on this file was 0daf2a5, checked in by Bruce Dubbs <bdubbs@…>, 3 weeks ago

Update to at-spi2-core-2.52.0.
  • Property mode set to 100644
File size: 8.2 KB
Line 
1<?xml version="1.0" encoding="UTF-8"?>
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 at-spi2-core-download-http
8 "&gnome-download-http;/at-spi2-core/2.52/at-spi2-core-&at-spi2-core-version;.tar.xz">
9 <!ENTITY at-spi2-core-download-ftp " ">
10 <!ENTITY at-spi2-core-md5sum "e6591545b2bf204fe9a58f777bd0b78a">
11 <!ENTITY at-spi2-core-size "564 KB">
12 <!ENTITY at-spi2-core-buildsize "15 MB (with tests)">
13 <!ENTITY at-spi2-core-time "0.2 SBU (with tests)">
14]>
15
16<sect1 id="at-spi2-core" xreflabel="at-spi2-core-&at-spi2-core-version;">
17 <?dbhtml filename="at-spi2-core.html"?>
18
19
20 <title>at-spi2-core-&at-spi2-core-version;</title>
21
22 <indexterm zone="at-spi2-core">
23 <primary sortas="a-at-spi2-core">at-spi2-core</primary>
24 </indexterm>
25
26 <sect2 role="package">
27 <title>Introduction to At-Spi2 Core</title>
28
29 <para>
30 The <application>At-Spi2 Core</application> package contains a
31 comprehensive accessibility framework for the Assistive Technologies
32 available on the <application>GNOME</application> platform. This includes
33 a set of interfaces which are implemented by other toolkits and
34 applications.
35 </para>
36
37 &lfs121_checked;
38
39 <bridgehead renderas="sect3">Package Information</bridgehead>
40 <itemizedlist spacing="compact">
41 <listitem>
42 <para>
43 Download (HTTP): <ulink url="&at-spi2-core-download-http;"/>
44 </para>
45 </listitem>
46 <listitem>
47 <para>
48 Download (FTP): <ulink url="&at-spi2-core-download-ftp;"/>
49 </para>
50 </listitem>
51 <listitem>
52 <para>
53 Download MD5 sum: &at-spi2-core-md5sum;
54 </para>
55 </listitem>
56 <listitem>
57 <para>
58 Download size: &at-spi2-core-size;
59 </para>
60 </listitem>
61 <listitem>
62 <para>
63 Estimated disk space required: &at-spi2-core-buildsize;
64 </para>
65 </listitem>
66 <listitem>
67 <para>
68 Estimated build time: &at-spi2-core-time;
69 </para>
70 </listitem>
71 </itemizedlist>
72
73 <bridgehead renderas="sect3">At-Spi2 Core Dependencies</bridgehead>
74
75 <bridgehead renderas="sect4">Required</bridgehead>
76 <para role="required">
77 <xref linkend="dbus"/>,
78 <xref linkend="glib2"/> (GObject Introspection required for GNOME),
79 <!-- Reports "Cannot get the default GSettingsSchemaSource" on
80 startup w/o it. -->
81 <xref role="runtime" linkend="gsettings-desktop-schemas"/> (Runtime),
82 and <xref linkend="xorg7-lib"/>
83 </para>
84
85 <bridgehead renderas="sect4">Optional</bridgehead>
86 <para role="optional">
87 <xref linkend="gi-docgen"/> and <xref linkend='sphinx'/>
88 </para>
89
90 </sect2>
91
92 <sect2 role="installation">
93 <title>Installation of At-Spi2 Core</title>
94
95 <para>
96 Install <application>At-Spi2 Core</application> by running the following
97 commands:
98 </para>
99
100<screen revision="sysv"><userinput>mkdir build &amp;&amp;
101cd build &amp;&amp;
102
103meson setup .. \
104 --prefix=/usr \
105 --buildtype=release \
106 -Dsystemd_user_dir=/tmp &amp;&amp;
107ninja</userinput></screen>
108
109<screen revision="systemd"><userinput>mkdir build &amp;&amp;
110cd build &amp;&amp;
111
112meson setup --prefix=/usr --buildtype=release .. &amp;&amp;
113ninja</userinput></screen>
114
115 <para>
116 The test suite requires the glib schemas of the package to be
117 installed already. The tests also need to run in a graphical
118 environment. To test the results, install the package first,
119 then issue: <command>dbus-run-session ninja test</command>.
120 </para>
121
122 <para>
123 Now, as the <systemitem class="username">root</systemitem> user:
124 </para>
125
126<screen role="root" revision="systemd"><userinput>ninja install</userinput></screen>
127<screen role="root" revision="sysv"><userinput>ninja install &amp;&amp;
128rm /tmp/at-spi-dbus-bus.service</userinput></screen>
129
130 </sect2>
131
132 <sect2 role="commands">
133 <title>Command Explanations</title>
134
135 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
136 href="../../xincludes/meson-buildtype-release.xml"/>
137
138 <para revision="sysv">
139 <parameter>-Dsystemd_user_dir=/tmp</parameter>: This flag puts the
140 systemd unit file in /tmp where it will be removed. SysV is unable to
141 use this file.
142 </para>
143
144 <para>
145 <option>-Ddocs=true</option>: Use this switch if you want to build the
146 documentation. Note that you must have both
147 <xref role="nodep" linkend="gi-docgen"/>
148 and <xref linkend='sphinx'/> installed on your system.
149 </para>
150
151 <!-- For when we remove gtk2 from the book:
152 <para>
153 <parameter>-Dgtk2_atk_adaptor=false</parameter>: This switch disables
154 building the GTK+-2 module for this package.
155 </para>
156 -->
157
158 </sect2>
159
160 <sect2 role="content">
161 <title>Contents</title>
162
163 <segmentedlist>
164 <segtitle>Installed Programs</segtitle>
165 <segtitle>Installed Library</segtitle>
166 <segtitle>Installed Directories</segtitle>
167
168 <seglistitem>
169 <!-- <seg> No user executable programs
170 at-spi-bus-launcher and at-spi2-registryd in /usr/libexec
171 </seg> -->
172 <seg>
173 None
174 </seg>
175 <seg>
176 libatk-1.0.so,
177 libatk-bridge-2.0.so,
178 libatspi.so, and
179 /usr/lib/gtk-2.0/modules/libatk-bridge.so
180 </seg>
181 <seg>
182 /usr/include/atk-1.0,
183 /usr/include/at-spi-2.0,
184 /usr/include/at-spi2-atk,
185 /usr/lib/gnome-settings-daemon-3.0,
186 /usr/share/defaults/at-spi2, and
187 /usr/share/gtk-doc/html/libatspi (optional)
188 </seg>
189 </seglistitem>
190 </segmentedlist>
191
192 <variablelist>
193 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
194 <?dbfo list-presentation="list"?>
195 <?dbhtml list-presentation="table"?>
196
197 <!-- Not user executable programs
198 <varlistentry id="at-spi2-registryd">
199 <term><command>at-spi2-registryd</command></term>
200 <listitem>
201 <para>
202 is the <application>At-Spi2</application> registry daemon.
203 </para>
204 <indexterm zone="at-spi2-core at-spi2-registryd">
205 <primary sortas="b-at-spi2-registryd">at-spi2-registryd</primary>
206 </indexterm>
207 </listitem>
208 </varlistentry>
209 -->
210
211 <varlistentry id="libatk-1.0">
212 <term><filename class="libraryfile">libatk-1.0.so</filename></term>
213 <listitem>
214 <para>
215 contains functions that are used by assistive technologies to
216 interact with desktop applications
217 </para>
218 <indexterm zone="at-spi2-core libatk-1.0">
219 <primary sortas="c-libatk-1.0">libatk-1.0.so</primary>
220 </indexterm>
221 </listitem>
222 </varlistentry>
223
224 <varlistentry id="libatk-bridge">
225 <term><filename class="libraryfile">libatk-bridge.so</filename></term>
226 <listitem>
227 <para>
228 contains the Accessibility Toolkit GTK+-2 bridge
229 </para>
230 <indexterm zone="at-spi2-core libatk-bridge">
231 <primary sortas="c-libatk-bridge">libatk-bridge.so</primary>
232 </indexterm>
233 </listitem>
234 </varlistentry>
235
236 <varlistentry id="libatk-bridge-2.0">
237 <term><filename class="libraryfile">libatk-bridge-2.0.so</filename></term>
238 <listitem>
239 <para>
240 contains the Accessibility Toolkit GTK+ module
241 </para>
242 <indexterm zone="at-spi2-core libatk-bridge-2.0">
243 <primary sortas="c-libatk-bridge-2.0">libatk-bridge-2.0.so</primary>
244 </indexterm>
245 </listitem>
246 </varlistentry>
247
248 <varlistentry id="libatspi">
249 <term><filename class="libraryfile">libatspi.so</filename></term>
250 <listitem>
251 <para>
252 contains the <application>At-Spi2</application> API functions
253 </para>
254 <indexterm zone="at-spi2-core libatspi">
255 <primary sortas="c-libatspi">libatspi.so</primary>
256 </indexterm>
257 </listitem>
258 </varlistentry>
259
260 </variablelist>
261
262 </sect2>
263
264</sect1>
Note: See TracBrowser for help on using the repository browser.