mirror of
https://codeberg.org/dnkl/foot.git
synced 2026-03-14 05:33:59 -04:00
Document socket activation feature
- Particular mention to included systemd user units
This commit is contained in:
parent
1783f69cbd
commit
4ec172a4ad
2 changed files with 17 additions and 1 deletions
|
|
@ -266,6 +266,9 @@ when starting your Wayland compositor (i.e. logging in to your
|
||||||
desktop), and then run `footclient` instead of `foot` whenever you
|
desktop), and then run `footclient` instead of `foot` whenever you
|
||||||
want to launch a new terminal.
|
want to launch a new terminal.
|
||||||
|
|
||||||
|
Foot support socket activation, which means `foot --server` will only be
|
||||||
|
started the first time you'll run `footclient`. (systemd user units are
|
||||||
|
included, but it can work with other supervision suites).
|
||||||
|
|
||||||
## URLs
|
## URLs
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -81,7 +81,7 @@ the foot command line
|
||||||
Initial working directory for the client application. Default:
|
Initial working directory for the client application. Default:
|
||||||
_CWD of foot_.
|
_CWD of foot_.
|
||||||
|
|
||||||
*-s*,*--server*[=_PATH_]
|
*-s*,*--server*[=_PATH_|_FD_]
|
||||||
Run as a server. In this mode, a single foot instance hosts
|
Run as a server. In this mode, a single foot instance hosts
|
||||||
multiple terminals (windows). Use *footclient*(1) to launch new
|
multiple terminals (windows). Use *footclient*(1) to launch new
|
||||||
terminals.
|
terminals.
|
||||||
|
|
@ -116,6 +116,19 @@ the foot command line
|
||||||
*--server-socket* option in *footclient*(1) and point it to your
|
*--server-socket* option in *footclient*(1) and point it to your
|
||||||
custom socket path.
|
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*
|
*-H*,*--hold*
|
||||||
Remain open after child process exits.
|
Remain open after child process exits.
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue