From 5f19a54debca482793ec121b19299e1a451b0b0f Mon Sep 17 00:00:00 2001 From: Erik Reider <35975961+ErikReider@users.noreply.github.com> Date: Sat, 19 Mar 2022 17:25:43 +0100 Subject: [PATCH] Added man page --- man/waybar-upower.5.scd | 45 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 man/waybar-upower.5.scd diff --git a/man/waybar-upower.5.scd b/man/waybar-upower.5.scd new file mode 100644 index 0000000..b16bca1 --- /dev/null +++ b/man/waybar-upower.5.scd @@ -0,0 +1,45 @@ +waybar-upower(5) + +# NAME + +waybar - upower module + +# DESCRIPTION + +The *upower* module displays the main battery capacity with all other upower +compatible devices in the tooltip. + +# CONFIGURATION + +*icon-size*: ++ + typeof: integer ++ + default: 20 ++ + Defines the size of the icons. + +*hide-if-empty*: ++ + typeof: bool ++ + default: true ++ + Defines visibility of the module if no devices can be found. + +*tooltip*: ++ + typeof: bool ++ + defualt: true ++ + Option to disable tooltip on hover. + +*tooltip-spacing*: ++ + typeof: integer ++ + default: 4 ++ + Defines the spacing between the tooltip device name and device battery ++ + status. + +# EXAMPLES + +``` +"upower": { + "icon-size": 20, + "hide-if-empty": true, + "tooltip": true, + "tooltip-spacing": 20 +} + +```