mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-17 06:11:21 +01:00
docs(schema): regenerate schemas, nix options and cli docs
Bring the generated files back in line with the code on master. - schema.json: add monocle_focus_behaviour and the MonocleFocusBehaviour definition. schema.asc.json and schema.bar.json were already current. - nix/komorebi-options.nix: add the monocle_focus_behaviour option. nix/komorebi-bar-options.nix was already current. - docs/cli: add the pages for layout-ratios, monocle-focus-behaviour, permissions and toggle-monocle-focus-behaviour. Update 19 pages for the --bar flag of enable-autostart, the per-value help of enum arguments and reworded help text. Re-wrap 4 pages whose text did not change. How the files were made: - schemars-nixgen writes the properties of an object in a different order on every run, so the files are not regenerated whole. Only the new option is added; the rest of a full run was checked to be the same lines in another order. - docgen on master writes a bare fence with no heading and "Usage: name", where the pages in docs/cli have a "# name" heading and "Usage: komorebic name". The pages keep the format they have. - Pages are wrapped at 100 columns, the width docgen uses when it does not write to a terminal, instead of the width of the terminal the old pages were made in.
This commit is contained in:
1 parent
ed19380659
commit
2cd5884f21
29 files changed
+268
-43
No files matched your search
@@ -7,13 +7,15 @@ Usage: komorebic adjust-container-padding <SIZING> <ADJUSTMENT>
|
||||
|
||||
Arguments:
|
||||
<SIZING>
|
||||
[possible values: increase, decrease]
|
||||
Possible values:
|
||||
- increase: Increase
|
||||
- decrease: Decrease
|
||||
|
||||
<ADJUSTMENT>
|
||||
Pixels to adjust by as an integer
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,13 +7,15 @@ Usage: komorebic adjust-workspace-padding <SIZING> <ADJUSTMENT>
|
||||
|
||||
Arguments:
|
||||
<SIZING>
|
||||
[possible values: increase, decrease]
|
||||
Possible values:
|
||||
- increase: Increase
|
||||
- decrease: Decrease
|
||||
|
||||
<ADJUSTMENT>
|
||||
Pixels to adjust by as an integer
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -8,10 +8,41 @@ Usage: komorebic animation-style [OPTIONS]
|
||||
Options:
|
||||
-s, --style <STYLE>
|
||||
Desired ease function for animation
|
||||
|
||||
Possible values:
|
||||
- linear: Linear
|
||||
- ease-in-sine: Ease in sine
|
||||
- ease-out-sine: Ease out sine
|
||||
- ease-in-out-sine: Ease in out sine
|
||||
- ease-in-quad: Ease in quad
|
||||
- ease-out-quad: Ease out quad
|
||||
- ease-in-out-quad: Ease in out quad
|
||||
- ease-in-cubic: Ease in cubic
|
||||
- ease-out-cubic: Ease out cubic
|
||||
- ease-in-out-cubic: Ease in out cubic
|
||||
- ease-in-quart: Ease in quart
|
||||
- ease-out-quart: Ease out quart
|
||||
- ease-in-out-quart: Ease in out quart
|
||||
- ease-in-quint: Ease in quint
|
||||
- ease-out-quint: Ease out quint
|
||||
- ease-in-out-quint: Ease in out quint
|
||||
- ease-in-expo: Ease in expo
|
||||
- ease-out-expo: Ease out expo
|
||||
- ease-in-out-expo: Ease in out expo
|
||||
- ease-in-circ: Ease in circ
|
||||
- ease-out-circ: Ease out circ
|
||||
- ease-in-out-circ: Ease in out circ
|
||||
- ease-in-back: Ease in back
|
||||
- ease-out-back: Ease out back
|
||||
- ease-in-out-back: Ease in out back
|
||||
- ease-in-elastic: Ease in elastic
|
||||
- ease-out-elastic: Ease out elastic
|
||||
- ease-in-out-elastic: Ease in out elastic
|
||||
- ease-in-bounce: Ease in bounce
|
||||
- ease-out-bounce: Ease out bounce
|
||||
- ease-in-out-bounce: Ease in out bounce
|
||||
|
||||
[default: linear]
|
||||
[possible values: linear, ease-in-sine, ease-out-sine, ease-in-out-sine, ease-in-quad, ease-out-quad, ease-in-out-quad, ease-in-cubic, ease-out-cubic, ease-in-out-cubic, ease-in-quart, ease-out-quart, ease-in-out-quart, ease-in-quint, ease-out-quint, ease-in-out-quint, ease-in-expo, ease-out-expo, ease-in-out-expo, ease-in-circ,
|
||||
ease-out-circ, ease-in-out-circ, ease-in-back, ease-out-back, ease-in-out-back, ease-in-elastic, ease-out-elastic, ease-in-out-elastic, ease-in-bounce, ease-out-bounce, ease-in-out-bounce]
|
||||
|
||||
-a, --animation-type <ANIMATION_TYPE>
|
||||
Animation type to apply the style to. If not specified, sets global style
|
||||
@@ -19,6 +50,6 @@ Options:
|
||||
[possible values: movement]
|
||||
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,10 +7,19 @@ Usage: komorebic change-layout <DEFAULT_LAYOUT>
|
||||
|
||||
Arguments:
|
||||
<DEFAULT_LAYOUT>
|
||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||
Possible values:
|
||||
- bsp: BSP Layout
|
||||
- columns: Columns Layout
|
||||
- rows: Rows Layout
|
||||
- vertical-stack: Vertical Stack Layout
|
||||
- horizontal-stack: Horizontal Stack Layout
|
||||
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
|
||||
- grid: Grid Layout
|
||||
- right-main-vertical-stack: Right Main Vertical Stack Layout
|
||||
- scrolling: Scrolling Layout
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -8,9 +8,11 @@ Usage: komorebic cross-monitor-move-behaviour <MOVE_BEHAVIOUR>
|
||||
Arguments:
|
||||
<MOVE_BEHAVIOUR>
|
||||
Possible values:
|
||||
- swap: Swap the window container with the window container at the edge of the adjacent monitor
|
||||
- swap: Swap the window container with the window container at the edge of the adjacent
|
||||
monitor
|
||||
- insert: Insert the window container into the focused workspace on the adjacent monitor
|
||||
- no-op: Do nothing if trying to move a window container in the direction of an adjacent monitor
|
||||
- no-op: Do nothing if trying to move a window container in the direction of an adjacent
|
||||
monitor
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
@@ -9,6 +9,9 @@ Options:
|
||||
-c, --config <CONFIG>
|
||||
Path to a static configuration JSON file
|
||||
|
||||
--bar
|
||||
Enable autostart of komorebi-bar
|
||||
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
|
||||
@@ -7,10 +7,13 @@ Usage: komorebic flip-layout <AXIS>
|
||||
|
||||
Arguments:
|
||||
<AXIS>
|
||||
[possible values: horizontal, vertical, horizontal-and-vertical]
|
||||
Possible values:
|
||||
- horizontal: Horizontal axis
|
||||
- vertical: Vertical axis
|
||||
- horizontal-and-vertical: Both horizontal and vertical axes
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,13 +7,17 @@ Usage: komorebic ignore-rule <IDENTIFIER> <ID>
|
||||
|
||||
Arguments:
|
||||
<IDENTIFIER>
|
||||
[possible values: exe, class, title, path]
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
<ID>
|
||||
Identifier as a string
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,7 +7,11 @@ Usage: komorebic initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
|
||||
|
||||
Arguments:
|
||||
<IDENTIFIER>
|
||||
[possible values: exe, class, title, path]
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
<ID>
|
||||
Identifier as a string
|
||||
@@ -17,6 +21,6 @@ Arguments:
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,7 +7,11 @@ Usage: komorebic initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
|
||||
|
||||
Arguments:
|
||||
<IDENTIFIER>
|
||||
[possible values: exe, class, title, path]
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
<ID>
|
||||
Identifier as a string
|
||||
@@ -20,6 +24,6 @@ Arguments:
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -0,0 +1,18 @@
|
||||
# layout-ratios
|
||||
|
||||
```
|
||||
Set the layout column and row ratios for the focused workspace
|
||||
|
||||
Usage: komorebic layout-ratios [OPTIONS]
|
||||
|
||||
Options:
|
||||
-c, --columns <COLUMNS>...
|
||||
Column width ratios (space-separated values between 0.1 and 0.9)
|
||||
|
||||
-r, --rows <ROWS>...
|
||||
Row height ratios (space-separated values between 0.1 and 0.9)
|
||||
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -7,13 +7,17 @@ Usage: komorebic manage-rule <IDENTIFIER> <ID>
|
||||
|
||||
Arguments:
|
||||
<IDENTIFIER>
|
||||
[possible values: exe, class, title, path]
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
<ID>
|
||||
Identifier as a string
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -0,0 +1,20 @@
|
||||
# monocle-focus-behaviour
|
||||
|
||||
```
|
||||
Set the behaviour when focusing in a direction while a monocle container is active
|
||||
|
||||
Usage: komorebic monocle-focus-behaviour <BEHAVIOUR>
|
||||
|
||||
Arguments:
|
||||
<BEHAVIOUR>
|
||||
Desired monocle focus behaviour
|
||||
|
||||
Possible values:
|
||||
- cycle: Cycle the monocle container to the next/previous container in the workspace
|
||||
- no-op: Do nothing, allowing focus to fall through to cross-monitor logic
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -13,10 +13,19 @@ Arguments:
|
||||
The number of window containers on-screen required to trigger this layout rule
|
||||
|
||||
<LAYOUT>
|
||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||
Possible values:
|
||||
- bsp: BSP Layout
|
||||
- columns: Columns Layout
|
||||
- rows: Rows Layout
|
||||
- vertical-stack: Vertical Stack Layout
|
||||
- horizontal-stack: Horizontal Stack Layout
|
||||
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
|
||||
- grid: Grid Layout
|
||||
- right-main-vertical-stack: Right Main Vertical Stack Layout
|
||||
- scrolling: Scrolling Layout
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -10,10 +10,19 @@ Arguments:
|
||||
Target workspace name
|
||||
|
||||
<VALUE>
|
||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||
Possible values:
|
||||
- bsp: BSP Layout
|
||||
- columns: Columns Layout
|
||||
- rows: Rows Layout
|
||||
- vertical-stack: Vertical Stack Layout
|
||||
- horizontal-stack: Horizontal Stack Layout
|
||||
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
|
||||
- grid: Grid Layout
|
||||
- right-main-vertical-stack: Right Main Vertical Stack Layout
|
||||
- scrolling: Scrolling Layout
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,7 +7,11 @@ Usage: komorebic named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
|
||||
|
||||
Arguments:
|
||||
<IDENTIFIER>
|
||||
[possible values: exe, class, title, path]
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
<ID>
|
||||
Identifier as a string
|
||||
@@ -17,6 +21,6 @@ Arguments:
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -0,0 +1,12 @@
|
||||
# permissions
|
||||
|
||||
```
|
||||
Show the System Settings permissions dialogs required by komorebi
|
||||
|
||||
Usage: komorebic permissions
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
+3
-1
@@ -7,7 +7,9 @@ Usage: komorebic query <STATE_QUERY>
|
||||
|
||||
Arguments:
|
||||
<STATE_QUERY>
|
||||
[possible values: focused-monitor-index, focused-workspace-index, focused-container-index, focused-window-index, focused-workspace-name, focused-workspace-layout, focused-container-kind, version]
|
||||
[possible values: focused-monitor-index, focused-workspace-index, focused-container-index,
|
||||
focused-window-index, focused-workspace-name, focused-workspace-layout,
|
||||
focused-container-kind, version]
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
@@ -7,13 +7,18 @@ Usage: komorebic resize-axis <AXIS> <SIZING>
|
||||
|
||||
Arguments:
|
||||
<AXIS>
|
||||
[possible values: horizontal, vertical, horizontal-and-vertical]
|
||||
Possible values:
|
||||
- horizontal: Horizontal axis
|
||||
- vertical: Vertical axis
|
||||
- horizontal-and-vertical: Both horizontal and vertical axes
|
||||
|
||||
<SIZING>
|
||||
[possible values: increase, decrease]
|
||||
Possible values:
|
||||
- increase: Increase
|
||||
- decrease: Decrease
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -10,10 +10,12 @@ Arguments:
|
||||
[possible values: left, right, up, down]
|
||||
|
||||
<SIZING>
|
||||
[possible values: increase, decrease]
|
||||
Possible values:
|
||||
- increase: Increase
|
||||
- decrease: Decrease
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -0,0 +1,12 @@
|
||||
# toggle-monocle-focus-behaviour
|
||||
|
||||
```
|
||||
Toggle the behaviour when focusing in a direction while a monocle container is active
|
||||
|
||||
Usage: komorebic toggle-monocle-focus-behaviour
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -1,7 +1,9 @@
|
||||
# toggle-workspace-float-override
|
||||
|
||||
```
|
||||
Enable or disable float override, which makes it so every new window opens in floating mode, for the currently focused workspace. If there was no override value set for the workspace previously it takes the opposite of the global value
|
||||
Enable or disable float override, which makes it so every new window opens in floating mode, for the
|
||||
currently focused workspace. If there was no override value set for the workspace previously it
|
||||
takes the opposite of the global value
|
||||
|
||||
Usage: komorebic toggle-workspace-float-override
|
||||
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
# toggle-workspace-window-container-behaviour
|
||||
|
||||
```
|
||||
Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace. If there was no behaviour set for the workspace previously it takes the opposite of the global value
|
||||
Toggle the behaviour for new windows (stacking or dynamic tiling) for currently focused workspace.
|
||||
If there was no behaviour set for the workspace previously it takes the opposite of the global value
|
||||
|
||||
Usage: komorebic toggle-workspace-window-container-behaviour
|
||||
|
||||
|
||||
@@ -8,8 +8,8 @@ Usage: komorebic unmanaged-window-operation-behaviour <OPERATION_BEHAVIOUR>
|
||||
Arguments:
|
||||
<OPERATION_BEHAVIOUR>
|
||||
Possible values:
|
||||
- op: Process komorebic commands on temporarily unmanaged/floated windows
|
||||
- no-op: Ignore komorebic commands on temporarily unmanaged/floated windows
|
||||
- op: Process commands on temporarily unmanaged/floated windows
|
||||
- no-op: Ignore commands on temporarily unmanaged/floated windows
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
@@ -16,10 +16,19 @@ Arguments:
|
||||
The number of window containers on-screen required to trigger this layout rule
|
||||
|
||||
<LAYOUT>
|
||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||
Possible values:
|
||||
- bsp: BSP Layout
|
||||
- columns: Columns Layout
|
||||
- rows: Rows Layout
|
||||
- vertical-stack: Vertical Stack Layout
|
||||
- horizontal-stack: Horizontal Stack Layout
|
||||
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
|
||||
- grid: Grid Layout
|
||||
- right-main-vertical-stack: Right Main Vertical Stack Layout
|
||||
- scrolling: Scrolling Layout
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -13,10 +13,19 @@ Arguments:
|
||||
Workspace index on the specified monitor (zero-indexed)
|
||||
|
||||
<VALUE>
|
||||
[possible values: bsp, columns, rows, vertical-stack, horizontal-stack, ultrawide-vertical-stack, grid, right-main-vertical-stack, scrolling]
|
||||
Possible values:
|
||||
- bsp: BSP Layout
|
||||
- columns: Columns Layout
|
||||
- rows: Rows Layout
|
||||
- vertical-stack: Vertical Stack Layout
|
||||
- horizontal-stack: Horizontal Stack Layout
|
||||
- ultrawide-vertical-stack: Ultrawide Vertical Stack Layout
|
||||
- grid: Grid Layout
|
||||
- right-main-vertical-stack: Right Main Vertical Stack Layout
|
||||
- scrolling: Scrolling Layout
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -7,7 +7,11 @@ Usage: komorebic workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
|
||||
|
||||
Arguments:
|
||||
<IDENTIFIER>
|
||||
[possible values: exe, class, title, path]
|
||||
Possible values:
|
||||
- exe: Executable name
|
||||
- class: Role or subrole
|
||||
- title: Window title
|
||||
- path: Executable path
|
||||
|
||||
<ID>
|
||||
Identifier as a string
|
||||
@@ -20,6 +24,6 @@ Arguments:
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help
|
||||
Print help (see a summary with '-h')
|
||||
|
||||
```
|
||||
@@ -792,6 +792,18 @@ in
|
||||
default = null;
|
||||
description = "Monitor and workspace configurations";
|
||||
};
|
||||
monocle_focus_behaviour = lib.mkOption {
|
||||
type = (
|
||||
lib.types.nullOr (
|
||||
lib.types.enum [
|
||||
"Cycle"
|
||||
"NoOp"
|
||||
]
|
||||
)
|
||||
);
|
||||
default = "NoOp";
|
||||
description = "Determine what happens when focusing in a direction while a monocle container is active";
|
||||
};
|
||||
mouse_follows_focus = lib.mkOption {
|
||||
type = (lib.types.nullOr lib.types.bool);
|
||||
default = true;
|
||||
|
||||
+27
@@ -253,6 +253,18 @@
|
||||
"$ref": "#/$defs/MonitorConfig"
|
||||
}
|
||||
},
|
||||
"monocle_focus_behaviour": {
|
||||
"description": "Determine what happens when focusing in a direction while a monocle container is active",
|
||||
"anyOf": [
|
||||
{
|
||||
"$ref": "#/$defs/MonocleFocusBehaviour"
|
||||
},
|
||||
{
|
||||
"type": "null"
|
||||
}
|
||||
],
|
||||
"default": "NoOp"
|
||||
},
|
||||
"mouse_follows_focus": {
|
||||
"description": "Enable or disable mouse follows focus",
|
||||
"type": [
|
||||
@@ -3167,6 +3179,21 @@
|
||||
"workspaces"
|
||||
]
|
||||
},
|
||||
"MonocleFocusBehaviour": {
|
||||
"description": "Behaviour when focusing in a direction while a monocle container is active",
|
||||
"oneOf": [
|
||||
{
|
||||
"description": "Cycle the monocle container to the next/previous container in the workspace",
|
||||
"type": "string",
|
||||
"const": "Cycle"
|
||||
},
|
||||
{
|
||||
"description": "Do nothing, allowing focus to fall through to cross-monitor logic",
|
||||
"type": "string",
|
||||
"const": "NoOp"
|
||||
}
|
||||
]
|
||||
},
|
||||
"MoveBehaviour": {
|
||||
"description": "Move behaviour when the operation works across a monitor boundary",
|
||||
"oneOf": [
|
||||
|
||||
Reference in new issue
Block a user