Skip to content

Commit

Permalink
docs(mkdocs): add more info on whkdrc config
Browse files Browse the repository at this point in the history
  • Loading branch information
ArnaudKunzi authored and LGUG2Z committed Oct 16, 2024
1 parent 7276dc2 commit c0c3c81
Showing 1 changed file with 20 additions and 1 deletion.
21 changes: 20 additions & 1 deletion docs/example-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@ If you like the `grid` layout in [LeftWM](https://github.com/leftwm/leftwm-layou

`whkd` is a fairly basic piece of software with a simple configuration format:
key bindings go to the left of the colon, and shell commands go to the right of the
colon. By default, the `whkdrc` file should be located in the `$Env:USERPROFILE/.config/` directory.
colon.

Please remember that `whkd` does not support overriding Microsoft's limitations
on hotkey bindings that include the `Windows` key. If this is important to you,
Expand All @@ -188,6 +188,25 @@ bindings for `komorebic` commands instead.
{% include "./whkdrc.sample" %}
```

### Configuration

`whkd` searches for a `whkdrc` configuration file in the following locations:

* `$Env:WHKD_CONFIG_HOME`
* `$Env:USERPROFILE/.config`

It is also possible to change a hotkey behavior depending on which application has focus:

```
alt + n [
# ProcessName as shown by `Get-Process`
Firefox : echo "hello firefox"
# Spaces are fine, no quotes required
Google Chrome : echo "hello chrome"
]
```

### Setting .shell

There is one special directive at the top of the file, `.shell` which can be
Expand Down

0 comments on commit c0c3c81

Please sign in to comment.