From f7c9a1a47e89207056c0b7f97d8eaf25db7a6950 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Daniel=20Ekl=C3=B6f?= <daniel@ekloef.se>
Date: Mon, 22 Apr 2019 10:44:41 +0200
Subject: [PATCH] doc: clock

---
 doc/f00bar-modules.5.scd | 42 ++++++++++++++++++++++++++++++++++++++++
 1 file changed, 42 insertions(+)

diff --git a/doc/f00bar-modules.5.scd b/doc/f00bar-modules.5.scd
index 6e06ddb..077b335 100644
--- a/doc/f00bar-modules.5.scd
+++ b/doc/f00bar-modules.5.scd
@@ -181,6 +181,48 @@ bar:
           string: {text: "BAT: {capacity}% {estimate}"}
 ```
 
+# CLOCK
+
+This module provides the current date and time.
+
+## TAGS
+
+[[ *Name*
+:[ *Type*
+:[ *Description*
+|  time
+:  string
+:  Current time, formatted using the _time-format_ attribute
+|  date
+:  string
+:  Current date, formatted using the _date-format_ attribute
+
+## CONFIGURATION
+
+[[ *Name*
+:[ *Type*
+:[ *Req*
+:[ *Description*
+|  time-format
+:  string
+:  no
+:  *strftime* formatter for the _time_ tag (default=*%H:%M*)
+|  date-format
+:  string
+:  no
+:  *strftime* formatter for the _date_ date (default=*%x*)
+
+## EXAMPLES
+
+```
+bar:
+  left:
+    - clock:
+        time-format: "%H:%M %Z"
+        content:
+          string: {text: "{date} {time}"}
+```
+
 # SEE ALSO
 
 *f00bar-particles*(5), *f00bar-tags*(5), *f00bar-decorations*(5)