source: x/lib/at-spi2-core.xml@ 6646cae6

12.1 ken/TL2024 ken/tuningfonts lazarus plabs/newcss python3.11 rahul/power-profiles-daemon renodr/vulkan-addition trunk xry111/llvm18
Last change on this file since 6646cae6 was a46cb1f, checked in by Douglas R. Reno <renodr@…>, 9 months ago

Update to at-spi2-core-2.50.0.

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