yambar-tags(5)

🦋 yambar-tags(5) 🦋

Okay bestie, this is the yambar-tags(5) page from the File Formats Manual, and it’s literally the tea on how tags work in yambar. 💖

🌸 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:

• 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 tag’s rendition.

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

"{tag_name:max:hex}"

In the formatter breakdown 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. Periodt. 💅

🎀 Formatter vibes 🎀

• [0]<number>[.] — Kind: format. Applies to: Numeric tags (integer and floats). The width reserved to the field. The leading 0 is optional and indicates zero padding, as opposed to space padding. The trailing . is also optional. ✨
• .<number> — Kind: format. Applies to: Float tags. How many decimals to print.
• [0]<N>[.]<M> — Kind: format. Applies to: N: numeric tags, M: float tags. Combined version of the two previous formatters.
• hex — Kind: format. Applies to: All tag types. Renders a tag’s value in hex.
• oct — Kind: format. Applies to: All tag types. Renders a tag’s value in octal.
• % — Kind: format. Applies to: Range tags. Renders a range tag’s value as a percentage value. 📊
• kb, mb, gb — Kind: format. Applies to: All tag types. Renders a tag’s value (in decimal) divided by 1000, 1000^2 or 1000^3. Note: no unit suffix is appended. 🧮
• kib, mib, gib — Kind: format. Applies to: All tag types. Same as kb, mb and gb, but divide by 1024^n instead of 1000^n. 💾
• min — Kind: selector. Applies to: Range tags. Renders a range tag’s minimum value. 🔽
• max — Kind: selector. Applies to: Range tags. Renders a range tag’s maximum value. 🔼
• unit — Kind: selector. Applies to: Realtime tags. Renders a realtime tag’s unit (e.g. "s", or "ms"). ⏲️

🔥 EXAMPLES 🔥

• A numeric (float or int) tag with at least 3 digits, zero-padded if necessary:

{tag:03}

• A float tag with 2 decimals:

{tag:.2}

• A "byte count" tag in gigabytes:

{tag:gib}GB

---

💖 That’s the whole thing, bestie. Source/version: yambar-tags(5) · manual: File Formats Manual · date: 2024-04-22 — go make your bar iconic. 🫶✨