.\" Generated by scdoc 1.11.3
.\" 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" "5" "2024-04-20"
.PP
.SH NAME
yambar - configuration file
.PP
.SH DESCRIPTION
.PP
A yambar configuration file is a yaml formatted document containing an
associative array named \fIbar\fR.\& You may define other top-level entities
and reference them using anchors.\&
.PP
Besides the normal yaml types, there are a couple of yambar specific
types that are frequently used:
.PP
.PD 0
.IP \(bu 4
\fBfont\fR: this is a comma separated list of fonts in \fIfontconfig\fR
format.\& Example of valid values:
.RS 4
.IP \(bu 4
Font Awesome 6 Brands
.IP \(bu 4
Font Awesome 6 Free:style=solid
.IP \(bu 4
Dina:pixelsize=10:slant=italic
.IP \(bu 4
Dina:pixelsize=10:weight=bold
.RE
.IP \(bu 4
\fBcolor\fR: an rgba hexstring; \fIRRGGBBAA\fR.\& Examples:
.RS 4
.IP \(bu 4
ffffffff: white, no transparency
.IP \(bu 4
000000ff: black, no transparency
.IP \(bu 4
00ff00ff: green, no transparency
.IP \(bu 4
ff000099: red, semi-transparent
.PD
.PP
.RE
.SH FORMAT
.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
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
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
l l l lx.
T{
\fBName\fR
T}	T{
\fBType\fR
T}	T{
\fBReq\fR
T}	T{
\fBDescription\fR
T}
T{
height
T}	T{
int
T}	T{
yes
T}	T{
The height of the bar, in pixels (\fBnot\fR including border)
T}
T{
location
T}	T{
enum
T}	T{
yes
T}	T{
one of \fItop\fR or \fIbottom\fR
T}
T{
background
T}	T{
color
T}	T{
yes
T}	T{
Background color
T}
T{
monitor
T}	T{
string
T}	T{
no
T}	T{
Monitor to place the bar on.\& If not specified, the primary monitor will be used
T}
T{
layer
T}	T{
string
T}	T{
no
T}	T{
Layer to put bar on.\& One of \fIoverlay\fR, \fItop\fR, \fIbottom\fR or \fIbackground\fR.\& Wayland only.\& Default: \fIbottom\fR.\&
T}
T{
left-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, added \fBbefore\fR each module
T}
T{
right-spacing
T}	T{
int
T}	T{
no
T}	T{
Space, in pixels, added \fBafter\fR each module
T}
T{
spacing
T}	T{
int
T}	T{
no
T}	T{
Short-hand for setting both \fIleft-spacing\fR and \fIright-spacing\fR
T}
T{
left-margin
T}	T{
int
T}	T{
no
T}	T{
Left-side margin, in pixels
T}
T{
right-margin
T}	T{
int
T}	T{
no
T}	T{
Right-side margin, in pixels
T}
T{
margin
T}	T{
int
T}	T{
no
T}	T{
Short-hand for setting both \fIleft-margin\fR and \fIright-margin\fR
T}
T{
border
T}	T{
associative array
T}	T{
no
T}	T{
Configures the border around the status bar
T}
T{
border.\&left-width
T}	T{
int
T}	T{
no
T}	T{
Width of the border on the left side, in pixels
T}
T{
border.\&right-width
T}	T{
int
T}	T{
no
T}	T{
Width of the border on the right side, in pixels
T}
T{
border.\&top-width
T}	T{
int
T}	T{
no
T}	T{
Width of the border on the top side, in pixels
T}
T{
border.\&bottom-width
T}	T{
int
T}	T{
no
T}	T{
Width of the border on the bottom side, in pixels
T}
T{
border.\&width
T}	T{
int
T}	T{
no
T}	T{
Short-hand for setting \fIborder.\&left/right/top/bottom-width\fR
T}
T{
border.\&color
T}	T{
color
T}	T{
no
T}	T{
The color of the border
T}
T{
border.\&left-margin
T}	T{
int
T}	T{
no
T}	T{
Left-side margin, in pixels, from screen edge to bar
T}
T{
border.\&right-margin
T}	T{
int
T}	T{
no
T}	T{
Right-side margin, in pixels, from screen edge to bar
T}
T{
border.\&top-margin
T}	T{
int
T}	T{
no
T}	T{
Top margin, in pixels, from screen edge to bar
T}
T{
border.\&bottom-margin
T}	T{
int
T}	T{
no
T}	T{
Bottom margin, in pixels, from screen edge to bar
T}
T{
border.\&margin
T}	T{
int
T}	T{
no
T}	T{
Short-hand for setting \fIborder.\&left/right/top/bottom-margin\fR
T}
T{
font
T}	T{
font
T}	T{
no
T}	T{
Default font to use in modules and particles.\& May also be a comma separated list of several fonts, in which case the first font is the primary font, and the rest fallback fonts.\& These are yambar custom fallback fonts that will be searched before the fontconfig provided fallback list.\&
T}
T{
font-shaping
T}	T{
enum
T}	T{
no
T}	T{
Default setting for font-shaping, for use in particles.\& One of \fIfull\fR or \fInone\fR.\& When set to \fIfull\fR (the default), strings will be "shaped" using HarfBuzz.\& Requires support in fcft.\&
T}
T{
foreground
T}	T{
color
T}	T{
no
T}	T{
Default foreground (text) color to use
T}
T{
trackpad-sensitivity
T}	T{
int
T}	T{
no
T}	T{
How easy it is to trigger wheel-up and wheel-down on-click handlers.\& Higher values means you need to drag your finger a longer distance.\& The default is 30.\&
T}
T{
left
T}	T{
list
T}	T{
no
T}	T{
Left-aligned modules (see \fByambar-modules\fR(5))
T}
T{
center
T}	T{
list
T}	T{
no
T}	T{
Center-aligned modules (see \fByambar-modules\fR(5))
T}
T{
right
T}	T{
list
T}	T{
no
T}	T{
Right-aligned modules (see \fByambar-modules\fR(5))
T}
.TE
.sp 1
.SH EXAMPLES
.PP
Top-oriented bar with a single, right-aligned, module: the \fBclock\fR,
rendered as a simple string displaying only the time (not date).\&
.PP
.nf
.RS 4
bar:
  location: top
  height: 26
  background: 00000066

  right:
    - clock:
        content:
          - string: {text: "{time}"}
.fi
.RE
.PP
.SH FILES
The configuration file is searched for (in this order):
.PP
.PD 0
.IP \(bu 4
\fI$XDG_CONFIG_HOME/yambar/config.\&yml\fR
.IP \(bu 4
\fI$HOME/.\&config/yambar/config.\&yml\fR
.PD
.PP
.SH SEE ALSO
.PP
\fByambar-modules\fR(5), \fByambar-particles\fR(5), \fByambar-tags\fR(5),
\fByambar-decorations\fR(5)