From df83404c8c951301eb78e0cb651fc1c625f06573 Mon Sep 17 00:00:00 2001 From: Michael Aquilina Date: Sat, 24 Aug 2019 21:46:56 +0100 Subject: [PATCH] Format headers --- waybar-backlight.5.scd | 7 +++---- waybar-battery.5.scd | 12 +++++++----- waybar-clock.5.scd | 7 ++++--- waybar.5.scd | 8 ++++---- 4 files changed, 18 insertions(+), 16 deletions(-) diff --git a/waybar-backlight.5.scd b/waybar-backlight.5.scd index 765bd8cc..2d971997 100644 --- a/waybar-backlight.5.scd +++ b/waybar-backlight.5.scd @@ -8,7 +8,7 @@ waybar - backlight module The *backlight* module displays the current backlight level. -# Config +# CONFIGURATION *interval* ++ typeof: integer ++ @@ -52,7 +52,7 @@ The *backlight* module displays the current backlight level. typeof: double Threshold to be used when scrolling. -# Example: +# EXAMPLE: ``` "backlight": { @@ -60,9 +60,8 @@ The *backlight* module displays the current backlight level. "format": "{percent}% {icon}", "format-icons": ["", ""] } - ``` -# Style +# STYLE - *#backlight* diff --git a/waybar-battery.5.scd b/waybar-battery.5.scd index 08a9432b..5e2f1d96 100644 --- a/waybar-battery.5.scd +++ b/waybar-battery.5.scd @@ -8,6 +8,8 @@ waybar - battery module The *battery* module displays the current capacity and state (eg. charging) of your battery. +# CONFIGURATION + *bat* ++ typeof: string ++ The battery to monitor, as in /sys/class/power_supply/ instead of auto detect. @@ -68,7 +70,7 @@ The *battery* module displays the current capacity and state (eg. charging) of y default: true ++ Option to disable tooltip on hover. -# Format Replacements: +# FORMAT REPLACEMENTS *{capacity}*: Capacity in percentage @@ -76,7 +78,7 @@ The *battery* module displays the current capacity and state (eg. charging) of y *{time}*: Estimate of time until full or empty. Note that this is based on the power draw at the last refresh time, not an average. -# Custom Formats: +# CUSTOM FORMATS The *battery* module allows to define custom formats based on up to two factors. The best fitting format will be selected. @@ -86,7 +88,7 @@ The *battery* module allows to define custom formats based on up to two factors. *format--*: You can also set a custom format depending on both values. -# States: +# STATES - Every entry (*state*) consists of a ** (typeof: *string*) and a ** (typeof: *integer*). - The state can be addressed as a CSS class in the *style.css*. The name of the CSS class is the ** of the state. Each class gets activated when the current capacity is equal or below the configured **. @@ -94,7 +96,7 @@ The *battery* module allows to define custom formats based on up to two factors. -# Example: +# EXAMPLE ``` "battery": { @@ -110,7 +112,7 @@ The *battery* module allows to define custom formats based on up to two factors. } ``` -# Style +# STYLE - *#battery* - *#battery.* diff --git a/waybar-clock.5.scd b/waybar-clock.5.scd index a0272a4f..e69a397e 100644 --- a/waybar-clock.5.scd +++ b/waybar-clock.5.scd @@ -8,6 +8,8 @@ waybar - clock module The *clock* module displays the current date and time. +# CONFIGURATION + *interval*: ++ typeof: integer ++ default: 60 ++ @@ -48,7 +50,7 @@ The *clock* module displays the current date and time. View all valid format options in *strftime(3)*. -# Example: +# EXAMPLE ``` "clock": { @@ -56,9 +58,8 @@ View all valid format options in *strftime(3)*. "format": "{:%H:%M}", "max-length": 25 } - ``` -# Style +# STYLE - *#clock* diff --git a/waybar.5.scd b/waybar.5.scd index 70f4efe0..727efc1e 100644 --- a/waybar.5.scd +++ b/waybar.5.scd @@ -17,7 +17,7 @@ Valid directories for this file are: A good starting point is the default config found at https://github.com/Alexays/Waybar/blob/master/resources/config. Also a minimal example config can be found on the at the bottom of this man page. -# Bar Config +# BAR CONFIG *layer* ++ typeof: string ++ @@ -74,7 +74,7 @@ e.g. ``` "format": "{}" ``` -# Multiple instances of a module +# MULTIPLE INSTANCES OF A MODULE If you want to have a second instance of a module, you can suffix it by a '#' and a custom name. For example if you want a second battery module, you can add `"battery#bat2"` to your modules. @@ -92,7 +92,7 @@ This could then look something like this *(this is an incomplete example)*: } ``` -# Minimal config +# MINIMAL CONFIG A minimal *config* file could look like this: @@ -115,7 +115,7 @@ A minimal *config* file could look like this: } ``` -# Multi output config +# MULTI OUTPUT CONFIG ## Limit a configuration to some outputs