.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "waybar-clock" "5" "2023-02-28"
.P
.SH NAME
.P
waybar - clock module
.P
.SH DESCRIPTION
.P
The \fBclock\fR module displays the current date and time.\&
.P
.SH CONFIGURATION
.P
\fBinterval\fR: 
.br
	typeof: integer 
.br
	default: 60 
.br
	The interval in which the information gets polled.\&
.P
\fBformat\fR: 
.br
	typeof: string 
.br
	default: {:%H:%M} 
.br
	The format, how the date and time should be displayed.\& 
.br
	It uses the format of the date library.\& See https://howardhinnant.\&github.\&io/date/date.\&html#to_stream_formatting for details.\&
.P
\fBtimezone\fR: 
.br
	typeof: string 
.br
	default: inferred local timezone 
.br
	The timezone to display the time in, e.\&g.\& America/New_York.\& 
.br
	This field will be ignored if \fBtimezones\fR field is set and have at least one value.\&
.P
\fBtimezones\fR: 
.br
	typeof: list of strings 
.br
	A list of timezones to use for time display, changed using the scroll wheel.\& 
.br
	Use "" to represent the system'\&s local timezone.\&  Using %Z in the format or tooltip format is useful to track which time zone is currently displayed.\&
.P
\fBlocale\fR: 
.br
	typeof: string 
.br
	default: inferred from current locale 
.br
	A locale to be used to display the time.\& Intended to render times in custom timezones with the proper language and format.\&
.P
\fBtoday-format\fR: 
.br
	typeof: string 
.br
	default: <b><u>{}</u></b> 
.br
	The format of today'\&s date in the calendar.\&
.P
\fBmax-length\fR: 
.br
	typeof: integer 
.br
	The maximum length in character the module should display.\&
.P
\fBmin-length\fR: 
.br
    typeof: integer 
.br
    The minimum length in characters the module should take up.\&
.P
\fBalign\fR: 
.br
    typeof: float 
.br
    The alignment of the text, where 0 is left-aligned and 1 is right-aligned.\& If the module is rotated, it will follow the flow of the text.\&
.P
\fBrotate\fR: 
.br
	typeof: integer 
.br
	Positive value to rotate the text label.\&
.P
\fBon-click\fR: 
.br
	typeof: string 
.br
	Command to execute when clicked on the module.\&
.P
\fBon-click-middle\fR: 
.br
	typeof: string 
.br
	Command to execute when middle-clicked on the module using mousewheel.\&
.P
\fBon-click-right\fR: 
.br
	typeof: string 
.br
	Command to execute when you right clicked on the module.\&
.P
\fBon-update\fR: 
.br
	typeof: string 
.br
	Command to execute when the module is updated.\&
.P
\fBon-scroll-up\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling up on the module.\&
.P
\fBon-scroll-down\fR: 
.br
	typeof: string 
.br
	Command to execute when scrolling down on the module.\&
.P
\fBsmooth-scrolling-threshold\fR: 
.br
	typeof: double 
.br
	Threshold to be used when scrolling.\&
.P
\fBtooltip\fR: 
.br
	typeof: bool 
.br
	default: true 
.br
	Option to disable tooltip on hover.\&
.P
View all valid format options in \fBstrftime(3)\fR.\&
.P
.SH FORMAT REPLACEMENTS
.P
\fB{calendar}\fR: Current month calendar
\fB{timezoned_time_list}\fR: List of time in the rest timezones, if more than one timezone is set in the config
.P
.SH EXAMPLES
.P
.nf
.RS 4
"clock": {
    "interval": 60,
    "format": "{:%H:%M}",
    "max-length": 25
}
.fi
.RE
.P
.SH STYLE
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fB#clock\fR
.RE