.\" 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-decorations" "5" "2022-12-17"
.P
.SH NAME
yambar-decorations - configuration file
.P
.SH DESCRIPTION
.P
Decorations are optional additions to particles, enabling you to
e.\&g.\& change the background color of the entire particle, draw an
underline and so on.\&
.P
Decorations are applied to the particle'\&s margins as well.\&
.P
All decorations define their own configuration attributes, and there
are no common attributes.\&
.P
.SH BACKGROUND
.P
This decoration sets the particles background color.\&
.P
.SS CONFIGURATION
.P
.TS
allbox;l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
color
T}	T{
color
T}	T{
yes
T}	T{
The background color.\& See \fByambar\fR(5) for format.\&
T}
.TE
.sp 1
.SS EXAMPLES
.P
.nf
.RS 4
content:
  string:
    deco:
      background:
        color: 00ff00ff
.fi
.RE
.P
.SH UNDERLINE
.P
This decoration renders a line of configurable size and color at the
bottom of the particle.\&
.P
.SS CONFIGURATION
.P
.TS
allbox;l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
size
T}	T{
int
T}	T{
yes
T}	T{
The size (height/thickness) of the line, in pixels
T}
T{
color
T}	T{
color
T}	T{
yes
T}	T{
The color of the line.\& See \fByambar\fR(5) for format.\&
T}
.TE
.sp 1
.SS EXAMPLES
.P
.nf
.RS 4
content:
  string:
    deco:
      underline:
        size: 2
        color: ff0000ff
.fi
.RE
.P
.P
.SH OVERLINE
.P
Similar to \fIunderline\fR, this decoration renders a line of configurable
size and color at the top of the particle.\&
.P
.SS CONFIGURATION
.P
.TS
allbox;l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
size
T}	T{
int
T}	T{
yes
T}	T{
The size (height/thickness) of the line, in pixels
T}
T{
color
T}	T{
color
T}	T{
yes
T}	T{
The color of the line.\& See \fByambar\fR(5) for format.\&
T}
.TE
.sp 1
.SS EXAMPLES
.P
.nf
.RS 4
content:
  string:
    deco:
      overline:
        size: 2
        color: ff0000ff
.fi
.RE
.P
.P
.SH BORDER
.P
This decoration renders a border of configurable size (i.\&e border
width) around the particle.\&
.P
.SS CONFIGURATION
.P
.TS
allbox;l l l lx
l l l lx
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
color
T}	T{
color
T}	T{
yes
T}	T{
The color of the line.\& See \fByambar\fR(5) for format.\&
T}
T{
size
T}	T{
int
T}	T{
no
T}	T{
Border width, in pixels.\& Defaults to 1px.\&
T}
.TE
.sp 1
.SS EXAMPLES
.P
.nf
.RS 4
content:
  string:
    deco:
      border:
        size: 2
        color: ff0000ff
.fi
.RE
.P
.P
.SH STACK
.P
This particles combines multiple decorations.\&
.P
.SS CONFIGURATION
.P
No configuration attributes available.\& The \fIstack\fR is just a \fBlist\fR of
the decorations that should be combined.\&
.P
.SS EXAMPLES
.P
.nf
.RS 4
content:
  string:
    deco:
      stack:
        - background: \&.\&.\&.
        - underline: \&.\&.\&.
.fi
.RE
.P
.SH SEE ALSO
.P
\fByambar-particles\fR(5)