From bc201fd0eb72000daf90b385a25f02e2d89231f1 Mon Sep 17 00:00:00 2001
From: asas1asas200 <asas1asas200@gmail.com>
Date: Wed, 31 Aug 2022 02:27:30 +0800
Subject: [PATCH] doc(sway/scratchpad): add man page

---
 man/waybar-sway-scratchpad.5.scd | 64 ++++++++++++++++++++++++++++++++
 man/waybar.5.scd.in              |  1 +
 meson.build                      |  1 +
 3 files changed, 66 insertions(+)
 create mode 100644 man/waybar-sway-scratchpad.5.scd

diff --git a/man/waybar-sway-scratchpad.5.scd b/man/waybar-sway-scratchpad.5.scd
new file mode 100644
index 00000000..11fc32c0
--- /dev/null
+++ b/man/waybar-sway-scratchpad.5.scd
@@ -0,0 +1,64 @@
+waybar-sway-scratchpad(5)
+
+# NAME
+
+waybar - sway scratchpad module
+
+# DESCRIPTION
+
+The *scratchpad* module displays the scratchpad status in Sway
+
+# CONFIGURATION
+
+Addressed by *sway/scratchpad*
+
+*format*: ++
+	typeof: string ++
+	default: {icon} {count} ++
+	The format, how information should be displayed.
+
+*show-empty*: ++
+	typeof: bool ++
+	default: false ++
+	Option to show module when scratchpad is empty.
+
+*format-icons*: ++
+	typeof: array/object ++
+	Based on the current scratchpad window counts, the corresponding icon gets selected.
+
+*tooltip*: ++
+	typeof: bool ++
+	default: true ++
+	Option to disable tooltip on hover.
+
+*tooltip-format*: ++
+	typeof: string ++
+	default: {app}: {title} ++
+	The format, how information in the tooltip should be displayed.
+
+# FORMAT REPLACEMENTS
+
+*{icon}*: Icon, as defined in *format-icons*.
+
+*{count}*: Number of windows in the scratchpad.
+
+*{app}*: Name of the application in the scratchpad.
+
+*{title}*: Title of the application in the scratchpad.
+
+# EXAMPLES
+
+```
+"sway/scratchpad": {
+    "format": "{icon} {count}",
+    "show-empty": false,
+    "format-icons": ["", ""],
+    "tooltip": true,
+    "tooltip-format": "{app}: {title}"
+}
+```
+
+# STYLE
+
+- *#scratchpad*
+- *#scratchpad.empty*
diff --git a/man/waybar.5.scd.in b/man/waybar.5.scd.in
index fafc2b36..54340f21 100644
--- a/man/waybar.5.scd.in
+++ b/man/waybar.5.scd.in
@@ -273,6 +273,7 @@ A module group is defined by specifying a module named "group/some-group-name".
 - *waybar-river-window(5)*
 - *waybar-states(5)*
 - *waybar-sway-mode(5)*
+- *waybar-sway-scratchpad(5)*
 - *waybar-sway-window(5)*
 - *waybar-sway-workspaces(5)*
 - *waybar-wlr-taskbar(5)*
diff --git a/meson.build b/meson.build
index d1442ec5..9fdabb2c 100644
--- a/meson.build
+++ b/meson.build
@@ -365,6 +365,7 @@ if scdoc.found()
         'waybar-river-window.5.scd',
         'waybar-sway-language.5.scd',
         'waybar-sway-mode.5.scd',
+        'waybar-sway-scratchpad.5.scd',
         'waybar-sway-window.5.scd',
         'waybar-sway-workspaces.5.scd',
         'waybar-temperature.5.scd',