Configuration file
wlmaker is highly configurable, and uses a human-readable configuration file in human-readable Property List format.
wlmaker will load try loading a configuration file from these locations:
- If a --config_file=<FILE> argument is provided, load <FILE>;
- if not given: from the "config home" according to XDG base directory spec;
- if not found there: from any of the preference-ordered "config directories", as described in the XDG base directory specification;
- Otherwise: compiled-in setttings from etc/Config.plist will be loaded.
The configuration file is a dictionary that may hold values for the following keys:
- Keyboard (required)
- Decoration (required)
- KeyBindings (required)
- HotCorner (required)
- ScreenLock (required)
- Outputs (required)
Keyboard
This dictionary configures the keyboard layout and properties.
- XkbRMLVO (required): A dictionary holding an XKB keyboard configuration.
- Rules (required): Defines the XKB mapping.
- Model: The name of the model of the keyboard hardware in use.
- Layout: Identifier of the general layout.
- Variant: Any minor variants on the general layout.
- Options: Setof extra options to customize the standard layout.
- Repeat (required): A dictionary holding two values that define the initial holdback and repeat rate when holding a key pressed.
- Delay (required): Delay before initiating repeats, in milliseconds.
- Rate (required): Repeats per second, once Delay has expired.
Example:
Decoration
By default, Wayland clients (using the XDG Shell) will draw window decorations themselves. For clients that implement and obey the XDG decoration protocol, wlmaker can whether decorations are drawn by the server, ie. by wlmaker.
For X11 clients, wlmaker will add decorations if the client requests.
Permitted modes (see _wlmaker_config_decoration_desc):
- SuggestClient: Requests the client to draw decoration.
- SuggestServer: Requests wlmaker to add decorations.
- EnforceClient: wlmaker will refuse to draw decorations, even if the client requests.
- EnforceServer: wlmaker will add decorations, even if the client refuses.
Example:
KeyBindings
A dictionary, where each key and value define a binding of a key combination to a wlmaker action. The dictionary may be empty.
See _wlmaker_keybindings_modifiers for the supported modifiers.
See wlmaker_action_desc for the list of permitted actions.
Example:
HotCorner
This dictionary configures which action is triggered when the mouse pointer enters and stays at the specified corner for TriggerDelay milliseconds. It must have the following items:
- TriggerDelay: Delay for the pointer residing in a corner before triggering the corresponding Enter event.
- TopLeftEnter, TopRightEnter, BottomLeftEnter, BottomRightEnter: Sets the action (wlmaker_action_desc) to trigger when entering the corner.
- TopLeftLeave, TopRightLeave, BottomLeftLeave, BottomRightLeave: Sets the action (wlmaker_action_desc) to trigger when entering the corner.
Note: As of wlmaker 0.5, the corners are relative to the total layout. They may not be reachable when using multiple outputs that don't have the same resolution.
Example:
ScreenLock
Configures the timeout and command for locking the screen. It must have the following keys:
- IdleSeconds: Number of seconds of inactivity before executing Command.
- Command: Defines the command that will be executed after IdleSeconds.
The LockScreen action is wired to execute Command of ScreenLock.
Example:
Autostart
An array of strings, each denoting an executable that will be executed once wlmaker has started.
Example:
Outputs
Using the Outputs array, wlmaker will configure and combine monitors into a multi-monitor setup as configured. When an output (monitor) is detected, wlmaker will first see if the output is found in State. Otherwise, it will scan the Outputs array for an entry that matches Name, Manufacturer, Model and Serial. Once found, it checks Enabled whether that output should be used. If so, the settings from Scale, Transformation, Position and Mode will be applied.
wlmaker supports the wlr output management protocol for dynamically modifying the output device configuration. There are third-party tools (wlr-randr, wldisplays, ...) to dynamically set output propertis.
- Optional Enabled: A boolean value, specifies whether that output should be used (Yes) or not (No). Defaults to Yes.
- Optional Scale: A fractional number, specifies the scaling factor to apply for contents on that output. Defaults to 1.0.
- Optional Transformation: Defines whether the monitor's contents should be rotated and/or flipped. Permitted values: Defaults to Normal.BSPL_ENUM("Normal", WL_OUTPUT_TRANSFORM_NORMAL),BSPL_ENUM("Rotate90", WL_OUTPUT_TRANSFORM_90),BSPL_ENUM("Rotate180", WL_OUTPUT_TRANSFORM_180),BSPL_ENUM("Rotate270", WL_OUTPUT_TRANSFORM_270),BSPL_ENUM("Flip", WL_OUTPUT_TRANSFORM_FLIPPED),BSPL_ENUM("FlipAndRotate90", WL_OUTPUT_TRANSFORM_FLIPPED_90),BSPL_ENUM("FlipAndRotate180", WL_OUTPUT_TRANSFORM_FLIPPED_180),BSPL_ENUM("FlipAndRotate270", WL_OUTPUT_TRANSFORM_FLIPPED_270),BSPL_ENUM_SENTINEL(),};
- Optional Position: Defines the position of the output's top left corner. Defaults to "0,0".
- Optional Mode: A string of the format <WIDTH>x<HEIGHT>[@<RATE>], denoting a resolution of WIDTH x HEIGHT, optionally with explicitly specified refresh rate <RATE> in Hz.
Example:
That example will configure any added output to use Normal transformation with a scale of 1.0.
Generated by
1.16.1