tReword / Rearrange manpages and README - safe - password protected secret keeper
HTML git clone git://git.z3bra.org/safe.git
DIR Log
DIR Files
DIR Refs
DIR README
DIR LICENSE
---
DIR commit e4c62d2894b9a3536e0251575bae76a12a3f152c
DIR parent fcb30202c868763203d8dc6f490e030e29a3b6d7
HTML Author: Willy Goiffon <dev@z3bra.org>
Date: Tue, 25 Jun 2019 09:06:35 +0200
Reword / Rearrange manpages and README
Diffstat:
M README | 6 ++++--
M safe-agent.1 | 9 ++++++---
M safe.1 | 20 +++++++++++---------
3 files changed, 21 insertions(+), 14 deletions(-)
---
DIR diff --git a/README b/README
t@@ -12,7 +12,7 @@ Store your secrets in an encrypted safe, protected by a password.
# retrieve a secret from your safe
safe my/deepest/secret
- # list all your deepest secrets
+ # list all your secrets
find .secrets -type f
# start a safe agent, export variables to the environment
t@@ -32,7 +32,9 @@ Store your secrets in an encrypted safe, protected by a password.
## design
-Your safe is stored on disk as a directory tree:
+Your safe is stored on disk as a directory tree, which location is set
+at compilation time (default: .secrets). This location can later be
+changed with the SAFE_DIR environment variable, or using the -s flag.
.secrets
.secrets/master
DIR diff --git a/safe-agent.1 b/safe-agent.1
t@@ -1,14 +1,17 @@
.Dd 2019-06-08
.Dt SAFE-AGENT 1
-.Os POSIX.1-2008
+.Os POSIX.1-2017
+
.Sh NAME
.Nm safe-agent
.Nd Digital safe for your secrets
+
.Sh SYNOPSIS
.Nm
.Op Fl hd
.Op Fl t Ar timeout
.Op Fl f Ar socket
+
.Sh DESCRIPTION
.Nm
can retain a derivated key and its salt in memroy, and send it over a
t@@ -57,11 +60,11 @@ Retrieve a secret from your safe, using the agent
.Sh ENVIRONMENT
.Bl -tag -width "SAFE_SOCK"
+.It Ev SAFE_PID
+Stores the PID of the currently running agent.
.It Ev SAFE_SOCK
Stores the path to the UNIX-domain socket used to communicate with
the agent.
-.It Ev SAFE_PID
-Stores the PID of the currently running agent.
.Sh AUTHORS
.An Willy Goiffon Aq Mt dev@z3bra.org
\ No newline at end of file
DIR diff --git a/safe.1 b/safe.1
t@@ -1,15 +1,18 @@
.Dd 2019-02-20
.Dt SAFE 1
-.Os POSIX.1-2008
+.Os POSIX.1-2017
+
.Sh NAME
.Nm safe
.Nd Digital safe for your secrets
+
.Sh SYNOPSIS
.Nm
.Op Fl hp
.Op Fl s Ar safe
.Op Fl a
.Ar secret
+
.Sh DESCRIPTION
.Nm
stores secrets (files) encrypted on your disk, and lets you retrieve them,
t@@ -33,6 +36,7 @@ Set the path to your safe as
.It Fl a Ar secret
Encrypt stdin to your safe as
.Ar secret .
+
.Sh AGENT
When the agent is started,
.Nm
t@@ -45,6 +49,7 @@ variable is set in the environment.
When the agent is first started, you can push the key to it using the
.Fl p
flag.
+
.Sh MASTER PASSWORD
When you add your first secret to the safe, a
.Ar master
t@@ -52,7 +57,8 @@ entry will be created automatically. This entry stores your master
password, and is used to check that you typed the master password
correctly on the next calls.
.Pp
-Do not delete this entry.
+Do not delete this entry as it could lead to a corrupted safe.
+
.Sh EXAMPLES
.Bd -literal
Store a secret in your safe
t@@ -77,10 +83,6 @@ Retrieve a secret from your safe
Defines the location of your safe (default: .secrets)
.It Ev SAFE_SOCK
Path to the UNIX-domain socket used to communicate with the agent.
-.Sh BUGS
-When the agent does not have the key in memory,
-.Nm
-will simply hang when trying to read from the socket.
+
.Sh AUTHORS
-.An
-.Pp Willy Goiffon Aq Mt dev@z3bra.org
-\ No newline at end of file
+.An Willy Goiffon Aq Mt dev@z3bra.org
+\ No newline at end of file