README File for Keytest v1.1 by CampbellWare
============================================

1.0 Introduction
----------------

Thank you for downloading Keytest v1.1 for Mac OS X!

Keytest's  main  function  is to allow ncurses programmers to acquire an
immediate  understanding  of  the  keycodes  their software will receive
when specific keyboard keys are pressed. 

2.0 Keytest Installation
------------------------

Keytest  is  extremely  easy  to  "install".  Simply  unpack the tarball
(which   you   have  done  if  you  are  reading  this!),  cd  into  the
keytest-1.1-release   directory  that  is  created  and  copy  the  file
"keytest"  to  any  convenient  location on your executable search path.
Thats  it  - you are ready to use Keytest! Simply type "keytest" and you
are off and running. 

3.0 Keytest Technical Information
---------------------------------

Keytest  is  a  simple  utility  to assist in ncurses based programming.
Very  simply, it sets up the ncurses environment via specific calls that
are  detailed  below,  and  then  enters  a loop, reading characters and
echoing their hex values back to the screen. 

Keytest  support  the  basic  set of mouse events (click, hold, release,
double  click,  triple click) and will report these for each of Button1,
Button2 and Button3. 

The ncurses set up calls used by Keytest are:

   kt_win = initscr();
   keypad ( kt_win, TRUE);
   raw();
   noecho();
   mousemask ( ALL_MOUSE_EVENTS, NULL );

Keytest  remains in its read-and-echo loop until the key '$' is pressed.
At that time, keytest exits. 

4.0 Building Keytest from Source
--------------------------------

The  source  for  Keytest  v1.1  is  included.  It  may  be found in the
keytest-1.1-src  folder  hierarchy  created  as  part  of  unpacking the
tarball. A makefile is provided to build keytest.

5.0 Keytest Has Been Verified On...
-----------------------------------

Keytest  has  been  verified  on  a  PowerMac  G5 running Mac OS X Tiger
(10.4.7  and 10.4.8). Note that Keytest has also been tested on a number
of  x86  Linux  distros,  including  Arch Linux 0.7.1, Arch Linux 0.7.2,
SuSE  Linux  9.0,  Mandrake  10.1,  Debian  3.1, Knoppix 3.4, Damn Small
Linux 0.8 and Yoper 2.1. 

6.0 Getting Support for Keytest
-------------------------------

Enjoy  Keytest!  If you have ANY issues with it, please send an email to
webmaster@campbell-tx.net.  We  will make every effort to respond to and
resolve issues raised. 

