summaryrefslogtreecommitdiff
path: root/plugins/last-working-dir/README.md
diff options
context:
space:
mode:
authorwilkis <git@marv.one>2021-01-12 20:40:27 +0100
committerGitHub <noreply@github.com>2021-01-12 20:40:27 +0100
commit869eb2091389eabd919c32b2ca98ed1b0af851e6 (patch)
tree025df38a6cfda141e93d968c9f5e728c2e99e5e7 /plugins/last-working-dir/README.md
parentfae34b383d6432f7118c2ad082224f6d27d51221 (diff)
downloadzsh-869eb2091389eabd919c32b2ca98ed1b0af851e6.tar.gz
zsh-869eb2091389eabd919c32b2ca98ed1b0af851e6.tar.bz2
zsh-869eb2091389eabd919c32b2ca98ed1b0af851e6.zip
feat(last-working-dir): log separate `lwd`s for different SSH keys on the same user account (#9534)
Co-authored-by: Marc Cornellà <hello@mcornella.com>
Diffstat (limited to 'plugins/last-working-dir/README.md')
-rw-r--r--plugins/last-working-dir/README.md28
1 files changed, 23 insertions, 5 deletions
diff --git a/plugins/last-working-dir/README.md b/plugins/last-working-dir/README.md
index ced9e0370..b5cc55828 100644
--- a/plugins/last-working-dir/README.md
+++ b/plugins/last-working-dir/README.md
@@ -1,15 +1,33 @@
# last-working-dir plugin
Keeps track of the last used working directory and automatically jumps into it
-for new shells, unless:
+for new shells, unless the starting directory is not `$HOME`.
-- The plugin is already loaded.
-- The current `$PWD` is not `$HOME`.
-
-Also adds `lwd` function to jump to the last working directory.
+Also adds a `lwd` function to jump to the last working directory.
To use it, add `last-working-dir` to the plugins array in your zshrc file:
```zsh
plugins=(... last-working-dir)
```
+
+## Features
+
+### Use separate last-working-dir files with different SSH keys
+
+If the same user account is used by multiple users connecting via different SSH keys, you can
+configure SSH to map them to different `SSH_USER`s and the plugin will use separate lwd files
+for each one.
+
+Make sure that your SSH server allows environment variables. You can enable this feature
+within the `/etc/sshd/sshd_config` file:
+
+```
+PermitUserEnvironment yes
+```
+
+Then, add `environment="SSH_USER=<SSH_USERNAME>"` before the SSH keys in your `authorized_keys` file:
+
+```
+environment="SSH_USER=a.test@example.com" ssh-ed25519 AAAAC3Nz...
+```