From f3c301ee8b94c3354080695326ceedc7a3866321 Mon Sep 17 00:00:00 2001 From: Daniel Eklöf Date: Sun, 2 Aug 2020 12:28:53 +0200 Subject: doc: foot.1: fix default path in -s,--server The documentation incorrectly stated that the default path is $XDG_RUNTIME_DIR/foot.sock. The correct default path is * $XDG_RUNTIME_DIR/foot-$XDG_SESSION_ID.sock * $XDG_RUNTIME_DIR/foot-no-session.sock * /tmp/foot.sock Depending on whether XDG_RUNTIME_DIR and XDG_SESSION_ID has been set or not. This also removes the '<>' from the default when XDG_SESSION_ID is not set. Closes #53. --- doc/foot.1.scd | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) (limited to 'doc') diff --git a/doc/foot.1.scd b/doc/foot.1.scd index c8b1f6e7..bf45777e 100644 --- a/doc/foot.1.scd +++ b/doc/foot.1.scd @@ -13,7 +13,7 @@ arguments, to execute (instead of the default shell). # OPTIONS *-c*,*--config*=_PATH_ - Path to configuration file. Default: *XDG_CONFIG_HOME/footrc*. + Path to configuration file. Default: *$XDG_CONFIG_HOME/footrc*. *--check-config* Verify configuration and then exit with 0 if ok, otherwise exit @@ -80,9 +80,18 @@ arguments, to execute (instead of the default shell). Also be aware that should one terminal crash, it will take all the others with it. - You may optionally override the default socket path, - *XDG\_RUNTIME\_DIR/foot.sock*. If you do so, you will need to use - the *--server-socket* option in *footclient*(1). + The default path is + *$XDG\_RUNTIME\_DIR/foot-$XDG\_SESSION\_ID.sock*. + + If *$XDG_RUNTIME_DIR* is not set, the default path is instead + */tmp/foot.sock*. + + If *$XDG_RUNTIME_DIR* is set, but *$XDG_SESSION_ID* is not, the + default path is *$XDG_RUNTIME_DIR/foot-no-session.sock*. + + Note that if you change the default, you will also need to use the + *--server-socket* option in *footclient*(1) and point it to your + custom socket path. *--hold* Remain open after child process exits. -- cgit v1.3