Skip to content

Commit

Permalink
#148 #1430 border configuration and documentation update
Browse files Browse the repository at this point in the history
  • Loading branch information
@koekeishiya
koekeishiya committed Sep 21, 2022
1 parent bdbf374 commit a0384c3
Show file tree
Hide file tree
Showing 7 changed files with 203 additions and 33 deletions.
58 changes: 55 additions & 3 deletions doc/yabai.1
View file
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,17 @@ Use the specified configuration file.
Install scripting\-addition. Must be run as root.
.br
Path is /System/Library/ScriptingAdditions on macOS High Sierra, and /Library/ScriptingAdditions on Mojave and newer.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-uninstall\-sa\fP
.RS 4
Uninstall scripting\-addition. Must be run as root.
.br
Path is /System/Library/ScriptingAdditions on macOS High Sierra, and /Library/ScriptingAdditions on Mojave and newer.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-check\-sa\fP
Expand All @@ -80,6 +84,8 @@ Returns a zero exit\-code if the latest version of the scripting\-addition is in
\fB\-\-load\-sa\fP
.RS 4
Loads the scripting\-addition into Dock.app.
.br
System Integrity Protection must be partially disabled.
.RE
.SH "DEFINITIONS"
.sp
Expand Down Expand Up @@ -173,51 +179,77 @@ Specify whether managed windows should become the first or second leaf\-node.
\fBwindow_topmost\fP [\fI<BOOL_SEL>\fP]
.RS 4
Make floating windows stay on top.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fBwindow_shadow\fP [\fI<BOOL_SEL>|float\fP]
.RS 4
Draw shadow for windows.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fBwindow_opacity\fP [\fI<BOOL_SEL>\fP]
.RS 4
Enable opacity for windows.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fBwindow_opacity_duration\fP [\fI<floating point number>\fP]
.RS 4
Duration of transition between active / normal opacity.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fBwindow_animation_duration\fP [\fI<floating point number>\fP]
.RS 4
Duration of window frame animation. If 0.0, the change in dimension is not animated.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fBactive_window_opacity\fP [\fI<FLOAT_SEL>\fP]
.RS 4
Opacity of the focused window.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fBnormal_window_opacity\fP [\fI<FLOAT_SEL>\fP]
.RS 4
Opacity of an unfocused window.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fBwindow_border\fP [\fI<BOOL_SEL>\fP]
.RS 4
Draw border for windows.
.RE
.sp
\fBwindow_border_hidpi\fP [\fI<BOOL_SEL>\fP]
.RS 4
Draw border in high resolution mode; for High Dots Per Inch ("Retina") displays.
.br
HiDPI uses significantly more memory.
.RE
.sp
\fBwindow_border_blur\fP [\fI<BOOL_SEL>\fP]
.RS 4
Blur border allowing it to act as a backdrop for transparent windows.
.RE
.sp
\fBwindow_border_width\fP [\fI<even integer number>\fP]
.RS 4
Width of window borders. If the given width is an odd number, it will be incremented by 1.
Width of window border. If the given width is an odd number, it will be incremented by 1.
.RE
.sp
\fBwindow_border_radius\fP [\fI<integer number>\fP]
.RS 4
Radius of window borders.
Radius of window border.
.RE
.sp
\fBactive_window_border_color\fP [\fI0xAARRGGBB\fP]
Expand All @@ -237,7 +269,7 @@ Color of the \fBwindow \-\-insert\fP message selection.
.sp
\fBsplit_ratio\fP [\fI<FLOAT_SEL>\fP]
.RS 4
Default split ratio.
Specify the size distribution when a window is split.
.RE
.sp
\fBsplit_type\fP [\fIvertical|horizontal|auto\fP]
Expand Down Expand Up @@ -325,35 +357,47 @@ yabai \-m space [\fI<SPACE_SEL>\fP] \fI<COMMAND>\fP
\fB\-\-focus\fP \fI<SPACE_SEL>\fP
.RS 4
Focus the given space.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-create\fP [\fI<SPACE_SEL>\fP]
.RS 4
Create a new space on the display of the given space. If none specified, use the selected space instead.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-destroy\fP [\fI<SPACE_SEL>\fP]
.RS 4
Remove the given space. If none specified, use the selected space instead.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-move\fP \fI<SPACE_SEL>\fP
.RS 4
Move position of the selected space to the position of the given space.
.br
The selected space and given space must both belong to the same display.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-swap\fP \fI<SPACE_SEL>\fP
.RS 4
Swap the selected space with the given space.
.br
The selected space and given space must both belong to the same display.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-display\fP \fI<DISPLAY_SEL>\fP
.RS 4
Send the selected space to the given display.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-balance\fP [\fIx\-axis|y\-axis\fP]
Expand Down Expand Up @@ -455,18 +499,24 @@ If type is \fIrel\fP the split ratio of the selected window is changed by \fIdr\
\fB\-\-toggle\fP \fIfloat|sticky|topmost|pip|shadow|border|split|zoom\-parent|zoom\-fullscreen|native\-fullscreen|expose\fP
.RS 4
Toggle the given property of the selected window.
.br
The following properties require System Integrity Protection to be partially disabled: sticky, topmost, pip, shadow.
.RE
.sp
\fB\-\-layer\fP \fI<LAYER>\fP
.RS 4
Set the stacking layer of the selected window.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-opacity\fP \fI<floating point number>\fP
.RS 4
Set the opacity of the selected window. The window will no longer be eligible for automatic change in opacity upon focus change.
.br
Specify the value \fI0.0\fP to reset back to full opacity OR have it be automatically managed through focus changes.
.br
System Integrity Protection must be partially disabled.
.RE
.sp
\fB\-\-display\fP \fI<DISPLAY_SEL>\fP
Expand Down Expand Up @@ -626,6 +676,8 @@ WINDOW
All registered rules that match the given filter will apply to a window in the order they were added.
.br
If multiple rules specify a value for the same argument, the latter rule will override that value as it was applied last.
.br
The following properties require System Integrity Protection to be partially disabled: sticky, layer, opacity.
.SS "General Syntax"
.sp
yabai \-m rule \fI<COMMAND>\fP
Expand Down
74 changes: 51 additions & 23 deletions doc/yabai.asciidoc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,17 +47,21 @@ Options

*--install-sa*::
Install scripting-addition. Must be run as root. +
Path is /System/Library/ScriptingAdditions on macOS High Sierra, and /Library/ScriptingAdditions on Mojave and newer.
Path is /System/Library/ScriptingAdditions on macOS High Sierra, and /Library/ScriptingAdditions on Mojave and newer. +
System Integrity Protection must be partially disabled.


*--uninstall-sa*::
Uninstall scripting-addition. Must be run as root. +
Path is /System/Library/ScriptingAdditions on macOS High Sierra, and /Library/ScriptingAdditions on Mojave and newer.
Path is /System/Library/ScriptingAdditions on macOS High Sierra, and /Library/ScriptingAdditions on Mojave and newer. +
System Integrity Protection must be partially disabled.

*--check-sa*::
Returns a zero exit-code if the latest version of the scripting-addition is installed.

*--load-sa*::
Loads the scripting-addition into Dock.app.
Loads the scripting-addition into Dock.app. +
System Integrity Protection must be partially disabled.

Definitions
-----------
Expand Down Expand Up @@ -132,34 +136,48 @@ Global Settings
Specify whether managed windows should become the first or second leaf-node.

*window_topmost* ['<BOOL_SEL>']::
Make floating windows stay on top.
Make floating windows stay on top. +
System Integrity Protection must be partially disabled.

*window_shadow* ['<BOOL_SEL>|float']::
Draw shadow for windows.
Draw shadow for windows. +
System Integrity Protection must be partially disabled.

*window_opacity* ['<BOOL_SEL>']::
Enable opacity for windows.
Enable opacity for windows. +
System Integrity Protection must be partially disabled.

*window_opacity_duration* ['<floating point number>']::
Duration of transition between active / normal opacity.
Duration of transition between active / normal opacity. +
System Integrity Protection must be partially disabled.

*window_animation_duration* ['<floating point number>']::
Duration of window frame animation. If 0.0, the change in dimension is not animated.
Duration of window frame animation. If 0.0, the change in dimension is not animated. +
System Integrity Protection must be partially disabled.

*active_window_opacity* ['<FLOAT_SEL>']::
Opacity of the focused window.
Opacity of the focused window. +
System Integrity Protection must be partially disabled.

*normal_window_opacity* ['<FLOAT_SEL>']::
Opacity of an unfocused window.
Opacity of an unfocused window. +
System Integrity Protection must be partially disabled.

*window_border* ['<BOOL_SEL>']::
Draw border for windows.

*window_border_hidpi* ['<BOOL_SEL>']::
Draw border in high resolution mode; for High Dots Per Inch ("Retina") displays. +
HiDPI uses significantly more memory.

*window_border_blur* ['<BOOL_SEL>']::
Blur border allowing it to act as a backdrop for transparent windows.

*window_border_width* ['<even integer number>']::
Width of window borders. If the given width is an odd number, it will be incremented by 1.
Width of window border. If the given width is an odd number, it will be incremented by 1.

*window_border_radius* ['<integer number>']::
Radius of window borders.
Radius of window border.

*active_window_border_color* ['0xAARRGGBB']::
Color of the border of the focused window.
Expand All @@ -171,7 +189,7 @@ Global Settings
Color of the *window --insert* message selection.

*split_ratio* ['<FLOAT_SEL>']::
Default split ratio.
Specify the size distribution when a window is split.

*split_type* ['vertical|horizontal|auto']::
Specify how a window should be split. +
Expand Down Expand Up @@ -241,24 +259,30 @@ COMMAND
^^^^^^^

*--focus* '<SPACE_SEL>'::
Focus the given space.
Focus the given space. +
System Integrity Protection must be partially disabled.

*--create* ['<SPACE_SEL>']::
Create a new space on the display of the given space. If none specified, use the selected space instead.
Create a new space on the display of the given space. If none specified, use the selected space instead. +
System Integrity Protection must be partially disabled.

*--destroy* ['<SPACE_SEL>']::
Remove the given space. If none specified, use the selected space instead.
Remove the given space. If none specified, use the selected space instead. +
System Integrity Protection must be partially disabled.

*--move* '<SPACE_SEL>'::
Move position of the selected space to the position of the given space. +
The selected space and given space must both belong to the same display.
The selected space and given space must both belong to the same display. +
System Integrity Protection must be partially disabled.

*--swap* '<SPACE_SEL>'::
Swap the selected space with the given space. +
The selected space and given space must both belong to the same display.
The selected space and given space must both belong to the same display. +
System Integrity Protection must be partially disabled.

*--display* '<DISPLAY_SEL>'::
Send the selected space to the given display.
Send the selected space to the given display. +
System Integrity Protection must be partially disabled.

*--balance* ['x-axis|y-axis']::
Adjust the split ratios on the selected space so that all windows along the given axis occupy the same area. If no axis is specified, use both.
Expand Down Expand Up @@ -326,14 +350,17 @@ COMMAND
If type is 'rel' the split ratio of the selected window is changed by 'dr', otherwise 'dr' will become the new split ratio. A positive/negative delta will increase/decrease the size of the left-child.

*--toggle* 'float|sticky|topmost|pip|shadow|border|split|zoom-parent|zoom-fullscreen|native-fullscreen|expose'::
Toggle the given property of the selected window.
Toggle the given property of the selected window. +
The following properties require System Integrity Protection to be partially disabled: sticky, topmost, pip, shadow.

*--layer* '<LAYER>'::
Set the stacking layer of the selected window.
Set the stacking layer of the selected window. +
System Integrity Protection must be partially disabled.

*--opacity* '<floating point number>'::
Set the opacity of the selected window. The window will no longer be eligible for automatic change in opacity upon focus change. +
Specify the value '0.0' to reset back to full opacity OR have it be automatically managed through focus changes.
Specify the value '0.0' to reset back to full opacity OR have it be automatically managed through focus changes. +
System Integrity Protection must be partially disabled.

*--display* '<DISPLAY_SEL>'::
Send the selected window to the given display.
Expand Down Expand Up @@ -467,7 +494,8 @@ Rule
~~~~

All registered rules that match the given filter will apply to a window in the order they were added. +
If multiple rules specify a value for the same argument, the latter rule will override that value as it was applied last.
If multiple rules specify a value for the same argument, the latter rule will override that value as it was applied last. +
The following properties require System Integrity Protection to be partially disabled: sticky, layer, opacity.

General Syntax
^^^^^^^^^^^^^^
Expand Down
8 changes: 5 additions & 3 deletions examples/yabairc
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,13 @@ yabai -m config \
active_window_opacity 1.0 \
normal_window_opacity 0.90 \
window_opacity off \
window_border_width 4 \
window_border_radius 12 \
insert_feedback_color 0xffd75f5f \
active_window_border_color 0xff775759 \
normal_window_border_color 0xff555555 \
insert_feedback_color 0xffd75f5f \
window_border_width 4 \
window_border_radius 12 \
window_border_blur off \
window_border_hidpi on \
window_border off \
split_ratio 0.50 \
split_type auto \
Expand Down
Loading

0 comments on commit a0384c3

Please sign in to comment.