.\" Generated by scdoc 1.11.5
.\" 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\-user" "5" "2026\-11\-05" "waybar\-user" "User Manual"
.PP
.SH NAME
.PP
waybar \- user module
.PP
.SH DESCRIPTION
.PP
The \fBuser\fR module displays the currently logged in user, the system uptime and,
optionally, the user'\&s avatar image.\&
.PP
.SH CONFIGURATION
.PP
Addressed by \fBuser\fR
.PP
.TS
allbox;c c c c
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l
l l l l.
T{
\fBOption\fR
T}	T{
\fBTypeof\fR
T}	T{
\fBDefault\fR
T}	T{
\fBDescription\fR
T}
T{
\fBinterval\fR
T}	T{
integer
T}	T{
60
T}	T{
The interval in which the information gets polled
T}
T{
\fBformat\fR
T}	T{
string
T}	T{
\fB{user} {work_H}:{work_M}\fR
T}	T{
The format, how the information should be displayed.\& See \fBFORMAT REPLACEMENTS\fR below
T}
T{
\fBicon\fR
T}	T{
bool
T}	T{
false
T}	T{
When enabled, displays the user'\&s avatar image next to the label
T}
T{
\fBavatar\fR
T}	T{
string
T}	T{
\fB$HOME/.\&face\fR
T}	T{
Path to the avatar image to display.\& Only used when \fBicon\fR is enabled.\& When unset, the default path \fB$HOME/.\&face\fR is used
T}
T{
\fBheight\fR
T}	T{
integer
T}	T{
20
T}	T{
The height of the avatar image in pixels
T}
T{
\fBwidth\fR
T}	T{
integer
T}	T{
20
T}	T{
The width of the avatar image in pixels
T}
T{
\fBopen\-on\-click\fR
T}	T{
bool
T}	T{
false
T}	T{
When enabled, left\-clicking the module opens the user'\&s home directory (or \fBopen\-path\fR) with the default file manager
T}
T{
\fBopen\-path\fR
T}	T{
string
T}	T{

T}	T{
Overrides the path that is opened when \fBopen\-on\-click\fR is enabled.\& When empty, the user'\&s home directory is used
T}
T{
\fBrotate\fR
T}	T{
integer
T}	T{

T}	T{
Positive value to rotate the text label (in 90 degree increments)
T}
T{
\fBtooltip\fR
T}	T{
bool
T}	T{
true
T}	T{
Option to enable tooltip on hover
T}
.TE
.sp 1
.SH FORMAT REPLACEMENTS
.PP
.PD 0
.IP \(bu 4
\fB{user}\fR: The login name of the currently logged in user, in uppercase
.IP \(bu 4
\fB{work_d}\fR: Whole days the system has been up
.IP \(bu 4
\fB{work_H}\fR: Hours part of the system uptime (00\-23)
.IP \(bu 4
\fB{work_M}\fR: Minutes part of the system uptime (00\-59)
.IP \(bu 4
\fB{work_S}\fR: Seconds part of the system uptime (00\-59)
.IP \(bu 4
\fB{up_H}\fR: Hour the system was booted (00\-23)
.IP \(bu 4
\fB{up_M}\fR: Minute the system was booted (00\-59)
.IP \(bu 4
\fB{up_d}\fR: Day of the month the system was booted (01\-31)
.IP \(bu 4
\fB{up_m}\fR: Month the system was booted (01\-12)
.IP \(bu 4
\fB{up_Y}\fR: Year the system was booted
.PD
.PP
.SH EXAMPLES
.PP
.nf
.RS 4
"user": {
	"format": "{user} up {work_H}:{work_M}:{work_S}",
	"interval": 60,
	"icon": true,
	"avatar": "/home/alice/\&.face",
	"height": 24,
	"width": 24,
	"open\-on\-click": true
}
.fi
.RE
.PP
.SH STYLE
.PP
.PD 0
.IP \(bu 4
\fB#user\fR
.PD
.PP
.SH AUTHOR
.PP
Alexis Rouillard <contact@arouillard.\&fr>