mirror of
https://gitlab.freedesktop.org/libinput/libinput.git
synced 2025-12-29 21:50:08 +01:00
doc: replace <a href> links with the doxygen markdown equivalent
Signed-off-by: Peter Hutterer <peter.hutterer@who-t.net>
This commit is contained in:
Peter Hutterer
parent
f4a253fb21
commit
e3a842a26d
11 changed files with 46 additions and 51 deletions
|
|
@ -109,8 +109,8 @@ The most common matrices are:
|
|||
@f$
|
||||
|
||||
See Wikipedia's
|
||||
<a href="http://en.wikipedia.org/wiki/Transformation_matrix">Transformation
|
||||
Matrix article</a> for more information on the matrix maths. See
|
||||
[Transformation Matrix article](http://en.wikipedia.org/wiki/Transformation_matrix)
|
||||
for more information on the matrix maths. See
|
||||
libinput_device_config_calibration_get_default_matrix() for how these
|
||||
matrices must be supplied to libinput.
|
||||
|
||||
|
|
|
|||
|
|
@ -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
|
||||
<a href="https://gitlab.freedesktop.org/libinput/libinput/blob/master/.gitlab-ci.yml">
|
||||
GitLab Continuous Integration file</a>. 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
|
||||
|
|
@ -160,7 +159,7 @@ $> makepkg --syncdeps --nobuild --noextract
|
|||
|
||||
If dependencies are missing, a message ```No package 'foo' found``` will be
|
||||
shown during the configure stage. See
|
||||
<a href="https://who-t.blogspot.com.au/2014/05/configure-fails-with-no-package-foo.html">this blog post here</a>.
|
||||
[this blog post here](https://who-t.blogspot.com.au/2014/05/configure-fails-with-no-package-foo.html)
|
||||
for instructions on how to fix it.
|
||||
|
||||
@subsection building_libwacom Building without libwacom
|
||||
|
|
|
|||
|
|
@ -4,13 +4,14 @@
|
|||
Clickpad is the name given to touchpads without physical buttons below the
|
||||
touchpad. Instead, the whole touchpad acts as a button and left or right
|
||||
button clicks are distinguished by the location and/or number of fingers on
|
||||
the touchpad. <a href="http://www.synaptics.com/en/clickpad.php">"ClickPad" is
|
||||
a trademark by Synaptics Inc.</a> but for simplicity we refer to any
|
||||
touchpad with the above feature as Clickpad, regardless of the manufacturer.
|
||||
the touchpad.
|
||||
("ClickPad" is a trademark by Synaptics Inc.)[http://www.synaptics.com/en/clickpad.php]
|
||||
but for simplicity we refer to any touchpad with the above feature as Clickpad,
|
||||
regardless of the manufacturer.
|
||||
|
||||
A clickpad is always marked with the <a
|
||||
href="https://www.kernel.org/doc/Documentation/input/event-codes.txt">INPUT_PROP_BUTTONPAD</a> property.
|
||||
To perform a right-click on a Clickpad, libinput provides @ref
|
||||
A clickpad is always marked with the
|
||||
[INPUT_PROP_BUTTONPAD](https://www.kernel.org/doc/Documentation/input/event-codes.txt)
|
||||
property. To perform a right-click on a Clickpad, libinput provides @ref
|
||||
software_buttons and @ref clickfinger.
|
||||
|
||||
In the page below, the term "click" shall refer to a physical button press
|
||||
|
|
|
|||
|
|
@ -148,9 +148,9 @@ is guaranteed.
|
|||
|
||||
@section hwdb Configuring the hwdb
|
||||
|
||||
This section outlines how to query the <a
|
||||
href="https://www.freedesktop.org/software/systemd/man/hwdb.html">udev
|
||||
hwdb</a> and reload properties so they are available to libinput.
|
||||
This section outlines how to query the
|
||||
[udev hwdb](https://www.freedesktop.org/software/systemd/man/hwdb.html)
|
||||
and reload properties so they are available to libinput.
|
||||
|
||||
The hwdb contains a set of match rules that assign udev properties that are
|
||||
available to libinput when the device is connected and/or libinput is
|
||||
|
|
|
|||
29
doc/faqs.dox
29
doc/faqs.dox
|
|
@ -96,7 +96,7 @@ desktop environment's configuration storage (e.g. gsettings).
|
|||
|
||||
See @ref faq_config_options If your desktop environment does not provide a
|
||||
graphical configuration tool you can use an
|
||||
<a href="https://www.x.org/archive/current/doc/man/man5/xorg.conf.5.xhtml">xorg.conf.d snippet</a>.
|
||||
[xorg.conf.d snippet](https://www.x.org/archive/current/doc/man/man5/xorg.conf.5.xhtml).
|
||||
Usually, such a snippet looks like this:
|
||||
@verbatim
|
||||
$> cat /etc/X11/xorg.conf.d/99-libinput-custom-config.conf
|
||||
|
|
@ -112,15 +112,15 @@ The identifier is merely a human-readable string that shows up in the log
|
|||
file. The MatchProduct line should contain the device name or a substring of
|
||||
the device name that the snippet should apply to. For a full list of option
|
||||
names and permitted values, see the
|
||||
<a href="https://www.mankier.com/4/libinput">libinput man page</a>.
|
||||
[libinput man page](https://www.mankier.com/4/libinput).
|
||||
xorg.conf.d snippets like the above apply to hotplugged devices but can be
|
||||
overwritten at runtime by desktop tools. Multiple snippets may be placed
|
||||
into the same file.
|
||||
|
||||
For run-time configuration and testing, the
|
||||
<a href="https://www.x.org/archive/X11R7.5/doc/man/man1/xinput.1.html">xinput</a>
|
||||
[xinput](https://www.x.org/archive/X11R7.5/doc/man/man1/xinput.1.html)
|
||||
debugging tool can modify a devices' properties. See the
|
||||
<a href="https://www.mankier.com/4/libinput">libinput man page</a>
|
||||
[libinput man page](https://www.mankier.com/4/libinput)
|
||||
for supported property names and values. Usually, an invocation looks like
|
||||
this:
|
||||
@verbatim
|
||||
|
|
@ -134,10 +134,9 @@ permanent configurations.
|
|||
|
||||
@section faq_configuration Can you add a configuration option for $FEATURE?
|
||||
|
||||
No. At least that's going to be the initial answer. Read <a
|
||||
href="http://who-t.blogspot.com/2016/04/why-libinput-doesnt-have-lot-of-config.html">Why
|
||||
libinput doesn't have a lot of configuration options</a> first.
|
||||
Configuration options for most features are a signal that we are incapable
|
||||
No. At least that's going to be the initial answer. Read
|
||||
[Why libinput doesn't have a lot of configuration options](http://who-t.blogspot.com/2016/04/why-libinput-doesnt-have-lot-of-config.html)
|
||||
first. Configuration options for most features are a signal that we are incapable
|
||||
of handling it correctly. To get to that point, we want to be sure we're
|
||||
truly incapable of doing so. libinput has several features that
|
||||
are handled automatically (and correctly) that users wanted to have
|
||||
|
|
@ -162,12 +161,8 @@ disable-while-typing. synclient is merely a configuration tool, see
|
|||
@ref faq_configure_xorg for similar functionality.
|
||||
|
||||
See also the blog posts
|
||||
<a
|
||||
href="http://who-t.blogspot.com.au/2017/01/the-definitive-guide-to-synclient.html">The
|
||||
definitive guide to synclient</a> and
|
||||
<a href="http://who-t.blogspot.com.au/2016/12/the-future-of-xinput-xmodmap-setxkbmap.html">
|
||||
The future of xinput, xmodmap, setxkbmap, xsetwacom and other tools under
|
||||
Wayland</a>
|
||||
[The definitive guide to synclient](http://who-t.blogspot.com.au/2017/01/the-definitive-guide-to-synclient.html) and
|
||||
[The future of xinput, xmodmap, setxkbmap, xsetwacom and other tools under Wayland](http://who-t.blogspot.com.au/2016/12/the-future-of-xinput-xmodmap-setxkbmap.html)
|
||||
|
||||
@section faq_tablets Does libinput support non-Wacom tablets?
|
||||
|
||||
|
|
@ -194,9 +189,9 @@ See @ref tablet-capabilities for more details.
|
|||
|
||||
@section faq_hwdb_changes How to apply hwdb changes
|
||||
|
||||
Sometimes users are asked to test updates to the <a
|
||||
href="https://www.freedesktop.org/software/systemd/man/hwdb.html">udev
|
||||
hwdb</a> or patches that include a change to the hwdb. See @ref hwdb for
|
||||
Sometimes users are asked to test updates to the
|
||||
[udev hwdb](https://www.freedesktop.org/software/systemd/man/hwdb.html)
|
||||
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
|
||||
|
|
|
|||
|
|
@ -46,10 +46,10 @@ See @ref tablet-relative-motion
|
|||
|
||||
Devices usually do not advertise their resolution and libinput relies on
|
||||
the udev property <b>MOUSE_DPI</b> for this information. This property is usually
|
||||
set via the <a
|
||||
href="http://cgit.freedesktop.org/systemd/systemd/tree/hwdb/70-mouse.hwdb">udev hwdb</a>.
|
||||
The "mouse-dpi-tool" utility provided by <a
|
||||
href="https://freedesktop.org/wiki/Software/libevdev/">libevdev</a> should be
|
||||
set via the
|
||||
[udev hwdb](http://cgit.freedesktop.org/systemd/systemd/tree/hwdb/70-mouse.hwdb).
|
||||
The "mouse-dpi-tool" utility provided by
|
||||
[libevdev](https://freedesktop.org/wiki/Software/libevdev/) should be
|
||||
used to measure a device's resolution.
|
||||
|
||||
The format of the property for single-resolution mice is:
|
||||
|
|
|
|||
|
|
@ -93,8 +93,8 @@ will generate a button event for this touch.
|
|||
|
||||
@section trackpoint-disabling Palm detection during trackpoint use
|
||||
|
||||
If a device provides a <a
|
||||
href="http://en.wikipedia.org/wiki/Pointing_stick">trackpoint</a>, it is
|
||||
If a device provides a
|
||||
[trackpoint](http://en.wikipedia.org/wiki/Pointing_stick), it is
|
||||
usually located above the touchpad. This increases the likelihood of
|
||||
accidental touches whenever the trackpoint is used.
|
||||
|
||||
|
|
|
|||
|
|
@ -182,7 +182,7 @@ E: USEC_INITIALIZED=5463031
|
|||
@note Where available, the @ref libinput-record tools should be used instead
|
||||
of evemu
|
||||
|
||||
<a href="https://www.freedesktop.org/wiki/Evemu/">evemu</a> records the
|
||||
[evemu](https://www.freedesktop.org/wiki/Evemu/) records the
|
||||
device capabilities together with the event stream from the kernel. On our
|
||||
side, this allows us to recreate a virtual device identical to your device
|
||||
and re-play the event sequence, hopefully triggering the same bug.
|
||||
|
|
|
|||
|
|
@ -69,7 +69,7 @@ a clickpad ends scrolling.
|
|||
|
||||
On-button scrolling converts the motion of a device into scroll events while
|
||||
a designated button is held down. For example, Lenovo devices provide a
|
||||
<a href="http://en.wikipedia.org/wiki/Pointing_stick">pointing stick</a> that emulates
|
||||
[pointing stick](http://en.wikipedia.org/wiki/Pointing_stick) that emulates
|
||||
scroll events when the trackstick's middle mouse button is held down.
|
||||
|
||||
@note On-button scrolling is enabled by default for pointing sticks. This
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ touchpads.
|
|||
|
||||
The Lenovo *40 series introduced a new type of touchpad. Previously, all
|
||||
laptops had a separate set of physical buttons for the
|
||||
<a href="http://en.wikipedia.org/wiki/Pointing_stick">trackstick</a>. This
|
||||
[trackstick](http://en.wikipedia.org/wiki/Pointing_stick). This
|
||||
series removed these buttons, relying on a software emulation of the top
|
||||
section of the touchpad. This is visually marked on the trackpad itself,
|
||||
and clicks can be triggered by pressing the touchpad down with a finger in
|
||||
|
|
@ -19,8 +19,8 @@ the respective area:
|
|||
This page only covers the top software buttons, the bottom button behavior
|
||||
is covered in @ref clickpad_softbuttons "Clickpad software buttons".
|
||||
|
||||
Clickpads with a top button area are marked with the <a
|
||||
href="https://www.kernel.org/doc/Documentation/input/event-codes.txt">INPUT_PROP_TOPBUTTONPAD</a>
|
||||
Clickpads with a top button area are marked with the
|
||||
[INPUT_PROP_TOPBUTTONPAD](https://www.kernel.org/doc/Documentation/input/event-codes.txt)
|
||||
property.
|
||||
|
||||
@section t440_support_btn_size Size of the buttons
|
||||
|
|
@ -89,16 +89,17 @@ this area to take effect.
|
|||
|
||||
The firmware on the first generation of touchpads providing top software
|
||||
buttons is buggy and announces wrong ranges.
|
||||
<a href="https://lkml.org/lkml/2014/3/7/722">Kernel patches</a> are required;
|
||||
[Kernel patches](https://lkml.org/lkml/2014/3/7/722) are required;
|
||||
these fixes are available in kernels 3.14.1, 3.15 and later but each
|
||||
touchpad needs a separate fix.
|
||||
|
||||
The October 2014 refresh of these laptops do not have this firmware bug
|
||||
anymore and should work without per-device patches, though
|
||||
<a href="http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=02e07492cdfae9c86e3bd21c0beec88dbcc1e9e8">this kernel commit</a> is required.
|
||||
[this kernel commit](http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/commit/?id=02e07492cdfae9c86e3bd21c0beec88dbcc1e9e8)
|
||||
is required.
|
||||
|
||||
For a complete list of supported touchpads check <a
|
||||
href="http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/drivers/input/mouse/synaptics.c">the
|
||||
kernel source</a> (search for "topbuttonpad_pnp_ids").
|
||||
For a complete list of supported touchpads check
|
||||
[the kernel source](http://git.kernel.org/cgit/linux/kernel/git/torvalds/linux.git/tree/drivers/input/mouse/synaptics.c)
|
||||
(search for "topbuttonpad_pnp_ids").
|
||||
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -162,8 +162,7 @@ This section only applied to libinput version 1.9.x, 1.10.x, and 1.11.x and
|
|||
has been removed. See @ref trackpoint_multiplier for versions 1.12.x and later.
|
||||
|
||||
If using libinput version 1.11.x or earlier, please see
|
||||
<a href="https://wayland.freedesktop.org/libinput/doc/1.11.0/trackpoints.html#trackpoint_range_measure">
|
||||
the 1.11.0 documentation</a>
|
||||
[the 1.11.0 documentation](https://wayland.freedesktop.org/libinput/doc/1.11.0/trackpoints.html#trackpoint_range_measure)
|
||||
|
||||
*/
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue