Provided by: yambar_1.9.0-1_amd64 
NAME
yambar-tags - 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:
┌─────────┬───────────────────────────────────────────────────────────────────────────────┐
│Type │ Description │
├─────────┼───────────────────────────────────────────────────────────────────────────────┤
│string │ Value is a string. Rendered as-is by the string particle. │
├─────────┼───────────────────────────────────────────────────────────────────────────────┤
│int │ Value is an integer. Rendered in base 10 by the string particle. │
├─────────┼───────────────────────────────────────────────────────────────────────────────┤
│bool │ Value is true or false. Rendered as "true" or "false" by the string particle │
├─────────┼───────────────────────────────────────────────────────────────────────────────┤
│float │ Value is a float. Rendered in base 10, with two decimal digits by the string │
│ │ particle │
├─────────┼───────────────────────────────────────────────────────────────────────────────┤
│range │ Value 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}"). │
├─────────┼───────────────────────────────────────────────────────────────────────────────┤
│realtime │ Value 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.
┌──────────────┬──────────┬─────────────────────┬─────────────────────────────────────────┐
│Formatter │ Kind │ Description │ Applies to │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│.<number> │ format │ How many decimals │ Float tags │
│ │ │ to print │ │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│hex │ format │ Renders a tag's │ All tag types │
│ │ │ value in hex │ │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│oct │ format │ Renders a tag's │ All tag types │
│ │ │ value in octal │ │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│% │ format │ Renders a range │ Range tags │
│ │ │ tag's value as a │ │
│ │ │ percentage value │ │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│kb, mb, gb │ format │ Renders a tag's │ All tag types │
│ │ │ value (in decimal) │ │
│ │ │ divided by 1000, │ │
│ │ │ 1000^2 or 1000^3. │ │
│ │ │ Note: no unit │ │
│ │ │ suffix is appended) │ │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│kib, mib, gib │ format │ Same as kb, mb and │ All tag types │
│ │ │ gb, but divide by │ │
│ │ │ 1024^n instead of │ │
│ │ │ 1000^n. │ │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│min │ selector │ Renders a range │ Range tags │
│ │ │ tag's minimum value │ │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│max │ selector │ Renders a range │ Range tags │
│ │ │ tag's maximum value │ │
├──────────────┼──────────┼─────────────────────┼─────────────────────────────────────────┤
│unit │ selector │ Renders a realtime │ Realtime tags │
│ │ │ tag's unit (e.g. │ │
│ │ │ "s", or "ms") │ │
└──────────────┴──────────┴─────────────────────┴─────────────────────────────────────────┘
2022-12-17 yambar-tags(5)