.\" 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 "yambar" "1" "2026\-10\-30"
.PP
.SH NAME
yambar \- modular status panel for X11 and Wayland
.PP
.SH SYNOPSIS
\fByambar\fR [\fIOPTIONS\fR].\&.\&.\&
.PP
.SH OPTIONS
.PP
\fB\-b\fR,\fB\-\-backend\fR={\fBxcb\fR,\fBwayland\fR,\fBauto\fR}
.RS 4
Backend to use.\& The default is \fBauto\fR.\& In this mode, yambar will
look for the environment variable \fIWAYLAND_DISPLAY\fR, and if
available, use the \fBWayland\fR backend.\& If not, the \fBXCB\fR backend is
used.\&
.PP
.RE
\fB\-c\fR,\fB\-\-config\fR=\fIFILE\fR
.RS 4
Use an alternative configuration file instead of the default one.\&
.PP
.RE
\fB\-C\fR,\fB\-\-validate\fR
.RS 4
Verify the configuration and then quit.\& If no errors are detected,
nothing is printed and the exit code is 0.\& If there are errors,
these are printed on stdout and the exit code is non\-zero.\&
.PP
.RE
\fB\-p\fR,\fB\-\-print\-pid\fR=\fIFILE\fR|\fIFD\fR
.RS 4
Print PID to this file, or FD, when successfully started.\& The file
(or FD) is closed immediately after writing the PID.\& When a \fIFILE\fR
as been specified, the file is unlinked exit.\&
.PP
.RE
\fB\-d\fR,\fB\-\-log\-level\fR={\fBinfo\fR,\fBwarning\fR,\fBerror\fR,\fBnone\fR}
.RS 4
Log level, used both for log output on stderr as well as
syslog.\& Default: \fIwarning\fR.\&
.PP
.RE
\fB\-l\fR,\fB\-\-log\-colorize\fR=[{\fBnever\fR,\fBalways\fR,\fBauto\fR}]
.RS 4
Enables or disables colorization of log output on stderr.\&
.PP
.RE
\fB\-s\fR,\fB\-\-log\-no\-syslog\fR
.RS 4
Disables syslog logging.\& Logging is only done on stderr.\&
.PP
.RE
\fB\-v\fR,\fB\-\-version\fR
.RS 4
Show the version number and quit
.PP
.RE
.SH DESCRIPTION
\fByambar\fR is a lightweight and configurable status panel (\fIbar\fR, for
short) for \fBX11\fR and \fBWayland\fR.\&
.PP
It has a number of \fImodules\fR that provide information in the form of
\fItags\fR.\& For example, the \fIclock\fR module has a \fIdate\fR tag that contains
the current date.\&
.PP
The modules do not know how to present the information though.\& This is
instead done by \fIparticles\fR.\& And the user, you, decides which
particles (and thus how to present the data) to use.\&
.PP
Furthermore, each particle can have a \fIdecoration\fR.\& These are things
like a different background, or an graphical underline.\&
.PP
There is \fBno\fR support for images or icons.\& use an icon font
(e.\&g.\& \fBFont Awesome\fR, or \fBMaterial Icons\fR) if you want a graphical
representation.\&
.PP
There are a number of modules and particles builtin.\& More can be added
as plugins.\& You can even write your own!\&
.PP
.SH CONFIGURATION
See \fByambar\fR(5)