external/yambar
1
0
Fork 1
mirror of https://codeberg.org/dnkl/yambar.git synced 2025-04-20 03:35:41 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

doc: yambar-tags: document the :hex and :oct suffixes

Browse source
This commit is contained in:
Daniel Eklöf 2020-09-24 17:03:36 +02:00
parent a5faf4896a
commit 41d0a17ea5
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
1 changed files with 11 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

14
doc/yambar-tags.5.scd
View file

@ -25,14 +25,22 @@ The available tag *types* are:
| range | range
: Value is an integer, with a minimum and maximum value associated : Value is an integer, with a minimum and maximum value associated
with it. By default, the _string_ particle renders the value. The with it. By default, the _string_ particle renders the value. The
_:min_ or _:max_ suffixes by be added to instead render the mininum *:min* or *:max* suffixes may be added to instead render the
or maximum value (_\"{tag_name:min}\"_). mininum or maximum value (_\"{tag_name:min}\"_).
| realtime | realtime
: Value is an integer that changes in a predictable manner (in : Value is an integer that changes in a predictable manner (in
"realtime"). This allows the particle to update itself "realtime"). This allows the particle to update itself
periodically. Only supported by the periodically. Only supported by the
*yambar-particle-progress-bar*(5). Other particles can still render *yambar-particle-progress-bar*(5). Other particles can still render
the tag's value. And, the _string_ particle recognizes the _:unit_ the tag's value. And, the _string_ particle recognizes the *:unit*
suffix, which will be translated to a "s" for a tag with "seconds" suffix, which will be translated to a "s" for a tag with "seconds"
resolution, or "ms" for one with "milliseconds" resolution. resolution, or "ms" for one with "milliseconds" resolution.
# FORMATTING
As mentioned above, each tag type has a default representation that is
used when the tag is rendered by a string particle.
All integer, floating point and boolean tag types can be modified to
instead be rendered in hexadecimal or octal form, by appending either
the *:hex* or *:oct* suffixes. For example, _\"{tag_name:hex}\"_.