1labwc-config(5) File Formats Manual labwc-config(5)
2
6 labwc - configuration files
7
9 Labwc uses openbox-3.6 specification for configuration and theming, but
10 does not support all options. The following files form the basis of the
11 labwc configuration: rc.xml, menu.xml, autostart and environment.
12 No configuration files are needed to start and run labwc.
14 In accordance with XDG Base Directory Specification, configuration
16 files are searched for in the following order:
17 • ${XDG_CONFIG_HOME:-$HOME/.config}/labwc
19 • ${XDG_CONFIG_DIRS:-/etc/xdg}/labwc
20 All configuration and theme files except autostart are re-loaded on re‐
23 ceiving signal SIGHUP.
24 The autostart file is executed as a shell script. This is the place for
26 executing clients for handling background images, panels and similar.
27 The environment file is parsed as variable=value and sets environment
29 variables accordingly. It is recommended to specify keyboard layout
30 settings and cursor size/theme here; see environment variable section
31 below for details. Note that the environment file is treated differ‐
32 ently by openbox where it is simply sourced prior to running openbox.
33 The menu.xml file defines the context/root-menus and is described in
35 labwc-menu(5)
36 There is a small <theme> section in rc.xml, for example to set rouned
38 corners, but the remainder of the theme specification and associated
39 files are described in labwc-theme(5).
40 rc.xml is the main configuration file and all its options are described
42 in detail below. Configuration must be wrapped in a <labwc_config>
43 root-element, like this:
44 <?xml version="1.0"?>
46 <labwc_config>
47 <!-- settings -->
49 </labwc_config>
52 The rest of this man page describes configuration options.
54 CORE
56 <core><decoration> [server|client]
57 Specify server or client side decorations for xdg-shell views. Note
58 that it is not always possible to turn off client side decorations.
59 Default is server.
60 <core><gap>
62 The distance in pixels between views and output edges when using
63 movement actions, for example MoveToEdge. Default is 0.
64 <core><adaptiveSync> [yes|no]
66 Enable adaptive sync. Default is no.
67 <core><cycleViewPreview> [yes|no]
69 Preview the contents of the selected window when cycling between
70 windows. Default is no.
71 <core><cycleViewOutlines> [yes|no]
73 Draw an outline around the selected window when cycling between
74 windows. Default is yes.
75 RESISTANCE
77 <resistance><screenEdgeStrength>
78 Screen Edge Strength is how far past the screen's edge your cursor
79 must move before the window will move with it. Resistance is
80 counted in pixels. Default is 20 pixels.
81 FOCUS
83 <focus><followMouse> [yes|no]
84 Make focus follow mouse, i.e. focus is given to window under mouse
85 cursor. Default is no.
86 <focus><raiseOnFocus> [yes|no]
88 Raise window to top when focused. Default is no.
89 WINDOW SNAPPING
91 <snapping><range>
92 The distance in pixels from the edge of an ouput for window Move
93 operations to trigger SnapToEdge. A range of 0 disables window
94 snapping. Default is 1.
95 <snapping><topMaximize> [yes|no]
97 Maximize window if Move operation ends on the top edge. Default is
98 yes.
99 WORKSPACES
101 <desktops><names><name>
102 Define workspaces. A workspace covers all outputs. The OSD only
103 shows windows on the current workspace. Workspaces can be switched
104 to with GoToDesktop and windows can be moved with SendToDesktop.
105 See labwc-actions(5) for more information about their arguments.
106 <desktops><popupTime>
108 Define the timeout after which to hide the workspace OSD. A setting
109 of 0 disables the OSD. Default is 1000 ms.
110 THEME
112 <theme><name>
113 The name of the Openbox theme to use. It is not set by default.
114 <theme><cornerRadius>
116 The radius of server side decoration top corners. Default is 8.
117 <theme><font place="">
119 The font to use for a specific element of a window, menu or OSD.
120 Places can be any of:
121 • ActiveWindow - titlebar of active window
122 • MenuItem - menu item (currently only root menu)
123 • OnScreenDisplay - items in the on screen display
124 If no place attribute is provided, the setting will be applied to all
126 places.
127 <theme><font place=""><name>
129 Describes font name. Default is sans.
130 <theme><font place=""><size>
132 Font size in pixels. Default is 10.
133 <theme><font place=""><slant>
135 Font slant (normal or italic). Default is normal.
136 <theme><font place=""><weight>
138 Font weight (normal or bold). Default is normal.
139 KEYBOARD
141 <keyboard><keybind key="">
142 Define a key binding in the format modifier-key, where supported
143 modifiers include S (shift); C (control); A (alt); W (super). Un‐
144 like Openbox, multiple space-separated key combinations and key-
145 chains are not supported.
146 <keyboard><keybind key=""><action name="">
148 Keybind action. See labwc-action(5)
149 <keyboard><default />
151 Load the default keybinds listed below. This is an addition to the
152 openbox specification and provides a way to keep config files sim‐
153 pler whilst allowing your specific keybinds. Note that if no rc.xml
154 is found, or if no <keyboard><keybind> entries exist, the same de‐
155 fault keybinds will be loaded even if the <default /> element is
156 not provided.
157 A-Tab - next window
159 W-Return - alacritty
160 A-F3 - run bemenu
161 A-F4 - close window
162 W-a - toggle maximize
163 A-<arrow> - move window to edge
164 W-<arrow> - resize window to fill half the output
165 Audio and MonBrightness keys are also bound to amixer and bright‐
167 nessctl respectively
168 <keyboard><repeatRate>
170 Set the rate at which keypresses are repeated per second. Default
171 is 25.
172 <keyboard><repeatDelay>
174 Set the delay before keypresses are repeated in milliseconds. De‐
175 fault is 600.
176 MOUSE
178 <mouse><doubleClickTime>
179 Set double click time in milliseconds. Default is 500.
180 <mouse><context name=""><mousebind button="" direction=""><action>
182 Multiple <mousebind> can exist within one <context>; and multiple
183 <action> can exist within one <mousebind>
184 Define a mouse binding. Supported context-names include:
186 • TitleBar: The decoration on top of the window, where the window
187 buttons and the window title are shown.
188 • Title: The area of the titlebar (including blank space) between
189 the window buttons, where the window title is displayed.
190 • WindowMenu: The button on the left.
191 • Iconify: The button that looks like an underline.
192 • Maximize: The button that looks like a box.
193 • Close: The button that looks like an X.
194 • Top: The top edge of the window's border.
195 • Bottom: The bottom edge of the window's border.
196 • Left: The left edge of the window's border.
197 • Right: The right edge of the window's border.
198 • TRCorner: The top-right corner of the window's border.
199 • TLCorner: The top-left corner of the window's border.
200 • BLCorner: The bottom-left corner of the window's border.
201 • BRCorner: The bottom-right edge of the window's border.
202 • Client: The client area of a window, inside its decorations.
203 Events bound to Client are also passed to applications.
204 • Frame: Any part of a window, but events bound to Frame are not
205 passed through to the application.
206 • Desktop: The desktop background, where no windows are present.
207 • Root: A synonym for Desktop (for compatibility).
208 Supported mouse buttons are:
211 • Left
212 • Middle
213 • Right
214 Supported scroll directions are:
217 • Up
218 • Down
219 • Left
220 • Right
221 Supported mouse actions include:
224 • Press: Pressing the specified button down in the context.
225 • Release: Releasing the specified button in the context.
226 • Click: Pressing and then releasing inside of the the context.
227 • DoubleClick: Two presses within the doubleClickTime.
228 • Drag: Pressing the button within the context, then moving the
229 cursor
230 • Scroll: Scrolling up or down in the context.
231 Scroll actions must have a direction specified instead of button.
233 <mouse><default />
235 Load default mousebinds. This is an addition to the openbox speci‐
236 fication and provides a way to keep config files simpler whilst al‐
237 lowing user specific binds. Note that if no rc.xml is found, or if
238 no <mouse><mousebind> entries exist, the same default mousebinds
239 will be loaded even if the <default /> element is not provided.
240 LIBINPUT
242 <libinput><device category="">
243 Define a category of devices to use the configuration values that
244 follow. The category can be set to touch (devices that define a
245 width and height), non-touch, default, or the name of a device. You
246 can obtain your devices name by running libinput list-devices (you
247 may need to be root or a part of the input group to perform this.)
248 Any members of this category that are not set use the default for
249 the device. With the exception of tap-to-click, which is enabled by
250 default.
251 <libinput><device category=""><naturalScroll> [yes|no]
253 Use natural scrolling for this category if available.
254 <libinput><device category=""><leftHanded> [yes|no]
256 Use your devices left-handed mode if available.
257 <libinput><device category=""><pointerSpeed> [-1.0 to 1.0]
259 Set the pointer speed for this category. The speed is a number be‐
260 tween -1.0 and 1.0, with 0.0 being the default in most cases, and
261 1.0 being the fastest.
262 <libinput><device category=""><accelProfile> [flat|adaptive]
264 Set the pointer's acceleration profile for this category. Flat ap‐
265 plies no acceleration (the pointers velocity is constant), while
266 adaptive changes the pointers speed based the actual speed of your
267 mouse or finger on your touchpad.
268 <libinput><device category=""><tap> [yes|no]
270 Enable or disable tap-to-click for this category. This is enabled
271 by default for all categories.
272 <libinput><device category=""><tapButtonMap> [lrm|lmr]
274 Set the buttons mapped to one-, two-, and three-finger taps to the
275 left button, right button, and middle button, respectively (lrm)
276 (the default), or to left button, middle button, and right button
277 (lmr).
278 <libinput><device category=""><middleEmulation> [yes|no]
280 Enable or disable middle button emulation for this category. Middle
281 emulation processes a simultaneous left and right click as a press
282 of the middle mouse button (scroll wheel).
283 <libinput>device category=""><disableWhileTyping> [yes|no]
285 Enable or disable disable while typing for this category. DWT ig‐
286 nores any motion events while a keyboard is typing, and for a short
287 while after as well.
288 ENVIRONMENT VARIABLES
290 XCURSOR_THEME and XCURSOR_SIZE are supported to set cursor theme and
291 size respectively. The default size is 24. System cursor themes can
292 typically be found with a command such as:
293 find /usr/share/icons/ -type d -name "cursors"
295 The following keyboard-configuration variables are supported: XKB_DE‐
297 FAULT_RULES, XKB_DEFAULT_MODEL, XKB_DEFAULT_LAYOUT, XKB_DEFAULT_VARIANT
298 and XKB_DEFAULT_OPTIONS.
299 See xkeyboard-config(7) for details.
301
303 labwc(1), labwc-actions(5), labwc-theme(5)
304 2022-12-04 labwc-config(5)