Skip to content
This repository was archived by the owner on Jun 15, 2020. It is now read-only.

Commit fc007cb

Browse files
committed
Updated README for 1.3.
1 parent 8bcf6e3 commit fc007cb

File tree

1 file changed

+18
-9
lines changed

1 file changed

+18
-9
lines changed

README.md

+18-9
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Using `weasel-pageant` is generally similar to using `ssh-agent` on Linux and
8080
similar operating systems.
8181

8282
1. Ensure that PuTTY's Pageant is running (and holds your SSH keys).
83-
* weasel-pageant does not start Pageant itself.
83+
* `weasel-pageant` does not start Pageant itself.
8484
* Recommended: Add Pageant to your Windows startup/Autostart configuration
8585
so it is always available.
8686

@@ -106,13 +106,18 @@ similar operating systems.
106106

107107
A previous version of this manual suggested using the `-a` flag to set a fixed
108108
socket path which could be reused by all open WSL consoles. Due to the limitations of
109-
WSL-Win32 interop, this would cause problems including hanging SSH agent connections
110-
and hanging `conhost` processes in many use cases.
109+
WSL-Win32 interop, this causes problems including hanging SSH agent connections
110+
and hanging `conhost` processes in many use cases. Unless you have a specific need
111+
for a fixed socket path, it is better to remove the `-a` flag froom your `weasel-pageant`
112+
startup command. A `weasel-pageant` instance will then be started for each WSL console
113+
you open.
111114

112-
Therefore, unless you have a specific need for it, *the `-a` flag should be removed
113-
from your `weasel-pageant` startup command*. A `weasel-pageant` instance will then
114-
be started for each WSL console you open, but will be reused by any sub-shells
115-
of that window (when `-r` is given).
115+
However, with Windows 10 version 1809 or newer, it is now possible to use a fixed
116+
socket path reliably. In addition to the `-a` flag, also set the `-b` to prevent
117+
the `weasel-pageant` process from exiting with its parent console. For example
118+
to create a persistent socket in your home directory:
119+
120+
eval $(<location where you unpacked the zip>/weasel-pageant -rb -a $HOME/.weasel-pageant.sock)
116121

117122
## Options
118123

@@ -136,7 +141,8 @@ of that window (when `-r` is given).
136141
-b Do not exit when tty closes (only use on Windows 10 version 1809 and newer).
137142

138143
By default, the Win32 helper will be searched for in the same directory where `weasel-pageant`
139-
is stored. If you have placed it elsewhere, the `-H` flag can be used to set the location.
144+
is installed. If you have placed `helper.exe` elsewhere, the `-H` flag can be used to set the
145+
location.
140146

141147
## Known issues
142148

@@ -162,6 +168,9 @@ to your shell initialization files (e.g. `.bashrc`).
162168
**Upgrade note:** remove the `-a` flag from the `weasel-pageant` command line unless you
163169
know you need it.
164170
* 2019-01-06: 1.2 - Fixed unexpected daemon exits caused by a signal handling issue.
171+
* 2019-03-10: 1.3 - Added the `-b` flag to prevent the daemon from exiting when its
172+
parent terminal closes. Requires Windows 10 1809 or newer. Thanks to @niklasholm for
173+
the patch.
165174

166175
## Bug reports and contributions
167176

@@ -192,7 +201,7 @@ of these):
192201

193202

194203
------------------------------------------------------------------------------
195-
Copyright 2017-2019 Valtteri Vuorikoski
204+
Copyright 2017-2019 Valtteri Vuorikoski & contributors
196205

197206
Based on `ssh-pageant`, copyright (C) 2009-2014 Josh Stone
198207

0 commit comments

Comments
 (0)