hyprland-wiki/pages/Configuring/Keywords.md

161 lines
3.6 KiB
Markdown
Raw Normal View History

2022-09-24 15:32:40 +02:00
This page documents all of the more advanced config options.
2022-08-12 20:46:36 +02:00
2022-08-13 18:53:45 +02:00
{{< hint type=important >}}
2022-08-13 01:47:48 +02:00
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*:
2022-08-12 20:46:36 +02:00
2022-09-24 16:03:37 +02:00
```ini
2022-10-03 15:31:47 +02:00
three_param_keyword = A, B, C # OK
2022-08-12 20:46:36 +02:00
2022-10-03 15:31:47 +02:00
three_param_keyword = A, C # NOT OK
2022-08-12 20:46:36 +02:00
2022-10-03 15:31:47 +02:00
three_param_keyword = A, , C # OK
2022-08-27 19:17:14 +02:00
2022-10-03 15:31:47 +02:00
three_param_keyword = A, B, # OK
2022-08-12 20:46:36 +02:00
```
2022-08-13 18:53:45 +02:00
{{< /hint >}}
2022-08-13 17:00:36 +02:00
# Table of contents
{{< toc format=html >}}
2022-08-12 20:46:36 +02:00
# Executing
you can execute a shell script on startup of the compositor or on each time it's
reloaded.
2022-08-13 19:15:20 +02:00
{{< hint type=info >}}
2022-10-06 20:08:27 +02:00
**Note:** The issue below was fixed in upstream. (since *after* v0.15.0beta)
2022-08-13 19:15:20 +02:00
There currently is a bug with the exec that makes the executed app
2022-08-13 01:47:48 +02:00
unable to die if killed, use `SIGKILL` (e.g. `killall name -9`) or launch from a
script (`exec-once=~/myscript.sh` and do `myapp &` in the script)
2022-08-12 20:46:36 +02:00
2022-08-13 19:15:20 +02:00
{{< /hint >}}
2022-08-12 20:46:36 +02:00
`exec-once=command` will execute only on launch
`exec=command` will execute on each reload
2022-08-24 14:21:48 +02:00
2022-08-12 20:46:36 +02:00
# Defining variables
You can define your own custom variables like this:
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
$VAR = value
```
for example:
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
$MyFavoriteGame = Among Us
```
then, to use them, simply use them. For example:
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
col.active_border=$MyColor
```
You ARE allowed to do this:
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
col.active_border=ff$MyRedValue1111
```
# Sourcing (multi-file)
Use the `source` keyword to source another file.
For example, in your `hyprland.conf` you can:
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
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 something like
[libinput-gestures](https://github.com/bulletmark/libinput-gestures), with
`hyprctl` if you want to expand Hyprland's gestures beyond what's offered in
2022-09-24 16:37:22 +02:00
[Variables](../Variables).
2022-08-12 20:46:36 +02:00
# 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, make a new category like this:
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
device:name {
}
```
the `name` can be easily obtained by doing `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
2022-08-12 20:46:36 +02:00
For example:
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
device:ROYUAN Akko Multi-modes Keyboard-B {
repeat_rate=50
repeat_delay=500
middle_button_emulation=0
}
```
*remember about the space after the end of the device's name (before the `{`)!*
2022-08-20 18:51:11 +02:00
{{< hint type=tip >}}
2022-09-24 16:37:22 +02:00
With hyprctl, the category's spaces get turned into `-`, and everything is
lowercase. So, for `hyprctl` calls, do for example:
2022-09-24 16:03:37 +02:00
```sh
2022-08-20 18:50:45 +02:00
hyprctl keyword device:royuan-akko-multi-modes-keyboard-b:kb_layout us
```
{{< /hint >}}
2022-08-12 20:46:36 +02:00
# 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).
# Blurring layerSurfaces
LayerSurfaces are not windows. These are for example: Your wallpapers,
notification overlays, bars, etc.
If you really want to blur them, use `blurls=`
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
blurls=NAMESPACE
```
where `NAMESPACE` is the namespace of the layerSurface. (You can get it from
`hyprctl layers`)
to remove a namespace from being blurred (useful in dynamic situations) use:
2022-09-24 16:03:37 +02:00
```ini
2022-08-12 20:46:36 +02:00
blurls=remove,NAMESPACE
```