fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2026-06-19 13:38:34 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

tools: tidy up the libinput man pages again

Browse source 
Make the libinput page more generic but suitable for short attention spans and
most importantly, point to the xf86-input-libinput man page in a more obvious
manner since we're now shadowing that.

The rest of the man pages have punctuation and formatting cleanups only.

Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer 2017-07-03 13:33:20 +10:00
parent 57e35f4afa
commit 945122c691
5 changed files with 40 additions and 43 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
tools/libinput-debug-events.man
View file

@ -2,7 +2,7 @@
.SH NAME
libinput\-debug\-events \- debug helper for libinput
.SH SYNOPSIS
libinput debug\-events [\-\-help] [\-\-show\-keycodes] [\-\-udev <seat>|\-\-device /dev/input/event0] [configuration options]
.B libinput debug\-events [\-\-help] [\-\-show\-keycodes] [\-\-udev \fI<seat>\fB|\-\-device \fI/dev/input/event0\fB] \fI[configuration options]\fB
.SH DESCRIPTION
.PP
The
@ -16,8 +16,8 @@ This tool usually needs to be run as root to have access to the
/dev/input/eventX nodes.
.SH OPTIONS
.TP 8
.B \-\-device /dev/input/event0
Use the given device with the path backend.
.B \-\-device \fI/dev/input/event0\fR
Use the given device with the path backend
.TP 8
.B \-\-grab
Exclusively grab all opened devices. This will prevent events from being
@ -36,7 +36,7 @@ and other sensitive information showing up in the output. Use the
.B \-\-show\-keycodes
argument to make all keycodes visible.
.TP 8
.B \-\-udev <seat>
.B \-\-udev \fI<seat>\fR
Use the udev backend to listen for device notifications on the given seat.
The default behavior is equivalent to \-\-udev "seat0".
.TP 8
@ -45,40 +45,40 @@ Use verbose output
.SS libinput configuration options
.TP 8
.B \-\-enable\-tap|\-\-disable\-tap
Enable or disable tap-to-click.
Enable or disable tap-to-click
.TP 8
.B \-\-enable-drag|\-\-disable\-drag
Enable or disable tap-and-drag
.TP 8
.B \-\-enable\-drag-lock|\-\-disable\-drag\-lock
Enable or disable tap-and-drag.
Enable or disable tap-and-drag
.TP 8
.B \-\-enable\-natural\-scrolling|\-\-disable\-natural\-scrolling
Enable or disable natural scrolling.
Enable or disable natural scrolling
.TP 8
.B \-\-enable\-left\-handed|\-\-disable\-left\-handed
Enable or disable left handed button configuration.
Enable or disable left handed button configuration
.TP 8
.B \-\-enable\-dwt|\-\-disable\-dwt
Enable or disable disable-while-typing.
Enable or disable disable-while-typing
.TP 8
.B \-\-set\-click\-method=[none|clickfinger|buttons]
Set the desired click method
.TP 8
.B \-\-set\-scroll\-method=[none|twofinger|edge|button]
Set the desired scroll method.
Set the desired scroll method
.TP 8
.B \-\-set\-scroll\-button=BTN_MIDDLE
Set the button to the given button code.
Set the button to the given button code
.TP 8
.B \-\-set\-profile=[adaptive|flat]
Set pointer acceleration profile.
Set pointer acceleration profile
.TP 8
.B \-\-set\-speed=<value>
Set pointer acceleration speed. The allowed range is [-1, 1].
.TP 8
.B \-\-set\-tap\-map=[lrm|lmr]
Set button mapping for tapping.
Set button mapping for tapping
.SH NOTES
.PP
Events shown by this tool may not correspond to the events seen by a

6
tools/libinput-debug-gui.man
View file

@ -2,7 +2,7 @@
.SH NAME
libinput\-debug\-gui \- visual debug helper for libinput
.SH SYNOPSIS
.B libinput debug\-gui [\-\-help] [\-\-udev <seat>|\-\-device /dev/input/event0] [configuration options]
.B libinput debug\-gui [\-\-help] [\-\-udev \fI<seat>\fB|\-\-device \fI/dev/input/event0\fB] \fI[configuration options]\fB
.SH DESCRIPTION
.PP
The
@ -20,7 +20,7 @@ This tool usually needs to be run as root to have access to the
/dev/input/eventX nodes.
.SH OPTIONS
.TP 8
.B \-\-device /dev/input/event0
.B \-\-device \fI/dev/input/event0\fR
Use the given device with the path backend.
.TP 8
.B \-\-grab
@ -30,7 +30,7 @@ delivered to the host system.
.B \-\-help
Print help
.TP 8
.B \-\-udev <seat>
.B \-\-udev \fI<seat>\fR
Use the udev backend to listen for device notifications on the given seat.
The default behavior is equivalent to \-\-udev "seat0".
.TP 8

2
tools/libinput-measure-touchpad-tap.man
View file

@ -2,7 +2,7 @@
.SH NAME
libinput\-measure\-touchpad\-tap \- measure tap-to-click properities of devices
.SH SYNOPSIS
.B libinput measure touchpad\-tap [\-\-help] [\-\-format=<format>] [/dev/input/event0]
.B libinput measure touchpad\-tap [\-\-help] [\-\-format=\fI<format>\fB] \fI[/dev/input/event0]\fR
.SH DESCRIPTION
.PP
The

4
tools/libinput-measure.man
View file

@ -2,7 +2,7 @@
.SH NAME
libinput\-measure \- measure properties of devices
.SH SYNOPSIS
.B libinput measure [\-\-help] <feature> [<args>]
.B libinput measure [\-\-help] \fI<feature> [<args>]\fR
.SH DESCRIPTION
.PP
The
@ -23,7 +23,7 @@ Print help
Features that can be measured include
.TP 8
.B libinput\-measure\-touchpad\-tap\-time(1)
Measure tap-to-click time.
Measure tap-to-click time
.SH LIBINPUT
Part of the
.B libinput(1)

45
tools/libinput.man
View file

@ -2,25 +2,28 @@
.SH NAME
libinput \- tool to interface with libinput
.SH SYNOPSIS
.B libinput [\-\-help] [\-\-version] <command> [<args>]
.B libinput [\-\-help|\-\-version] \fI<command>\fR \fI[<args>]\fR
.SH DESCRIPTION
.PP
libinput is a library to handle input devices and provides device
detection and input device event processing for most Wayland
compositors and the X.Org xf86-input-libinput driver.
.PP
The
.B "libinput"
tool creates a libinput context on the default seat "seat0" and interacts
with that libinput context.
tools are a set of tools to debug, interface with and analyze data for
libinput. These tools create libinput contexts separate from that of
the compositor/X server and cannot change settings in a running session.
See section
.B COMMANDS
for a list of available commands.
.PP
This tool usually needs to be run as root to have access to the
/dev/input/eventX nodes.
libinput's API documentation and details on features and various high-level
concepts are available online at
.I https://wayland.freedesktop.org/libinput/doc/latest/
.PP
The context created by this tool is a new libinput context and independent
of that created by the X.Org libinput driver, the Wayland compositor or any
other process that utilizes libinput (henceforth called "the caller").
Configuration options set in this context do not affect any other libinput
contexts.
.PP
Note that a device may be recognized by this tool but not handled by the
X.Org libinput driver or the Wayland compositor.
The man page for the X.Org xf86-input-libinput driver is
.B libinput(4).
.SH OPTIONS
.TP 8
.B \-\-help
@ -28,28 +31,22 @@ Print help and exit
.TP 8
.B \-\-version
Print the version and exit
.SH COMMANDS
All commands support a
.B \-\-help
argument that prints command\-specific usage
information, e.g.
.B "libinput debug\-events \-\-help".
.TP 8
.B libinput\-debug\-events(1)
Print all events as seen by libinput.
Print all events as seen by libinput
.TP 8
.B libinput\-debug\-gui(1)
Show a GUI to visualize libinput's events.
Show a GUI to visualize libinput's events
.TP 8
.B libinput\-list\-devices(1)
List all devices recognized by libinput.
List all devices recognized by libinput
.TP 8
.B libinput\-measure(1)
Measure various properties of devices.
Measure various properties of devices
.TP 8
.B libinput\-measure\-touchpad\-tap(1)
Measure tap-to-click time.
Measure tap-to-click time
.SH LIBINPUT
Part of the
.B libinput(1)