yambar/README.md

F00bar

Index

1. Configuration

Configuration

Overview

F00bar is configured using YAML, in ~/.config/f00bar/config.yml. It must define a top-level dictionary named bar:

bar:
  height: 26
  location: top
  background: 000000ff

Types

There are a couple types used that are specific to f00bar.

• 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 transparancy
  • 000000ff: black, no transparancy
  • 00ff00ff: green, no transparancy
  • ff000099: red, semi-transparent

Bar

• height (int, required): the height of the bar, in pixels. Note that the bar will always occupy the entire width of the monitor.
• location (enum, required): one of top or bottom. Should be self-explanatory.
• background (color, required): background color, in rgba. Thus, in the example above, the background is set to black
• left-spacing (int): space, in pixels, added before each module
• right-spacing (int): space, in pixels, added after each module
• spacing (int): short-hand for setting both left-spacing and right-spacing
• left-margin (int): left-side margin, in pixels
• right-margin (int): right-side margin, in pixels
• margin (int): short-hand for setting both left-margin and right-margin
• border (dictionary): configures a border around the status bar
• font (font): default font to use
• foreground (color): default foreground (text) color to use
• left (list): left-aligned modules
• center (list): center-aligned modules
• right (list): right-aligned modules

The border dictionary has the following attributes:

• width (int, required): with, in pixels, of the border
• color (color, required): the color of the border