LinuxCommandLibrary

synclient

Configure Synaptics touchpad parameters

SYNOPSIS

synclient [options] [parameter=value ...]
synclient [parameter]

PARAMETERS

-l or --list
    Lists all current parameter values set for the Synaptics TouchPad driver. This provides an overview of the active configuration.

-V or --version
    Prints the version number of the synclient utility.

-h or --help
    Displays a brief help message, outlining the command's usage and available options.

parameter
    When used without an assigned value, this queries and displays the current value of the specified touchpad parameter.

parameter=value
    Sets the specified touchpad parameter to the given new value. Multiple parameters can be set simultaneously on a single command line by separating them with spaces.

DESCRIPTION

synclient is a command-line utility used to query, modify, and display the current settings of the Synaptics TouchPad driver. It provides a granular level of control over various aspects of a touchpad's behavior, such as enabling/disabling tapping, adjusting scroll speeds, configuring palm detection, and setting edge motion. This tool directly interacts with the X server's input device properties. While primarily designed for the xf86-input-synaptics driver, many of its parameters still offer analogous functionality or are emulated when libinput is in use, making it relevant for fine-tuning touchpad behavior in Xorg environments. It is especially useful for scripting touchpad configurations or for users requiring control beyond graphical settings.

CAVEATS

synclient primarily functions within Xorg environments and is less relevant for Wayland. Changes made with synclient are typically temporary and are lost upon reboot or X server restart. Persistent configuration requires settings to be placed in Xorg configuration files (e.g., /etc/X11/xorg.conf.d/) or startup scripts. Its effectiveness depends on the xf86-input-synaptics driver being loaded, or libinput providing Synaptics emulation.

PERSISTENT CONFIGURATION

To make synclient settings permanent across reboots, they must be saved in Xorg configuration files. Typically, this involves creating or modifying a file in /etc/X11/xorg.conf.d/ (e.g., 50-synaptics.conf) and adding an 'InputClass' section with 'Option' lines for desired parameters.

COMMONLY ADJUSTED PARAMETERS

Users frequently adjust parameters such as TapButton1, TapButton2, TapButton3 (for defining tap-to-click behavior for left, middle, right clicks), VertScrollDelta and HorizScrollDelta (to control scrolling speed), PalmDetect (to prevent accidental touches from palms), and ClickPad (for integrated button touchpads).

HISTORY

synclient emerged as a dedicated command-line tool alongside the development of the xf86-input-synaptics driver for Linux. It quickly became the go-to utility for users needing to deeply customize their Synaptics touchpads within Xorg. While its prominence has somewhat shifted with the rise of libinput and Wayland, it remains a valuable tool for many existing Xorg setups and specific configuration needs, reflecting its long-standing role in Linux input device management.

SEE ALSO

xinput(1), xorg.conf(5), libinput(4), xf86-input-synaptics(4)

Copied to clipboard