hyprwm/hyprland-wiki
1
0
Fork 0
mirror of https://github.com/hyprwm/hyprland-wiki.git synced 2024-12-23 01:59:49 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add libinput links and reword some settings (#47)

Browse source
This commit is contained in:
Fabian Preuß 2022-11-09 15:05:50 +01:00 committed by GitHub
parent 649ad27ef4
commit 703305c5be
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 45 additions and 39 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

84
pages/Configuring/Variables.md
View file

@ -43,7 +43,7 @@ SHIFT CAPS CTRL/CONTROL ALT MOD2 MOD3 SUPER/WIN/LOGO/MOD4 MOD5
## General ## General
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| sensitivity | mouse sensitivity (legacy, may cause bugs if not 1, prefer `input:sensitivity`) | float | 1.0 | | sensitivity | mouse sensitivity (legacy, may cause bugs if not 1, prefer `input:sensitivity`) | float | 1.0 |
| border_size | self-explanatory | int | 1 | | border_size | self-explanatory | int | 1 |
| no_border_on_floating | disable borders for floating windows | bool | false | | no_border_on_floating | disable borders for floating windows | bool | false |
@ -63,7 +63,7 @@ Prefer using `input:sensitivity` over `general:sensitivity` to avoid bugs, espec
## Decoration ## Decoration
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| rounding | rounded corners' radius (in layout px) | int | 0 | | rounding | rounded corners' radius (in layout px) | int | 0 |
| multisample_edges | enable antialiasing (no-jaggies) for rounded corners | bool | true | | multisample_edges | enable antialiasing (no-jaggies) for rounded corners | bool | true |
| active_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 | | active_opacity | self-explanatory, only for windows. (0.0 - 1.0) | float | 1.0 |
@ -105,7 +105,7 @@ Using `blur_new_optimizations` with an animated wallpaper may actually increase
# Animations # Animations
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| enabled | enable animations | bool | true | | enabled | enable animations | bool | true |
| use_resize_transitions | enable fade transitions for resize animations | bool | false | | use_resize_transitions | enable fade transitions for resize animations | bool | false |
@ -120,53 +120,59 @@ _[More about Animations](../Animations)._
## Input ## Input
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| kb_model | Appropriate XKB keymap parameter. See the note below. | str | \[EMPTY\] |
| kb_layout | Appropriate XKB keymap parameter | str | us | | kb_layout | Appropriate XKB keymap parameter | str | us |
| kb_variant | Appropriate XKB keymap parameter | str | \[EMPTY\] | | kb_variant | Appropriate XKB keymap parameter | str | \[EMPTY\] |
| kb_model | Appropriate XKB keymap parameter | str | \[EMPTY\] |
| kb_options | Appropriate XKB keymap parameter | str | \[EMPTY\] | | kb_options | Appropriate XKB keymap parameter | str | \[EMPTY\] |
| kb_rules | Appropriate XKB keymap parameter | str | \[EMPTY\] | | kb_rules | Appropriate XKB keymap parameter | str | \[EMPTY\] |
| kb_file | If you prefer, you can use a path to an .xkb file. | str | \[EMPTY\] | | kb_file | If you prefer, you can use a path to your custom .xkb file. | str | \[EMPTY\] |
| follow_mouse | (0/1/2/3) enable mouse following (focus on enter new window) - See the note below for more info | int | 1 | | numlock_by_default | Engage numlock by default. | bool | false |
| float_switch_override_focus | if enabled (1 or 2), focus will follow mouse if changing from tiled to floating and vice versa. 2 will also follow mouse on float -> float switches | int | 1 | | repeat_rate | The repeat rate for held-down keys, in repeats per second. | int | 25 |
| repeat_rate | in repeats per second, the repeat rate for held keys | int | 25 | | repeat_delay | Delay before a held-down key is repeated, in milliseconds. | int | 600 |
| repeat_delay | in ms, the repeat delay (grace period) before the spam | int | 600 | | sensitivity | Sets the mouse input sensitivity. Value will be clamped to the range -1.0 to 1.0. [libinput#pointer-acceleration](https://wayland.freedesktop.org/libinput/doc/latest/pointer-acceleration.html#pointer-acceleration) | float | 0.0 |
| natural_scroll | enable natural scroll | bool | false | | accel_profile | Sets the cursor acceleration profile. Can be one of `adaptive`, `flat`. Leave empty to use `libinput`'s default mode for your input device. [libinput#pointer-acceleration](https://wayland.freedesktop.org/libinput/doc/latest/pointer-acceleration.html#pointer-acceleration) | str | \[EMPTY\]
| numlock_by_default | lock numlock by default | bool | false | | force_no_accel | Force no cursor acceleration. This bypasses most of your pointer settings to get as raw of a signal as possible. **Enabling this is not recommended due to potential cursor desynchronization.** | bool | false |
| force_no_accel | force no mouse acceleration, bypasses most of your pointer settings to get as raw of a signal as possible. | bool | false | | left_handed | Switches RMB and LMB | bool | false |
| sensitivity | set the libinput sensitivity. This **HAS** to be from -1 to 1, or else it will be clamped. | float | 0.0 | | scroll_method | Sets the scroll method. Can be one of `2fg` (2 fingers), `edge`, `on_button_down`, `no_scroll`. [libinput#scrolling](https://wayland.freedesktop.org/libinput/doc/latest/scrolling.html) | str | \[EMPTY\]
| left_handed | switches RMB and LMB | bool | false | | natural_scroll | Inverts scrolling direction. When enabled, scrolling moves content directly instead of manipulating a scrollbar. | bool | false |
| accel_profile | set the libinput acceleration profile. Can be one of `adaptive`, `flat`. | str | \[EMPTY\] | follow_mouse | (0/1/2/3) Specify if and how cursor movement should affect window focus. See the note below. | int | 1 |
| scroll_method | set the libinput scroll method. Can be one of `2fg` (2 fingers), `edge`, `on_button_down`, `no_scroll`. | str | \[EMPTY\] | float_switch_override_focus | If enabled (1 or 2), focus will change to the window under the cursor when changing from tiled-to-floating and vice versa. If 2, focus will also follow mouse on float-to-float switches. | int | 1 |
{{< hint type=info >}} {{< hint type=info >}}
## XKB Settings
## Follow Mouse You can find a list of models, layouts, variants and options in [`/usr/share/X11/xkb/rules/base.lst`](file:///usr/share/X11/xkb/rules/base.lst).
Alternatively, you can use the `localectl` command to discover what is available on your system.
For switchable keyboard configurations, take a look at [the uncommon tips & tricks page entry](../Uncommon-tips--tricks/#switchable-keyboard-layouts).
{{< /hint >}}
{{< hint type=info >}}
## Follow Mouse Cursor
- 0 - Cursor movement will not change focus.
- 1 - Cursor movement will always change focus to the window under the cursor.
- 2 - Cursor focus will be detached from keyboard focus. Clicking on a window will move keyboard focus to that window.
- 3 - Cursor focus will be completely separate from keyboard focus. Clicking on a window will not change keyboard focus.
- 0 - disabled
- 1 - full
- 2 - loose. Will focus mouse on other windows on focus but not the keyboard.
- 3 - full loose, will not refocus on click, but allow mouse focus to be
detached from the keyboard like in 2.
{{< /hint >}} {{< /hint >}}
{{< hint type=info >}}
For switchable keyboard configs, take a look at [the uncommon tips & tricks page entry](../Uncommon-tips--tricks/#switchable-keyboard-layouts).
{{< /hint >}}
## Touchpad ## Touchpad
_Subcategory `input:touchpad:`_ _Subcategory `input:touchpad:`_
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| disable_while_typing | disables the touchpad while typing | bool | true | | disable_while_typing | Disable the touchpad while typing. | bool | true |
| natural_scroll | self-explanatory | bool | false | | natural_scroll | Inverts scrolling direction. When enabled, scrolling moves content directly instead of manipulating a scrollbar. | bool | false |
| clickfinger_behavior | self-explanatory | bool | false | | scroll_factor | Multiplier applied to the amount of scroll movement. | float | 1.0
| middle_button_emulation | self-explanatory | bool | false | | middle_button_emulation | Sending LMB and RMB simultaneously will be interpreted as a middle click. This disables any touchpad area that would normally send a middle click based on location. [libinput#middle-button-emulation](https://wayland.freedesktop.org/libinput/doc/latest/middle-button-emulation.html) | bool | false |
| tap-to-click | self-explanatory | bool | true | | clickfinger_behavior | Button presses with 1, 2, or 3 fingers will be mapped to LMB, RMB, and MMB respectively. This disables interpretation of clicks based on location on the touchpad. [libinput#clickfinger-behavior](https://wayland.freedesktop.org/libinput/doc/latest/clickpad-softbuttons.html#clickfinger-behavior) | bool | false |
| drag_lock | enable dragging with drag lock | bool | false | | tap-to-click | Tapping on the touchpad with 1, 2, or 3 fingers will send LMB, RMB, and MMB respectively. | bool | true |
| scroll_factor | control the amount of scroll applied | float | 1.0 | drag_lock | When enabled, lifting the finger off for a short time while dragging will not drop the dragged item. [libinput#tap-and-drag](https://wayland.freedesktop.org/libinput/doc/latest/tapping.html#tap-and-drag) | bool | false |
{{< hint type=important >}} {{< hint type=important >}}
A subcategory is a nested category: A subcategory is a nested category:
@ -191,7 +197,7 @@ Doing `input:touchpad {` is **invalid**!
_Subcategory `input:touchdevice:`_ _Subcategory `input:touchdevice:`_
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| transform | transform the input from touchdevices. The possible transformations are the same as [those of the monitors](../Monitors/#rotating-and-the-default-workspace) | int | 0 | | transform | transform the input from touchdevices. The possible transformations are the same as [those of the monitors](../Monitors/#rotating-and-the-default-workspace) | int | 0 |
| output | the output to bind touch devices. Empty means unset and will use the current / autodetected. | string | \[EMPTY\] | | output | the output to bind touch devices. Empty means unset and will use the current / autodetected. | string | \[EMPTY\] |
@ -202,7 +208,7 @@ Described [here](../Keywords#per-device-input-configs).
# Gestures # Gestures
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| workspace_swipe | enable workspace swipe gesture | bool | false | | workspace_swipe | enable workspace swipe gesture | bool | false |
| workspace_swipe_fingers | how many fingers for the gesture | int | 3 | | workspace_swipe_fingers | how many fingers for the gesture | int | 3 |
| workspace_swipe_distance | in px, the distance of the gesture | int | 300 | | workspace_swipe_distance | in px, the distance of the gesture | int | 300 |
@ -215,7 +221,7 @@ Described [here](../Keywords#per-device-input-configs).
# Misc # Misc
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| disable_hyprland_logo | disables the hyprland logo background. :( | bool | false | | disable_hyprland_logo | disables the hyprland logo background. :( | bool | false |
| disable_splash_rendering | disables the hyprland splash rendering. (requires a monitor reload to take effect) | bool | false | | disable_splash_rendering | disables the hyprland splash rendering. (requires a monitor reload to take effect) | bool | false |
| no_vfr | disables VFR (variable frame rate) - VFR increases battery life at the expense of possible issues on a few monitors. | bool | true | | no_vfr | disables VFR (variable frame rate) - VFR increases battery life at the expense of possible issues on a few monitors. | bool | true |
@ -233,7 +239,7 @@ Described [here](../Keywords#per-device-input-configs).
# Binds # Binds
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| pass_mouse_when_bound | if disabled, will not pass the mouse events to apps / dragging windows around if a keybind has been triggered. | bool | false | | pass_mouse_when_bound | if disabled, will not pass the mouse events to apps / dragging windows around if a keybind has been triggered. | bool | false |
| scroll_event_delay | in ms, how many ms to wait after a scroll event to allow to pass another one for the binds. | int | 300 | | scroll_event_delay | in ms, how many ms to wait after a scroll event to allow to pass another one for the binds. | int | 300 |
| workspace_back_and_forth | If enabled, an attempt to switch to the currently focused workspace will instead switch to the previous workspace. Akin to i3's *auto_back_and_forth*. | bool | false | | workspace_back_and_forth | If enabled, an attempt to switch to the currently focused workspace will instead switch to the previous workspace. Akin to i3's *auto_back_and_forth*. | bool | false |
@ -248,7 +254,7 @@ Only for developers.
{{< /hint >}} {{< /hint >}}
| name | description | type | default | | name | description | type | default |
|---|---|---|---|---| |---|---|---|---|
| overlay | print the debug performance overlay. Disable VFR for accurate results. | bool | false | | overlay | print the debug performance overlay. Disable VFR for accurate results. | bool | false |
| damage_blink | (epilepsy warning!) flash areas updated with damage tracking | bool | false | | damage_blink | (epilepsy warning!) flash areas updated with damage tracking | bool | false |
| disable_logs | self-explanatory | bool | false | | disable_logs | self-explanatory | bool | false |