toml: format spec.yaml file
This commit is contained in:
Julian Orth
parent
fbd37e6662
commit
a7808d89c2
3 changed files with 18 additions and 18 deletions
|
|
@ -816,7 +816,7 @@
|
|||
"properties": {
|
||||
"mod-mask": {
|
||||
"type": "string",
|
||||
"description": "The mod mask to apply to this shortcut.\n\nShould be a string containing modifiers concatenated by `-`. See the description\nof `Config.shortcuts` for more details.\n\nIf this field is omitted, all modifiers are included in the mask.\n\n- Example:\n \n To raise the volume whenever the XF86AudioRaiseVolume key is pressed regardless\n of any modifiers except `alt`:\n\n ```toml\n [complex-shortcuts.XF86AudioRaiseVolume]\n mod-mask = \"alt\"\n action = { type = \"exec\", exec = [\"pactl\", \"set-sink-volume\", \"0\", \"+10%\"] }\n ```\n\n Set `mod-mask = \"\"` to ignore all modifiers.\n"
|
||||
"description": "The mod mask to apply to this shortcut.\n\nShould be a string containing modifiers concatenated by `-`. See the description\nof `Config.shortcuts` for more details.\n\nIf this field is omitted, all modifiers are included in the mask.\n\n- Example:\n\n To raise the volume whenever the XF86AudioRaiseVolume key is pressed regardless\n of any modifiers except `alt`:\n\n ```toml\n [complex-shortcuts.XF86AudioRaiseVolume]\n mod-mask = \"alt\"\n action = { type = \"exec\", exec = [\"pactl\", \"set-sink-volume\", \"0\", \"+10%\"] }\n ```\n\n Set `mod-mask = \"\"` to ignore all modifiers.\n"
|
||||
},
|
||||
"action": {
|
||||
"description": "The action to execute.\n\nOmitting this is the same as setting it to `\"none\"`.\n",
|
||||
|
|
@ -838,7 +838,7 @@
|
|||
"$ref": "#/$defs/Keymap"
|
||||
},
|
||||
"repeat-rate": {
|
||||
"description": "The keyboard repeat rate.\n\n- Example:\n \n ```toml\n repeat-rate = { rate = 25, delay = 250 }\n ```\n",
|
||||
"description": "The keyboard repeat rate.\n\n- Example:\n\n ```toml\n repeat-rate = { rate = 25, delay = 250 }\n ```\n",
|
||||
"$ref": "#/$defs/RepeatRate"
|
||||
},
|
||||
"shortcuts": {
|
||||
|
|
@ -962,7 +962,7 @@
|
|||
"description": "Configures a key that will enable window management mode while pressed.\n\nIn window management mode, floating windows can be moved by pressing the left\nmouse button and all windows can be resize by pressing the right mouse button.\n\n- Example:\n\n ```toml\n window-management-key = \"Alt_L\"\n ```\n"
|
||||
},
|
||||
"vrr": {
|
||||
"description": "Configures the default VRR settings.\n\nThis can be overwritten for individual outputs.\n\nBy default, the VRR mode is `never` and the cursor refresh rate is unbounded.\n\n- Example:\n \n ```toml\n vrr = { mode = \"always\", cursor-hz = 90 }\n ```\n",
|
||||
"description": "Configures the default VRR settings.\n\nThis can be overwritten for individual outputs.\n\nBy default, the VRR mode is `never` and the cursor refresh rate is unbounded.\n\n- Example:\n\n ```toml\n vrr = { mode = \"always\", cursor-hz = 90 }\n ```\n",
|
||||
"$ref": "#/$defs/Vrr"
|
||||
},
|
||||
"tearing": {
|
||||
|
|
@ -1219,7 +1219,7 @@
|
|||
}
|
||||
},
|
||||
{
|
||||
"description": "The name, arguments, and environment variables of the executable to execute.\n\nExactly one of the `prog` or `shell` fields must be specified.\n\n- Example 1:\n\n ```toml\n [shortcuts]\n ctrl-a = { type = \"exec\", exec = { prog = \"notify-send\", args = [\"hello world\"], env.WAYLAND_DISPLAY = \"2\" } }\n ```\n\n- Example 2:\n \n ```toml\n [shortcuts]\n ctrl-a = { type = \"exec\", exec = { shell = \"grim - | wl-copy\", privileged = true } }\n ```\n",
|
||||
"description": "The name, arguments, and environment variables of the executable to execute.\n\nExactly one of the `prog` or `shell` fields must be specified.\n\n- Example 1:\n\n ```toml\n [shortcuts]\n ctrl-a = { type = \"exec\", exec = { prog = \"notify-send\", args = [\"hello world\"], env.WAYLAND_DISPLAY = \"2\" } }\n ```\n\n- Example 2:\n\n ```toml\n [shortcuts]\n ctrl-a = { type = \"exec\", exec = { shell = \"grim - | wl-copy\", privileged = true } }\n ```\n",
|
||||
"type": "object",
|
||||
"properties": {
|
||||
"prog": {
|
||||
|
|
|
|||
|
|
@ -1382,7 +1382,7 @@ The table has the following fields:
|
|||
If this field is omitted, all modifiers are included in the mask.
|
||||
|
||||
- Example:
|
||||
|
||||
|
||||
To raise the volume whenever the XF86AudioRaiseVolume key is pressed regardless
|
||||
of any modifiers except `alt`:
|
||||
|
||||
|
|
@ -1513,7 +1513,7 @@ The table has the following fields:
|
|||
The keyboard repeat rate.
|
||||
|
||||
- Example:
|
||||
|
||||
|
||||
```toml
|
||||
repeat-rate = { rate = 25, delay = 250 }
|
||||
```
|
||||
|
|
@ -1884,7 +1884,7 @@ The table has the following fields:
|
|||
By default, the VRR mode is `never` and the cursor refresh rate is unbounded.
|
||||
|
||||
- Example:
|
||||
|
||||
|
||||
```toml
|
||||
vrr = { mode = "always", cursor-hz = 90 }
|
||||
```
|
||||
|
|
@ -2550,7 +2550,7 @@ Exactly one of the `prog` or `shell` fields must be specified.
|
|||
```
|
||||
|
||||
- Example 2:
|
||||
|
||||
|
||||
```toml
|
||||
[shortcuts]
|
||||
ctrl-a = { type = "exec", exec = { shell = "grim - | wl-copy", privileged = true } }
|
||||
|
|
|
|||
|
|
@ -797,7 +797,7 @@ Exec:
|
|||
```
|
||||
|
||||
- Example 2:
|
||||
|
||||
|
||||
```toml
|
||||
[shortcuts]
|
||||
ctrl-a = { type = "exec", exec = { shell = "grim - | wl-copy", privileged = true } }
|
||||
|
|
@ -2270,7 +2270,7 @@ Config:
|
|||
The keyboard repeat rate.
|
||||
|
||||
- Example:
|
||||
|
||||
|
||||
```toml
|
||||
repeat-rate = { rate = 25, delay = 250 }
|
||||
```
|
||||
|
|
@ -2634,7 +2634,7 @@ Config:
|
|||
By default, the VRR mode is `never` and the cursor refresh rate is unbounded.
|
||||
|
||||
- Example:
|
||||
|
||||
|
||||
```toml
|
||||
vrr = { mode = "always", cursor-hz = 90 }
|
||||
```
|
||||
|
|
@ -2790,9 +2790,9 @@ Config:
|
|||
required: false
|
||||
description: |
|
||||
Sets the keysym that can be used to revert the pointer to the default state.
|
||||
|
||||
|
||||
Pressing this key cancels any grabs, drags, selections, etc.
|
||||
|
||||
|
||||
The default is `Escape`. Setting this to `NoSymbol` effectively disables
|
||||
this functionality.
|
||||
|
||||
|
|
@ -2998,7 +2998,7 @@ ComplexShortcut:
|
|||
If this field is omitted, all modifiers are included in the mask.
|
||||
|
||||
- Example:
|
||||
|
||||
|
||||
To raise the volume whenever the XF86AudioRaiseVolume key is pressed regardless
|
||||
of any modifiers except `alt`:
|
||||
|
||||
|
|
@ -3270,7 +3270,7 @@ UiDrag:
|
|||
required: false
|
||||
description: |
|
||||
Sets the distance at which ui dragging starts.
|
||||
|
||||
|
||||
The default is `10`.
|
||||
|
||||
|
||||
|
|
@ -3375,7 +3375,7 @@ Brightness:
|
|||
The brightness setting of an output.
|
||||
variants:
|
||||
- kind: string
|
||||
description: |
|
||||
description: |
|
||||
The default brightness setting.
|
||||
values:
|
||||
- value: default
|
||||
|
|
@ -3729,7 +3729,7 @@ WindowRule:
|
|||
required: false
|
||||
description: |
|
||||
Whether newly mapped windows that match this rule get the keyboard focus.
|
||||
|
||||
|
||||
If a window matches any rule for which this is false, the window will not be
|
||||
automatically focused.
|
||||
initial-tile-state:
|
||||
|
|
@ -3876,7 +3876,7 @@ WindowMatch:
|
|||
required: false
|
||||
description: |
|
||||
Matches if the window has/hasn't just been mapped.
|
||||
|
||||
|
||||
This is true for one iteration of the compositor's main loop immediately after the
|
||||
window has been mapped.
|
||||
tag:
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue