aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorDaniel Eklöf <daniel@ekloef.se>2020-08-02 11:10:31 +0000
committerDaniel Eklöf <daniel@ekloef.se>2020-08-02 11:10:31 +0000
commit5e26d3ef470bc1129e7fb442334e34dcbb045d12 (patch)
treeef10126fed29cb0c7f2bc145eaf36557077d7a1c /doc
parentmain: update --help with correct default path for -s,--server (diff)
server/client: use $WAYLAND_DISPLAY instead of $XDG_SESSION_ID in default socket path
Foot is a Wayland client and cannot be run outside of a Wayland session. As such, it makes more sense to use $WAYLAND_SESSION instead of $XDG_SESSION_ID in the default socket path since this makes it clearer which Wayland session we belong to. Closes #55.
Diffstat (limited to 'doc')
-rw-r--r--doc/foot.1.scd8
-rw-r--r--doc/footclient.1.scd3
2 files changed, 6 insertions, 5 deletions
diff --git a/doc/foot.1.scd b/doc/foot.1.scd
index bf45777e..55c82e18 100644
--- a/doc/foot.1.scd
+++ b/doc/foot.1.scd
@@ -81,13 +81,13 @@ arguments, to execute (instead of the default shell).
others with it.
The default path is
- *$XDG\_RUNTIME\_DIR/foot-$XDG\_SESSION\_ID.sock*.
+ *$XDG\_RUNTIME\_DIR/foot-$WAYLAND\_DISPLAY.sock*.
- If *$XDG_RUNTIME_DIR* is not set, the default path is instead
+ 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*.
+ If *$XDG\_RUNTIME\_DIR* is set, but *$WAYLAND\_DISPLAY* is not,
+ the default path is *$XDG\_RUNTIME\_DIR/foot.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
diff --git a/doc/footclient.1.scd b/doc/footclient.1.scd
index 4f65bf9d..88b6676c 100644
--- a/doc/footclient.1.scd
+++ b/doc/footclient.1.scd
@@ -34,7 +34,8 @@ arguments, to execute (instead of the default shell).
Start a login shell, by prepending a '-' to argv[0].
*-s*,*--server-socket*=_PATH_
- Connect to _PATH_ instead of _XDG\_RUNTIME\_DIR/foot.sock_.
+ Connect to _PATH_ instead of
+ *$XDG\_RUNTIME\_DIR/foot-$WAYLAND\_DISPLAY.sock*.
*--hold*
Remain open after child process exits.