tUpdate examples in manpage / README - safe - password protected secret keeper
(HTM) git clone git://git.z3bra.org/safe.git
(DIR) Log
(DIR) Files
(DIR) Refs
(DIR) README
(DIR) LICENSE
---
(DIR) commit 579eb5dc88c06576da5b3f159e28e71ecb65ae03
(DIR) parent 4cf289d713e858ae1ed0dc4e2c744787562aa3b9
(HTM) Author: Willy Goiffon <dev@z3bra.org>
Date: Mon, 24 Jun 2019 14:35:08 +0200
Update examples in manpage / README
Diffstat:
M README | 2 +-
M safe-agent.1 | 9 +++++++++
M safe.1 | 11 +++++------
3 files changed, 15 insertions(+), 7 deletions(-)
---
(DIR) diff --git a/README b/README
t@@ -17,7 +17,7 @@ Store your secrets in an encrypted safe, protected by a password.
# start a safe agent, export variables to the environment
# and push your key to it
- eval $(safe-agent &)
+ eval $(safe-agent)
safe -p
# have the agent forget the key
(DIR) diff --git a/safe-agent.1 b/safe-agent.1
t@@ -45,7 +45,16 @@ Later calls to
.Xr safe 1
will use these environment variables internally to retrieve the key and
use it to encrypt/decrypt the stored secrets.
+
+.Sh EXAMPLES
.Bd -literal
+Retrieve a secret from your safe, using the agent
+
+ $ eval $(safe-agent)
+ $ safe -p
+ password:
+ $ safe secret/file > kitten.gif
+
.Sh ENVIRONMENT
.Bl -tag -width "SAFE_SOCK"
.It Ev SAFE_SOCK
(DIR) diff --git a/safe.1 b/safe.1
t@@ -40,8 +40,9 @@ can retrieve the key from it rather than prompting you for a password.
.Nm
will try to read the key from the agent whenever the
.Ev SAFE_SOCK
-variable is set in the environment. When the agent is first started,
-you can push the key to it using the
+variable is set in the environment.
+.Pp
+When the agent is first started, you can push the key to it using the
.Fl p
flag.
.Sh MASTER PASSWORD
t@@ -65,12 +66,10 @@ List all secrets in $STORE (choose your weapon)
$ ls -R $STORE
$ tar -C $STORE -v -f /dev/null -c . | cut -d / -f 2-
-Retrieve a secret from your safe, using the agent
+Retrieve a secret from your safe
- $ eval $(safe-agent &)
- $ safe -p
+ $ safe secret/file > kitten.gif
password:
- $ safe passwords/email
.Sh ENVIRONMENT
.Bl -tag -width "SAFE_SOCK"