README

   1 D-Bus AT-SPI
   2 ------------
   3
   4 This version of at-spi is a major break from version 1.x.
   5 It has been completely rewritten to use D-Bus rather than
   6 ORBIT / CORBA for its transport protocol.
   7
   8 A page including instructions for testing, project status and
   9 TODO items is kept up to date at:
  10
  11         http://www.linuxfoundation.org/en/AT-SPI_on_D-Bus
  12
  13 The mailing list used for general questions is:
  14
  15         accessibility-atspi@lists.linux-foundation.org
  16
  17 For bug reports, feature requests, patches or enhancements please use
  18 the AT-SPI project on bugzilla.gnome.org. Use the at-spi2-core component for
  19 bugs specific to this module.
  20
  21         http://bugzilla.gnome.org
  22
  23 A git repository with the latest development code is available at:
  24
  25         git://git.gnome.org/at-spi2-core
  26
  27 More information
  28 ----------------
  29
  30 The project was started with a D-Bus performance review
  31 the results of which are available on the GNOME wiki. Keep in
  32 mind that the D-Bus AT-SPI design documents on this page
  33 have not been kept up to date.
  34
  35         http://live.gnome.org/GAP/AtSpiDbusInvestigation/
  36
  37 Other sources of relevant information about AT-SPI and Accessibility
  38 include:
  39
  40         http://live.gnome.org/Accessibility
  41         http://www.sun.com/software/star/gnome/accessibility/architecture.xml
  42         http://accessibility.kde.org/developer/atk.php
  43         http://www.gnome.org/~billh/at-spi-idl/html/
  44
  45
  46 Contents of this package
  47 ------------------------
  48
  49 This package includes the protocol definitions for the new D-Bus
  50 at-spi.
  51
  52 Also included is the daemon necessary for forwarding device events
  53 and registering accessible applicaitions.
  54
  55
  56 Directory structure
  57 -------------------
  58
  59 The directories within this package are arranged as follows:
  60
  61     xml
  62
  63         This directory contains XML documents describing
  64         the D-Bus protocol in the format used for D-Bus introspection.
  65
  66     idl
  67
  68         The D-Bus specification in an idl-like format. This is likely not
  69         parseable by any existing tools, is not entirely up-to-date, and may
  70         by removed in a future release.
  71
  72     registryd
  73
  74         The registry daemon code. The registry daemon
  75         keeps a register of accessible applications and presents
  76         this to clients (ATs).
  77         It is also responsible for delivering device events.
  78
  79     dbind
  80
  81         Library to ease making D-Bus method calls, contains
  82         marshalling code to convert function arguments
  83         and a provided D-Bus signature into a D-Bus message.
  84
  85         Used by libatspi.
  86
  87     atspi
  88
  89         C library for use by ATs. Wraps the various D-Bus calls, provides
  90         an interface for listening to events, and caches some information about
  91         accessible objects. Also contains some functions used by at-spi2-atk.
  92
  93     bus
  94
  95         A server that sits on the session bus and provides an interface
  96         allowing applications to find the accessibility bus daemon, launching
  97         it as needed. The accessibility bus is separate from the session bus
  98         because it may in fact span user sessions if a user, for instance,
  99         runs an application that escalates to run as root. The accessibility
 100         bus is thus tied to the X session rather than the D-Bus session.
 101
 102     doc
 103
 104         Contains infrastructure for creating libatspi documentation.
 105
 106     test
 107
 108         Contains files that may be useful for testing AT-SPI.
 109
 110    m4
 111
 112         Some macros used for building the module.
 113
 114     po
 115
 116         Infrastructure used for translation.