mirror of
https://github.com/LGUG2Z/komorebi.git
synced 2026-11-18 06:38:38 +01:00
docs(komorebic): regenerate the pages of the fifteen commands whose help was unified
docs/cli of the three trees for the commands the previous revision unified, written the way each tree writes its pages: komorebi-for-kde 6 pages (colour/behaviour spelling), komorebi-for-mac 7 (the shorter scrolling descriptions), the Windows tree 2 (eager-focus, promote-focus). The Windows docs/cli is otherwise stale (older clap output, three pages missing; found in step 4 prep) and the other pages are left alone. Verified: the KDE pages are byte-identical to komorebic docgen (166 of 166 against the real binary); the macOS and Windows pages are the docgen-all output with the same page transform that made 158 of 158 macOS pages identical before. Diffs are two-line spelling or description changes (see the previous revision).
This commit is contained in:
1 parent
6dbcfdf1f3
commit
72dc31452f
15 files changed
+24
-38
No files matched your search
@@ -1,7 +1,7 @@
|
||||
# eager-focus
|
||||
|
||||
```
|
||||
Focus the first managed window matching the given exe
|
||||
Focus the first managed window matching the given executable
|
||||
|
||||
Usage: komorebic.exe eager-focus <EXE>
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
# promote-focus
|
||||
|
||||
```
|
||||
Promote the user focus to the top of the tree
|
||||
Promote the user focus to the largest window container
|
||||
|
||||
Usage: komorebic.exe promote-focus
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
```text
|
||||
Set the color for a window border kind
|
||||
Set the colour for a window border kind
|
||||
|
||||
Usage: border-colour [OPTIONS] <R> <G> <B>
|
||||
|
||||
|
||||
@@ -1,11 +1,11 @@
|
||||
```text
|
||||
Set the behavior when focusing in a direction while a monocle container is active
|
||||
Set the behaviour when focusing in a direction while a monocle container is active
|
||||
|
||||
Usage: monocle-focus-behaviour <BEHAVIOUR>
|
||||
|
||||
Arguments:
|
||||
<BEHAVIOUR>
|
||||
Desired monocle focus behavior
|
||||
Desired monocle focus behaviour
|
||||
|
||||
Possible values:
|
||||
- cycle: Cycle the monocle container to the next/previous container in the workspace
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
```text
|
||||
Toggle the behavior when focusing in a direction while a monocle container is active
|
||||
Toggle the behaviour when focusing in a direction while a monocle container is active
|
||||
|
||||
Usage: toggle-monocle-focus-behaviour
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
```text
|
||||
Toggle the behavior for new windows (stacking or dynamic tiling)
|
||||
Toggle the behaviour for new windows (stacking or dynamic tiling)
|
||||
|
||||
Usage: toggle-window-container-behaviour
|
||||
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
```text
|
||||
Toggle the behavior for new windows (stacking or dynamic tiling) for currently focused workspace. If
|
||||
there was no behavior 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: toggle-workspace-window-container-behaviour
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
```text
|
||||
Set the operation behavior when the focused window is not managed
|
||||
Set the operation behaviour when the focused window is not managed
|
||||
|
||||
Usage: unmanaged-window-operation-behaviour <OPERATION_BEHAVIOUR>
|
||||
|
||||
|
||||
@@ -3,12 +3,10 @@
|
||||
```
|
||||
Scroll the Scrolling layout so that the focused column is in the middle of the screen, once
|
||||
|
||||
Only the Scrolling layout scrolls, so this does nothing in the other layouts.
|
||||
|
||||
Usage: komorebic center-focus
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -1,11 +1,7 @@
|
||||
# consume
|
||||
|
||||
```
|
||||
Take the window on one side into the focused column
|
||||
|
||||
Left takes the last window of the column on the left to the top of the focused column, and right
|
||||
takes the first window of the column on the right to the bottom of it. Up and down do nothing. Only
|
||||
the Scrolling layout has columns of several windows, so this does nothing in the other layouts.
|
||||
Take the neighbouring window on one side into the focused column of the Scrolling layout
|
||||
|
||||
Usage: komorebic consume <OPERATION_DIRECTION>
|
||||
|
||||
@@ -15,6 +11,6 @@ Arguments:
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -1,14 +1,13 @@
|
||||
# expel
|
||||
|
||||
```
|
||||
Take the focused window out of its column and into a column of its own
|
||||
|
||||
Only the Scrolling layout has columns of several windows, so this does nothing in the other layouts.
|
||||
Take the focused window out of its column in the Scrolling layout and put it in a column of its own
|
||||
on the right
|
||||
|
||||
Usage: komorebic expel
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -3,14 +3,10 @@
|
||||
```
|
||||
Force the retiling of all managed windows
|
||||
|
||||
Every column of a workspace in the Scrolling layout goes back to the width that
|
||||
scrolling-layout-columns gives, and every window in a column of several goes back to an equal share
|
||||
of its height.
|
||||
|
||||
Usage: komorebic retile
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
Print help
|
||||
|
||||
```
|
||||
@@ -1,13 +1,13 @@
|
||||
# scrolling-layout-columns
|
||||
|
||||
```
|
||||
Set how many columns fit across the Scrolling layout on the focused workspace
|
||||
Set the number of visible columns for the Scrolling layout on the focused workspace
|
||||
|
||||
Usage: komorebic scrolling-layout-columns <COUNT>
|
||||
|
||||
Arguments:
|
||||
<COUNT>
|
||||
Number of columns that fit across the screen
|
||||
Desired number of visible columns
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
# scrolling-layout-full-width
|
||||
|
||||
```
|
||||
Make the focused column of the Scrolling layout as wide as the screen, or put it back
|
||||
Make the focused column of the Scrolling layout as wide as the screen, or put it back to the width
|
||||
that it had
|
||||
|
||||
Usage: komorebic scrolling-layout-full-width
|
||||
|
||||
|
||||
@@ -1,17 +1,13 @@
|
||||
# toggle-column-stack
|
||||
|
||||
```
|
||||
Stack the windows of the focused column, or spread a stack out into a column
|
||||
|
||||
A column of several windows becomes one stack of all of them, which takes the height of the column
|
||||
and shows one window at a time, and the usual stack commands work on it. A stack becomes a column
|
||||
with a window in each slot, in the order of its tabs. Only the Scrolling layout has columns of
|
||||
several windows, so this does nothing in the other layouts.
|
||||
Stack the windows of the focused column of the Scrolling layout, or spread the focused stack out
|
||||
into a column with a window in each slot
|
||||
|
||||
Usage: komorebic toggle-column-stack
|
||||
|
||||
Options:
|
||||
-h, --help
|
||||
Print help (see a summary with '-h')
|
||||
Print help
|
||||
|
||||
```
|
||||
Reference in new issue
Block a user