aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2023-05-17 18:51:40 +0000
committerDaniel Eklöf <daniel@ekloef.se>2023-05-22 16:47:25 +0000
commite78319fccd2b8c057deff4b1937b325be1d35140 (patch)
tree493ce56bf9ffe7b00386108d89869b8998f2ea6f /doc
parentslave: unset TERM_PROGRAM{,_VERSION} (diff)
utmp: rewrite utmp logging
This patch generalizes the utmp support, to not only support libutempter, but also ulog (and in the future, even more interfaces). * Rename config option main.utempter to main.utmp-helper * Add meson option -Dutmp-backend=none|libutempter|ulog|auto * Rename meson option -Ddefault-utempter-path to -Dutmp-default-helper-path * utmp is no longer detected at compile time, but at runtime instead. Meson will configure the following pre-processor macros, based on the selected utmp backend: * UTMP_ADD - argument to pass to utmp helper when adding a record (starting foot) * UTMP_DEL - argument to pass to utmp helper when removing a record (exiting foot) * UTMP_DEL_HAVE_ARGUMENT - if defined, UTMP_DEL expects an extra argument ($WAYLAND_DISPLAY) * UTMP_DEFAULT_HELPER_PATH - path to the default utmp helper binary The documentation has been updated to mention which arguments are passed to the helper binary. Closes #1314
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.ini.5.scd21
-rw-r--r--doc/meson.build18
2 files changed, 32 insertions, 7 deletions
diff --git a/doc/foot.ini.5.scd b/doc/foot.ini.5.scd
index 5ef62045..6a820892 100644
--- a/doc/foot.ini.5.scd
+++ b/doc/foot.ini.5.scd
@@ -343,9 +343,24 @@ empty string to be set, but it must be quoted: *KEY=""*)
(including SMT). Note that this is not always the best value. In
some cases, the number of physical _cores_ is better.
-*utempter*
- Path to utempter helper binary. Set to *none* to disable utmp
- records. Default: _@utempter@_.
+*utmp-helper*
+ Path to utmp logging helper binary.
+
+ When starting foot, an utmp record is created by launching the
+ helper binary with the following arguments:
+
+ ```
+ @utmp_add_args@
+ ```
+
+ When foot is closed, the utmp record is removed by launching the
+ helper binary with the following arguments:
+
+ ```
+ @utmp_del_args@
+ ```
+
+ Set to *none* to disable utmp records. Default: _@utmp_helper_path@_.
# SECTION: environment
diff --git a/doc/meson.build b/doc/meson.build
index 86e75952..17f09f39 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -2,16 +2,26 @@ sh = find_program('sh', native: true)
scdoc_prog = find_program(scdoc.get_variable('scdoc'), native: true)
-if utempter_path == ''
- default_utempter_value = 'not set'
+if utmp_backend != 'none'
+ utmp_add_args = '@0@ $WAYLAND_DISPLAY'.format(utmp_add)
+ utmp_del_args = (utmp_del_have_argument
+ ? '@0@ $WAYLAND_DISPLAY'.format(utmp_del)
+ : '@0@'.format(utmp_del))
+ utmp_path = utmp_default_helper_path
else
- default_utempter_value = utempter_path
+ utmp_add_args = '<no utmp support in foot>'
+ utmp_del_args = '<no utmp support in foot>'
+ utmp_path = 'none'
endif
+
conf_data = configuration_data(
{
'default_terminfo': get_option('default-terminfo'),
- 'utempter': default_utempter_value,
+ 'utmp_backend': utmp_backend,
+ 'utmp_add_args': utmp_add_args,
+ 'utmp_del_args': utmp_del_args,
+ 'utmp_helper_path': utmp_path,
}
)