fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2025-12-20 05:40:04 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions
libinput/tools/libinput-measure-touchpad-tap.man

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

81 lines
2.8 KiB
Groff
Raw Permalink Normal View History

tools: add the libinput version to the man pages Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net> Reviewed-by: Eric Engestrom <eric.engestrom@imgtec.com>
2017-06-29 08:40:28 +10:00
.TH libinput-measure-touchpad-tap "1" "" "libinput @LIBINPUT_VERSION@" "libinput Manual"
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
.SH NAME
tools: fix typo in man page Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-09-06 09:32:39 +10:00
libinput\-measure\-touchpad\-tap \- measure tap-to-click properties of devices
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
.SH SYNOPSIS
tools: tidy up the libinput man pages again 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>
2017-07-03 13:33:20 +10:00
.B libinput measure touchpad\-tap [\-\-help] [\-\-format=\fI<format>\fB] \fI[/dev/input/event0]\fR
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
.SH DESCRIPTION
.PP
The
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
.B "libinput measure touchpad\-tap"
tool measures properties of the tap\-to\-click behavior of the user. This is
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
an interactive tool. When executed, the tool will prompt the user to
interact with the touchpad. On termination, the tool prints a summary of the
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
tap interactions seen. This data should be attached to any tap\-related bug
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
report.
.PP
For a full description on how libinput's tap-to-click behavior works, see
the online documentation here:
.I https://wayland.freedesktop.org/libinput/doc/latest/tapping.html
.PP
This is a debugging tool only, its output may change at any time. Do not
rely on the output.
.PP
This tool usually needs to be run as root to have access to the
/dev/input/eventX nodes.
.SH OPTIONS
tools: note that the touchpad-tap measuring tool picks a touchpad Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-13 13:53:10 +10:00
If a device node is given, this tool opens that device node. Otherwise, this
tool searches for the first node that looks like a touchpad and uses that
node.
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
.TP 8
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
.B \-\-help
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
Print help
.TP 8
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
.B \-\-format=summary|dat
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
Specify the data format to be printed. The default (or if
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
.B \-\-format
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
is omitted) is "summary". See section
.B DATA FORMATS
.SH DATA FORMATS
This section describes the data formats printed with the
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
.B \-\-format
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
commandline argument. Note that any of the output may change at any time.
.RE
.PP
summary
.RS 4
The
.I summary
format prints a summary of the data collected. This format is useful to
get a quick overview of a user's tapping behavior and why some taps may or
may not be detected.
.RE
.PP
dat
.RS 4
The
.I dat
format prints the touch sequence data (raw and processed) in column-style
format, suitable for processing by other tools such as
.B gnuplot(1).
The data is aligned in one row per touch with each column containing a
separate data entry.
tools: escape all dashes in man pages (for commands and options) Apparently the rule is that if a dash may end up being copy/pasted, it needs to be escaped. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-02 12:15:50 +10:00
.B libinput\-measure\-touchpad\-tap
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
prints comments at the top of the file to describe each column.
.PP
.B WARNING:
The data contained in the output is grouped by different sort orders. For
example, the first few columns may list tap information in the 'natural'
treewide: fix typos Signed-off-by: Torstein Husebø <torstein@huseboe.net>
2020-08-27 19:52:34 +02:00
sort order (i.e. as they occurred), the data in the next few columns may list
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
tap information sorted by the delta time between touch down and touch up.
Comparing columns across these group boundaries will compare data of two
different touch points and result in invalid analysis.
tools: point out that measuring taps may be different to what libinput sees Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-06-09 15:00:36 +10:00
.SH BUGS
This tool does not take finger pressure into account. The tap it detects may
be different to those detected by libinput if libinput's pressure thresholds
differ significantly to the kernel's pressure thresholds.
tools: add "libinput measure touchpad-tap" This is the first tool of many more to come to enable users to gather information aobut their devices and/or usage of these devices. Previously, these required the users to record events, submit them to a bugzilla, have me run various scripts over it and then decree that the scripts have spoken. Push some of this into the hands of the users so they can query the numbers locally and start investigating (or at least get an idea of what's happening). This tool measures the time deltas between touch up and touch down and prints a basic summary, together with the ability to print a dat file with the data for visualization by e.g. gnuplot. Eventually, more of the current analysis scripts will be moved into this or other helpers. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
2017-05-23 15:07:31 +10:00
.SH LIBINPUT
Part of the
.B libinput(1)
suite
Reference in a new issue Copy permalink