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 string in fontconfig format. Example of valid val‐
17 ues:
18 • Font Awesome 5 Brands
19 • Font Awesome 5 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 │
34 │ │ │ │ the bar, in pix‐ │
35 │ │ │ │ els (not includ‐ │
36 │ │ │ │ ing border) │
37 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
38 │location │ enum │ yes │ one of top or │
39 │ │ │ │ bottom │
40 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
41 │background │ color │ yes │ Background color │
42 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
43 │monitor │ string │ no │ Monitor to place │
44 │ │ │ │ the bar on. If │
45 │ │ │ │ not specified, │
46 │ │ │ │ the primary mon‐ │
47 │ │ │ │ itor will be │
48 │ │ │ │ used │
49 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
50 │layer │ string │ no │ Layer to put bar │
51 │ │ │ │ on. One of top │
52 │ │ │ │ or bottom. Way‐ │
53 │ │ │ │ land only │
54 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
55 │left-spacing │ int │ no │ Space, in pix‐ │
56 │ │ │ │ els, added be‐ │
57 │ │ │ │ fore each module │
58 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
59 │right-spacing │ int │ no │ Space, in pix‐ │
60 │ │ │ │ els, added after │
61 │ │ │ │ each module │
62 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
63 │spacing │ int │ no │ Short-hand for │
64 │ │ │ │ setting both │
65 │ │ │ │ left-spacing and │
66 │ │ │ │ right-spacing │
67 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
68 │left-margin │ int │ no │ Left-side mar‐ │
69 │ │ │ │ gin, in pixels │
70 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
71 │right-margin │ int │ no │ Right-side mar‐ │
72 │ │ │ │ gin, in pixels │
73 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
74 │margin │ int │ no │ Short-hand for │
75 │ │ │ │ setting both │
76 │ │ │ │ left-margin and │
77 │ │ │ │ right-margin │
78 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
79 │border │ associative ar‐ │ no │ Configures the │
80 │ │ ray │ │ border around │
81 │ │ │ │ the status bar │
82 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
83 │border.left- │ int │ no │ Width of the │
84 │width │ │ │ border on the │
85 │ │ │ │ left side, in │
86 │ │ │ │ pixels │
87 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
88 │border.right- │ int │ no │ Width of the │
89 │width │ │ │ border on the │
90 │ │ │ │ right side, in │
91 │ │ │ │ pixels │
92 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
93 │border.top-width │ int │ no │ Width of the │
94 │ │ │ │ border on the │
95 │ │ │ │ top side, in │
96 │ │ │ │ pixels │
97 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
98 │border.bottom- │ int │ no │ Width of the │
99 │width │ │ │ border on the │
100 │ │ │ │ bottom side, in │
101 │ │ │ │ pixels │
102 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
103 │border.width │ int │ no │ Short-hand for │
104 │ │ │ │ setting bor‐ │
105 │ │ │ │ der.left/right/top/bot‐ │
106 │ │ │ │ tom-width │
107 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
108 │border.color │ color │ no │ The color of the border │
109 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
110 │border.left-mar‐ │ int │ no │ Left-side margin, in │
111 │gin │ │ │ pixels, from screen │
112 │ │ │ │ edge to bar │
113 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
114 │border.right- │ int │ no │ Right-side margin, in │
115 │margin │ │ │ pixels, from screen │
116 │ │ │ │ edge to bar │
117 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
118 │border.top-mar‐ │ int │ no │ Top margin, in pixels, │
119 │gin │ │ │ from screen edge to bar │
120 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
121 │border.bottom- │ int │ no │ Bottom margin, in pix‐ │
122 │margin │ │ │ els, from screen edge │
123 │ │ │ │ to bar │
124 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
125 │border.margin │ int │ no │ Short-hand for setting │
126 │ │ │ │ bor‐ │
127 │ │ │ │ der.left/right/top/bot‐ │
128 │ │ │ │ tom-margin │
129 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
130 │font │ font │ no │ Default font to use in │
131 │ │ │ │ modules and particles │
132 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
133 │foreground │ color │ no │ Default foreground │
134 │ │ │ │ (text) color to use │
135 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
136 │trackpad-sensi‐ │ int │ no │ How easy it is to trig‐ │
137 │tivity │ │ │ ger wheel-up and wheel- │
138 │ │ │ │ down on-click handlers. │
139 │ │ │ │ Higher values means you │
140 │ │ │ │ need to drag your fin‐ │
141 │ │ │ │ ger a longer distance. │
142 │ │ │ │ The default is 30. │
143 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
144 │left │ list │ no │ Left-aligned modules │
145 │ │ │ │ (see yambar-modules(5)) │
146 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
147 │center │ list │ no │ Center-aligned modules │
148 │ │ │ │ (see yambar-modules(5)) │
149 ├─────────────────┼─────────────────┼─────┼─────────────────────────┤
150 │right │ list │ no │ Right-aligned modules │
151 │ │ │ │ (see yambar-modules(5)) │
152 └─────────────────┴─────────────────┴─────┴─────────────────────────┘
153
155 Top-oriented bar with a single, right-aligned, module: the clock, ren‐
156 dered as a simple string displaying only the time (not date).
157 bar:
159 location: top
160 height: 26
161 background: 00000066
162 right:
164 - clock:
165 content:
166 - string: {text: "{time}"}
167
169 The configuration file is searched for (in this order):
170 • $XDG_CONFIG_HOME/yambar/config.yml
172 • $HOME/.config/yambar/config.yml
173
176 yambar-modules(5), yambar-particles(5), yambar-tags(5), yambar-decora‐
177 tions(5)
178 2022-08-26 yambar(5)