path: root/README
diff options
authorJakob Kaivo <>2015-04-18 00:38:56 -0400
committerJakob Kaivo <>2015-04-18 00:38:56 -0400
commitaac2afbf514abc27a4c3b2af9c46ee9e2adf7940 (patch)
tree0e6872856f16927b312e32810e4eef6a589df667 /README
parentac0708c3af77d0e28c704248b5f361b369504666 (diff)
added command line optionspenxortouch
updated README to reflect said options
Diffstat (limited to 'README')
1 files changed, 12 insertions, 11 deletions
diff --git a/README b/README
index f05e560..8db1870 100644
--- a/README
+++ b/README
@@ -4,16 +4,17 @@ digitizer is near.
It requires the XInput extension and its accompanying library. On Debian, this
is available in the package libxi-dev.
-It's been developed and tested on a ThinkPad Yoga (first generation), which
-is what the input device names are configured for.
+The default pen and touch devices are specified by the PENDEVICE and
+TOUCHDEVICE symbolic constants #defined near the top of the code,
+respectively. These are the devices on a ThinkPad Yoga (first generation),
+on which this program was originally developed. Command line options are
+available to override either or both. The options are -t for the touch
+device and -p for the pen device. Check the output of xinput(1) for the names
+of the devices on your system. Note that if the names of your devices contain
+spaces, which is likely, you'll need to quote them in your shell.
-A future revision will support naming devices via command line options, but
-for the time being they are compiled in. If you are using a different tablet,
-you may need to edit the values of PENDEVICE and/or TOUCHDEVICE in
-penxortouch.c. Hopefully these names are self-explanatory. The command
-xinput(1) will give you a list of the input devices available on your system.
+A future revision will include an actual man page. As it is, the command is
+very simple and provides a basic usage synopsis with the -h option.
-A future revision will also include a genuine man page. As it is, there are
-no run-time options. Simply run the program, penxortouch, and it will disable
-the touchscreen device whenever the pen device comes in proximity to the
-screen, and reenable the touchscreen when the pen leaves proximity.
+A possibility for the future is some sort of intelligent default search