.\" Generated by scdoc 1.11.2
.\" Complete documentation for this program is not available as a GNU info page
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.nh
.ad l
.\" Begin generated content:
.TH "yambar-tags" "5" "2022-12-17"
.P
.SH NAME
yambar-tags - configuration file
.P
.SH DESCRIPTION
.P
Tags are the data carriers; it is through tags that modules expose
their information.\& Each module defines its own set of tags.\&
.P
The available tag \fBtypes\fR are:
.P
.TS
allbox;l lx
l lx
l lx
l lx
l lx
l lx
l lx.
T{
\fBType\fR
T}	T{
\fBDescription\fR
T}
T{
string
T}	T{
Value is a string.\& Rendered as-is by the \fIstring\fR particle.\&
T}
T{
int
T}	T{
Value is an integer.\& Rendered in base 10 by the \fIstring\fR particle.\&
T}
T{
bool
T}	T{
Value is true or false.\& Rendered as "true" or "false" by the \fIstring\fR particle
T}
T{
float
T}	T{
Value is a float.\& Rendered in base 10, with two decimal digits by the \fIstring\fR particle
T}
T{
range
T}	T{
Value is an integer, with a minimum and maximum value associated with it.\& By default, the \fIstring\fR particle renders the value.\& The \fB:min\fR or \fB:max\fR suffixes may be added to instead render the minimum or maximum value (\fI"{tag_name:min}"\fR).\&
T}
T{
realtime
T}	T{
Value is an integer that changes in a predictable manner (in "realtime").\& This allows the particle to update itself periodically.\& Only supported by the \fByambar-particle-progress-bar\fR(5).\& Other particles can still render the tag'\&s value.\& And, the \fIstring\fR particle recognizes the \fB:unit\fR suffix, which will be translated to a "s" for a tag with "seconds" resolution, or "ms" for one with "milliseconds" resolution.\&
T}
.TE
.sp 1
.SH FORMATTING
.P
A tag may be followed by one or more formatters that alter the tags
rendition.\&
.P
Formatters are added by appending a '\&:'\& separated list of formatter
names:
.P
.RS 4
"{tag_name:max:hex}"
.P
.RE
In the table below, "kind" describes the type of action performed by
the formatter:
.P
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBformat\fR: changes the representation of the tag'\&s value
.RE
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.IP \(bu 4
.\}
\fBselector\fR: changes what to render

.RE
.P
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.\&
.P
.TS
allbox;l l l lx
l l l lx
l l l lx
l l l lx
l l l lx
l l l lx
l l l lx
l l l lx
l l l lx
l l l lx.
T{
\fBFormatter\fR
T}	T{
\fBKind\fR
T}	T{
\fBDescription\fR
T}	T{
\fBApplies to\fR
T}
T{
\&.\&<number>
T}	T{
format
T}	T{
How many decimals to print
T}	T{
Float tags
T}
T{
hex
T}	T{
format
T}	T{
Renders a tag'\&s value in hex
T}	T{
All tag types
T}
T{
oct
T}	T{
format
T}	T{
Renders a tag'\&s value in octal
T}	T{
All tag types
T}
T{
%
T}	T{
format
T}	T{
Renders a range tag'\&s value as a percentage value
T}	T{
Range tags
T}
T{
kb, mb, gb
T}	T{
format
T}	T{
Renders a tag'\&s value (in decimal) divided by 1000, 1000^2 or 1000^3.\& Note: no unit suffix is appended)
T}	T{
All tag types
T}
T{
kib, mib, gib
T}	T{
format
T}	T{
Same as \fBkb\fR, \fBmb\fR and \fBgb\fR, but divide by 1024^n instead of 1000^n.\&
T}	T{
All tag types
T}
T{
min
T}	T{
selector
T}	T{
Renders a range tag'\&s minimum value
T}	T{
Range tags
T}
T{
max
T}	T{
selector
T}	T{
Renders a range tag'\&s maximum value
T}	T{
Range tags
T}
T{
unit
T}	T{
selector
T}	T{
Renders a realtime tag'\&s unit (e.\&g.\& "s", or "ms")
T}	T{
Realtime tags
T}
.TE
.sp 1