README

   1 $URL$
   2 $Author$
   3 $Date$
   4 $Rev$
   5
   6 === Preamble ===
   7 This software is intended to help users of XWindows automate basic windowing
   8 tasks.  For example you can open, move, and close windows based on title,
   9 you can move the mouse, or send keystrokes.
  10
  11 I provide this software free of charge without warranty of any type.  I
  12 provide this in the hopes that it will be useful.  In the event you break
  13 this software, you are entitled to a full refund of the amount I charged. :)
  14
  15
  16 === My Rationale ===
  17 There are a few X11 control libraries out there.  My basic problem with
  18 most of them  are that they are all called from the bash prompt.  This is fine,
  19 but it makes it difficult to do things like track window state.  At each call
  20 to the program, window information is gathered again, and the request is
  21 processed.
  22
  23
  24 === What you'll need to compile this ===
  25 Note that Ubuntu (along with some other distributions of Linux) do not come
  26 with a development environment installed.  You'll need to install a development
  27 environment if you do not already have one.
  28
  29 Ubuntu (and similar):
  30  -- build-essential
  31
  32 Programs:
  33  -- swig
  34
  35 Libraries:
  36  -- x11proto-xext-dev
  37  -- libx11-dev
  38  -- libxtst-dev
  39
  40 Specifically if you are using Ubuntu and wish to compile this software, you can
  41 use the following command:
  42
  43 $ sudo aptitude install build-essential swig x11proto-xext-dev libx11-dev \
  44   libxtst-dev
  45
  46
  47 === If you want to modify the build ===
  48  -- autoconf
  49  -- automake
  50  -- libtool
  51
  52 === What you'll need to run this ===
  53 This software was originally written against Python 2.6.  It's likely that
  54 there are few (if any) things which will prevent this code from running in
  55 Python 3.x.  However, I do not have Python 3.x installed, and cannot test it.
  56
  57 To run this software - like say for example you compile it on one machine, and
  58 then transport the binary to another machine - make sure you have the following
  59 libraries installed:
  60  -- libx11-dev
  61  -- libxtst-dev
  62
  63 === Installing this software ===
  64 I highly recommend that you do not install this software.  It is simply beyond
  65 my resources to test this software in a wide variety of environments, and it's
  66 likely that automated update tools and the like will cause problems on your
  67 computer if you ignore this advice.  Note that there is a "make install" build
  68 target, which is installed for completeness sake, but I suggest you ignore it.
  69
  70 All you need to do to use this software is make sure that xaut.py and
  71 _xautpy.so are in the same directory as your script.
  72