diff options
author | Peter Hutterer <peter.hutterer@who-t.net> | 2011-01-05 13:38:03 +1000 |
---|---|---|
committer | Henrik Rydberg <rydberg@euromail.se> | 2011-01-05 10:39:25 +0100 |
commit | 6fc005d5e1120b376ec02b7f4a6c1554835749b2 (patch) | |
tree | 4dbc656fb127dff1840a95fb1e0973a5206e47cc | |
parent | 8a4c03414863cb58ca58b18fe590defe172c0ca3 (diff) |
Add man-pages for the various evemu-tools.
Using asciidoc and xmlto, conditional on their availability at configure
time.
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
Signed-off-by: Henrik Rydberg <rydberg@euromail.se>
-rw-r--r-- | configure.ac | 11 | ||||
-rw-r--r-- | tools/Makefile.am | 23 | ||||
-rw-r--r-- | tools/evemu-describe.txt | 44 | ||||
-rw-r--r-- | tools/evemu-device.txt | 38 |
4 files changed, 116 insertions, 0 deletions
diff --git a/configure.ac b/configure.ac index 1105932..f5b8980 100644 --- a/configure.ac +++ b/configure.ac @@ -22,6 +22,17 @@ AC_PROG_LIBTOOL 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 diff --git a/tools/Makefile.am b/tools/Makefile.am index e845fb2..ca86c07 100644 --- a/tools/Makefile.am +++ b/tools/Makefile.am @@ -10,3 +10,26 @@ bin_PROGRAMS = \ INCLUDES=-I$(top_srcdir)/include/ 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 diff --git a/tools/evemu-describe.txt b/tools/evemu-describe.txt new file mode 100644 index 0000000..8544169 --- /dev/null +++ b/tools/evemu-describe.txt @@ -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 <rydberg@euromail.se> diff --git a/tools/evemu-device.txt b/tools/evemu-device.txt new file mode 100644 index 0000000..05d1d30 --- /dev/null +++ b/tools/evemu-device.txt @@ -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 <rydberg@euromail.se> |