feat(windows): update docs after updating docstrings on kfw

This commit is contained in:
LGUG2Z committed 2025-12-27 22:25:52 -08:00
1 parent b28b85d530
commit a7b128e465
26 files changed
+18116 -4676

No files matched your search

File diff suppressed because it is too large. Load diff
File diff suppressed because it is too large. Load diff
@@ -5,13 +5,15 @@ Usage: 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')
```
@@ -5,13 +5,15 @@ Usage: 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')
```
+34 -3
View File
@@ -6,10 +6,41 @@ Usage: 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-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
@@ -17,6 +48,6 @@ Options:
[possible values: movement, transparency]
-h, --help
Print help
Print help (see a summary with '-h')
```
+8 -3
View File
@@ -15,10 +15,15 @@ Arguments:
Options:
-w, --window-kind <WINDOW_KIND>
[default: single]
[possible values: single, stack, monocle, unfocused, unfocused-locked, floating]
Possible values:
- single: Single window
- stack: Stack container
- monocle: Monocle container
- unfocused: Unfocused window
- unfocused-locked: Unfocused locked container
- floating: Floating window[default: single]
-h, --help
Print help
Print help (see a summary with '-h')
```
+11 -2
View File
@@ -5,10 +5,19 @@ Usage: 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')
```
+5 -2
View File
@@ -5,10 +5,13 @@ Usage: 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')
```
@@ -5,13 +5,17 @@ Usage: identify-layered-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
@@ -5,13 +5,17 @@ Usage: identify-object-name-change-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
@@ -5,13 +5,17 @@ Usage: identify-tray-application <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -5,13 +5,17 @@ Usage: ignore-rule <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
@@ -5,7 +5,11 @@ Usage: initial-named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
@@ -15,6 +19,6 @@ Arguments:
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
@@ -5,7 +5,11 @@ Usage: initial-workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
@@ -18,6 +22,6 @@ Arguments:
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -5,13 +5,17 @@ Usage: manage-rule <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
@@ -11,10 +11,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')
```
+11 -2
View File
@@ -8,10 +8,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')
```
+6 -2
View File
@@ -5,7 +5,11 @@ Usage: named-workspace-rule <IDENTIFIER> <ID> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
@@ -15,6 +19,6 @@ Arguments:
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+6 -2
View File
@@ -5,13 +5,17 @@ Usage: remove-title-bar <IDENTIFIER> <ID>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
+8 -3
View File
@@ -5,13 +5,18 @@ Usage: 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')
```
+4 -2
View File
@@ -8,10 +8,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')
```
+6 -3
View File
@@ -6,11 +6,14 @@ Usage: stackbar-mode <MODE>
Arguments:
<MODE>
Desired stackbar mode
[possible values: always, never, on-stack]
Possible values:
- always: Always show
- never: Never show
- on-stack: Show on stack
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```
@@ -6,8 +6,8 @@ Usage: 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
+11 -2
View File
@@ -14,10 +14,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')
```
+11 -2
View File
@@ -11,10 +11,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')
```
+6 -2
View File
@@ -5,7 +5,11 @@ Usage: workspace-rule <IDENTIFIER> <ID> <MONITOR> <WORKSPACE>
Arguments:
<IDENTIFIER>
[possible values: exe, class, title, path]
Possible values:
- exe: Executable name
- class: Class
- title: Window title
- path: Executable path
<ID>
Identifier as a string
@@ -18,6 +22,6 @@ Arguments:
Options:
-h, --help
Print help
Print help (see a summary with '-h')
```