1waybar-clock(5)               File Formats Manual              waybar-clock(5)
2
3
4

NAME

6       waybar - clock module
7

DESCRIPTION

9       The clock module displays the current date and time.
10

CONFIGURATION

12       interval:
13            typeof: integer
14            default: 60
15            The interval in which the information gets polled.
16
17       format:
18            typeof: string
19            default: {:%H:%M}
20            The format, how the date and time should be displayed.
21            It uses the format of the date library. See https://howardhin‐
22       nant.github.io/date/date.html#to_stream_formatting for details.
23
24       timezone:
25            typeof: string
26            default: inferred local timezone
27            The timezone to display the time in, e.g. America/New_York.
28
29       timezones:
30            typeof: list of strings
31            A list of timezones to use for time display, changed using the
32       scroll wheel.
33            Use "" to represent the system's local timezone.  Using %Z in the
34       format or tooltip format is useful to track which time zone is cur‐
35       rently displayed.
36
37       locale:
38            typeof: string
39            default: inferred from current locale
40            A locale to be used to display the time. Intended to render times
41       in custom timezones with the proper language and format.
42
43       today-format:
44            typeof: string
45            default: <b><u>{}</u></b>
46            The format of today's date in the calendar.
47
48       max-length:
49            typeof: integer
50            The maximum length in character the module should display.
51
52       min-length:
53           typeof: integer
54           The minimum length in characters the module should take up.
55
56       align:
57           typeof: float
58           The alignment of the text, where 0 is left-aligned and 1 is right-
59       aligned. If the module is rotated, it will follow the flow of the text.
60
61       rotate:
62            typeof: integer
63            Positive value to rotate the text label.
64
65       on-click:
66            typeof: string
67            Command to execute when clicked on the module.
68
69       on-click-middle:
70            typeof: string
71            Command to execute when middle-clicked on the module using mouse‐
72       wheel.
73
74       on-click-right:
75            typeof: string
76            Command to execute when you right clicked on the module.
77
78       on-update:
79            typeof: string
80            Command to execute when the module is updated.
81
82       on-scroll-up:
83            typeof: string
84            Command to execute when scrolling up on the module.
85
86       on-scroll-down:
87            typeof: string
88            Command to execute when scrolling down on the module.
89
90       smooth-scrolling-threshold:
91            typeof: double
92            Threshold to be used when scrolling.
93
94       View all valid format options in strftime(3).
95

FORMAT REPLACEMENTS

97       {calendar}: Current month calendar
98

EXAMPLES

100           "clock": {
101               "interval": 60,
102               "format": "{:%H:%M}",
103               "max-length": 25
104           }
105

STYLE

107       •   #clock
108
109
110
111                                  2021-11-02                   waybar-clock(5)