table of contents
- buster-backports 3.5.5-1~bpo10+1
- testing 3.5.5-1
- unstable 3.5.5-1
POLYBAR(5) | Polybar User Manual | POLYBAR(5) |
NAME¶
polybar - configuration file for polybar(1)DESCRIPTION¶
The polybar configuration file defines the behavior and look of polybar. It uses a variant of the INI file format. The exact syntax is described below but first a small snippet to get familiar with the syntax:[section_name] ; A comment # Another comment background = #ff992a width = 90% monitor = HDMI-0 screenchange-reload = false ; Use double quotes if you want to keep the surrounding space. text = " Some text "
When started polybar will search for the config file in one of several places in the following order:
- If the -c or --config command line argument is specified, it will use the path given there.
- $XDG_CONFIG_HOME/polybar/config
- $HOME/.config/polybar/config
SYNTAX¶
The entire config is line-based so everything is constrained to a single line. This means there are no multiline values or other multiline constructs (except for sections). Each line has one of four types:- Empty
- Comment
- Section Header
- Key
Spaces at the beginning and end of each line will be ignored.
NOTE:
Any line that doesn't fit into one of these four types is a syntax error.
NOTE:
In practice all characters are allowed except for spaces and any of these: "'=;#[](){}:.$\%
Section Headers¶
Sections are used to group config options together. For example each module is defined in its own section.A section is defined by placing the name of the section in square brackets ([ and ]). For example:
[module/wm]
This declares a section with the name module/wm and all keys defined after this line will belong to that section until a new section is declared.
WARNING:
NOTE:
Keys¶
Keys are defined by assigning a value to a name like this:name = value
This assigns value to the key name in whatever section this line is in. Key names need to be unique per section. If the value is enclosed by double-quotes ("), the quotes will be ignored. So the following still assigns value to name:
name = "value"
Spaces around the equal sign are ignored, the following are all equivalent:
name=value name = value name = value
Because spaces at the beginning and end of the line are also ignored, if you want your value to begin and/or end with a space, the value needs to be enclosed in double-quotes:
name = " value "
Here name has a leading and trailing whitespace.
Empty Lines & Comments¶
Empty lines and comment lines are ignored when reading the config file, they do not affect polybar's behavior. Comment lines start with either the ; or the # character.NOTE:
name = value ; comment
SEE ALSO¶
polybar(1)COPYRIGHT¶
2016-2021, Michael Carlberg & contributorsMarch 17, 2021 | 3.5.5 |