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            This field will be ignored if timezones field is set and have at
29       least one value.
30
31       timezones:
32            typeof: list of strings
33            A list of timezones to use for time display, changed using the
34       scroll wheel.
35            Use "" to represent the system's local timezone.  Using %Z in the
36       format or tooltip format is useful to track which time zone is cur‐
37       rently displayed.
38
39       locale:
40            typeof: string
41            default: inferred from current locale
42            A locale to be used to display the time. Intended to render times
43       in custom timezones with the proper language and format.
44
45       today-format:
46            typeof: string
47            default: <b><u>{}</u></b>
48            The format of today's date in the calendar.
49
50       max-length:
51            typeof: integer
52            The maximum length in character the module should display.
53
54       min-length:
55           typeof: integer
56           The minimum length in characters the module should take up.
57
58       align:
59           typeof: float
60           The alignment of the text, where 0 is left-aligned and 1 is right-
61       aligned. If the module is rotated, it will follow the flow of the text.
62
63       rotate:
64            typeof: integer
65            Positive value to rotate the text label.
66
67       on-click:
68            typeof: string
69            Command to execute when clicked on the module.
70
71       on-click-middle:
72            typeof: string
73            Command to execute when middle-clicked on the module using mouse‐
74       wheel.
75
76       on-click-right:
77            typeof: string
78            Command to execute when you right clicked on the module.
79
80       on-update:
81            typeof: string
82            Command to execute when the module is updated.
83
84       on-scroll-up:
85            typeof: string
86            Command to execute when scrolling up on the module.
87
88       on-scroll-down:
89            typeof: string
90            Command to execute when scrolling down on the module.
91
92       smooth-scrolling-threshold:
93            typeof: double
94            Threshold to be used when scrolling.
95
96       tooltip:
97            typeof: bool
98            default: true
99            Option to disable tooltip on hover.
100
101       View all valid format options in strftime(3).
102

FORMAT REPLACEMENTS

104       {calendar}: Current month calendar {timezoned_time_list}: List of time
105       in the rest timezones, if more than one timezone is set in the config
106

EXAMPLES

108           "clock": {
109               "interval": 60,
110               "format": "{:%H:%M}",
111               "max-length": 25
112           }
113

STYLE

115       •   #clock
116
117
118
119                                  2022-05-23                   waybar-clock(5)