hyprland-wiki/pages/Configuring/Keywords.md

---
weight: 3
title: Keywords
---

Keywords are not variables, but "commands" for more advanced configuring. On
this page, you will be presented with some that do not deserve their own page.

See the sidebar for more keywords to control binds, animations, monitors, et
cetera.

{{< callout >}}

Please remember, that for ALL arguments separated by a comma, if you want to
leave one of them empty, you cannot reduce the number of commas, _unless told
otherwise in a specific section_:

```ini
three_param_keyword = A, B, C # OK
three_param_keyword = A, C    # NOT OK
three_param_keyword = A, , C  # OK
three_param_keyword = A, B,   # OK
```

{{< /callout >}}

## Executing

You can execute a shell script on:
- startup of the compositor
- every time the config is reloaded.
- shutdown of the compositor

`exec-once = command` will execute only on launch

`exec = command` will execute on each reload

`exec-shutdown = command` will execute only on shutdown

## Defining variables

You can define your own custom variables using a dollar sign (`$`):

```ini
$VAR = value
```

For example:

```ini
$MyFavoriteGame = Among Us
```

Then you can reference them in the rest of the config. For example:

```ini
col.active_border = $MyColor
```

You are allowed to combine variables in-place with other strings, like this:

```ini
col.active_border = ff$MyRedValue1111
```

## Sourcing (multi-file)

Use the `source` keyword to source another file.

For example, in your `hyprland.conf` you can:

```ini
source = ~/.config/hypr/myColors.conf
```

And Hyprland will enter that file and parse it like a Hyprland config.

Please note it's LINEAR. Meaning lines above the `source =` will be parsed first,
then lines inside `~/.config/hypr/myColors.conf`, then lines below.

## Gestures

Use [libinput-gestures](https://github.com/bulletmark/libinput-gestures) with
`hyprctl` if you want to expand Hyprland's gestures beyond what's offered in
[Variables](../Variables).

## Per-device input configs

Per-device config options will overwrite your options set in the `input`
section. It's worth noting that ONLY values explicitly changed will be
overwritten.

In order to apply per-device config options, add a new category like this:

```ini
device {
    name = ...
    # options ...
}
```

The `name` can be easily obtained by checking the output of `hyprctl devices`.

Inside of it, put your config options. All options from the `input` category
(and all subcategories, e.g. `input:touchpad`) can be put inside, **EXCEPT**:

- `force_no_accel`
- `follow_mouse`
- `float_switch_override_focus`
- `scroll_factor`

Properties that change names:

```plain
touchdevice:transform -> transform
touchdevice:output -> output
```

You can also use the `output` setting for tablets to bind them to outputs.
Remember to use the name of the `Tablet` and not `Tablet Pad` or `Tablet tool`.

Additional properties only present in per-device configs:

- `enabled` -> (only for mice / touchpads / touchdevices / keyboards)
    - enables / disables the device (connects / disconnects from the on-screen cursor)
    - default: Enabled

Example config section:

```ini
device {
    name = royuan-akko-multi-modes-keyboard-b
    repeat_rate = 50
    repeat_delay = 500
    middle_button_emulation = 0
}
```

Example modifying per-device config values using `hyprctl`:

```bash
hyprctl -r -- keyword device[my-device]:sensitivity -1
```

{{< callout type=info >}}

Per-device layouts will by default not alter the keybind keymap, so for example
with a global keymap of `us` and a per-device one of `fr`, the keybinds will
still act as if you were on `us`.

You can change this behavior by setting `resolve_binds_by_sym = 1`. In that case
you'll need to type the symbol specified in the bind to activate it.

{{< /callout >}}

## Wallpapers

The "Hyprland" background you see when you first start Hyprland is **NOT A
WALLPAPER**, it's the default image rendered at the bottom of the render stack.

To set a wallpaper, use a wallpaper utility like
[hyprpaper](https://github.com/hyprwm/hyprpaper) or
[swaybg](https://github.com/swaywm/swaybg).

More can be found in [Useful Utilities](../../Useful-Utilities).

## Blurring layerSurfaces

Layer surfaces are not windows. These are, for example: wallpapers,
notification overlays, bars, etc.

If you want to blur them, use a layer rule:

```ini
layerrule = blur, NAMESPACE
# or
layerrule = blur, address:0x<ADDRESS>
```

You can get the namespace / address from `hyprctl layers`.

To remove a layer rule (useful in dynamic situations) use:

```ini
layerrule = unset, <whatever you used before>
```

For example:

```ini
layerrule = unset, NAMESPACE
```

## Setting the environment

{{< callout type=info >}}

The `env` keyword works just like `exec-once`, meaning it will only fire once on
Hyprland's launch.

{{< /callout >}}

You can use the `env` keyword to set environment variables when Hyprland starts,
e.g:

```ini
env = XCURSOR_SIZE,24
```

You can also add a `d` flag if you want the env var to be exported to D-Bus
(systemd only):

```ini
envd = XCURSOR_SIZE,24
```

{{< callout >}}

Hyprland puts the raw string to the env var. You should _not_ add quotes around
the values.

e.g.:

```ini
env = QT_QPA_PLATFORM,wayland
```

and _**NOT**_

```ini
env = QT_QPA_PLATFORM,"wayland"
```

{{< /callout >}}