Skip to content

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
FelixKratz committed Dec 13, 2023
1 parent a430b13 commit 46dbc91
Show file tree
Hide file tree
Showing 4 changed files with 45 additions and 18 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,5 @@
bin
.cache
compile_commands.json
*.wiki
*.sh
33 changes: 24 additions & 9 deletions docs/borders.1
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
.nh
.ad l
.\" Begin generated content:
.TH "borders" "1" "2023-11-28"
.TH "borders" "1" "2023-12-13"
.P
.SH NAME
.P
Expand All @@ -17,10 +17,10 @@ JankyBorders - A window border system for macOS
.P
.SH DESCRIPTION
.P
\fBJankyBorders\fR 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.\&
\fBJankyBorders\fR 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.\&
.P
.SH OPTIONS
.P
Expand Down Expand Up @@ -51,12 +51,19 @@ Determines the width of the border.\& For example, width=5.\&0 creates a border
If set to \fIon\fR, the border will be drawn with retina resolution.\&
.P
.RE
\fBblacklist=<application_list>\fR
.RS 4
The applications specified here are excluded from being bordered.\& For
example, blacklist="Safari,kitty" excludes Safari and kitty from being
bordered.\&
.P
.RE
If an instance of \fBborders\fR is already running, subsequent invocations will
update the existing process with the new arguments.\&
.P
If no instance of \fBborders\fR is running and no arguments are supplied, we
try to execute the file at ~/.\&config/borders/bordersrc where a configuration
command could be issued.\&
If no instance of \fBborders\fR is running and no arguments are supplied, we try
to execute a file at ~/.\&config/borders/bordersrc where a configuration command
could be issued.\&
.P
.SH NOMENCLATURE
.P
Expand Down Expand Up @@ -87,7 +94,15 @@ The color argument can take the special values:
.br
\fIgradient(top_right=0xAARRGGBB,bottom_left=0xAARRGGBB)\fR
.br
to create a gradient border.\& (You might need to quote these arguments depending on your shell)
\fIglow(0xAARRGGBB)\fR
.br
(You might need to quote these arguments depending on your shell)
.P
.RE
\fB<application_list>\fR
.RS 4
A comma separated list of application names.\& This argument should be
quoted.\&
.P
.RE
.SH BUGS
Expand Down
26 changes: 18 additions & 8 deletions docs/borders.1.scd
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@ JankyBorders - A window border system for macOS

# 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.
*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

Expand All @@ -34,12 +34,17 @@ being faster than comparable tools.
*hidpi=<boolean>*
If set to _on_, the border will be drawn with retina resolution.

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

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 the file at ~/.config/borders/bordersrc where a configuration
command could be issued.
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

Expand All @@ -60,7 +65,12 @@ command could be issued.
The color argument can take the special values: ++
_gradient(top_left=0xAARRGGBB,bottom_right=0xAARRGGBB)_ ++
_gradient(top_right=0xAARRGGBB,bottom_left=0xAARRGGBB)_ ++
to create a gradient border. (You might need to quote these arguments depending on your shell)
_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

Expand Down
2 changes: 1 addition & 1 deletion src/parse.c
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ uint32_t parse_settings(struct settings* settings, int count, char** arguments)
update_mask |= BORDER_UPDATE_MASK_INACTIVE;
}
}
else if (str_starts_with(arguments[i], "blacklist")) {
else if (str_starts_with(arguments[i], blacklist)) {
if (parse_blacklist(&settings->blacklist,
arguments[i] + strlen(blacklist))) {
update_mask |= BORDER_UPDATE_MASK_RECREATE_ALL;
Expand Down

0 comments on commit 46dbc91

Please sign in to comment.