Asciidoc manpage instead of nroff, add manpage for evtest-capture.
asciidoc has the huge advantage of being human-readable. The generation of the actual manpage is somewhat complicated, but one can link straight to the evtest.txt file in cgit instead of being blamed for bleeding eyes when users look at nroff source. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer
parent
2552683bca
commit
36da59d4f6
24
Makefile.am
24
Makefile.am
|
|
@ -1,13 +1,33 @@
|
|||
|
||||
bin_PROGRAMS = evtest
|
||||
man_pages_src = evtest.txt
|
||||
|
||||
if HAVE_LIBXML
|
||||
bin_PROGRAMS += evtest-capture
|
||||
AM_CFLAGS = $(XML_CFLAGS)
|
||||
|
||||
evtest_capture_LDADD = $(XML_LIBS)
|
||||
man_pages_src += evtest-capture.txt
|
||||
endif
|
||||
|
||||
EXTRA_DIST = evtest-create-device.xsl INSTALL
|
||||
|
||||
# man page generation.
|
||||
if HAVE_DOCTOOLS
|
||||
man_pages = $(man_pages_src:.txt=.1)
|
||||
|
||||
SUFFIXES = .1 .txt .xml
|
||||
|
||||
.xml.1:
|
||||
@$(XMLTO) man $<
|
||||
|
||||
.txt.xml:
|
||||
@$(ASCIIDOC) -b docbook -d manpage -o $@ $<
|
||||
|
||||
dist_man_MANS = $(man_pages)
|
||||
|
||||
EXTRA_DIST += $(man_pages_src) $(man_pages)
|
||||
CLEANFILES = $(dist_man_MANS)
|
||||
MAINTAINERCLEANFILES = $(man_pages) *.xml
|
||||
endif
|
||||
|
||||
man1_MANS = evtest.man
|
||||
EXTRA_DIST = $(man1_MANS) evtest-create-device.xsl INSTALL
|
||||
|
|
|
|||
|
|
@ -18,4 +18,13 @@ if test "x$XSLTPROC" = "x"; then
|
|||
AC_MSG_WARN([xsltproc not found, needed to generate devices.])
|
||||
fi
|
||||
|
||||
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_OUTPUT([Makefile])
|
||||
|
|
|
|||
|
|
@ -0,0 +1,49 @@
|
|||
EVTEST-CAPTURE(1)
|
||||
=================
|
||||
|
||||
NAME
|
||||
----
|
||||
|
||||
evtest-capture - Input device event capture program
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
evtest-capture "/dev/input/eventX" [evtest-capture.xml]
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
evtest-capture captures the information and events from the input device
|
||||
specified on the command line and writes it to the xml file given. If no
|
||||
filename is given for the output file, evtest-capture.xml is chosen as
|
||||
default.
|
||||
|
||||
evtest-capture needs to be able to read from the device; in most cases this means it
|
||||
must be run as root.
|
||||
|
||||
Together with with evtest-create-device.xsl, a simple uinput-based software
|
||||
input device can be created that replays the events as if the same input was
|
||||
performed on the physical device. This can be useful to replicate bugs with
|
||||
input devices in upper layers of the stack.
|
||||
|
||||
To convert evtest-capture.xml into such a uinput device, run:
|
||||
|
||||
xsltproc evtest-create-device.xls evtest-capture.xml > mydevice.c
|
||||
gcc -o mydevice mydevice.c
|
||||
./mydevice
|
||||
|
||||
|
||||
DIAGNOSTICS
|
||||
-----------
|
||||
If evtest-capture 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 device from within X. VT switching to a TTY or
|
||||
shutting down the X server terminates this grab and synaptics devices can be
|
||||
debugged.
|
||||
|
||||
SEE ALSO
|
||||
--------
|
||||
evtest(1)
|
||||
|
||||
AUTHOR
|
||||
------
|
||||
evtest-capture was written by Peter Hutterer <peter.hutterer@redhat.com>.
|
||||
|
|
@ -1,11 +1,17 @@
|
|||
.TH EVTEST 1 "Oct 21, 2009"
|
||||
.SH NAME
|
||||
evtest \- Input device event monitor
|
||||
.SH SYNOPSIS
|
||||
.B evtest
|
||||
.I "/dev/input/eventX"
|
||||
EVTEST(1)
|
||||
=========
|
||||
|
||||
.SH "DESCRIPTION"
|
||||
NAME
|
||||
----
|
||||
|
||||
evtest - Input device event monitor
|
||||
|
||||
SYNOPSIS
|
||||
--------
|
||||
evtest "/dev/input/eventX"
|
||||
|
||||
DESCRIPTION
|
||||
-----------
|
||||
evtest displays information on the input device specified on the command
|
||||
line, including all the events supported by the device. It then monitors the
|
||||
device and displays all the events layer events generated.
|
||||
|
|
@ -17,22 +23,24 @@ evtest is commonly used to debug issues with input devices in X.Org. The
|
|||
output of evtest shows the information presented by the kernel; based on
|
||||
this information it can be determined whether a bug may be a kernel or an
|
||||
X.Org issue.
|
||||
.SH DIAGNOSTICS
|
||||
|
||||
DIAGNOSTICS
|
||||
-----------
|
||||
If evtest does not show 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 device from within X. VT switching to a TTY or
|
||||
shutting down the X server terminates this grab and synaptics devices can be
|
||||
debugged.
|
||||
.SH SEE ALSO
|
||||
\fBinputattach\fP(1)
|
||||
|
||||
.SH AUTHOR
|
||||
.B evtest
|
||||
was written by Vojtech Pavlik <vojtech@suse.cz>.
|
||||
SEE ALSO
|
||||
--------
|
||||
inputattach(1)
|
||||
|
||||
AUTHOR
|
||||
------
|
||||
evtest was written by Vojtech Pavlik <vojtech@suse.cz>.
|
||||
|
||||
This manual page was written by Stephen Kitt <steve@sk2.org>, based on that
|
||||
present in the
|
||||
.B lineakd
|
||||
package, for the Debian GNU/Linux system (but may be used by others).
|
||||
present in the lineakd package, for the Debian GNU/Linux system (but may be
|
||||
used by others).
|
||||
|
||||
Loading…
Reference in New Issue