mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2026-01-09 01:40:17 +01:00
doc: indent all @note continuation lines
This isn't required by doxygen but for a potential switch to RTD/sphinx (see #95) it helps having this set up correctly. Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer
parent
2560c53fee
commit
c1f010a6eb
11 changed files with 44 additions and 42 deletions
|
|
@ -77,7 +77,7 @@ evdev:name:SynPS/2 Synaptics TouchPad:dmi:*svnLENOVO:*pvrThinkPadT440s*
|
|||
@endverbatim
|
||||
|
||||
@note hwdb match strings only allow for alphanumeric ascii characters. Use a
|
||||
wildcard (* or ?, whichever appropriate) for special characters.
|
||||
wildcard (* or ?, whichever appropriate) for special characters.
|
||||
|
||||
The actual axis overrides are in the form:
|
||||
@verbatim
|
||||
|
|
@ -95,8 +95,9 @@ in *linux/input-event-codes.h*. For touchpads ABS_X, ABS_Y,
|
|||
ABS_MT_POSITION_X and ABS_MT_POSITION_Y are required.
|
||||
|
||||
@note The touchpad's ranges and/or resolution should only be fixed when
|
||||
there is a significant discrepancy. A few units do not make a difference and
|
||||
a resolution that is off by 2 or less usually does not matter either.
|
||||
there is a significant discrepancy. A few units do not make a
|
||||
difference and a resolution that is off by 2 or less usually does
|
||||
not matter either.
|
||||
|
||||
Once a match and override rule has been found, follow the instructions at
|
||||
the top of the
|
||||
|
|
|
|||
|
|
@ -124,10 +124,9 @@ libinput has a few build-time dependencies that must be installed prior to
|
|||
running configure.
|
||||
|
||||
@note The build dependencies for some distributions can be found in the
|
||||
[GitLab Continuous Integration file](https://gitlab.freedesktop.org/libinput/libinput/blob/master/.gitlab-ci.yml)
|
||||
. Search for <b>FEDORA_RPMS</b> in the <b>variables:</b> definition and check
|
||||
the list for an entry for your distribution.
|
||||
|
||||
[GitLab Continuous Integration file](https://gitlab.freedesktop.org/libinput/libinput/blob/master/.gitlab-ci.yml).
|
||||
Search for <b>FEDORA_RPMS</b> in the <b>variables:</b> definition
|
||||
and check the list for an entry for your distribution.
|
||||
|
||||
In most cases, it is sufficient to install the dependencies that your
|
||||
distribution uses to build the libinput package. These can be installed
|
||||
|
|
@ -210,7 +209,7 @@ $> sudo udevadm hwdb --update
|
|||
@endverbatim
|
||||
|
||||
@note On Debian-based distributions including Ubuntu and its derivatives skip the
|
||||
```--libdir=/usr/lib64``` argument.
|
||||
```--libdir=/usr/lib64``` argument.
|
||||
|
||||
To uninstall libinput as detailed in section @ref reverting_install, run
|
||||
|
||||
|
|
|
|||
|
|
@ -39,8 +39,8 @@ location of the button is not visibly obvious.
|
|||
@image html software-buttons.svg "Left, right and middle-button click with software button areas"
|
||||
|
||||
@note If middle button emulation is enabled on a clickpad, only left and right
|
||||
button areas are available. For more details, see
|
||||
libinput_device_config_middle_emulation_set_enabled().
|
||||
button areas are available. For more details, see
|
||||
libinput_device_config_middle_emulation_set_enabled().
|
||||
|
||||
If fingers are down in the main area in addition to fingers in the
|
||||
left or right button area, those fingers are are ignored.
|
||||
|
|
|
|||
|
|
@ -13,7 +13,7 @@ at least one of `ModelFoo=1` or `AttrFoo=bar` directive. See the
|
|||
their contents.
|
||||
|
||||
@note Model quirks are internal API and may change at any time. No
|
||||
backwards-compatibility is guaranteed.
|
||||
backwards-compatibility is guaranteed.
|
||||
|
||||
For example, a quirks file may have this content to label all keyboards on
|
||||
the serial bus (PS/2) as internal keyboards:
|
||||
|
|
@ -45,8 +45,8 @@ this file to add a device quirk for a local device but beware that **any
|
|||
modification must be upstreamed** or it may cease to work at any time.
|
||||
|
||||
@note Model quirks are internal API and may change at any time. No
|
||||
backwards-compatibility is guaranteed. Local overrides should only be used
|
||||
until the distribution updates the libinput packages.
|
||||
backwards-compatibility is guaranteed. Local overrides should only
|
||||
be used until the distribution updates the libinput packages.
|
||||
|
||||
The `local-overrides.quirks` file usually needs to be created by the user.
|
||||
Once the required section has been added, use the information from section
|
||||
|
|
|
|||
13
doc/faqs.dox
13
doc/faqs.dox
|
|
@ -127,10 +127,9 @@ this:
|
|||
$> xinput set-prop "the device name" "the property name" value [value2] [value3]
|
||||
@endverbatim
|
||||
|
||||
@note
|
||||
Changes performed by xinput do not persist across device hotplugs. xinput is
|
||||
considered a debugging and testing tool only and should not be used for
|
||||
permanent configurations.
|
||||
@note Changes performed by xinput do not persist across device hotplugs. xinput
|
||||
is considered a debugging and testing tool only and should not be used
|
||||
for permanent configurations.
|
||||
|
||||
@section faq_configuration Can you add a configuration option for $FEATURE?
|
||||
|
||||
|
|
@ -195,9 +194,9 @@ or patches that include a change to the hwdb. See @ref hwdb for
|
|||
details on the hwdb and how to modify it locally.
|
||||
|
||||
@note As of libinput 1.12, libinput-specific properties are now stored in
|
||||
the @ref device-quirks system. There are no libinput-specific hwdb entries
|
||||
anymore and any changes to the hwdb must be merged into the systemd
|
||||
repository.
|
||||
the @ref device-quirks system. There are no libinput-specific hwdb
|
||||
entries anymore and any changes to the hwdb must be merged into the
|
||||
systemd repository.
|
||||
|
||||
@section faq_timer_offset What causes the "timer offset negative" warning?
|
||||
|
||||
|
|
|
|||
|
|
@ -155,9 +155,9 @@ libinput uses two triggers for thumb detection: pressure and
|
|||
location. A touch exceeding a pressure threshold is considered a thumb if it
|
||||
is within the thumb detection zone.
|
||||
|
||||
@note "Pressure" on touchpads is synonymous with "contact area", a large
|
||||
touch surface area has a higher pressure and thus hints at a thumb or palm
|
||||
touching the surface.
|
||||
@note "Pressure" on touchpads is synonymous with "contact area", a large touch
|
||||
surface area has a higher pressure and thus hints at a thumb or palm
|
||||
touching the surface.
|
||||
|
||||
Pressure readings are unreliable at the far bottom of the touchpad as a
|
||||
thumb hanging mostly off the touchpad will have a small surface area.
|
||||
|
|
|
|||
|
|
@ -180,7 +180,7 @@ E: USEC_INITIALIZED=5463031
|
|||
@section evemu Recording devices with evemu
|
||||
|
||||
@note Where available, the @ref libinput-record tools should be used instead
|
||||
of evemu
|
||||
of evemu
|
||||
|
||||
[evemu](https://www.freedesktop.org/wiki/Evemu/) records the
|
||||
device capabilities together with the event stream from the kernel. On our
|
||||
|
|
@ -221,7 +221,8 @@ keys down, with the position of the device in the neutral position, without
|
|||
touching the screen/touchpad.
|
||||
|
||||
@note The longer the recording, the harder it is to identify the event
|
||||
sequence triggering the bug. Please keep the event sequence as short as possible.
|
||||
sequence triggering the bug. Please keep the event sequence as short
|
||||
as possible.
|
||||
|
||||
To verify that the recording contains the bug, you can replay it on your
|
||||
device. For example, to replay the sequence recorded in the example above:
|
||||
|
|
@ -233,8 +234,9 @@ If the bug is triggered by replaying on your device, attach the recording to
|
|||
the bug report.
|
||||
|
||||
@note libinput does not affect the evemu recording. libinput and evemu talk
|
||||
directly to the kernel's device nodes. An evemu recording is not influenced
|
||||
by the libinput version or whether a libinput context is currently active.
|
||||
directly to the kernel's device nodes. An evemu recording is not
|
||||
influenced by the libinput version or whether a libinput context is
|
||||
currently active.
|
||||
|
||||
@dotfile evemu.gv
|
||||
|
||||
|
|
|
|||
|
|
@ -73,8 +73,8 @@ a designated button is held down. For example, Lenovo devices provide a
|
|||
scroll events when the trackstick's middle mouse button is held down.
|
||||
|
||||
@note On-button scrolling is enabled by default for pointing sticks. This
|
||||
prevents middle-button dragging; all motion events while the middle button is
|
||||
down are converted to scroll events.
|
||||
prevents middle-button dragging; all motion events while the middle
|
||||
button is down are converted to scroll events.
|
||||
|
||||
@image html button-scrolling.svg "Button scrolling"
|
||||
|
||||
|
|
|
|||
|
|
@ -29,7 +29,7 @@ different than expected. For example, if a device does not show up in the
|
|||
output, it is not a supported input device.
|
||||
|
||||
@note This tool does **not** show your desktop's configuration, just the
|
||||
libinput built-in defaults.
|
||||
libinput built-in defaults.
|
||||
|
||||
@verbatim
|
||||
$ sudo libinput list-devices
|
||||
|
|
@ -61,7 +61,7 @@ with an asterisk (*). In the example above, the default click method is
|
|||
button-areas but clickinger is available.
|
||||
|
||||
@note This tool is intended to be human-readable and may change its output
|
||||
at any time.
|
||||
at any time.
|
||||
|
||||
@section libinput-debug-events libinput debug-events
|
||||
The `libinput debug-events` command prints events from devices and can help
|
||||
|
|
@ -78,7 +78,7 @@ on or off as required. See the **libinput-debug-events(1)** man page or the
|
|||
`--help` output for information about the available options.
|
||||
|
||||
@note When submitting a bug report, always use the `--verbose` flag to get
|
||||
additional information: `libinput debug-events --verbose <other options>`
|
||||
additional information: `libinput debug-events --verbose <other options>`
|
||||
|
||||
An example output from this tool may look like the snippet below.
|
||||
|
||||
|
|
@ -120,7 +120,7 @@ gathers data directly from libinput, it is thus suitable for
|
|||
pointer-acceleration testing.
|
||||
|
||||
@note This tool does **not** use your desktop's configuration, just the
|
||||
libinput built-in defaults.
|
||||
libinput built-in defaults.
|
||||
|
||||
@verbatim
|
||||
$ sudo libinput debug-gui --enable-tapping
|
||||
|
|
@ -139,9 +139,10 @@ replay` command. This pair of tools is crucial to capturing bugs and
|
|||
reproducing them on a developer's machine.
|
||||
|
||||
@note These tools are shipped with libinput, but the recorded events
|
||||
are **kernel events** and independent of the libinput context. libinput does not
|
||||
need to be running, it does not matter whether a user is running X.Org or
|
||||
Wayland or even what version of libinput is currently running.
|
||||
are **kernel events** and independent of the libinput context. libinput
|
||||
does not need to be running, it does not matter whether a user is
|
||||
running X.Org or Wayland or even what version of libinput is currently
|
||||
running.
|
||||
|
||||
The use of the tools is straightforward, just run without arguments, piping
|
||||
the output into a file:
|
||||
|
|
@ -182,7 +183,7 @@ For data protection, `libinput record` obscures key codes by default, any
|
|||
alphanumeric key shows up as letter "a".
|
||||
|
||||
@note When reproducing a bug that crashes libinput, run inside `screen` or
|
||||
`tmux`.
|
||||
`tmux`.
|
||||
|
||||
The recording can be replayed with the `libinput replay` command:
|
||||
@verbatim
|
||||
|
|
|
|||
|
|
@ -96,9 +96,9 @@ Interact with the touchpad and check if the output of this tool matches your
|
|||
expectations.
|
||||
|
||||
@note **This is an interactive process. You will need to re-run the
|
||||
tool with varying thresholds until you find the right range for your
|
||||
touchpad. Attaching output logs to a bug will not help, only you with access
|
||||
to the hardware can figure out the correct ranges.**
|
||||
tool with varying thresholds until you find the right range for your
|
||||
touchpad. Attaching output logs to a bug will not help, only you with access
|
||||
to the hardware can figure out the correct ranges.**
|
||||
|
||||
Once the thresholds are decided on (e.g. 10 and 8), they can be enabled with
|
||||
@ref device-quirks entry similar to this:
|
||||
|
|
|
|||
|
|
@ -87,8 +87,8 @@ slows the trackpoint down, a value above 1.0 speeds the trackpoint up.
|
|||
Values below zero are invalid.
|
||||
|
||||
@note The multiplier is not a configuration to adjust to personal
|
||||
preferences. The multiplier normalizes the input data into a range that can
|
||||
then be configured with the speed setting.
|
||||
preferences. The multiplier normalizes the input data into a range that
|
||||
can then be configured with the speed setting.
|
||||
|
||||
To adjust the local multiplier, first @ref building_libinput
|
||||
"build libinput from git master". It is not required to install libinput
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue