diff --git a/meson.build b/meson.build index c3314d9b..a7103b17 100644 --- a/meson.build +++ b/meson.build @@ -163,6 +163,7 @@ if scdoc.found() 'waybar.5.scd', 'waybar-backlight.5.scd', 'waybar-battery.5.scd', + 'waybar-clock.5.scd', ] foreach filename : man_files diff --git a/waybar-clock.5.scd b/waybar-clock.5.scd new file mode 100644 index 00000000..a0272a4f --- /dev/null +++ b/waybar-clock.5.scd @@ -0,0 +1,64 @@ +waybar-clock(5) + +# NAME + +waybar - clock module + +# DESCRIPTION + +The *clock* module displays the current date and time. + +*interval*: ++ + typeof: integer ++ + default: 60 ++ + The interval in which the information gets polled. + +*format*: ++ + typeof: string ++ + default: {:%H:%M} ++ + The format, how the date and time should be displayed. + +*max-length*: ++ + typeof: integer ++ + The maximum length in character the module should display. + +*rotate*: ++ + typeof: integer ++ + Positive value to rotate the text label. + +*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. + +View all valid format options in *strftime(3)*. + +# Example: + +``` +"clock": { + "interval": 60, + "format": "{:%H:%M}", + "max-length": 25 +} + +``` + +# Style + +- *#clock*