docs: add example shutdown file

Closes #1809

diff --git a/README.md b/README.md
index 5e0e9b9e42c61779e2c7e776def02be2f7a909b4..88ed65ad316c11cadb4cda183be2cf728ef0dbb6 100644 (file)
--- a/README.md
+++ b/README.md
@@ -107,7 +107,7 @@ See [scope] for full details on implemented features.
 
 High-level summary of items that Labwc supports:
 
-- [x] Config files (rc.xml, autostart, environment, menu.xml)
+- [x] Config files (rc.xml, autostart, shutdown, environment, menu.xml)
 - [x] Theme files and xbm/png/svg icons
 - [x] Basic desktop and client menus
 - [x] HiDPI
@@ -182,7 +182,7 @@ prevent installing the wlroots headers:
 ## 3. Configuration
 
 User config files are located at `${XDG_CONFIG_HOME:-$HOME/.config/labwc/}`
-with the following five files being used: [rc.xml], [menu.xml], [autostart],
+with the following five files being used: [rc.xml], [menu.xml], [autostart], [shutdown],
 [environment] and [themerc-override].
 
 Run `labwc --reconfigure` to reload configuration and theme.
@@ -277,6 +277,7 @@ See [integration] for further details.
 [rc.xml]: docs/rc.xml.all
 [menu.xml]: docs/menu.xml
 [autostart]: docs/autostart
+[shutdown]: docs/shutdown
 [environment]: docs/environment
 [themerc-override]: docs/themerc
 [themerc]: docs/themerc

diff --git a/docs/README b/docs/README
index e2b393961f1e5336d341af59950de45344333878..b5f022fc892feaceff3dc295a3cf6dc5ed1cb2bf 100644 (file)
--- a/docs/README
+++ b/docs/README
@@ -3,6 +3,7 @@ Config layout for ~/.config/labwc/
 - environment
 - menu.xml
 - rc.xml
+- shutdown
 - themerc-override
 
 See `man labwc-config and `man labwc-theme` for further details.

diff --git a/docs/meson.build b/docs/meson.build
index f118980fba19c7613af04f737ca2320e4ee3c43e..a667678471caa615e0c40e1f790905c79d6e7928 100644 (file)
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -30,6 +30,7 @@ install_data(
     'environment',
     'menu.xml',
     'README',
+    'shutdown',
     'themerc',
     'rc.xml',
     'rc.xml.all'

diff --git a/docs/shutdown b/docs/shutdown
new file mode 100644 (file)
index 0000000..970eaa2
--- /dev/null
+++ b/docs/shutdown
@@ -0,0 +1,4 @@
+# Example shutdown file
+
+# This file is executed as a shell script when labwc is preparing to terminate itself.
+# For further details see labwc-config(5).