Configuration

custard is configured via the X resource manager. Most often, the Xresources file is located at ~/.Xresources, but it can be elsewhere, so long as it is loaded with xrdb.

There are fourteen modifiable settings, all of which should be put into an Xresources file. An example file is provided at /examples/Xresources in the repository.

If the settings are in their own Xresources file, executing the following command will suffice.

$ xrdb -merge ~/.config/custard/Xresources

If the settings are in a pre-existing file, then the way that file is loaded should suffice without change.

Configuring the virtual grid

custard creates a virtual grid that windows are moved and sized about. By default, there is only two rows and three columns. The grid may also be offset from the top, left, right, or bottom of the screen, as well as create gaps between windows.

The settings related to the virtual grid, as well as their default values, are listed below.

Setting	Default value	Possible values
custard.rows	2	Any positive number
custard.columns	3	Any positive number
custard.margin	0	Any positive number
custard.margin_top	0	Any positive number
custard.margin_bottom	0	Any positive number
custard.margin_left	0	Any positive number
custard.margin_right	0	Any positive number

Note that in custard, gaps are called margins. margin_top, margin_bottom, margin_left and margin_right all offset the virtual grid from the sides of the screen.

Window Borders

Types and sizes

Windows can have one of four border types, as well as a specific size.

If the border size is Single, the total border size is that value of custard.outer_border_size. If the border size is Double or Triple, the total border is is the value of custard.inner_border_size and two times custard.outer_border_size added together.

Setting	Default value	Possible values
custard.border_type	None	None, Single, Double, Triple
custard.inner_border_size	0	Any positive number
custard.outer_border_size	0	Any positive number

Border colors

Borders can use up to three different colors depending on the border type. You can also swap colors using the invert color setting, but a specific set of conditions applies to how this setting works based on the used border type.

Setting	Default value	Possible values	Conditions
custard.focused_color	#FFFFFF	0x000000 - 0xFFFFFF	Only shown when a window is focused
custard.unfocused_color	#676767	0x000000 - 0xFFFFFF	Only shown when a window is not focused
custard.background_color	#000000	0x000000 - 0xFFFFFF	Only shown if the border type is either Double or Triple
custard.invert_colors	False	True or False	Conditions outlined below

If invert_colors is set to True, then custard will swap the focused and unfocused colors. If the border type is set to Single, this setting will swap the focused color with the background color. If the border type is set to either Double or Single, then the setting will swap based on the focused state. If a given window is focused, the background and focused colors are swapped, and if a given window is not focused, the background and unfocused colors are swapped.

Miscellaneous

Setting	Default value	Possible values	Description
custard.workspaces	2	Any positive number	The number of workspaces that are created when custard starts.