docs: add book
This commit is contained in:
parent
c9d6fb9e40
commit
d14105eb1a
43 changed files with 7254 additions and 1204 deletions
|
|
@ -844,7 +844,7 @@
|
|||
},
|
||||
"Color": {
|
||||
"type": "string",
|
||||
"description": "A color.\n\nThe format should be one of the following:\n\n- `#rgb`\n- `#rrggbb`\n- `#rgba`\n- `#rrggbba`\n"
|
||||
"description": "A color.\n\nThe format should be one of the following:\n\n- `#rgb`\n- `#rrggbb`\n- `#rgba`\n- `#rrggbbaa`\n"
|
||||
},
|
||||
"ColorManagement": {
|
||||
"description": "Describes color-management settings.\n\n- Example:\n\n ```toml\n [color-management]\n enabled = true\n ```\n",
|
||||
|
|
@ -1109,6 +1109,10 @@
|
|||
"description": "Configures the order of workspaces displayed.\n\nThe default is `manual`.\n\n- Example:\n\n ```toml\n workspace-display-order = \"sorted\"\n ```\n",
|
||||
"$ref": "#/$defs/WorkspaceDisplayOrder"
|
||||
},
|
||||
"auto-reload": {
|
||||
"type": "boolean",
|
||||
"description": "Configures whether the compositor automatically reloads the configuration when\nthe config file changes on disk.\n\nWhen enabled, the compositor uses inotify to watch the config file and its parent\ndirectories for changes. Changes are debounced with a 400ms delay to avoid\nredundant reloads from rapid successive writes. If the file contents have not\nchanged, the reload is skipped.\n\nSetting this to `false` and will stop the file watcher. Removing this key entirely\nleaves the watcher state unchanged.\n\nThe default is `false`.\n\n- Example:\n\n ```toml\n auto-reload = true\n ```\n"
|
||||
},
|
||||
"simple-im": {
|
||||
"description": "Configures the simple, XCompose based input method.\n\nBy default, the input method is enabled. \n\nEven if the input method is enabled, it will only be used if there is no\nrunning external IM.\n\n- Example:\n\n ```toml\n [simple-im]\n enabled = false\n ```\n",
|
||||
"$ref": "#/$defs/SimpleIm"
|
||||
|
|
@ -1638,6 +1642,10 @@
|
|||
"description": "Whether the devices has been identified as a tablet pad.\n\n- Example:\n\n ```toml\n [[inputs]]\n match.is-tablet-tool = true\n tap-enabled = true\n ```\n"
|
||||
},
|
||||
"is-gesture": {
|
||||
"type": "boolean",
|
||||
"description": "Whether the devices has been identified as a gesture device.\n\n- Example:\n\n ```toml\n [[inputs]]\n match.is-gesture = true\n ```\n"
|
||||
},
|
||||
"is-switch": {
|
||||
"type": "boolean",
|
||||
"description": "Whether the devices has been identified as a switch.\n\n- Example:\n\n ```toml\n [[inputs]]\n match.is-switch = true\n ```\n"
|
||||
}
|
||||
|
|
|
|||
|
|
@ -1420,7 +1420,7 @@ The format should be one of the following:
|
|||
- `#rgb`
|
||||
- `#rrggbb`
|
||||
- `#rgba`
|
||||
- `#rrggbba`
|
||||
- `#rrggbbaa`
|
||||
|
||||
Values of this type should be strings.
|
||||
|
||||
|
|
@ -2269,6 +2269,29 @@ The table has the following fields:
|
|||
|
||||
The value of this field should be a [WorkspaceDisplayOrder](#types-WorkspaceDisplayOrder).
|
||||
|
||||
- `auto-reload` (optional):
|
||||
|
||||
Configures whether the compositor automatically reloads the configuration when
|
||||
the config file changes on disk.
|
||||
|
||||
When enabled, the compositor uses inotify to watch the config file and its parent
|
||||
directories for changes. Changes are debounced with a 400ms delay to avoid
|
||||
redundant reloads from rapid successive writes. If the file contents have not
|
||||
changed, the reload is skipped.
|
||||
|
||||
Setting this to `false` and will stop the file watcher. Removing this key entirely
|
||||
leaves the watcher state unchanged.
|
||||
|
||||
The default is `false`.
|
||||
|
||||
- Example:
|
||||
|
||||
```toml
|
||||
auto-reload = true
|
||||
```
|
||||
|
||||
The value of this field should be a boolean.
|
||||
|
||||
- `simple-im` (optional):
|
||||
|
||||
Configures the simple, XCompose based input method.
|
||||
|
|
@ -3534,6 +3557,19 @@ The table has the following fields:
|
|||
|
||||
- `is-gesture` (optional):
|
||||
|
||||
Whether the devices has been identified as a gesture device.
|
||||
|
||||
- Example:
|
||||
|
||||
```toml
|
||||
[[inputs]]
|
||||
match.is-gesture = true
|
||||
```
|
||||
|
||||
The value of this field should be a boolean.
|
||||
|
||||
- `is-switch` (optional):
|
||||
|
||||
Whether the devices has been identified as a switch.
|
||||
|
||||
- Example:
|
||||
|
|
|
|||
|
|
@ -1208,7 +1208,7 @@ Color:
|
|||
- `#rgb`
|
||||
- `#rrggbb`
|
||||
- `#rgba`
|
||||
- `#rrggbba`
|
||||
- `#rrggbbaa`
|
||||
|
||||
|
||||
ConnectorMatch:
|
||||
|
|
@ -1626,6 +1626,18 @@ InputMatch:
|
|||
tap-enabled = true
|
||||
```
|
||||
is-gesture:
|
||||
kind: boolean
|
||||
required: false
|
||||
description: |
|
||||
Whether the devices has been identified as a gesture device.
|
||||
|
||||
- Example:
|
||||
|
||||
```toml
|
||||
[[inputs]]
|
||||
match.is-gesture = true
|
||||
```
|
||||
is-switch:
|
||||
kind: boolean
|
||||
required: false
|
||||
description: |
|
||||
|
|
@ -3081,6 +3093,28 @@ Config:
|
|||
```toml
|
||||
workspace-display-order = "sorted"
|
||||
```
|
||||
auto-reload:
|
||||
kind: boolean
|
||||
required: false
|
||||
description: |
|
||||
Configures whether the compositor automatically reloads the configuration when
|
||||
the config file changes on disk.
|
||||
|
||||
When enabled, the compositor uses inotify to watch the config file and its parent
|
||||
directories for changes. Changes are debounced with a 400ms delay to avoid
|
||||
redundant reloads from rapid successive writes. If the file contents have not
|
||||
changed, the reload is skipped.
|
||||
|
||||
Setting this to `false` and will stop the file watcher. Removing this key entirely
|
||||
leaves the watcher state unchanged.
|
||||
|
||||
The default is `false`.
|
||||
|
||||
- Example:
|
||||
|
||||
```toml
|
||||
auto-reload = true
|
||||
```
|
||||
simple-im:
|
||||
ref: SimpleIm
|
||||
required: false
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue