yambar - Man Page

configuration file

Description

A yambar configuration file is a yaml formatted document containing an associative array named bar. You may define other top-level entities and reference them using anchors.

Besides the normal yaml types, there are a couple of yambar specific types that are frequently used:

  • font: this is a string in fontconfig format. Example of valid values:

    • Font Awesome 5 Brands
    • Font Awesome 5 Free:style=solid
    • Dina:pixelsize=10:slant=italic
    • Dina:pixelsize=10:weight=bold
  • color: an rgba hexstring; RRGGBBAA. Examples:

    • ffffffff: white, no transparency
    • 000000ff: black, no transparency
    • 00ff00ff: green, no transparency
    • ff000099: red, semi-transparent

Format

NameTypeReqDescription
heightintyesThe height of the bar, in pixels (not including border)
locationenumyesone of top or bottom
backgroundcoloryesBackground color
monitorstringnoMonitor to place the bar on. If not specified, the primary monitor will be used
layerstringnoLayer to put bar on. One of top or bottom. Wayland only
left-spacingintnoSpace, in pixels, added before each module
right-spacingintnoSpace, in pixels, added after each module
spacingintnoShort-hand for setting both left-spacing and right-spacing
left-marginintnoLeft-side margin, in pixels
right-marginintnoRight-side margin, in pixels
marginintnoShort-hand for setting both left-margin and right-margin
borderassociative arraynoConfigures the border around the status bar
border.left-widthintnoWidth of the border on the left side, in pixels
border.right-widthintnoWidth of the border on the right side, in pixels
border.top-widthintnoWidth of the border on the top side, in pixels
border.bottom-widthintnoWidth of the border on the bottom side, in pixels
border.widthintnoShort-hand for setting border.left/right/top/bottom-width
border.colorcolornoThe color of the border
border.left-marginintnoLeft-side margin, in pixels, from screen edge to bar
border.right-marginintnoRight-side margin, in pixels, from screen edge to bar
border.top-marginintnoTop margin, in pixels, from screen edge to bar
border.bottom-marginintnoBottom margin, in pixels, from screen edge to bar
border.marginintnoShort-hand for setting border.left/right/top/bottom-margin
fontfontnoDefault font to use in modules and particles
foregroundcolornoDefault foreground (text) color to use
trackpad-sensitivityintnoHow 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.
leftlistnoLeft-aligned modules (see yambar-modules(5))
centerlistnoCenter-aligned modules (see yambar-modules(5))
rightlistnoRight-aligned modules (see yambar-modules(5))

Examples

Top-oriented bar with a single, right-aligned, module: the clock, rendered as a simple string displaying only the time (not date).

  bar:
    location: top
    height: 26
    background: 00000066

  right:
    - clock:
        content:
          - string: {text: "{time}"}

Files

The configuration file is searched for (in this order):

  • $XDG_CONFIG_HOME/yambar/config.yml
  • $HOME/.config/yambar/config.yml

See Also

yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decorations(5)

Referenced By

yambar(1), yambar-decorations(5).

2022-08-26