Merge lp:~oif-team/evemu/trunk.v1.0.4 into lp:evemu

[Henrik Rydberg]

Thanks to Peter Hutterer, we now have man pages and documentation for
the evemu tools.

[Chase Douglas (chasedouglas)]

Looks good here.

review: Approve

[Stephen M. Webb (bregma)]

All good.

review: Approve

=== modified file 'README'
--- README	2010-09-18 17:10:11 +0000
+++ README	2011-01-05 11:05:09 +0000
@@ -6,6 +6,27 @@
 http://bitmath.org/code/evemu/
 Please send patches to: [e-mail]
 
+evemu produces two different data formats, one for the device description
+and one for the device event data. hex data is without a 0x prefix.
+
+Device Description Format:
+    N: <device name>
+    I: <bustype (hex)> <vendor (hex)> <product (hex)> <version (hex)>
+    # for each kernel property (2.3.38 only)
+    P: <byte 0 (hex)> <byte 1 (hex)> ... <byte 7 (hex)>
+    P: <byte 8 (hex)> ...
+    # for each index from 0 to EV_CNT
+    B: <index (hex)> <byte 0 (hex)> <byte 1 (hex)> ... <byte 7 (hex)>
+    B: <index (hex)> <byte 8 (hex)> ...
+    # for each absolute axis
+    A: <index (hex)> <min> <max> <fuzz> <flat>
+
+
+Event Data Format:
+    E: <sec>.<usec> <evtype (hex)> <evcode (hex)> <ev value>
+where type, code and value are the respective fields of the
+input_event struct defined in linux/input.h
+
 ---
 Copyright (C) 2010 Henrik Rydberg <[e-mail]>
 Copyright (C) 2010 Canonical Ltd.
 
=== modified file 'configure.ac'
--- configure.ac	2010-12-22 07:47:53 +0000
+++ configure.ac	2011-01-05 11:05:09 +0000
@@ -1,7 +1,7 @@
 # Initialize Autoconf
 AC_PREREQ([2.60])
 AC_INIT([Kernel device emulation],
-        [1.0.3],
+        [1.0.4],
         [],
         [utouch-evemu])
 AC_CONFIG_SRCDIR([Makefile.am])
@@ -22,6 +22,17 @@
 AC_PROG_CC
 AC_PROG_INSTALL
 
+# man page generation
+AC_ARG_VAR([XMLTO], [Path to xmlto command])
+AC_PATH_PROG([XMLTO], [xmlto])
+AC_ARG_VAR([ASCIIDOC], [Path to asciidoc command])
+AC_PATH_PROG([ASCIIDOC], [asciidoc])
+AM_CONDITIONAL([HAVE_DOCTOOLS], [test "x$XMLTO" != "x" && test "x$ASCIIDOC" != "x"])
+if test "x$XMLTO" = "x" || test "x$ASCIIDOC" = "x"; then
+	AC_MSG_WARN([xmlto or asciidoc not found - cannot create man pages without it])
+fi
+
+
 AC_CONFIG_FILES([Makefile
                  src/Makefile
                  tools/Makefile
 
=== modified file 'src/evemu.c'
--- src/evemu.c	2010-12-22 07:22:51 +0000
+++ src/evemu.c	2011-01-05 11:05:09 +0000
@@ -33,6 +33,8 @@
 #include <fcntl.h>
 #include <errno.h>
 #include <poll.h>
+#include <ctype.h>
+#include <unistd.h>
 
 #ifndef UI_SET_PROPBIT
 #define UI_SET_PROPBIT		_IOW(UINPUT_IOCTL_BASE, 110, int)
@@ -239,6 +241,8 @@
 	for (i = 0; i < ABS_CNT; i++)
 		if (evemu_has_event(dev, EV_ABS, i))
 			write_abs(fp, i, &dev->abs[i]);
+
+	return 0;
 }
 
 static void read_prop(struct evemu_device *dev, FILE *fp)
 
=== modified file 'tools/Makefile.am'
--- tools/Makefile.am	2010-09-19 18:15:10 +0000
+++ tools/Makefile.am	2011-01-05 11:05:09 +0000
@@ -9,16 +9,27 @@
 
 INCLUDES=-I$(top_srcdir)/include/
 
-evemu_describe_SOURCES = evemu-describe.c
-evemu_describe_LDFLAGS = -L$(top_builddir)/src/.libs/ -lutouch-evemu
-
-evemu_echo_SOURCES = evemu-echo.c
-evemu_echo_LDFLAGS = -L$(top_builddir)/src/.libs/ -lutouch-evemu
-
-evemu_device_SOURCES = evemu-device.c
-evemu_device_LDFLAGS = -L$(top_builddir)/src/.libs/ -lutouch-evemu
-
-evemu_record_SOURCES = evemu-record.c
-evemu_record_LDFLAGS = -L$(top_builddir)/src/.libs/ -lutouch-evemu
-evemu_play_SOURCES = evemu-play.c
-evemu_play_LDFLAGS = -L$(top_builddir)/src/.libs/ -lutouch-evemu
+AM_LDFLAGS = $(top_builddir)/src/libutouch-evemu.la
+
+
+# man page generation
+if HAVE_DOCTOOLS
+# actual man pages
+man_pages_sources = evemu-describe.txt evemu-device.txt
+# shadow man pages
+man_pages_shadows = evemu-record.1 evemu-play.1
+
+man_pages = $(man_pages_sources:.txt=.1) $(man_pages_shadows)
+
+SUFFIXES = .1 .txt .xml
+
+.xml.1:
+	@$(XMLTO) man $<
+
+.txt.xml:
+	@$(ASCIIDOC) -b docbook -d manpage -o $@ $<
+
+dist_man_MANS = $(man_pages)
+CLEANFILES = $(dist_man_MANS)
+MAINTAINERCLEANFILES = $(man_pages) *.xml
+endif
 
=== modified file 'tools/evemu-describe.c'
--- tools/evemu-describe.c	2010-12-21 16:50:56 +0000
+++ tools/evemu-describe.c	2011-01-05 11:05:09 +0000
@@ -30,6 +30,7 @@
 #include <stdio.h>
 #include <fcntl.h>
 #include <string.h>
+#include <unistd.h>
 
 static int describe_device(int fd)
 {
 
=== added file 'tools/evemu-describe.txt'
--- tools/evemu-describe.txt	1970-01-01 00:00:00 +0000
+++ tools/evemu-describe.txt	2011-01-05 11:05:09 +0000
@@ -0,0 +1,44 @@
+EVEMU-DESCRIBE(1)
+=================
+
+NAME
+----
+
+     evemu-describe, evemu-record  - print information and events from an
+     input device
+
+SYNOPSIS
+--------
+     evemu-describe /dev/input/eventX
+
+     evemu-record /dev/input/eventX
+
+DESCRIPTION
+-----------
+evemu-describe gathers information about the input device and prints it to
+stdout. This information can be parsed by evemu-device(1) to create a
+virtual input device with the same properties.
+
+evemu-record captures events from the input device and prints them to
+stdout. The events can be parsed by evemu-play(1) to let a virtual input
+device created with evemu-device(1) emit the exact same event sequence.
+
+evemu-describe and evemu-record need to be able to read from the device; in
+most cases this means they must be run as root.
+
+DIAGNOSTICS
+-----------
+If evtest-record does not see any events even though the device is being
+used, the device may be grabbed by a process (EVIOCGRAB).  This is usually
+the case when debugging a synaptics or wacom device from within X. VT
+switching to a TTY or shutting down the X server terminates this grab and
+the devices can be recorded.
+
+SEE ALSO
+--------
+evemu-device(1)
+evemu-play(1)
+
+AUTHOR
+------
+evemu was written by Henrik Rydberg <[e-mail]>
 
=== modified file 'tools/evemu-device.c'
--- tools/evemu-device.c	2010-12-21 16:50:56 +0000
+++ tools/evemu-device.c	2011-01-05 11:05:09 +0000
@@ -30,6 +30,7 @@
 #include <stdio.h>
 #include <fcntl.h>
 #include <string.h>
+#include <unistd.h>
 
 #define UINPUT_NODE "/dev/uinput"
 #define MAX_EVENT_NODE 32
 
=== added file 'tools/evemu-device.txt'
--- tools/evemu-device.txt	1970-01-01 00:00:00 +0000
+++ tools/evemu-device.txt	2011-01-05 11:05:09 +0000
@@ -0,0 +1,38 @@
+EVEMU-DEVICE(1)
+===============
+
+NAME
+----
+
+     evemu-device, evemu-play  - create a virtual input device and replay an
+     event sequence
+
+SYNOPSIS
+--------
+     evemu-device [description-file]
+
+     evemu-play /dev/input/eventX < event-sequence
+
+DESCRIPTION
+-----------
+evemu-device creates a virtual input device based on the description-file.
+This description is usually created by evemu-describe(1). evemu-device then
+creates a new input device with uinput and prints the name and the device
+file to
+stdout.
+
+evemu-play replays the event sequence given on stdin through the input
+device. The event sequence must be in the form created by evemu-record(1).
+
+evemu-device must be able to write to the uinput device node, and evemu-play
+must be able to write to the device node specified; in most cases this means
+it must be run as root.
+
+SEE ALSO
+--------
+evemu-describe(1)
+evemu-record(1)
+
+AUTHOR
+------
+evemu was written by Henrik Rydberg <[e-mail]>
 
=== modified file 'tools/evemu-play.c'
--- tools/evemu-play.c	2010-09-22 15:14:42 +0000
+++ tools/evemu-play.c	2011-01-05 11:05:09 +0000
@@ -30,6 +30,7 @@
 #include <stdio.h>
 #include <fcntl.h>
 #include <string.h>
+#include <unistd.h>
 
 int main(int argc, char *argv[])
 {
 
=== modified file 'tools/evemu-record.c'
--- tools/evemu-record.c	2010-09-18 17:10:11 +0000
+++ tools/evemu-record.c	2011-01-05 11:05:09 +0000
@@ -30,6 +30,7 @@
 #include <stdio.h>
 #include <fcntl.h>
 #include <string.h>
+#include <unistd.h>
 
 #define WAIT_MS 10000