4.6 KiB
F00bar
Index
Introduction
f00bar is a light-weight and configurable status panel (bar, for short) for X.
It has a number of modules that provide information in the form of tags. For example, the clock module has a date tag that contains the current date.
The modules do not know how to present the information though. This is instead done by particles. And the user, you, decides which particles (and thus how to present the data) to use.
Furthermore, each particle can have a decoration. These are things like a different background, or an graphical underline.
There is no support for images or icons. use an icon font (e.g. Font Awesome, or Material Icons) if you want a graphical representation.
There are a number of modules and particles builtin. More can be added as plugins. You can even write your own!
To summarize: a bar displays information provided by modules, using particles and decorations. How is configured by you.
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
| Name | Type | Req. | Description |
|---|---|---|---|
| height | int | yes | The height of the bar, in pixels |
| location | enum | yes | One of top or bottom |
| background | color | yes | Background color. |
| monitor | string | no | Monitor to place the bar. If not specified, the primary monitor will be used |
| left-spacing | int | no | Space, in pixels, added before each module |
| right-spacing | int | no | Space, in pixels, added after each module |
| spacing | int | no | Short-hand for setting both left-spacing and right-spacing |
| left-margin | int | no | Left-side margin, in pixels |
| right-margin | int | no | Right-side margin, in pixels |
| margin | int | no | Short-hand for setting both left-margin and right-margin |
| border | dict | no | Configures a border around the status bar |
| border.width | int | yes | Width, in pixels, of the border |
| border.color | color | yes | The color of the border |
| font | font | no | Default font to use in modules and particles |
| foreground | color | no | Default foreground (text) color to use |
| left | list | no | Left-aligned modules |
| center | list | no | Center-aligned modules |
| right | list | no | Right-aligned modules |
The value of each item in the left, center and right lists is a module.