diff --git a/Makefile.am b/Makefile.am index 8397f73..a963530 100644 --- a/Makefile.am +++ b/Makefile.am @@ -21,7 +21,7 @@ DISTCHECK_CONFIGURE_FLAGS = --with-sdkdir='$${includedir}/xorg' -SUBDIRS = src +SUBDIRS = src man MAINTAINERCLEANFILES = ChangeLog INSTALL .PHONY: ChangeLog INSTALL diff --git a/configure.ac b/configure.ac index a168644..b88373d 100644 --- a/configure.ac +++ b/configure.ac @@ -68,5 +68,6 @@ DRIVER_NAME=libinput AC_SUBST([DRIVER_NAME]) AC_CONFIG_FILES([Makefile - src/Makefile]) + src/Makefile + man/Makefile]) AC_OUTPUT diff --git a/man/libinput.man b/man/libinput.man new file mode 100644 index 0000000..f04cc76 --- /dev/null +++ b/man/libinput.man @@ -0,0 +1,73 @@ +.\" shorthand for double quote that works everywhere. +.ds q \N'34' +.TH LIBINPUT __drivermansuffix__ __vendorversion__ +.SH NAME +libinput \- libinput-based X.Org input driver +.SH SYNOPSIS +.nf +.B "Section \*qInputDevice\*q" +.BI " Identifier \*q" devname \*q +.B " Driver \*qlibinput\*q" +.BI " Option \*qDevice\*q \*q" devpath \*q +\ \ ... +.B EndSection +.fi +.SH NOTE +This is the man page for the X input driver. If you are looking for the +library documentation, go to +.BI http://wayland.freedesktop.org/libinput/doc/ + +.SH DESCRIPTION +.B libinput +is an __xservername__ input driver based on libinput. It +therefore supports all input devices that libinput can handle, including +most mice, keyboards, tablets and touchscreens. +.PP +It is recommended that +.B libinput +devices are configured through the +.B InputClass +directive (refer to __xconfigfile__(__filemansuffix__)) instead of manual +per-device configuration. Devices configured in the +__xconfigfile__(__filemansuffix__) are not hot-plug capable. +.SH CONFIGURATION DETAILS +Please refer to __xconfigfile__(__filemansuffix__) for general configuration +details and for options that can be used with all input drivers. This +section only covers configuration details specific to this driver. +.PP +The following driver +.B Options +are supported: +.TP 7 +.BI "Option \*qDevice\*q \*q" string \*q +Specifies the device through which the device can be accessed. This will +generally be of the form \*q/dev/input/eventX\*q, where X is some integer. +The mapping from device node to hardware is system-dependent. Property: +"Device Node" (read-only). + +.SH SUPPORTED PROPERTIES +The following properties are provided by the +.B libinput +driver. +.TP 7 +.BI "libinput Tapping Enabled" +1 boolean value (8 bit, 0 or 1). 1 enables tapping +.TP 7 +.BI "libinput Calibration Matrix" +9 32-bit float values, representing a 3x3 calibration matrix, order is row +1, row 2, row 3 +.TP 7 +.BI "libinput Accel Speed" +1 32-bit float value, defines the pointer speed. Value range -1, 1 +.TP 7 +.BI "libinput Natural Scrolling Enabled" +1 boolean value (8 bit, 0 or 1). 1 enables natural scrolling +.TP 7 +.BI "libinput Send Events Mode" +1 32-bit value, defines the sendevent mode. See the libinput documentation +for the allowed values. + +.SH AUTHORS +Peter Hutterer +.SH "SEE ALSO" +__xservername__(__appmansuffix__), __xconfigfile__(__filemansuffix__), Xserver(__appmansuffix__), X(__miscmansuffix__)