Skip to content

Commit

Permalink
clarify docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tudurom committed Apr 22, 2020
1 parent 9ea60a4 commit 11062f2
Show file tree
Hide file tree
Showing 6 changed files with 40 additions and 53 deletions.
27 changes: 10 additions & 17 deletions man/waitron.1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" https://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WAITRON" "1" "September 2018" "Windowchef" "Windowchef Manual"
.TH "WAITRON" "1" "April 2020" "Windowchef" "Windowchef Manual"
.
.SH "NAME"
\fBwaitron\fR \- A client for windowchef(1)
Expand Down Expand Up @@ -82,11 +82,11 @@ If the currently focused window is maximized in any way (fully, vertically, hori
.
.TP
\fBwindow_hor_maximize\fR
Horizontally maximize the focused window on the current monitor, preserving its \fIx\fR component\. Leaves a gap at the left and right of the monitor that can be configured\. Execute it again after maximizing to revert the state of the window\.
Horizontally maximize the focused window on the current monitor, preserving its \fIy\fR component\. Leaves a gap at the left and right of the monitor that can be configured\. Execute it again after maximizing to revert the state of the window\.
.
.TP
\fBwindow_ver_maximize\fR
Vertically maximize the focused window on the current monitor, preserving its \fIy\fR component\. Leaves a gap at the top and bottom of the monitor whose width can be configured\. Execute it again after maximizing to revert the state of the window\.
Vertically maximize the focused window on the current monitor, preserving its \fIx\fR component\. Leaves a gap at the top and bottom of the monitor whose width can be configured\. Execute it again after maximizing to revert the state of the window\.
.
.TP
\fBwindow_monocle\fR
Expand All @@ -102,11 +102,11 @@ Moves and resizes the focused windows accordingly to fit in a cell defined by th
.
.TP
\fBwindow_move_in_grid\fR \fIx\fR \fIy\fR
Move a gridded window by \fIx\fR and \fIy\fR grid spaces.
Move a gridded window by \fIx\fR and \fIy\fR grid spaces\.
.
.TP
\fBwindow_resize_in_grid\fR \fIx\fR \fIy\fR
Resize a gridded window by \fIx\fR and \fIy\fR grid spaces.
Resize a gridded window by \fIx\fR and \fIy\fR grid spaces\. Positive values grow, negative values shrink\.
.
.TP
\fBwindow_snap\fR \fIPOSITION\fR
Expand All @@ -122,7 +122,7 @@ Reverse cycle through mapped windows\.
.
.TP
\fBwindow_cycle_in_group\fR
Cycle trough mapped windows that belong to the same group as the focused window\.
Cycle through mapped windows that belong to the same group as the focused window\.
.
.TP
\fBwindow_rev_cycle_in_group\fR
Expand All @@ -138,7 +138,7 @@ Focus the window that was focused before the currently focused window\.
.
.TP
\fBwindow_cardinal_focus\fR \fIDIRECTION\fR
Focus the closest window in a direction, relative to the currently currently focused window\. Does nothing if there is no window focused\.
Focus the closest window in a direction, relative to the currently focused window\. Does nothing if there is no window focused\.
.
.TP
\fBgroup_add_window\fR \fIgroup_nr\fR
Expand Down Expand Up @@ -176,18 +176,11 @@ Activate group \fIgroup_nr\fR and deactivate the rest\.
Quit windowchef with exit_status \fIexit_status\fR\.
.
.TP
\fBwm_change_number_of_groups\fR \fInumber_of_groups\fR
Change the number of maximum groups to \fInumber_of_groups\fR\.
.
.IP
Windows that belong to a group that has a \fIgroup_nr\fR greater or equal to \fInumber_of_groups\fR will become orphaned\.
.
.TP
\fBwm_config\fR \fIkey\fR [\fIvalues\fR\.\.\.]
See \fICONFIGURING\fR\.
.
.SH "QUERYING"
Information about the current state of windowchef is made available through X properties of the root window\. Example:
Information about the current state of windowchef is available through X properties of the root window\. Example:
.
.IP "" 4
.
Expand All @@ -200,7 +193,7 @@ xprop \-root WINDOWCHEF_ACTIVE_GROUPS
.IP "" 0
.
.P
Information about the current state of each managed window is made available through X properties of the window\. Example:
Information about the current state of each managed window is available through X properties of the window\. Example:
.
.IP "" 4
.
Expand Down Expand Up @@ -280,7 +273,7 @@ If true, when the currently focused window is unmapped or closed, \fBwindowchef\
.
.TP
\fBapply_settings\fR \fIBOOL\fR
If true, then some settings will be applied on all windows instead of newly created windows\. True by default\.
If true, some settings will be applied on all windows instead of newly created windows\. True by default\.
.
.TP
\fBreplay_click_on_focus\fR \fIBOOL\fR
Expand Down
28 changes: 13 additions & 15 deletions man/waitron.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

28 changes: 12 additions & 16 deletions man/waitron.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,12 @@ anything on `stdout`.

* `window_hor_maximize`:
Horizontally maximize the focused window on the current monitor, preserving
its <x> component. Leaves a gap at the left and right of the monitor that
its <y> component. Leaves a gap at the left and right of the monitor that
can be configured. Execute it again after maximizing to revert the state of the window.

* `window_ver_maximize`:
Vertically maximize the focused window on the current monitor, preserving
its <y> component. Leaves a gap at the top and bottom of the monitor whose
its <x> component. Leaves a gap at the top and bottom of the monitor whose
width can be configured. Execute it again after maximizing to revert the state of the window.

* `window_monocle`:
Expand All @@ -91,10 +91,11 @@ anything on `stdout`.
Gaps around the windows in the grid can be added along with monitor gaps.

* `window_move_in_grid` <x> <y>:
Move a gridded window by <x> and <y> grid spaces.
Move a gridded window by <x> and <y> grid spaces.

* `window_resize_in_grid` <x> <y>:
Resize a gridded window by <x> and <y> grid spaces.
Resize a gridded window by <x> and <y> grid spaces. Positive values grow,
negative values shrink.

* `window_snap` <POSITION>:
Snap the window on the screen in a position defined by <POSITION>.
Expand All @@ -106,7 +107,7 @@ anything on `stdout`.
Reverse cycle through mapped windows.

* `window_cycle_in_group`:
Cycle trough mapped windows that belong to the same group as the
Cycle through mapped windows that belong to the same group as the
focused window.

* `window_rev_cycle_in_group`:
Expand All @@ -122,7 +123,7 @@ anything on `stdout`.

* `window_cardinal_focus` <DIRECTION>:
Focus the closest window in a direction, relative to the currently
currently focused window. Does nothing if there is no window focused.
focused window. Does nothing if there is no window focused.

* `group_add_window` <group_nr>:
Add the focused window to the <group_nr> group.
Expand Down Expand Up @@ -150,25 +151,19 @@ anything on `stdout`.
* `wm_quit` <exit_status>:
Quit windowchef with exit_status <exit_status>.

* `wm_change_number_of_groups` <number_of_groups>:
Change the number of maximum groups to <number_of_groups>.

Windows that belong to a group that has a <group_nr> greater or equal to
<number_of_groups> will become orphaned.

* `wm_config` <key> [<values>...]:
See [CONFIGURING][].

## QUERYING

Information about the current state of windowchef is made available through
Information about the current state of windowchef is available through
X properties of the root window. Example:

```
xprop -root WINDOWCHEF_ACTIVE_GROUPS
```

Information about the current state of each managed window is made available
Information about the current state of each managed window is available
through X properties of the window. Example:

```
Expand Down Expand Up @@ -225,7 +220,8 @@ are:
will be mapped to screen and assigned to the null group.

* `enable_resize_hints` <BOOL>:
If true, `windowchef` will respect window resize hints as defined by ICCCM. Most terminal emulators should have this feature.
If true, `windowchef` will respect window resize hints as defined by ICCCM.
Most terminal emulators should have this feature.

* `enable_sloppy_focus` <BOOL>:
Enable sloppy focus.
Expand All @@ -247,7 +243,7 @@ are:
previously focused window. See the `window_focus_last` command.

* `apply_settings` <BOOL>:
If true, then some settings will be applied on all windows instead of newly created windows.
If true, some settings will be applied on all windows instead of newly created windows.
True by default.

* `replay_click_on_focus` <BOOL>:
Expand Down
4 changes: 2 additions & 2 deletions man/windowchef.1
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
.\" generated with Ronn/v0.7.3
.\" https://github.com/rtomayko/ronn/tree/0.7.3
.
.TH "WINDOWCHEF" "1" "February 2018" "Windowchef" "Windowchef Manual"
.TH "WINDOWCHEF" "1" "April 2020" "Windowchef" "Windowchef Manual"
.
.SH "NAME"
\fBwindowchef\fR \- A stacking window cooker
Expand Down Expand Up @@ -30,7 +30,7 @@ Print version information\.
Load script from \fIconfig_path\fR instead of \fB$XDG_CONFIG_HOME/windowchef/windowchefrc\fR\.
.
.SH "SEE ALSO"
waitron(1), sxhkd(1), xinit(1), xmmv(1), xmrs(1)
waitron(1), sxhkd(1), xinit(1)
.
.SH "REPORTING BUGS"
\fBwindowchef\fR issue tracker: https://github\.com/tudurom/windowchef/issues
Expand Down
4 changes: 2 additions & 2 deletions man/windowchef.1.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion man/windowchef.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ overridden with the `-c` flag.

## SEE ALSO

waitron(1), sxhkd(1), xinit(1), xmmv(1), xmrs(1)
waitron(1), sxhkd(1), xinit(1)

## REPORTING BUGS

Expand Down

0 comments on commit 11062f2

Please sign in to comment.