INSTALL

   1 Instructions for testing
   2 ------------------------
   3
   4 To test AT-SPI D-Bus both a client (AT) library and server (Application)
   5 module is required.
   6
   7 The ATK-Bridge application module
   8 ---------------------------------
   9
  10 Currently there is an implementation of the ATK-Bridge for AT-SPI D-Bus. This
  11 is a GTK module that will expose GAIL objects as accessible objects over D-Bus.
  12 There are a number of ways to load a GTK module into an application. A special
  13 directory exists on a system where all modules in the directory are loaded by
  14 GTK applications. The ATK-Bridge GTK module is called libspiatk.so. It is
  15 installed to $(libdir)/$(GTK_MODULE_DIR) meaning that if the AT-SPI D-Bus
  16 package were installed on a system then all GTK apps would load it at
  17 startup.As the library is unstable this is probably not a good idea. Instead
  18 individual GTK applications can be started with the libspiatk.so module using
  19 the command line options. --gtk-module $(install_path)/libspiatk.so. This
  20 should work with all GTK applications.
  21
  22 Once a module is loaded with the libspiatk.so module it will print out its
  23 unique address on the D-Bus bus. You should write this down. Its currently the
  24 only way to access the application using a client (AT).
  25
  26 The Python client (AT) bindings
  27  -------------------------------
  28
  29 Once we have an application made accessible over the D-Bus we need an AT to
  30 access the information. There is a python implementation of the pyatspi
  31 bindings used by Accerciser and Orca. These bindings are installed to
  32 $(pythondir)/pyatspi. To use these bindings set your PYTHONPATH environment
  33 variable to the $(pythondir) directory and use "import pyatspi".
  34
  35 The only pyatspi based program tested so-far is Accerciser, and it can be
  36 problematic to run using PYTHONPATH, as it modifies the search path based on
  37 installation directory.
  38
  39 When running an AT using the new pyatspi bindings it is necessary to tell the
  40 pyatspi module where to find the accessible application this is done by setting
  41 the environment variable ATSPI_TEST_APP_NAME to the D-Bus unique name of
  42 application.
  43
  44 Summary
  45 -------
  46
  47     * Run a GTK application, make it accessible by either installing
  48 libspiatk.so to the GTK modules directory or by using the --gtk-module command
  49 line argument.
  50
  51     * Run an AT using the new pyatspi module. Either install AT-SPI D-Bus on a
  52 system without the old version of pyatspi, or set the PYTHONPATH environment
  53 variable.
  54
  55     * Dont forget to set the ATSPI_TEST_APP_NAME environment variable to that
  56 of the application. The Application will print its D-Bus unique name to stdout
  57 on connecting to the bus.