2021-03-05 22:14:02 +00:00
|
|
|
labwc(1)
|
|
|
|
|
|
|
|
|
|
# NAME
|
|
|
|
|
|
2022-05-31 22:37:26 +01:00
|
|
|
labwc - a wayland stacking compositor
|
2021-03-05 22:14:02 +00:00
|
|
|
|
|
|
|
|
# SYNOPSIS
|
|
|
|
|
|
2024-01-13 19:51:20 +02:00
|
|
|
*labwc* [options...]
|
2021-03-05 22:14:02 +00:00
|
|
|
|
|
|
|
|
# DESCRIPTION
|
|
|
|
|
|
2022-05-31 22:37:26 +01:00
|
|
|
Labwc is a wlroots-based stacking compositor for wayland.
|
2021-04-10 09:19:35 +01:00
|
|
|
|
2022-05-31 22:37:26 +01:00
|
|
|
It is light-weight and independent with a focus on simply stacking windows
|
|
|
|
|
well and rendering some window decorations. Where practicable it uses clients
|
|
|
|
|
for wall-paper, panels, screenshots and so on.
|
2021-03-05 22:14:02 +00:00
|
|
|
|
2022-10-04 21:57:38 +01:00
|
|
|
The compositor will exit or reload its configuration upon receiving SIGTERM
|
|
|
|
|
and SIGHUP respectively. For example:
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
kill -s <signal> $LABWC_PID
|
|
|
|
|
killall -s <signal> labwc
|
|
|
|
|
```
|
|
|
|
|
|
2022-10-06 21:54:49 +01:00
|
|
|
Each running instance of labwc sets the environment variable `LABWC_PID` to
|
|
|
|
|
its PID. This is useful for sending signals to a specific instance and is what
|
|
|
|
|
the `--exit` and `--reconfigure` options use.
|
|
|
|
|
|
2021-03-05 22:14:02 +00:00
|
|
|
# OPTIONS
|
|
|
|
|
|
2022-10-06 21:54:26 +01:00
|
|
|
*-c, --config* <config-file>
|
2022-04-22 17:00:36 +01:00
|
|
|
Specify a config file with path
|
|
|
|
|
|
2022-10-06 21:54:26 +01:00
|
|
|
*-C, --config-dir* <config-directory>
|
2022-04-22 17:00:36 +01:00
|
|
|
Specify a config directory
|
2021-03-05 22:14:02 +00:00
|
|
|
|
2022-10-06 21:54:26 +01:00
|
|
|
*-d, --debug*
|
2021-03-05 22:14:02 +00:00
|
|
|
Enable full logging, including debug information
|
|
|
|
|
|
2022-10-06 21:54:49 +01:00
|
|
|
*-e, --exit*
|
|
|
|
|
Exit the compositor
|
|
|
|
|
|
2022-10-06 21:54:26 +01:00
|
|
|
*-h, --help*
|
2021-03-05 22:14:02 +00:00
|
|
|
Show help message and quit
|
|
|
|
|
|
config: support merging multiple config files
Add the -m|--merge-config command line option to iterate backwards over
XDG Base Dir paths and read config/theme files multiple times.
For example if both ~/.config/labwc/rc.xml and /etc/xdg/labwc/rc.xml
exist, the latter will be read first and then the former (if
--merge-config is enabled).
When $XDG_CONFIG_HOME is defined, make it replace (not augment)
$HOME/.config. Similarly, make $XDG_CONFIG_DIRS replace /etc/xdg when
defined.
XDG Base Dir Spec does not specify whether or not an application (or a
compositor!) should (a) define that only the file under the most important
base directory should be used, or (b) define rules for merging the
information from the different files.
ref: https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html
In the case of labwc there is a use-case for both positions, just to be
clear, the default behaviour, described by position (a) above, does NOT
change.
This change affects the following config/theme files:
- rc.xml
- menu.xml
- autostart
- environment
- themerc
- themerc-override
- Theme buttons, for example max.xbm
Instead of caching global config/theme directories, create lists of paths
(e.g. '/home/foo/.config/labwc/rc.xml', '/etc/xdg/labwc/rc.xml', etc).
This creates more common parsing logic and just reversing the direction
of iteration and breaks early if config-merge is not wanted.
Enable better fallback for themes. For example if a particular theme does
not exist in $HOME/.local/share/themes, it will be searched for in
~/.themes/ and so on. This also applies to theme buttons which now
fallback on an individual basis.
Avoid using stat() in most situations and just go straight to fopen().
Fixes #1406
2024-01-09 22:00:45 +00:00
|
|
|
*-m, --merge-config*
|
|
|
|
|
Merge user config/theme files in all XDG Base Directories
|
|
|
|
|
|
2022-10-06 21:54:49 +01:00
|
|
|
*-r, --reconfigure*
|
|
|
|
|
Reload the compositor configuration
|
|
|
|
|
|
2022-10-06 21:54:26 +01:00
|
|
|
*-s, --startup* <command>
|
2021-03-05 22:14:02 +00:00
|
|
|
Run command on startup
|
|
|
|
|
|
2022-10-06 21:54:26 +01:00
|
|
|
*-v, --version*
|
2021-03-05 22:14:02 +00:00
|
|
|
Show the version number and quit
|
|
|
|
|
|
2022-10-06 21:54:26 +01:00
|
|
|
*-V, --verbose*
|
2021-03-05 22:14:02 +00:00
|
|
|
Enable more verbose logging
|
|
|
|
|
|
|
|
|
|
# SEE ALSO
|
|
|
|
|
|
|
|
|
|
labwc-config(5), labwc-theme(5), labwc-actions(5)
|