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

12.0 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 ac7dd639 was 14891a90, checked in by Xi Ruoyao <xry111@…>, 11 months ago

treewide: More "User Notes" clean up

Remove links to pages w/o real contents.
  • Property mode set to 100644
File size: 8.3 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.48/at-spi2-core-&at-spi2-core-version;.tar.xz">
9 <!ENTITY at-spi2-core-download-ftp
10 "&gnome-download-ftp;/at-spi2-core/2.48/at-spi2-core-&at-spi2-core-version;.tar.xz">
11 <!ENTITY at-spi2-core-md5sum "4ef1875d9e7035f672d494b997c892af">
12 <!ENTITY at-spi2-core-size "541 KB">
13 <!ENTITY at-spi2-core-buildsize "20 MB (with tests)">
14 <!ENTITY at-spi2-core-time "less than 0.1 SBU (with tests, except if there is a timeout)">
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 &lfs113_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"/>
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 A session bus address, normally available in an Xorg terminal,
123 is necessary to run the tests. The test suite also requires the glib
124 schemas of the package to be installed already. To test the results,
125 install the package first, then issue: <command>ninja test</command>.
126 One test, <filename>atk-test</filename>, is known to timeout on some
127 systems.
128 </para>
129
130 <para>
131 Now, as the <systemitem class="username">root</systemitem> user:
132 </para>
133
134<screen role="root" revision="systemd"><userinput>ninja install</userinput></screen>
135<screen role="root" revision="sysv"><userinput>ninja install &amp;&amp;
136rm /tmp/at-spi-dbus-bus.service</userinput></screen>
137
138 </sect2>
139
140 <sect2 role="commands">
141 <title>Command Explanations</title>
142
143 <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
144 href="../../xincludes/meson-buildtype-release.xml"/>
145
146 <para revision="sysv">
147 <parameter>-Dsystemd_user_dir=/tmp</parameter>: This flag puts the
148 systemd unit file in /tmp where it will be removed. SysV is unable to
149 use this file.
150 </para>
151
152 <para>
153 <option>-Ddocs=true</option>: Use this switch if you want to build the
154 documentation. Note that you must have
155 <xref role="nodep" linkend="gi-docgen"/> installed on your system.
156 </para>
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.