1yambar(5) File Formats Manual yambar(5)
2
6 yambar - configuration file
7
9 A yambar configuration file is a yaml formatted document containing an
10 associative array named bar. You may define other top-level entities
11 and reference them using anchors.
12 Besides the normal yaml types, there are a couple of yambar specific
14 types that are frequently used:
15 • font: this is a comma separated list of fonts in fontconfig format.
17 Example of valid values:
18 • Font Awesome 6 Brands
19 • Font Awesome 6 Free:style=solid
20 • Dina:pixelsize=10:slant=italic
21 • Dina:pixelsize=10:weight=bold
22 • color: an rgba hexstring; RRGGBBAA. Examples:
23 • ffffffff: white, no transparency
24 • 000000ff: black, no transparency
25 • 00ff00ff: green, no transparency
26 • ff000099: red, semi-transparent
27
30 ┌─────────────────┬─────────────────┬─────┬────────────────────────────┐
31 │Name │ Type │ Req │ Description │
32 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
33 │height │ int │ yes │ The height of the bar, in │
34 │ │ │ │ pixels (not including bor‐ │
35 │ │ │ │ der) │
36 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
37 │location │ enum │ yes │ one of top or bottom │
38 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
39 │background │ color │ yes │ Background color │
40 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
41 │monitor │ string │ no │ Monitor to place the bar │
42 │ │ │ │ on. If not specified, the │
43 │ │ │ │ primary monitor will be │
44 │ │ │ │ used │
45 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
46 │layer │ string │ no │ Layer to put bar on. One │
47 │ │ │ │ of top or bottom. Wayland │
48 │ │ │ │ only │
49 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
50 │left-spacing │ int │ no │ Space, in pixels, added │
51 │ │ │ │ before each module │
52 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
53 │right-spacing │ int │ no │ Space, in pixels, added │
54 │ │ │ │ after each module │
55 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
56 │spacing │ int │ no │ Short-hand for setting │
57 │ │ │ │ both left-spacing and │
58 │ │ │ │ right-spacing │
59 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
60 │left-margin │ int │ no │ Left-side margin, in pix‐ │
61 │ │ │ │ els │
62 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
63 │right-margin │ int │ no │ Right-side margin, in pix‐ │
64 │ │ │ │ els │
65 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
66 │margin │ int │ no │ Short-hand for setting │
67 │ │ │ │ both left-margin and │
68 │ │ │ │ right-margin │
69 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
70 │border │ associative ar‐ │ no │ Configures the border │
71 │ │ ray │ │ around the status bar │
72 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
73 │border.left- │ int │ no │ Width of the border on the │
74 │width │ │ │ left side, in pixels │
75 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
76 │border.right- │ int │ no │ Width of the border on the │
77 │width │ │ │ right side, in pixels │
78 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
79 │border.top-width │ int │ no │ Width of the border on the │
80 │ │ │ │ top side, in pixels │
81 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
82 │border.bottom- │ int │ no │ Width of the border on the │
83 │width │ │ │ bottom side, in pixels │
84 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
85 │border.width │ int │ no │ Short-hand for setting │
86 │ │ │ │ border.left/right/top/bot‐ │
87 │ │ │ │ tom-width │
88 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
89 │border.color │ color │ no │ The color of the border │
90 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
91 │border.left-mar‐ │ int │ no │ Left-side margin, in pix‐ │
92 │gin │ │ │ els, from screen edge to │
93 │ │ │ │ bar │
94 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
95 │border.right- │ int │ no │ Right-side margin, in pix‐ │
96 │margin │ │ │ els, from screen edge to │
97 │ │ │ │ bar │
98 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
99 │border.top-mar‐ │ int │ no │ Top margin, in pixels, │
100 │gin │ │ │ from screen edge to bar │
101 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
102 │border.bottom- │ int │ no │ Bottom margin, in pixels, │
103 │margin │ │ │ from screen edge to bar │
104 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
105 │border.margin │ int │ no │ Short-hand for setting │
106 │ │ │ │ border.left/right/top/bot‐ │
107 │ │ │ │ tom-margin │
108 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
109 │font │ font │ no │ Default font to use in │
110 │ │ │ │ modules and particles. May │
111 │ │ │ │ also be a comma separated │
112 │ │ │ │ list of several fonts, in │
113 │ │ │ │ which case the first font │
114 │ │ │ │ is the primary font, and │
115 │ │ │ │ the rest fallback fonts. │
116 │ │ │ │ These are yambar custom │
117 │ │ │ │ fallback fonts that will │
118 │ │ │ │ be searched before the │
119 │ │ │ │ fontconfig provided fall‐ │
120 │ │ │ │ back list. │
121 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
122 │font-shaping │ enum │ no │ Default setting for font- │
123 │ │ │ │ shaping, for use in parti‐ │
124 │ │ │ │ cles. One of full or none. │
125 │ │ │ │ When set to full (the de‐ │
126 │ │ │ │ fault), strings will be │
127 │ │ │ │ "shaped" using HarfBuzz. │
128 │ │ │ │ Requires support in fcft. │
129 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
130 │foreground │ color │ no │ Default foreground (text) │
131 │ │ │ │ color to use │
132 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
133 │trackpad-sensi‐ │ int │ no │ How easy it is to trigger │
134 │tivity │ │ │ wheel-up and wheel-down │
135 │ │ │ │ on-click handlers. Higher │
136 │ │ │ │ values means you need to │
137 │ │ │ │ drag your finger a longer │
138 │ │ │ │ distance. The default is │
139 │ │ │ │ 30. │
140 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
141 │left │ list │ no │ Left-aligned modules (see │
142 │ │ │ │ yambar-modules(5)) │
143 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
144 │center │ list │ no │ Center-aligned modules │
145 │ │ │ │ (see yambar-modules(5)) │
146 ├─────────────────┼─────────────────┼─────┼────────────────────────────┤
147 │right │ list │ no │ Right-aligned modules (see │
148 │ │ │ │ yambar-modules(5)) │
149 └─────────────────┴─────────────────┴─────┴────────────────────────────┘
150
152 Top-oriented bar with a single, right-aligned, module: the clock, ren‐
153 dered as a simple string displaying only the time (not date).
154 bar:
156 location: top
157 height: 26
158 background: 00000066
159 right:
161 - clock:
162 content:
163 - string: {text: "{time}"}
164
166 The configuration file is searched for (in this order):
167 • $XDG_CONFIG_HOME/yambar/config.yml
169 • $HOME/.config/yambar/config.yml
170
173 yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
174 tions(5)
175 2023-07-22 yambar(5)