From 45ac3ea0a592734910a9b391b0783a0d302ff3a7 Mon Sep 17 00:00:00 2001 From: Tobias Manske Date: Thu, 18 Apr 2024 15:39:07 +0200 Subject: [PATCH] docs --- include/util/command.hpp | 1 + man/waybar-custom.5.scd | 9 ++++++++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/include/util/command.hpp b/include/util/command.hpp index 4b9decaa..3567055e 100644 --- a/include/util/command.hpp +++ b/include/util/command.hpp @@ -5,6 +5,7 @@ #include #include #include +#include #ifdef __linux__ #include diff --git a/man/waybar-custom.5.scd b/man/waybar-custom.5.scd index a62c9312..b0172524 100644 --- a/man/waybar-custom.5.scd +++ b/man/waybar-custom.5.scd @@ -132,7 +132,7 @@ This should look like this: The *class* parameter also accepts an array of strings. -If nothing or an invalid option is specified, Waybar expects i3blocks style output. Values are *newline* separated. +If nothing is specified, Waybar expects i3blocks style output. Values are *newline* separated. This should look like this: ``` @@ -149,6 +149,13 @@ $text\\n$tooltip\\n$class* *{icon}*: An icon from 'format-icons' according to percentage. +All fields present in the returned json can be used in the *format* field. +In the following example, *$myvalue* can be accessed via the *{myfield}* +placeholder. +``` +{"text": "$text", ..., "myfield": "$myvalue" } +``` + # EXAMPLES ## Spotify: