[f6b650a8] | 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 |
|
---|
[0d7900a] | 7 | <!ENTITY at-spi2-core-download-http
|
---|
[a46cb1f] | 8 | "&gnome-download-http;/at-spi2-core/2.50/at-spi2-core-&at-spi2-core-version;.tar.xz">
|
---|
[f4ac7141] | 9 | <!ENTITY at-spi2-core-download-ftp " ">
|
---|
[a46cb1f] | 10 | <!ENTITY at-spi2-core-md5sum "1d82a5295c30b3ec70d533ba318a07e2">
|
---|
| 11 | <!ENTITY at-spi2-core-size "556 KB">
|
---|
| 12 | <!ENTITY at-spi2-core-buildsize "24 MB (with tests)">
|
---|
| 13 | <!ENTITY at-spi2-core-time "0.4 SBU (with tests)">
|
---|
[f6b650a8] | 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>
|
---|
[1514851] | 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.
|
---|
[f6b650a8] | 35 | </para>
|
---|
| 36 |
|
---|
[30c1c72] | 37 | &lfs120_checked;
|
---|
[f6b650a8] | 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">
|
---|
[54666831] | 77 | <xref linkend="dbus"/>,
|
---|
[6102095a] | 78 | <xref linkend="glib2"/>,
|
---|
| 79 | <!-- Reports "Cannot get the default GSettingsSchemaSource" on
|
---|
| 80 | startup w/o it. -->
|
---|
| 81 | <xref role="runtime" linkend="gsettings-desktop-schemas"/> (Runtime),
|
---|
[c807a2b] | 82 | and <xref linkend="xorg7-lib"/>
|
---|
[f6b650a8] | 83 | </para>
|
---|
| 84 |
|
---|
[4849cdc] | 85 | <bridgehead renderas="sect4">Optional (Required if building GNOME)</bridgehead>
|
---|
| 86 | <para role="optional">
|
---|
[f6b650a8] | 87 | <xref linkend="gobject-introspection"/>
|
---|
| 88 | </para>
|
---|
| 89 |
|
---|
| 90 | <bridgehead renderas="sect4">Optional</bridgehead>
|
---|
| 91 | <para role="optional">
|
---|
[04303e9f] | 92 | <xref linkend="gi-docgen"/> and <xref linkend='sphinx'/>
|
---|
[f6b650a8] | 93 | </para>
|
---|
| 94 |
|
---|
| 95 | </sect2>
|
---|
| 96 |
|
---|
| 97 | <sect2 role="installation">
|
---|
| 98 | <title>Installation of At-Spi2 Core</title>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
| 101 | Install <application>At-Spi2 Core</application> by running the following
|
---|
| 102 | commands:
|
---|
| 103 | </para>
|
---|
| 104 |
|
---|
[a468270d] | 105 | <screen revision="sysv"><userinput>mkdir build &&
|
---|
| 106 | cd build &&
|
---|
| 107 |
|
---|
[91318eb] | 108 | meson setup .. \
|
---|
| 109 | --prefix=/usr \
|
---|
[adf17153] | 110 | --buildtype=release \
|
---|
[91318eb] | 111 | -Dsystemd_user_dir=/tmp &&
|
---|
[a468270d] | 112 | ninja</userinput></screen>
|
---|
| 113 |
|
---|
| 114 | <screen revision="systemd"><userinput>mkdir build &&
|
---|
[462f1ad] | 115 | cd build &&
|
---|
| 116 |
|
---|
[91318eb] | 117 | meson setup --prefix=/usr --buildtype=release .. &&
|
---|
[462f1ad] | 118 | ninja</userinput></screen>
|
---|
[f6b650a8] | 119 |
|
---|
| 120 | <para>
|
---|
[8828b5c0] | 121 | The test suite also requires the glib schemas of the package to be
|
---|
| 122 | installed already. To test the results, install the package first,
|
---|
| 123 | then issue: <command>dbus-run-session ninja test</command>.
|
---|
[3df352ac] | 124 | One test, <filename>atk-test</filename>, is known to timeout on some
|
---|
| 125 | systems.
|
---|
[f6b650a8] | 126 | </para>
|
---|
[1514851] | 127 |
|
---|
[f6b650a8] | 128 | <para>
|
---|
| 129 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 130 | </para>
|
---|
| 131 |
|
---|
[92195dd1] | 132 | <screen role="root" revision="systemd"><userinput>ninja install</userinput></screen>
|
---|
| 133 | <screen role="root" revision="sysv"><userinput>ninja install &&
|
---|
| 134 | rm /tmp/at-spi-dbus-bus.service</userinput></screen>
|
---|
[f6b650a8] | 135 |
|
---|
| 136 | </sect2>
|
---|
| 137 |
|
---|
[adf17153] | 138 | <sect2 role="commands">
|
---|
| 139 | <title>Command Explanations</title>
|
---|
| 140 |
|
---|
| 141 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 142 | href="../../xincludes/meson-buildtype-release.xml"/>
|
---|
| 143 |
|
---|
[3df352ac] | 144 | <para revision="sysv">
|
---|
| 145 | <parameter>-Dsystemd_user_dir=/tmp</parameter>: This flag puts the
|
---|
| 146 | systemd unit file in /tmp where it will be removed. SysV is unable to
|
---|
| 147 | use this file.
|
---|
| 148 | </para>
|
---|
| 149 |
|
---|
[a0d2c26] | 150 | <para>
|
---|
| 151 | <option>-Ddocs=true</option>: Use this switch if you want to build the
|
---|
[04303e9f] | 152 | documentation. Note that you must have both
|
---|
| 153 | <xref role="nodep" linkend="gi-docgen"/>
|
---|
| 154 | and <xref linkend='sphinx'/> installed on your system.
|
---|
[a0d2c26] | 155 | </para>
|
---|
| 156 |
|
---|
[a46cb1f] | 157 | <!-- For when we remove gtk2 from the book:
|
---|
| 158 | <para>
|
---|
| 159 | <parameter>-Dgtk2_atk_adaptor=false</parameter>: This switch disables
|
---|
| 160 | building the GTK+-2 module for this package.
|
---|
| 161 | </para>
|
---|
| 162 | -->
|
---|
| 163 |
|
---|
[adf17153] | 164 | </sect2>
|
---|
| 165 |
|
---|
[f6b650a8] | 166 | <sect2 role="content">
|
---|
| 167 | <title>Contents</title>
|
---|
| 168 |
|
---|
| 169 | <segmentedlist>
|
---|
[910d888] | 170 | <segtitle>Installed Programs</segtitle>
|
---|
[f6b650a8] | 171 | <segtitle>Installed Library</segtitle>
|
---|
| 172 | <segtitle>Installed Directories</segtitle>
|
---|
| 173 |
|
---|
| 174 | <seglistitem>
|
---|
[462f1ad] | 175 | <!-- <seg> No user executable programs
|
---|
| 176 | at-spi-bus-launcher and at-spi2-registryd in /usr/libexec
|
---|
[1db07ae] | 177 | </seg> -->
|
---|
[13507eb] | 178 | <seg>
|
---|
| 179 | None
|
---|
| 180 | </seg>
|
---|
[f6b650a8] | 181 | <seg>
|
---|
[1514851] | 182 | libatk-1.0.so,
|
---|
| 183 | libatk-bridge-2.0.so,
|
---|
| 184 | libatspi.so, and
|
---|
| 185 | /usr/lib/gtk-2.0/modules/libatk-bridge.so
|
---|
[f6b650a8] | 186 | </seg>
|
---|
| 187 | <seg>
|
---|
[1514851] | 188 | /usr/include/atk-1.0,
|
---|
[bc1d337] | 189 | /usr/include/at-spi-2.0,
|
---|
[1514851] | 190 | /usr/include/at-spi2-atk,
|
---|
| 191 | /usr/lib/gnome-settings-daemon-3.0,
|
---|
[bc1d337] | 192 | /usr/share/defaults/at-spi2, and
|
---|
[3df352ac] | 193 | /usr/share/gtk-doc/html/libatspi (optional)
|
---|
[f6b650a8] | 194 | </seg>
|
---|
| 195 | </seglistitem>
|
---|
| 196 | </segmentedlist>
|
---|
| 197 |
|
---|
| 198 | <variablelist>
|
---|
| 199 | <bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 200 | <?dbfo list-presentation="list"?>
|
---|
| 201 | <?dbhtml list-presentation="table"?>
|
---|
| 202 |
|
---|
[298fee30] | 203 | <!-- Not user executable programs
|
---|
[f6b650a8] | 204 | <varlistentry id="at-spi2-registryd">
|
---|
| 205 | <term><command>at-spi2-registryd</command></term>
|
---|
| 206 | <listitem>
|
---|
| 207 | <para>
|
---|
| 208 | is the <application>At-Spi2</application> registry daemon.
|
---|
| 209 | </para>
|
---|
| 210 | <indexterm zone="at-spi2-core at-spi2-registryd">
|
---|
| 211 | <primary sortas="b-at-spi2-registryd">at-spi2-registryd</primary>
|
---|
| 212 | </indexterm>
|
---|
| 213 | </listitem>
|
---|
| 214 | </varlistentry>
|
---|
[298fee30] | 215 | -->
|
---|
[f6b650a8] | 216 |
|
---|
[1514851] | 217 | <varlistentry id="libatk-1.0">
|
---|
| 218 | <term><filename class="libraryfile">libatk-1.0.so</filename></term>
|
---|
| 219 | <listitem>
|
---|
| 220 | <para>
|
---|
| 221 | contains functions that are used by assistive technologies to
|
---|
| 222 | interact with desktop applications
|
---|
| 223 | </para>
|
---|
| 224 | <indexterm zone="at-spi2-core libatk-1.0">
|
---|
| 225 | <primary sortas="c-libatk-1.0">libatk-1.0.so</primary>
|
---|
| 226 | </indexterm>
|
---|
| 227 | </listitem>
|
---|
| 228 | </varlistentry>
|
---|
| 229 |
|
---|
| 230 | <varlistentry id="libatk-bridge">
|
---|
| 231 | <term><filename class="libraryfile">libatk-bridge.so</filename></term>
|
---|
| 232 | <listitem>
|
---|
| 233 | <para>
|
---|
| 234 | contains the Accessibility Toolkit GTK+-2 bridge
|
---|
| 235 | </para>
|
---|
| 236 | <indexterm zone="at-spi2-core libatk-bridge">
|
---|
| 237 | <primary sortas="c-libatk-bridge">libatk-bridge.so</primary>
|
---|
| 238 | </indexterm>
|
---|
| 239 | </listitem>
|
---|
| 240 | </varlistentry>
|
---|
| 241 |
|
---|
| 242 | <varlistentry id="libatk-bridge-2.0">
|
---|
| 243 | <term><filename class="libraryfile">libatk-bridge-2.0.so</filename></term>
|
---|
| 244 | <listitem>
|
---|
| 245 | <para>
|
---|
[4628237e] | 246 | contains the Accessibility Toolkit GTK+ module
|
---|
[1514851] | 247 | </para>
|
---|
| 248 | <indexterm zone="at-spi2-core libatk-bridge-2.0">
|
---|
| 249 | <primary sortas="c-libatk-bridge-2.0">libatk-bridge-2.0.so</primary>
|
---|
| 250 | </indexterm>
|
---|
| 251 | </listitem>
|
---|
| 252 | </varlistentry>
|
---|
| 253 |
|
---|
[f6b650a8] | 254 | <varlistentry id="libatspi">
|
---|
[983fc68] | 255 | <term><filename class="libraryfile">libatspi.so</filename></term>
|
---|
[f6b650a8] | 256 | <listitem>
|
---|
| 257 | <para>
|
---|
[4c24eb0a] | 258 | contains the <application>At-Spi2</application> API functions
|
---|
[f6b650a8] | 259 | </para>
|
---|
| 260 | <indexterm zone="at-spi2-core libatspi">
|
---|
| 261 | <primary sortas="c-libatspi">libatspi.so</primary>
|
---|
| 262 | </indexterm>
|
---|
| 263 | </listitem>
|
---|
| 264 | </varlistentry>
|
---|
| 265 |
|
---|
| 266 | </variablelist>
|
---|
| 267 |
|
---|
| 268 | </sect2>
|
---|
| 269 |
|
---|
| 270 | </sect1>
|
---|