From 4ec172a4ad3e64489945a42b3bf6adb147e8e2d3 Mon Sep 17 00:00:00 2001 From: Max Gautier Date: Sat, 15 Jan 2022 17:37:31 +0100 Subject: Document socket activation feature - Particular mention to included systemd user units --- doc/foot.1.scd | 15 ++++++++++++++- 1 file changed, 14 insertions(+), 1 deletion(-) (limited to 'doc') diff --git a/doc/foot.1.scd b/doc/foot.1.scd index e990ca0d..65d7f5da 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -81,7 +81,7 @@ the foot command line Initial working directory for the client application. Default: _CWD of foot_. -*-s*,*--server*[=_PATH_] +*-s*,*--server*[=_PATH_|_FD_] Run as a server. In this mode, a single foot instance hosts multiple terminals (windows). Use *footclient*(1) to launch new terminals. @@ -116,6 +116,19 @@ the foot command line *--server-socket* option in *footclient*(1) and point it to your custom socket path. + If the argument is a number, foot will interpret it as the file descriptor + of a socket provided by a supervision daemon (such as systemd or s6), and + use that socket as it's own. + + Two systemd units (foot-server@.{service,socket}) are provided to use that + feature with systemd. They need to be instantiated with the value of + $WAYLAND_DISPLAY (multiples instances can co-exists). + + Note that starting *foot --server* as a systemd service will use + the environment of the systemd user instance; thus, if you need specific + environment variables, you'll need to import them using *systemctl --user + import-environment* or use a drop-in for the foot-server service. + *-H*,*--hold* Remain open after child process exits. -- cgit v1.3