.\" Generated by scdoc 1.11.3
.\" 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 "yambar-modules-clock" "5" "2024-04-20"
.PP
.SH NAME
clock - This module provides the current date and time
.PP
.SH TAGS
.PP
.TS
allbox;l l lx
l l lx
l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
time
T}	T{
string
T}	T{
Current time, formatted using the \fItime-format\fR attribute
T}
T{
date
T}	T{
string
T}	T{
Current date, formatted using the \fIdate-format\fR attribute
T}
.TE
.sp 1
.SH CONFIGURATION
.PP
.TS
allbox;l l l lx
l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
time-format
T}	T{
string
T}	T{
no
T}	T{
\fBstrftime\fR formatter for the \fItime\fR tag (default=\fB%H:%M\fR)
T}
T{
date-format
T}	T{
string
T}	T{
no
T}	T{
\fBstrftime\fR formatter for the \fIdate\fR date (default=\fB%x\fR)
T}
T{
utc
T}	T{
bool
T}	T{
no
T}	T{
Use GMT instead of local timezone (default=false)
T}
.TE
.sp 1
.SH EXAMPLES
.PP
.nf
.RS 4
bar:
  left:
    - clock:
        time-format: "%H:%M %Z"
        content:
          string: {text: "{date} {time}"}
.fi
.RE
.PP
.SH SEE ALSO
.PP
\fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5), \fByambar-decorations\fR(5)
.PP