Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add waybar-styles(5) manual page #3127

Merged
merged 1 commit into from
Apr 10, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 34 additions & 0 deletions man/waybar-styles.5.scd.in
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
waybar-styles(5)

# NAME

waybar-styles - using stylesheets for waybar

# DESCRIPTION

Waybar uses Cascading Style Sheets (CSS) to configure its appearance.

It uses the first file found in this search order:

- *$XDG_CONFIG_HOME/waybar/style.css*
- *~/.config/waybar/style.css*
- *~/waybar/style.css*
- */etc/xdg/waybar/style.css*
- *@sysconfdir@/xdg/waybar/style.css*

# EXAMPLE

An example user-controlled stylesheet that just changes the color of the clock to be green on black, while keeping the rest of the system config the same would be:

```
@import url("file:///etc/xdg/waybar/style.css")

#clock {
background: #000000;
color: #00ff00;
}
```

# SEE ALSO

- *waybar(5)*
3 changes: 3 additions & 0 deletions man/waybar.5.scd.in
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ Valid locations for this file are:
A good starting point is the default configuration found at https://github.com/Alexays/Waybar/blob/master/resources/config.jsonc
Also, a minimal example configuration can be found at the bottom of this man page.

The visual display elements for waybar use a CSS stylesheet, see *waybar-styles(5)* for details.

# BAR CONFIGURATION

*layer* ++
Expand Down Expand Up @@ -347,3 +349,4 @@ A group may hide all but one element, showing them only on mouse hover. In order
# SEE ALSO

*sway-output(5)*
*waybar-styles(5)"
8 changes: 8 additions & 0 deletions meson.build
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,14 @@ if scdoc.found()
}
)

man_files += configure_file(
input: 'man/waybar-styles.5.scd.in',
output: 'waybar-styles.5.scd',
configuration: {
'sysconfdir': prefix / sysconfdir
}
)

fs = import('fs')
mandir = get_option('mandir')
foreach file : man_files
Expand Down
Loading