From bddc8703403e37d37f66841cd3421ef6a6406794 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?F=C3=A9lix=20Baylac=20Jacqu=C3=A9?=
 <felix@alternativebit.fr>
Date: Fri, 1 Mar 2024 15:07:58 +0100
Subject: [PATCH] modules/power-profiles-daemon: add man page

There was no way to display the default value of format-icons without
breaking the table :(
---
 man/waybar-power-profiles-daemon.5.scd | 72 ++++++++++++++++++++++++++
 meson.build                            |  2 +-
 2 files changed, 73 insertions(+), 1 deletion(-)
 create mode 100644 man/waybar-power-profiles-daemon.5.scd

diff --git a/man/waybar-power-profiles-daemon.5.scd b/man/waybar-power-profiles-daemon.5.scd
new file mode 100644
index 00000000..435fdbdf
--- /dev/null
+++ b/man/waybar-power-profiles-daemon.5.scd
@@ -0,0 +1,72 @@
+waybar-power-profiles-daemon(5)
+
+# NAME
+
+waybar - power-profiles-daemon module
+
+# DESCRIPTION
+
+The *power-profiles-daemon* module displays the active power-profiles-daemon profile and cycle through the available profiles on click.
+
+# FILES
+
+$XDG_CONFIG_HOME/waybar/config
+
+# CONFIGURATION
+
+
+[- *Option*
+:- *Typeof*
+:- *Default*
+:= *Description*
+|[ *format*
+:[ string
+:[ "{icon}"
+:[ Message displayed on the bar. {icon} and {profile} are respectively substituted with the icon representing the active profile and its full name.
+|[ *tooltip-format*
+:[ string
+:[ "Power profile: {profile}\\nDriver: {driver}"
+:[ Messaged displayed in the module tooltip. {icon} and {profile} are respectively substituted with the icon representing the active profile and its full name.
+|[ *tooltip*
+:[ bool
+:[ true
+:[ Display the tooltip.
+|[ *format-icons*
+:[ object
+:[ See default value in the example below.
+:[ Icons used to represent the various power-profile. *Note*: the default configuration uses the font-awesome icons. You may want to override it if you don't have this font installed on your system.
+
+
+# CONFIGURATION EXAMPLES
+
+Compact display (default config):
+
+```
+"power_profiles_daemon": {
+  "format": "{icon}",
+  "tooltip-format": "Power profile: {profile}\nDriver: {driver}",
+  "tooltip": true,
+  "format-icons": {
+    "default": "",
+    "performance": "",
+    "balanced": "",
+    "power-saver": ""
+  }
+}
+```
+
+Display the full profile name:
+
+```
+"power_profiles_daemon": {
+  "format": "{icon}   {profile}",
+  "tooltip-format": "Power profile: {profile}\nDriver: {driver}",
+  "tooltip": true,
+  "format-icons": {
+    "default": "",
+    "performance": "",
+    "balanced": "",
+    "power-saver": ""
+  }
+}
+```
diff --git a/meson.build b/meson.build
index 10c82620..4ce7363d 100644
--- a/meson.build
+++ b/meson.build
@@ -222,6 +222,7 @@ if is_linux
         'man/waybar-cpu.5.scd',
         'man/waybar-memory.5.scd',
         'man/waybar-systemd-failed-units.5.scd',
+        'man/waybar-power-profiles-daemon.5.scd',
     )
 elif is_dragonfly or is_freebsd or is_netbsd or is_openbsd
     add_project_arguments('-DHAVE_CPU_BSD', language: 'cpp')
@@ -578,4 +579,3 @@ if clangtidy.found()
             '-p', meson.project_build_root()
         ] + src_files)
 endif
-