Skip to content

Commit 8921db7

Browse files
committed
fix and update documentation
1 parent e2660c3 commit 8921db7

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

mayland-config/readme.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -186,7 +186,7 @@ output {
186186

187187
sets the output resolution and refresh rate.
188188

189-
the format is `"<width>x<height>"` and allows you to optionally pass the refresh rate as "`<width>x<height>@<refresh-rate in hz>`".
189+
the format is `"<width>x<height>"` and allows you to optionally pass the refresh rate as `"<width>x<height>@<refresh-rate in hz>"`.
190190
if the refresh rate is omitted, mayland will pick the mode with the highest refresh rate,
191191
otherwise it will pick the refresh rate that matches the given one as closely as possible.
192192

@@ -276,14 +276,28 @@ you can configure keybindings in the `bind` category.
276276

277277
```ini
278278
bind {
279-
mod+shift+escape = "exit"
279+
mod+shift+escape = "quit"
280+
280281
mod+q = "close"
282+
mod+v = "toggle-floating"
283+
284+
mod+t = "spawn" [ "kitty" ]
285+
mod+e = "spawn" [ "nautilus" ]
286+
mod+n = "spawn" [ "firefox" ]
287+
mod+space = "spawn" [ "fuzzel" ]
288+
289+
mod+1 = "workspace" [ 0 ]
290+
mod+2 = "workspace" [ 1 ]
291+
mod+3 = "workspace" [ 2 ]
292+
mod+4 = "workspace" [ 3 ]
293+
mod+5 = "workspace" [ 4 ]
294+
mod+6 = "workspace" [ 5 ]
281295
}
282296
```
283297

284298
keybinds are in the form of `<keymapping> = "<action>"`.
285299

286-
actions may have additional parameters. these are passed through via brackets as tagged values. etc.
300+
actions may have additional parameters. these are passed through via brackets as [tagged enums](https://github.com/m4rch3n1ng/mayfig?tab=readme-ov-file#tagged-enums).
287301

288302
keymappings are in the form `"{ <modifier>+ } <key>"`.
289303
supported modifiers are `"super"` (with an alias of `"meta"`), `"ctrl"` and `"alt"`.
@@ -294,9 +308,9 @@ both the `<key>` and all `<modifier>` are case-insenstive. there is no support f
294308
currently supported actions are:
295309
- `"quit"`: quit the compositor.
296310
- `"close"`: close the active window.
297-
- `"toggle-floating"`:
311+
- `"toggle-floating"`: toggle the active window's floating state
298312
- `"workspace" [ <index> ]`: switch to workspace with the index `<index>`.
299-
- `"spawn" [ <... args> ]`
313+
- `"spawn" [ <cmd> <... args> ]`: spawns the `<cmd>` as a command, with the other parameters as arguments.
300314

301315
### windowrules
302316

0 commit comments

Comments
 (0)