aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorMax Gautier <mg@max.gautier.name>2022-01-15 16:37:31 +0000
committerMax Gautier <mg@max.gautier.name>2022-02-26 15:09:30 +0000
commit4ec172a4ad3e64489945a42b3bf6adb147e8e2d3 (patch)
treebfc254d700450e195996443d0b700bf39c9a8f0f /doc
parentAdding systemd unit files for socket activation (diff)
Document socket activation feature
- Particular mention to included systemd user units
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd15
1 files changed, 14 insertions, 1 deletions
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.