1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/README	Tue Sep 08 22:45:57 2009 -0700
     1.3 @@ -0,0 +1,62 @@
     1.4 +2008-05-06
     1.5 +
     1.6 +This is Jordan Sissel's 'keynav', modified by Paulo Ang.
     1.7 +
     1.8 +http://www.semicomplete.com/projects/keynav
     1.9 +http://iacs5.ucsd.edu/~pbang/mouseless.htm
    1.10 +
    1.11 +Note that this is based on an earlier release of 'keynav', not the
    1.12 +latest 'xdotool' based code. 
    1.13 +
    1.14 +
    1.15 +To build:
    1.16 +
    1.17 +Run 'xmkmf', then 'make keynav'.
    1.18 +
    1.19 +To run: 
    1.20 +
    1.21 +Simply run 'keynav'. For a list of the default keys see 'config.h'.
    1.22 +
    1.23 +To configure keys:
    1.24 +
    1.25 +Modify 'config.h' and recompile.
    1.26 +
    1.27 +To configure even more:
    1.28 +
    1.29 +Modify 'keynav.c' and recompile.
    1.30 +
    1.31 +
    1.32 +Hints:
    1.33 +
    1.34 +It's faster to use the "diagonal" movement keys, since they split the 
    1.35 +mouse area into four accessible parts, but the binary vi-keys is easier 
    1.36 +when you're just starting out or fine-tuning a small area.
    1.37 +
    1.38 +A good tactic would be to use the diagonal keys until the point you want to
    1.39 +click on is exactly on the crosshairs (or the selection area is too small),
    1.40 +then just use vi-keys to hone in.
    1.41 +
    1.42 +The nine-grid mode is even faster than the regular four-grid mode. 
    1.43 +Enable it by default by specifying '-n <num>' parameters to keynav, where
    1.44 +<num> is the number of moves before it automatically switches back to 
    1.45 +four-grid mode. Or press Shift-[center]. But you may want to hold off on 
    1.46 +using it until you get the hang of the four-grid mode first.
    1.47 +
    1.48 +You can have two instances of 'keynav' running simulataneously, as long as 
    1.49 +they have different trigger keys. You may want to do this to be able to use
    1.50 +both home row keys and the numeric keypad to 'keynav', for example.
    1.51 +
    1.52 +
    1.53 +About the statistics:
    1.54 +
    1.55 +'keynav' outputs debug messages to stderr, and stats to stdout. Simply
    1.56 +redirect to taste. 'hits' are the number of keys you've hit, 'moves' are the
    1.57 +number of movements made, and 'clicks' are the number of mouseclicks
    1.58 + not including simple clicks (ie, clicks that don't end the movement mode).
    1.59 +
    1.60 +
    1.61 +If 'keynav' appears to hang:
    1.62 +
    1.63 +It's probably because of the drag mode, which can be buggy with some apps.
    1.64 +A click from your real mouse will probably restore keyboard control, where
    1.65 +you can kill 'keynav' and start it up again.