From 247589efbb4079dab13b3b0dc5ef46020cb6b071 Mon Sep 17 00:00:00 2001
From: Guillaume Maudoux <layus.on@gmail.com>
Date: Wed, 25 Sep 2019 09:07:46 +0200
Subject: [PATCH] Add some documentation for disks

---
 man/waybar-disk.5.scd | 93 +++++++++++++++++++++++++++++++++++++++++++
 meson.build           |  1 +
 2 files changed, 94 insertions(+)
 create mode 100644 man/waybar-disk.5.scd

diff --git a/man/waybar-disk.5.scd b/man/waybar-disk.5.scd
new file mode 100644
index 0000000..2a69cf4
--- /dev/null
+++ b/man/waybar-disk.5.scd
@@ -0,0 +1,93 @@
+waybar-disk(5)
+
+# NAME
+
+waybar - disk module
+
+# DESCRIPTION
+
+The *disk* module displays the current disk space used.
+
+# CONFIGURATION
+
+Addressed by *disk*
+
+*path*: ++
+	typeof: string ++
+	default: "/" ++
+	Any path residing in the filesystem or mountpoint for which the information should be displayed.
+
+*interval*: ++
+	typeof: integer++
+	default: 30 ++
+	The interval in which the information gets polled.
+
+*format*: ++
+	typeof: string ++
+	default: "{percentage_used}%" ++
+	The format, how information should be displayed.
+
+*rotate*: ++
+	typeof: integer ++
+	Positive value to rotate the text label.
+
+*max-length*: ++
+	typeof: integer ++
+	The maximum length in character the module should display.
+
+*on-click*: ++
+	typeof: string ++
+	Command to execute when clicked on the module.
+
+*on-click-right*: ++
+	typeof: string ++
+	Command to execute when you right clicked on the module.
+
+*on-scroll-up*: ++
+	typeof: string ++
+	Command to execute when scrolling up on the module.
+
+*on-scroll-down*: ++
+	typeof: string ++
+	Command to execute when scrolling down on the module.
+
+*smooth-scrolling-threshold*: ++
+	typeof: double ++
+	Threshold to be used when scrolling.
+
+*tooltip*: ++
+	typeof: bool ++
+	default: true ++
+	Option to disable tooltip on hover.
+
+*tooltip-format*: ++
+	typeof: string ++
+	default: "{used} out of {total} used ({percentage_used}%)" ++
+	The format of the information displayed in the tooltip.
+
+# FORMAT REPLACEMENTS
+
+*{percentage_used}*: Percentage of disk in use.
+
+*{percentage_free}*: Percentage of free disk space
+
+*{total}*: Total amount of space on the disk, partition or mountpoint.
+
+*{used}*: Amount of used disk space.
+
+*{free}*: Amount of available disk space for normal users.
+
+*{path}*: The path specified in the configuration.
+
+# EXAMPLES
+
+```
+"disk": {
+	"interval": 30,
+	"format": "{percentage_free}% free on {path}",
+}
+```
+
+# STYLE
+
+- *#disk*
diff --git a/meson.build b/meson.build
index fa07cfb..b0d99b9 100644
--- a/meson.build
+++ b/meson.build
@@ -184,6 +184,7 @@ if scdoc.found()
         'waybar-clock.5.scd',
         'waybar-cpu.5.scd',
         'waybar-custom.5.scd',
+        'waybar-disk.5.scd',
         'waybar-idle-inhibitor.5.scd',
         'waybar-memory.5.scd',
         'waybar-mpd.5.scd',