summaryrefslogtreecommitdiff
path: root/README
blob: e41a5c66adf1803c051b55c0ce597aafc74befc4 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
D-Bus AT-SPI
------------

This version of at-spi is a major break from version 1.x.
It has been completely rewritten to use D-Bus rather than
ORBIT / CORBA for its transport protocol.

A page including instructions for testing, project status and
TODO items is kept up to date at:

        http://www.linuxfoundation.org/en/AT-SPI_on_D-Bus

The mailing list used for general questions is:

        accessibility-atspi@lists.linux-foundation.org

For bug reports, feature requests, patches or enhancements please use
the AT-SPI project on bugzilla.gnome.org. Use the at-spi2-core component for
bugs specific to this module.

        http://bugzilla.gnome.org

A git repository with the latest development code is available at:

	git://git.gnome.org/at-spi2-core

More information
----------------

The project was started with a D-Bus performance review
the results of which are available on the GNOME wiki. Keep in
mind that the D-Bus AT-SPI design documents on this page
have not been kept up to date.

        http://live.gnome.org/GAP/AtSpiDbusInvestigation/

Other sources of relevant information about AT-SPI and Accessibility
include:

        http://live.gnome.org/Accessibility
        http://www.sun.com/software/star/gnome/accessibility/architecture.xml
        http://accessibility.kde.org/developer/atk.php
        http://www.gnome.org/~billh/at-spi-idl/html/


Contents of this package
------------------------

This package includes the protocol definitions for the new D-Bus
at-spi.

Also included is the daemon necessary for forwarding device events
and registering accessible applicaitions.


Directory structure
-------------------

The directories within this package are arranged as follows:

    xml 

        This directory contains XML documents describing
        the D-Bus protocol in the format used for D-Bus introspection.

    idl

        The D-Bus specification in an idl-like format. This is likely not
        parseable by any existing tools, is not entirely up-to-date, and may
        by removed in a future release.

    registryd

        The registry daemon code. The registry daemon
        keeps a register of accessible applications and presents
        this to clients (ATs).
        It is also responsible for delivering device events.

    dbind

        Library to ease making D-Bus method calls, contains
        marshalling code to convert function arguments
        and a provided D-Bus signature into a D-Bus message.

        Used by libatspi.

    atspi

        C library for use by ATs. Wraps the various D-Bus calls, provides
        an interface for listening to events, and caches some information about
        accessible objects. Also contains some functions used by at-spi2-atk.

    bus

        A server that sits on the session bus and provides an interface
        allowing applications to find the accessibility bus daemon, launching
        it as needed. The accessibility bus is separate from the session bus
        because it may in fact span user sessions if a user, for instance,
        runs an application that escalates to run as root. The accessibility
        bus is thus tied to the X session rather than the D-Bus session.

    doc

        Contains infrastructure for creating libatspi documentation.

    test

        Contains files that may be useful for testing AT-SPI.

   m4

        Some macros used for building the module.

    po

        Infrastructure used for translation.