doc: clock

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)