| 1 |
.TH libinput-test-suite "1" "" "libinput @LIBINPUT_VERSION@" "libinput Manual" |
| 2 |
.SH NAME |
| 3 |
libinput\-test\-suite \- run the libinput test suite |
| 4 |
.SH SYNOPSIS |
| 5 |
.B libinput test\-suite [OPTIONS] |
| 6 |
.PP |
| 7 |
.SH DESCRIPTION |
| 8 |
.PP |
| 9 |
The |
| 10 |
.B "libinput test\-suite" |
| 11 |
command runs the libinput test suite. |
| 12 |
Its primary purpose is to verify distribution composes after package updates. Test |
| 13 |
suite failures usually indicate missing patches and/or incompatible lower |
| 14 |
system layers. |
| 15 |
.PP |
| 16 |
.B The test suite should not be run by users. Data loss is possible. |
| 17 |
.PP |
| 18 |
The test suite must be run as root. The test suite installs several files |
| 19 |
on the host system (see section \fBFILES\fR), runs system commands and |
| 20 |
creates virtual kernel devices via uinput. These devices will interfere with |
| 21 |
any active session and may cause data loss. |
| 22 |
.PP |
| 23 |
It is recommended that the test suite is run in a virtual machine and/or on |
| 24 |
a system not otherwise in use. A graphical environment is not required to |
| 25 |
run the test suite. |
| 26 |
|
| 27 |
.SH OPTIONS |
| 28 |
Note that the options may change in future releases of libinput. Test names, |
| 29 |
test device names and test group names may change at any time. |
| 30 |
.TP 8 |
| 31 |
.B \-\-filter\-test \fI"testname"\fB |
| 32 |
A glob limiting the tests to run. Specifying a filter sets the |
| 33 |
\fB\-\-jobs\fR default to 1. |
| 34 |
.TP 8 |
| 35 |
.B \-\-filter\-device \fI"devicename"\fB |
| 36 |
A glob limiting the devices to run tests for. Specifying a filter sets the |
| 37 |
\fB\-\-jobs\fR default to 1. |
| 38 |
.TP 8 |
| 39 |
.B \-\-filter\-group \fI"groupname"\fB |
| 40 |
A glob limiting the tests to (arbitrarily named) groups. Specifying a filter sets the |
| 41 |
\fB\-\-jobs\fR default to 1. |
| 42 |
.TP 8 |
| 43 |
.B \-\-filter\-deviceless |
| 44 |
\fBFOR INTERNAL USE ONLY\fR |
| 45 |
.TP 8 |
| 46 |
.B \-h, \-\-help |
| 47 |
Print help |
| 48 |
.TP 8 |
| 49 |
.B \-j, \-\-jobs 8 |
| 50 |
Number of parallel processes to run. Default: 8. |
| 51 |
.TP 8 |
| 52 |
.B \-\-list |
| 53 |
List all test cases and the devices they are run for. Test names, test device |
| 54 |
names and test group names may change at any time. |
| 55 |
.TP 8 |
| 56 |
.B \-\-verbose |
| 57 |
Enable verbose output, including libinput debug messages. |
| 58 |
.SH FILES |
| 59 |
The following directories are modified: |
| 60 |
|
| 61 |
.TP 8 |
| 62 |
.B @LIBINPUT_DATA_DIR@ |
| 63 |
Test device-specific quirks are installed in this directory with a custom |
| 64 |
prefix. Files in this directory are untouched but new files are installed |
| 65 |
and removed on exit. Existing files (e.g. from a previous aborted run) with |
| 66 |
the same name will be silently overwritten and removed. |
| 67 |
.TP 8 |
| 68 |
.B /run/udev/rules.d |
| 69 |
Test-specific udev rules are installed in this directory and removed on |
| 70 |
exit. |
| 71 |
.PP |
| 72 |
.SH SYSTEM SETUP |
| 73 |
The \fBxorg.conf.d(5)\fR snippet below ensures the X server ignores the test |
| 74 |
devices created by this test suite: |
| 75 |
.PP |
| 76 |
.RS 4 |
| 77 |
.nf |
| 78 |
.B "Section ""InputClass"" |
| 79 |
.B " Identifier ""Ignore libinput test suite devices"" |
| 80 |
.B " MatchProduct ""litest"" |
| 81 |
.B " Option ""Ignore"" ""on"" |
| 82 |
.B "EndSection" |
| 83 |
.fi |
| 84 |
.RE |
| 85 |
.PP |
| 86 |
No configuration is required for Wayland compositors. libinput's default |
| 87 |
mode will ignore test devices from this test suite. |
| 88 |
.SH BUGS |
| 89 |
Some tests are sensitive to timing. Where a system is under heavy load, |
| 90 |
a test may fail. Re-running the test with \fB\-\-filter-test\fR can help |
| 91 |
verify whether a test case failure was a true failure. |
| 92 |
.SH LIBINPUT |
| 93 |
Part of the |
| 94 |
.B libinput(1) |
| 95 |
suite |