Skip to content

Man Page

Felix Kratz edited this page Feb 20, 2024 · 4 revisions

date: 2024-02-20 section: 1 title: borders

NAME

JankyBorders - A window border system for macOS

SYNOPSIS

borders [options]

DESCRIPTION

JankyBorders is a lightweight tool designed to add colored borders to user windows on macOS 14.0+. It enhances the user experience by visually highlighting the currently focused window without relying on the accessibility API, thereby being faster than comparable tools.

OPTIONS

style=<style>

Specifies the style of the border (either round or square)

active_color=<color>

Sets the border color for the focused window (format: 0xAARRGGBB). For instance, active_color=0xff00ff00 creates a green border.

inactive_color=<color>

Sets the border color for all windows not in focus.

background_color=<color>

Sets the background fill color for all windows (only 0xAARRGGBB arguments supported).

blur_radius=<float>

Sets the blur radius applied to the borders or backgrounds with transparency.

width=<float>

Determines the width of the border. For example, width=5.0 creates a border 5.0 points wide.

hidpi=<boolean>

If set to on, the border will be drawn with retina resolution.

ax_focus=<boolean>

If set to on, the (slower) accessibility API is used to resolve the focused window. Enabled automatically if the (parent) process has accessibility permissions. Improves compatibility with other tools modifying window properties on a system level (e.g. yabai).

blacklist=<application_list>

The applications specified here are excluded from being bordered. For example, blacklist="Safari,kitty" excludes Safari and kitty from being bordered.

whitelist=<application_list>

Once this list is populated, only applications listed here are considered for receiving a border. If the whitelist is empty (default) it is inactive.

If an instance of borders is already running, subsequent invocations will update the existing process with the new arguments.

If no instance of borders is running and no arguments are supplied, we try to execute a file at ~/.config/borders/bordersrc where a configuration command could be issued.

NOMENCLATURE

<float>

A floating point number.

<boolean>

Either on or off.

<style>

Either round or square.

<color>

A color formatted as 0xAARRGGBB, where A is the alpha channel, R the red channel, G the green channel and B the blue channel. All constituents take a base 16 number, i.e. 0-F.

The color argument can take the special values:
gradient(top_left=0xAARRGGBB,bottom_right=0xAARRGGBB)
gradient(top_right=0xAARRGGBB,bottom_left=0xAARRGGBB)
glow(0xAARRGGBB)
(You might need to quote these arguments depending on your shell)

<application_list>

A comma separated list of application names. This argument should be quoted.

BUGS

Report them at https://github.com/FelixKratz/JankyBorders/issues.

MAINTAINERS

Felix Kratz <felix.kratz@tu-dortmund.de>