mirrors/labwc
1
0
Fork 0
mirror of https://github.com/labwc/labwc.git synced 2026-04-06 07:15:40 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs/labwc-config.5.scd: clarify expectations of startup, shutdown files

Browse source
This commit is contained in:
Andrew J. Hesford 2025-11-16 13:06:31 -05:00
parent 8ced055cb9
commit b05ad34e8d
1 changed files with 13 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

23
docs/labwc-config.5.scd
View file

@ -62,19 +62,22 @@ as a comment. Trailing comments are not supported.
Please note that as labwc reloads the environment file(s) on reconfigure, Please note that as labwc reloads the environment file(s) on reconfigure,
recursive/circular assignments (for example FOO=$FOO:bar) should not be made. recursive/circular assignments (for example FOO=$FOO:bar) should not be made.
The *autostart* file is executed as a shell script after labwc has read its The *autostart* file, if it exists, is executed after labwc has read its
configuration and set variables defined in the environment file. Additionally, configuration and set variables defined in the environment file. Additionally,
the environment variables WAYLAND_DISPLAY and (when labwc is built with Xwayland the environment variables WAYLAND_DISPLAY and (when labwc is built with Xwayland
support) DISPLAY will be defined. This is the place for executing clients for support) DISPLAY will be defined. This is a convenient place for executing
handling background images, panels and other tasks that should run automatically clients for handling background images, panels and other tasks that should run
when labwc launches. automatically when labwc launches. While it is generally expected that the
autostart file be a shell script, labwc does not impose any constraints other
than that the file exist and be executable.
The *shutdown* file is executed as a shell script when labwc is preparing to The *shutdown* file, if it exists, is executed when labwc is preparing to
terminate itself. All environment variables, including WAYLAND_DISPLAY and terminate itself. All environment variables, including WAYLAND_DISPLAY and
DISPLAY, will be available to the script. However, because the script runs DISPLAY, will be available to the executable. However, because *shutdown* runs
asynchronously with other termination tasks, the shutdown file should not assume asynchronously with other termination tasks, the process should not assume that
that the display will be usable. This file is useful to perform any custom the display will be usable. This file is useful to perform any custom operations
operations necessary to finalize a labwc session. necessary to finalize a labwc session. As with the autostart file, the shutdown
file is generally expected to be a shell script, but this is not a requirement.
The *menu.xml* file defines the context/root-menus and is described in The *menu.xml* file defines the context/root-menus and is described in
labwc-menu(5). labwc-menu(5).
@ -86,7 +89,7 @@ in labwc-theme(5).
*rc.xml* is the main configuration file and all its options are described in *rc.xml* is the main configuration file and all its options are described in
detail below. detail below.
The *xinitrc* file is executed as a shell script whenever labwc launches the The *xinitrc* file, if it exists, is executed whenever labwc launches the
Xwayland X11 server. This may happen multiple times throughout the session if Xwayland X11 server. This may happen multiple times throughout the session if
Xwayland is not configured to persist when no X11 clients are connected. Xwayland is not configured to persist when no X11 clients are connected.