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.
This commit is contained in:
Daniel Eklöf 2020-08-02 12:28:53 +02:00
parent a026938547
commit f3c301ee8b
No known key found for this signature in database
GPG key ID: 5BBD4992C116573F
3 changed files with 15 additions and 6 deletions

View file

@ -176,7 +176,7 @@ main(int argc, char *const *argv)
const char *xdg_runtime = getenv("XDG_RUNTIME_DIR"); const char *xdg_runtime = getenv("XDG_RUNTIME_DIR");
if (xdg_runtime != NULL) { if (xdg_runtime != NULL) {
if (xdg_session_id == NULL) if (xdg_session_id == NULL)
xdg_session_id = "<no-session>"; xdg_session_id = "no-session";
snprintf(addr.sun_path, sizeof(addr.sun_path), "%s/foot-%s.sock", xdg_runtime, xdg_session_id); snprintf(addr.sun_path, sizeof(addr.sun_path), "%s/foot-%s.sock", xdg_runtime, xdg_session_id);
if (connect(fd, (const struct sockaddr *)&addr, sizeof(addr)) == 0) if (connect(fd, (const struct sockaddr *)&addr, sizeof(addr)) == 0)

View file

@ -1194,7 +1194,7 @@ get_server_socket_path(void)
return strdup("/tmp/foot.sock"); return strdup("/tmp/foot.sock");
if (xdg_session_id == NULL) if (xdg_session_id == NULL)
xdg_session_id = "<no-session>"; xdg_session_id = "no-session";
char *path = malloc(strlen(xdg_runtime) + 1 + strlen("foot-.sock") + strlen(xdg_session_id) + 1); char *path = malloc(strlen(xdg_runtime) + 1 + strlen("foot-.sock") + strlen(xdg_session_id) + 1);
sprintf(path, "%s/foot-%s.sock", xdg_runtime, xdg_session_id); sprintf(path, "%s/foot-%s.sock", xdg_runtime, xdg_session_id);

View file

@ -13,7 +13,7 @@ arguments, to execute (instead of the default shell).
# OPTIONS # OPTIONS
*-c*,*--config*=_PATH_ *-c*,*--config*=_PATH_
Path to configuration file. Default: *XDG_CONFIG_HOME/footrc*. Path to configuration file. Default: *$XDG_CONFIG_HOME/footrc*.
*--check-config* *--check-config*
Verify configuration and then exit with 0 if ok, otherwise exit 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 Also be aware that should one terminal crash, it will take all the
others with it. others with it.
You may optionally override the default socket path, The default path is
*XDG\_RUNTIME\_DIR/foot.sock*. If you do so, you will need to use *$XDG\_RUNTIME\_DIR/foot-$XDG\_SESSION\_ID.sock*.
the *--server-socket* option in *footclient*(1).
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* *--hold*
Remain open after child process exits. Remain open after child process exits.