yambar-tags - Man Page

configuration file

Description

Tags are the data carriers; it is through tags that modules expose their information. Each module defines its own set of tags.

The available tag types are:

TypeDescription
stringValue is a string. Rendered as-is by the string particle.
intValue is an integer. Rendered in base 10 by the string particle.
boolValue is true or false. Rendered as "true" or "false" by the string particle
floatValue is a float. Rendered in base 10, with two decimal digits by the string particle
rangeValue is an integer, with a minimum and maximum value associated with it. By default, the string particle renders the value. The :min or :max suffixes may be added to instead render the minimum or maximum value ("{tag_name:min}").
realtimeValue is an integer that changes in a predictable manner (in "realtime"). This allows the particle to update itself periodically. Only supported by the yambar-particle-progress-bar(5). Other particles can still render the tag's value. And, the string particle recognizes the :unit suffix, which will be translated to a "s" for a tag with "seconds" resolution, or "ms" for one with "milliseconds" resolution.

Formatting

A tag may be followed by one or more formatters that alter the tags rendition.

Formatters are added by appending a ':' separated list of formatter names:

"{tag_name:max:hex}"

In the table below, "kind" describes the type of action performed by the formatter:

  • format: changes the representation of the tag's value
  • selector: changes what to render

In general, formatters of the same kind cannot be combined; if multiple formatters of the same kind are specified, the last one will be used.

FormatterKindDescriptionApplies to]
hexformatRenders a tag's value in hexAll tag types
octformatRenders a tag's value in octalAll tag types
%formatRenders a range tag's value as a percentage valueRange tags
kb, mb, gbformatRenders a tag's value (in decimal) divided by 1024, 1024^2 or 1024^3. Note: no unit suffix is appended)All tag types
kib, mib, gibformatSame as kb, mb and gb, but divide by 1000^n instead of 1024^n.All tag types
minselectorRenders a range tag's minimum valueRange tags
maxselectorRenders a range tag's maximum valueRange tags
unitselectorRenders a realtime tag's unit (e.g. "s", or "ms")Realtime tags

Referenced By

yambar(5), yambar-modules(5), yambar-modules-alsa(5), yambar-modules-backlight(5), yambar-modules-battery(5), yambar-modules-clock(5), yambar-modules-cpu(5), yambar-modules-foreign-toplevel(5), yambar-modules-i3(5), yambar-modules-label(5), yambar-modules-mem(5), yambar-modules-mpd(5), yambar-modules-network(5), yambar-modules-removables(5), yambar-modules-river(5), yambar-modules-script(5), yambar-modules-sway-xkb(5), yambar-modules-xkb(5), yambar-modules-xwindow(5), yambar-particles(5).

2022-08-26