Skip to content

Libinput

services.libinput.enable

Whether to enable libinput. Type: boolean

Default

config.services.xserver.enable

Example

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.accelProfile

Sets the pointer acceleration profile to the given profile. 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. flat: Pointer motion is accelerated by a constant (device-specific) factor, depending on the current speed. adaptive: Pointer acceleration depends on the input speed. This is the default profile for most devices.

Type: one of "flat", "adaptive"

Default

"adaptive"

Example

"flat"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.accelSpeed

Cursor acceleration (how fast speed increases from minSpeed to maxSpeed). Type: null or string

Default

null

Example

"-0.5"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.additionalOptions

Additional options for libinput mouse driver. See {manpage}libinput(4) for available options.";

Type: strings concatenated with "\n"

Default

""

Example

'' Option "DragLockButtons" "L1 B1 L2 B2"''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.buttonMapping

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‐ tivates the button. Multiple buttons can have the same mapping. Invalid mapping strings are discarded and the default mapping is used for all buttons. Buttons not specified in the user's mapping use the default mapping. See section BUTTON MAPPING for more details.

Type: null or string

Default

null

Example

"1 6 3 4 5 0 7"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.calibrationMatrix

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).

Type: null or string

Default

null

Example

"0.5 0 0 0 0.8 0.1 0 0 1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.clickMethod

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.

Type: null or one of "none", "buttonareas", "clickfinger"

Default

null

Example

"buttonareas"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.dev

Path for mouse device. Set to null to apply to any auto-detected mouse.

Type: null or string

Default

null

Example

"/dev/input/event0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.disableWhileTyping

Disable input method while typing.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.horizontalScrolling

Enables or disables horizontal scrolling. When disabled, this driver will discard any horizontal scroll events from libinput. This does not disable horizontal scroll events from libinput; it merely discards the horizontal axis from any scroll events.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.leftHanded

Enables left-handed button orientation, i.e. swapping left and right buttons. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.middleEmulation

Enables middle button emulation. When enabled, pressing the left and right buttons simultaneously produces a middle mouse button click.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.naturalScrolling

Enables or disables natural scrolling behavior. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.scrollButton

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.

Type: null or signed integer

Default

null

Example

1

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.scrollMethod

Specify the scrolling method: twofinger, edge, button, or none

Type: one of "twofinger", "edge", "button", "none"

Default

"twofinger"

Example

"edge"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.sendEventsMode

Sets the send events mode to disabled, enabled, or disabled-on-external-mouse

Type: one of "disabled", "enabled", "disabled-on-external-mouse"

Default

"enabled"

Example

"disabled"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.tapping

Enables or disables tap-to-click behavior.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.tappingButtonMap

Set the button mapping for 1/2/3-finger taps to left/right/middle or left/middle/right, respectively.

Type: null or one of "lrm", "lmr"

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.tappingDragLock

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 dragging process continues.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.mouse.transformationMatrix

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).

Type: null or string

Default

null

Example

"0.5 0 0 0 0.8 0.1 0 0 1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.accelProfile

Sets the pointer acceleration profile to the given profile. 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. flat: Pointer motion is accelerated by a constant (device-specific) factor, depending on the current speed. adaptive: Pointer acceleration depends on the input speed. This is the default profile for most devices.

Type: one of "flat", "adaptive"

Default

"adaptive"

Example

"flat"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.accelSpeed

Cursor acceleration (how fast speed increases from minSpeed to maxSpeed). Type: null or string

Default

null

Example

"-0.5"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.additionalOptions

Additional options for libinput touchpad driver. See {manpage}libinput(4) for available options.";

Type: strings concatenated with "\n"

Default

""

Example

'' Option "DragLockButtons" "L1 B1 L2 B2"''

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.buttonMapping

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‐ tivates the button. Multiple buttons can have the same mapping. Invalid mapping strings are discarded and the default mapping is used for all buttons. Buttons not specified in the user's mapping use the default mapping. See section BUTTON MAPPING for more details.

Type: null or string

Default

null

Example

"1 6 3 4 5 0 7"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.calibrationMatrix

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).

Type: null or string

Default

null

Example

"0.5 0 0 0 0.8 0.1 0 0 1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.clickMethod

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.

Type: null or one of "none", "buttonareas", "clickfinger"

Default

null

Example

"buttonareas"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.dev

Path for touchpad device. Set to null to apply to any auto-detected touchpad.

Type: null or string

Default

null

Example

"/dev/input/event0"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.disableWhileTyping

Disable input method while typing.

Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.horizontalScrolling

Enables or disables horizontal scrolling. When disabled, this driver will discard any horizontal scroll events from libinput. This does not disable horizontal scroll events from libinput; it merely discards the horizontal axis from any scroll events.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.leftHanded

Enables left-handed button orientation, i.e. swapping left and right buttons. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.middleEmulation

Enables middle button emulation. When enabled, pressing the left and right buttons simultaneously produces a middle mouse button click.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.naturalScrolling

Enables or disables natural scrolling behavior. Type: boolean

Default

false

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.scrollButton

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.

Type: null or signed integer

Default

null

Example

1

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.scrollMethod

Specify the scrolling method: twofinger, edge, button, or none

Type: one of "twofinger", "edge", "button", "none"

Default

"twofinger"

Example

"edge"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.sendEventsMode

Sets the send events mode to disabled, enabled, or disabled-on-external-mouse

Type: one of "disabled", "enabled", "disabled-on-external-mouse"

Default

"enabled"

Example

"disabled"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.tapping

Enables or disables tap-to-click behavior.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.tappingButtonMap

Set the button mapping for 1/2/3-finger taps to left/right/middle or left/middle/right, respectively.

Type: null or one of "lrm", "lmr"

Default

null

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.tappingDragLock

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 dragging process continues.

Type: boolean

Default

true

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix

services.libinput.touchpad.transformationMatrix

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).

Type: null or string

Default

null

Example

"0.5 0 0 0 0.8 0.1 0 0 1"

Declared by: https://github.com/nixos/nixpkgs/blob/master/nixos/modules/services/hardware/libinput.nix