yambar - Man Page

modular status panel for X11 and Wayland

Synopsis

yambar [Options]...

Options

-b,--backend={xcb,wayland,auto}

Backend to use. The default is auto. In this mode, yambar will look for the environment variable WAYLAND_DISPLAY, and if available, use the Wayland backend. If not, the XCB backend is used.

-c,--config=FILE

Use an alternative configuration file instead of the default one.

-C,--validate

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.

-p,--print-pid=FILE|FD

Print PID to this file, or FD, when successfully started. The file (or FD) is closed immediately after writing the PID. When a FILE as been specified, the file is unlinked exit.

-d,--log-level={info,warning,error,none}

Log level, used both for log output on stderr as well as syslog. Default: info.

-l,--log-colorize=[{never,always,auto}]

Enables or disables colorization of log output on stderr.

-s,--log-no-syslog

Disables syslog logging. Logging is only done on stderr.

-v,--version

Show the version number and quit

Description

yambar is a lightweight and configurable status panel (bar, for short) for X11 and Wayland.

It has a number of modules that provide information in the form of tags. For example, the clock module has a date tag that contains the current date.

The modules do not know how to present the information though. This is instead done by particles. And the user, you, decides which particles (and thus how to present the data) to use.

Furthermore, each particle can have a decoration. These are things like a different background, or an graphical underline.

There is no support for images or icons. use an icon font (e.g. Font Awesome, or Material Icons) if you want a graphical representation.

There are a number of modules and particles builtin. More can be added as plugins. You can even write your own!

Configuration

See yambar(5)

Info

2022-08-26