diff options
Diffstat (limited to 'nixos/modules/services/x11/hardware/libinput.nix')
| -rw-r--r-- | nixos/modules/services/x11/hardware/libinput.nix | 58 |
1 files changed, 29 insertions, 29 deletions
diff --git a/nixos/modules/services/x11/hardware/libinput.nix b/nixos/modules/services/x11/hardware/libinput.nix index efdb7c61dfa..6603498eeaf 100644 --- a/nixos/modules/services/x11/hardware/libinput.nix +++ b/nixos/modules/services/x11/hardware/libinput.nix @@ -12,8 +12,8 @@ let cfg = config.services.xserver.libinput; default = null; example = "/dev/input/event0"; description = - '' - Path for ${deviceType} device. Set to <literal>null</literal> to apply to any + lib.mdDoc '' + Path for ${deviceType} device. Set to `null` to apply to any auto-detected ${deviceType}. ''; }; @@ -23,14 +23,14 @@ let cfg = config.services.xserver.libinput; default = "adaptive"; example = "flat"; description = - '' + lib.mdDoc '' Sets the pointer acceleration profile to the given profile. - Permitted values are <literal>adaptive</literal>, <literal>flat</literal>. + Permitted values are `adaptive`, `flat`. Not all devices support this option or all profiles. If a profile is unsupported, the default profile for this is used. - <literal>flat</literal>: Pointer motion is accelerated by a constant + `flat`: Pointer motion is accelerated by a constant (device-specific) factor, depending on the current speed. - <literal>adaptive</literal>: Pointer acceleration depends on the input speed. + `adaptive`: Pointer acceleration depends on the input speed. This is the default profile for most devices. ''; }; @@ -39,7 +39,7 @@ let cfg = config.services.xserver.libinput; type = types.nullOr types.str; default = null; example = "-0.5"; - description = "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; + description = lib.mdDoc "Cursor acceleration (how fast speed increases from minSpeed to maxSpeed)."; }; buttonMapping = mkOption { @@ -47,7 +47,7 @@ let cfg = config.services.xserver.libinput; default = null; example = "1 6 3 4 5 0 7"; description = - '' + lib.mdDoc '' Sets the logical button mapping for this device, see XSetPointerMapping(3). The string must be a space-separated list of button mappings in the order of the logical buttons on the device, starting with button 1. The default mapping is "1 2 3 ... 32". A mapping of 0 deac‐ @@ -62,7 +62,7 @@ let cfg = config.services.xserver.libinput; default = null; example = "0.5 0 0 0 0.8 0.1 0 0 1"; description = - '' + lib.mdDoc '' A string of 9 space-separated floating point numbers. Sets the calibration matrix to the 3x3 matrix where the first row is (abc), the second row is (def) and the third row is (ghi). ''; @@ -73,9 +73,9 @@ let cfg = config.services.xserver.libinput; default = null; example = "buttonareas"; description = - '' - Enables a click method. Permitted values are <literal>none</literal>, - <literal>buttonareas</literal>, <literal>clickfinger</literal>. + lib.mdDoc '' + Enables a click method. Permitted values are `none`, + `buttonareas`, `clickfinger`. Not all devices support all methods, if an option is unsupported, the default click method for this device is used. ''; @@ -84,14 +84,14 @@ let cfg = config.services.xserver.libinput; leftHanded = mkOption { type = types.bool; default = false; - description = "Enables left-handed button orientation, i.e. swapping left and right buttons."; + description = lib.mdDoc "Enables left-handed button orientation, i.e. swapping left and right buttons."; }; middleEmulation = mkOption { type = types.bool; default = true; description = - '' + lib.mdDoc '' Enables middle button emulation. When enabled, pressing the left and right buttons simultaneously produces a middle mouse button click. ''; @@ -100,7 +100,7 @@ let cfg = config.services.xserver.libinput; naturalScrolling = mkOption { type = types.bool; default = false; - description = "Enables or disables natural scrolling behavior."; + description = lib.mdDoc "Enables or disables natural scrolling behavior."; }; scrollButton = mkOption { @@ -108,7 +108,7 @@ let cfg = config.services.xserver.libinput; default = null; example = 1; description = - '' + lib.mdDoc '' Designates a button as scroll button. If the ScrollMethod is button and the button is logically held down, x/y axis movement is converted into scroll events. ''; @@ -119,9 +119,9 @@ let cfg = config.services.xserver.libinput; default = "twofinger"; example = "edge"; description = - '' - Specify the scrolling method: <literal>twofinger</literal>, <literal>edge</literal>, - <literal>button</literal>, or <literal>none</literal> + lib.mdDoc '' + Specify the scrolling method: `twofinger`, `edge`, + `button`, or `none` ''; }; @@ -129,7 +129,7 @@ let cfg = config.services.xserver.libinput; type = types.bool; default = true; description = - '' + lib.mdDoc '' Disables horizontal scrolling. When disabled, this driver will discard any horizontal scroll events from libinput. Note that this does not disable horizontal scrolling, it merely discards the horizontal axis from any scroll events. @@ -141,9 +141,9 @@ let cfg = config.services.xserver.libinput; default = "enabled"; example = "disabled"; description = - '' - Sets the send events mode to <literal>disabled</literal>, <literal>enabled</literal>, - or <literal>disabled-on-external-mouse</literal> + lib.mdDoc '' + Sets the send events mode to `disabled`, `enabled`, + or `disabled-on-external-mouse` ''; }; @@ -151,7 +151,7 @@ let cfg = config.services.xserver.libinput; type = types.bool; default = true; description = - '' + lib.mdDoc '' Enables or disables tap-to-click behavior. ''; }; @@ -160,7 +160,7 @@ let cfg = config.services.xserver.libinput; type = types.bool; default = true; description = - '' + lib.mdDoc '' Enables or disables drag lock during tapping behavior. When enabled, a finger up during tap- and-drag will not immediately release the button. If the finger is set down again within the timeout, the draging process continues. @@ -171,7 +171,7 @@ let cfg = config.services.xserver.libinput; type = types.nullOr types.str; default = null; example = "0.5 0 0 0 0.8 0.1 0 0 1"; - description = '' + description = lib.mdDoc '' A string of 9 space-separated floating point numbers. Sets the transformation matrix to the 3x3 matrix where the first row is (abc), the second row is (def) and the third row is (ghi). ''; @@ -181,7 +181,7 @@ let cfg = config.services.xserver.libinput; type = types.bool; default = false; description = - '' + lib.mdDoc '' Disable input method while typing. ''; }; @@ -193,9 +193,9 @@ let cfg = config.services.xserver.libinput; '' Option "DragLockButtons" "L1 B1 L2 B2" ''; - description = '' + description = lib.mdDoc '' Additional options for libinput ${deviceType} driver. See - <citerefentry><refentrytitle>libinput</refentrytitle><manvolnum>4</manvolnum></citerefentry> + {manpage}`libinput(4)` for available options."; ''; }; |