Skip to content

Commit 29d6eaa

Browse files
committed
modules/power-profiles-daemon: add man page
There was no way to display the default value of format-icons without breaking the table :(
1 parent 09bb6a0 commit 29d6eaa

File tree

2 files changed

+73
-1
lines changed

2 files changed

+73
-1
lines changed
+72
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
waybar-power-profiles-daemon(5)
2+
3+
# NAME
4+
5+
waybar - power-profiles-daemon module
6+
7+
# DESCRIPTION
8+
9+
The *power-profiles-daemon* module displays the active power-profiles-daemon profile and cycle through the available profiles on click.
10+
11+
# FILES
12+
13+
$XDG_CONFIG_HOME/waybar/config
14+
15+
# CONFIGURATION
16+
17+
18+
[- *Option*
19+
:- *Typeof*
20+
:- *Default*
21+
:= *Description*
22+
|[ *format*
23+
:[ string
24+
:[ "{icon}"
25+
:[ Message displayed on the bar. {icon} and {profile} are respectively substituted with the icon representing the active profile and its full name.
26+
|[ *tooltip-format*
27+
:[ string
28+
:[ "Power profile: {profile}\\nDriver: {driver}"
29+
:[ Messaged displayed in the module tooltip. {icon} and {profile} are respectively substituted with the icon representing the active profile and its full name.
30+
:[ *tooltip*
31+
:[ bool
32+
:[ true
33+
:[ Display the tooltip.
34+
|[ *format-icons*
35+
:[ object
36+
:[ See default value in the example below.
37+
:[ 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.
38+
39+
40+
# CONFIGURATION EXAMPLES
41+
42+
Compact display (default config):
43+
44+
```
45+
"power_profiles_daemon": {
46+
"format": "{icon}",
47+
"tooltip-format": "Power profile: {profile}\nDriver: {driver}",
48+
"tooltip": true,
49+
"format-icons": {
50+
"default": "",
51+
"performance": "",
52+
"balanced": "",
53+
"power-saver": ""
54+
}
55+
}
56+
```
57+
58+
Display the full profile name:
59+
60+
```
61+
"power_profiles_daemon": {
62+
"format": "{icon} {profile}",
63+
"tooltip-format": "Power profile: {profile}\nDriver: {driver}",
64+
"tooltip": true,
65+
"format-icons": {
66+
"default": "",
67+
"performance": "",
68+
"balanced": "",
69+
"power-saver": ""
70+
}
71+
}
72+
```

meson.build

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,7 @@ if is_linux
222222
'man/waybar-cpu.5.scd',
223223
'man/waybar-memory.5.scd',
224224
'man/waybar-systemd-failed-units.5.scd',
225+
'man/waybar-power-profiles-daemon.5.scd',
225226
)
226227
elif is_dragonfly or is_freebsd or is_netbsd or is_openbsd
227228
add_project_arguments('-DHAVE_CPU_BSD', language: 'cpp')
@@ -578,4 +579,3 @@ if clangtidy.found()
578579
'-p', meson.project_build_root()
579580
] + src_files)
580581
endif
581-

0 commit comments

Comments
 (0)