From dbc7471f83331a265367f908b8edeeaa391359cf Mon Sep 17 00:00:00 2001
From: dmitry <shemeldima2@yandex.ru>
Date: Sat, 1 Jul 2023 02:13:36 +0300
Subject: [PATCH] add docs

---
 man/waybar-hyprland-workspaces.5.scd | 59 ++++++++++++++++++++++++++++
 man/waybar-wlr-workspaces.5.scd      |  4 +-
 2 files changed, 61 insertions(+), 2 deletions(-)
 create mode 100644 man/waybar-hyprland-workspaces.5.scd

diff --git a/man/waybar-hyprland-workspaces.5.scd b/man/waybar-hyprland-workspaces.5.scd
new file mode 100644
index 0000000..0678fb2
--- /dev/null
+++ b/man/waybar-hyprland-workspaces.5.scd
@@ -0,0 +1,59 @@
+waybar-wlr-workspaces(5)
+
+# NAME
+
+waybar - hyprland workspaces module
+
+# DESCRIPTION
+
+The *workspaces* module displays the currently used workspaces in hyprland compositor.
+
+# CONFIGURATION
+
+Addressed by *hyprland/workspaces*
+
+*format*: ++
+	typeof: string ++
+	default: {id} ++
+	The format, how information should be displayed.
+
+*format-icons*: ++
+	typeof: array ++
+	Based on the workspace id and state, the corresponding icon gets selected. See *icons*.
+
+# FORMAT REPLACEMENTS
+
+*{id}*: id of workspace assigned by compositor
+
+*{icon}*: Icon, as defined in *format-icons*.
+
+# ICONS
+
+Additional to workspace name matching, the following *format-icons* can be set.
+
+- *default*: Will be shown, when no string match is found.
+- *active*: Will be shown, when workspace is active
+
+# EXAMPLES
+
+```
+"wlr/workspaces": {
+	"format": "{name}: {icon}",
+	"format-icons": {
+		"1": "",
+		"2": "",
+		"3": "",
+		"4": "",
+		"5": "",
+		"active": "",
+		"default": ""
+	},
+	"sort-by-number": true
+}
+```
+
+# Style
+
+- *#workspaces*
+- *#workspaces button*
+- *#workspaces button.active*
diff --git a/man/waybar-wlr-workspaces.5.scd b/man/waybar-wlr-workspaces.5.scd
index 169112f..4a256f0 100644
--- a/man/waybar-wlr-workspaces.5.scd
+++ b/man/waybar-wlr-workspaces.5.scd
@@ -65,7 +65,7 @@ Addressed by *wlr/workspaces*
 Additional to workspace name matching, the following *format-icons* can be set.
 
 - *default*: Will be shown, when no string match is found.
-- *focused*: Will be shown, when workspace is focused
+- *active*: Will be shown, when workspace is active
 
 # EXAMPLES
 
@@ -78,7 +78,7 @@ Additional to workspace name matching, the following *format-icons* can be set.
 		"3": "",
 		"4": "",
 		"5": "",
-		"focused": "",
+		"active": "",
 		"default": ""
 	},
 	"sort-by-number": true