mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2026-06-04 15:18:30 +02:00
doc: fix typos and misspellings across documentation
Co-authored-by: Claude <noreply@anthropic.com> Part-of: <https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/1469>
This commit is contained in:
parent
60028ea595
commit
f854eb0515
14 changed files with 27 additions and 28 deletions
|
|
@ -110,7 +110,7 @@ The most common matrices are:
|
|||
.. math::
|
||||
\begin{pmatrix}
|
||||
-1 & 0 & 1 \\
|
||||
1 & 0 & 0 \\
|
||||
0 & 1 & 0 \\
|
||||
0 & 0 & 1
|
||||
\end{pmatrix}
|
||||
|
||||
|
|
|
|||
|
|
@ -60,7 +60,7 @@ is unfortunately not visibly obvious.
|
|||
available.
|
||||
|
||||
If fingers are down in the main area in addition to fingers in the
|
||||
left or right button area, those fingers are are ignored.
|
||||
left or right button area, those fingers are ignored.
|
||||
A release event always releases the buttons logically down, regardless of
|
||||
the current finger position
|
||||
|
||||
|
|
@ -77,7 +77,7 @@ The movement of a finger can alter the button area behavior:
|
|||
- once a finger has moved out of the button area, it cannot move back in and
|
||||
trigger a right or middle button event
|
||||
- a finger moving within the software button area does not move the pointer
|
||||
- once a finger moves out out of the button area it will control the
|
||||
- once a finger moves out of the button area it will control the
|
||||
pointer (this only applies if there is no other finger down on the
|
||||
touchpad)
|
||||
|
||||
|
|
|
|||
|
|
@ -205,8 +205,8 @@ Tablet tool pressure range
|
|||
|
||||
The pressure range on a :ref:`Tablet tool <tablet-tools>` can be reduced
|
||||
from the full available hardware range to a subset of that range. The effect
|
||||
of this is that the tablet will not register pressure below the given
|
||||
the given threshold is met, and will reach the maximum logical pressure
|
||||
of this is that the tablet will not register pressure until the given
|
||||
threshold is met, and will reach the maximum logical pressure
|
||||
before the maximum hardware-supported pressure is reached.
|
||||
|
||||
See :ref:`tablet-pressure-range` for more info.
|
||||
|
|
|
|||
|
|
@ -144,10 +144,9 @@ This test suite can take test names etc. as arguments, have a look at
|
|||
:ref:`test-suite` for more info. There are a bunch of other tests that are
|
||||
run by the CI on merge requests, you can run those locally with ::
|
||||
|
||||
$> sudo ninja -C builddir check
|
||||
$> sudo meson test -C builddir
|
||||
|
||||
So it always pays to run that before submitting. This will also run the code
|
||||
through valgrind and pick up any memory leaks.
|
||||
So it always pays to run that before submitting.
|
||||
|
||||
.. _contributing_submitting_code:
|
||||
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ MOUSE_DPI
|
|||
|
||||
MOUSE_WHEEL_CLICK_ANGLE
|
||||
The angle in degrees for each click on a mouse wheel. See
|
||||
**libinput_pointer_get_axis_source()** for details.
|
||||
**libinput_event_pointer_get_axis_source()** for details.
|
||||
|
||||
|
||||
Below is an example udev rule to assign "seat1" to a device from vendor
|
||||
|
|
@ -94,7 +94,7 @@ type label does not guarantee that the device is initialized by libinput.
|
|||
If a device fails to meet the requirements for a device type (e.g. a keyboard
|
||||
labelled as touchpad) the device will not be available through libinput.
|
||||
|
||||
Only one device type should be set per device at a type, though libinput can
|
||||
Only one device type should be set per device at a time, though libinput can
|
||||
handle some combinations for historical reasons.
|
||||
|
||||
Below is an example udev rule to remove an **ID_INPUT_TOUCHPAD** setting
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ the serial bus (PS/2) as internal keyboards: ::
|
|||
|
||||
[Serial Keyboards]
|
||||
MatchUdevType=keyboard
|
||||
MatchBus=serial
|
||||
MatchBus=ps2
|
||||
AttrKeyboardIntegration=internal
|
||||
|
||||
|
||||
|
|
@ -130,7 +130,7 @@ Quirks starting with **Model*** triggers implementation-defined behaviour
|
|||
for this device not needed for any other device. Only the more
|
||||
general-purpose **Model*** flags are listed here.
|
||||
|
||||
ModelALPSTouchpad, ModelAppleTouchpad, ModelWacomTouchpad, ModelChromebook
|
||||
ModelALPSSerialTouchpad, ModelAppleTouchpad, ModelWacomTouchpad, ModelChromebook
|
||||
Reserved for touchpads made by the respective vendors
|
||||
ModelTouchpadVisibleMarker
|
||||
Indicates the touchpad has a drawn-on visible marker between the software
|
||||
|
|
@ -162,9 +162,9 @@ ModelScrollOnMiddleClick
|
|||
Some mice can generate unwanted high-resolution scroll events when the wheel
|
||||
is pressed. Increases the scroll threshold required to start scrolling to
|
||||
avoid accidentally scrolling when middle clicking.
|
||||
AttrSizeHint=NxM, AttrResolutionHint=N
|
||||
AttrSizeHint=NxM, AttrResolutionHint=NxM
|
||||
Hints at the width x height of the device in mm, or the resolution
|
||||
of the x/y axis in units/mm. These may only be used where they apply to
|
||||
of the x and y axes in units/mm. These may only be used where they apply to
|
||||
a large proportion of matching devices. They should not be used for any
|
||||
specific device, override ``EVDEV_ABS_*`` instead, see
|
||||
:ref:`absolute_coordinate_ranges_fix`.
|
||||
|
|
|
|||
|
|
@ -21,7 +21,7 @@ input devices (see :ref:`udev_device_type`) but that should not be used by
|
|||
libinput. It is recommended that devices that should not be handled as input
|
||||
devices at all unset the **ID_INPUT** and related properties instead. The
|
||||
**LIBINPUT_IGNORE_DEVICE** property signals that only libinput should
|
||||
ignore this property but other parts of the stack (if any) should continue
|
||||
ignore this device but other parts of the stack (if any) should continue
|
||||
treating this device normally.
|
||||
|
||||
Below is an example udev rule to assign **LIBINPUT_IGNORE_DEVICE** to the
|
||||
|
|
|
|||
|
|
@ -162,7 +162,7 @@ the value can be crafted manually:
|
|||
|
||||
.. code-block:: lua
|
||||
|
||||
evdev_type = 0x3 -- EV_REL
|
||||
evdev_type = 0x2 -- EV_REL
|
||||
evdev_code = 0x1 -- REL_Y
|
||||
evdev_usage = (evdev_type << 16) | evdev_code
|
||||
|
||||
|
|
|
|||
|
|
@ -43,7 +43,7 @@ Thus, devices "Foo" and "Bar" both reference the same struct
|
|||
The effect of seat assignment
|
||||
------------------------------------------------------------------------------
|
||||
|
||||
A logical set is interpreted as a group of devices that usually belong to a
|
||||
A logical seat is interpreted as a group of devices that usually belong to a
|
||||
single user that interacts with a computer. Thus, the devices are
|
||||
semantically related. This means for devices within the same logical seat:
|
||||
|
||||
|
|
|
|||
|
|
@ -58,7 +58,7 @@ event of type **LIBINPUT_EVENT_TABLET_TOOL_TIP**, and again when the tip
|
|||
ceases contact with the surface.
|
||||
|
||||
Tablet tools may send button events; these are exclusively for extra buttons
|
||||
unrelated to the tip. A button event is independent of the tip and can while
|
||||
unrelated to the tip. A button event is independent of the tip and can occur while
|
||||
the tip is down or up.
|
||||
|
||||
Some tablet tools' pressure detection is too sensitive, causing phantom
|
||||
|
|
@ -100,7 +100,7 @@ all pen-like tools to absolute mode.
|
|||
|
||||
If a tool in relative mode must not use pointer acceleration, callers
|
||||
should use the absolute coordinates returned by
|
||||
**libinput_event_tablet_tool_get_x()** and libinput_event_tablet_tool_get_y()
|
||||
**libinput_event_tablet_tool_get_x()** and **libinput_event_tablet_tool_get_y()**
|
||||
and calculate the delta themselves. Callers that require exact physical
|
||||
distance should also use these functions to calculate delta movements.
|
||||
|
||||
|
|
@ -357,7 +357,7 @@ tablet by 180 degrees to move the tablet pad button area to right side of
|
|||
the tablet. When left-handed mode is enabled on a tablet device (see
|
||||
**libinput_device_config_left_handed_set()**) the tablet tool and tablet pad
|
||||
behavior changes. In left-handed mode, the tools' axes are adjusted
|
||||
so that the origin of each axis remains the logical north-east of
|
||||
so that the origin of each axis remains the logical north-west of
|
||||
the physical tablet. For example, the x and y axes are inverted and the
|
||||
positive x/y coordinates are down/right of the top-left corner of the tablet
|
||||
in its current orientation. On a tablet pad, the ring and strip are
|
||||
|
|
@ -401,7 +401,7 @@ caller to decide whether the mode only applies to buttons, rings and strips
|
|||
or only to rings and strips (this is the case with the Wacom OS X and
|
||||
Windows driver).
|
||||
|
||||
The availability of modes on a touchpad usually depends on visual feedback
|
||||
The availability of modes on a tablet pad usually depends on visual feedback
|
||||
such as LEDs around the touch ring. If no visual feedback is available, only
|
||||
one mode may be available.
|
||||
|
||||
|
|
@ -509,7 +509,7 @@ tip of the tool - inverting the tool brings the eraser into proximity.
|
|||
.. figure:: tablet-eraser-invert.svg
|
||||
:align: center
|
||||
|
||||
An pen-like tool used as pen and as eraser by inverting it
|
||||
A pen-like tool used as pen and as eraser by inverting it
|
||||
|
||||
Having an eraser as a separate tool is beneficial in many applications as the
|
||||
eraser tool can be assigned different functionality (colors, paint tools, etc.)
|
||||
|
|
@ -524,7 +524,7 @@ into proximity immediately after - as if the tool was physically inverted.
|
|||
.. figure:: tablet-eraser-button.svg
|
||||
:align: center
|
||||
|
||||
An pen-like tool used as pen and as eraser by pressing the eraser button
|
||||
A pen-like tool used as pen and as eraser by pressing the eraser button
|
||||
|
||||
Microsoft mandates this behavior (see
|
||||
`Windows Pen States <https://learn.microsoft.com/en-us/windows-hardware/design/component-guidelines/windows-pen-states>`_
|
||||
|
|
@ -541,4 +541,4 @@ is disabled, pressing that button will generate a normal tablet tool button
|
|||
event.
|
||||
|
||||
This configuration is only available on pens with an eraser button, not on
|
||||
with an invert-type eraser.
|
||||
pens with an invert-type eraser.
|
||||
|
|
|
|||
|
|
@ -235,7 +235,7 @@ suites as:
|
|||
|
||||
::
|
||||
|
||||
$ meson test --no-suite=machine # only run container-friendly tests
|
||||
$ meson test --no-suite=hardware # only run container-friendly tests
|
||||
$ meson test --suite=valgrind --setup=valgrind # run all valgrind-compatible tests
|
||||
$ meson test --no-suite=root # run all tests not requiring root
|
||||
|
||||
|
|
|
|||
|
|
@ -11,7 +11,7 @@ libinput has a mechanism called a **hysteresis** to avoid that jitter. When
|
|||
active, movement within the **hysteresis margin** is discarded. If the
|
||||
movement delta is larger than the margin, the movement is passed on as
|
||||
pointer movement. This is a simplified summary, developers should
|
||||
read the implementation of the hysteresis in ``src/evdev.c``.
|
||||
read the implementation of the hysteresis in ``src/evdev.h``.
|
||||
|
||||
libinput uses the kernel ``fuzz`` value to determine the size of the
|
||||
hysteresis. Users should override this with a udev hwdb entry where the
|
||||
|
|
|
|||
|
|
@ -45,7 +45,7 @@ Both events have their own set of APIs to access the data within:
|
|||
- ``LIBINPUT_EVENT_POINTER_SCROLL_WHEEL`` available since libinput 1.19.
|
||||
|
||||
* ``libinput_event_pointer_get_scroll_value_v120()`` returns a value
|
||||
normalized into the 0..120 range, see below. Any multiple of 120 should
|
||||
normalized into multiples of 120, see below. Any multiple of 120 should
|
||||
be treated as one full wheel click.
|
||||
|
||||
.. note:: Where possible, the ``libinput_event_pointer_get_axis_value()``,
|
||||
|
|
|
|||
|
|
@ -1932,7 +1932,7 @@ libinput_event_touch_get_base_event(struct libinput_event_touch *event);
|
|||
*
|
||||
* Gesture events are generated when a gesture is recognized on a touchpad.
|
||||
*
|
||||
* Gesture sequences always start with a LIBINPUT_EVENT_GESTURE_FOO_START
|
||||
* Gesture sequences always start with a LIBINPUT_EVENT_GESTURE_FOO_BEGIN
|
||||
* event. All following gesture events will be of the
|
||||
* LIBINPUT_EVENT_GESTURE_FOO_UPDATE type until a
|
||||
* LIBINPUT_EVENT_GESTURE_FOO_END is generated which signals the end of the
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue