-README
+D-Bus AT-SPI
+------------
-at-spi version 1.9.0
-
-This version of at-spi requires atk 1.17.0 or later.
-
-This version of at-spi is a MAJOR break from previous versions.
+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.
-*** Welcome to the Gnome Accessibility Project! ***
+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
-If you have not already done so, please visit
+More information
+----------------
-http://developer.gnome.org/projects/gap
+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.
-for background information on accessibility, the Gnome
-Accessibility Project, mailing list info, and project status.
+ http://live.gnome.org/GAP/AtSpiDbusInvestigation/
-Contents of this package ==================================
+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:
- idl : This directory contains the interface definitions
- (in Interface Definition Language) for the
- accessibility support interfaces exposed by
- the AT central registry, accessible applications,
- and UI components.
- This is possibly historic. The idl formed the basis
- for the XML protocol definitions now located
- in the directory "xml".
-
- registryd : This directory contains code specific to the
- central accessibility registry, and the registry
- executable is built in this directory.
-
- atk-adaptor : This directory contains code that bridges
- the at-spi to the GTK+ toolkit, and which is
- loaded at runtime by GTK+-based Gnome applications.
- The 'bridge' automatically registers GTK+-2.0
- applications with the accessibility registry,
- and relays UI events from application to registry.
- It is also responsible for servicing requests from
- the registry to register handlers for specific event
- types.
+ 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.
projects / platform / upstream / at-spi2-core.git / blobdiff