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