Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
roddhjav committed Sep 15, 2017
1 parent 46be0dc commit 71c5b43
Show file tree
Hide file tree
Showing 3 changed files with 12 additions and 3 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ pass update 2.0 - A pass extension extension that provides an
easy flow for updating passwords.
Usage:
pass update [-h] [-n] [-l <s>] [-c | -p] [-p | -m] [-f] pass-names...
pass update [-h] [-n] [-l <s>] [-c | -p] [-p | -m] [-e] [-f] pass-names
Provide an interactive solution to update a set of passwords.
pass-names can refer either to password store path(s) or to directory.
Expand All @@ -32,6 +32,7 @@ Usage:
-l, --length Provide a password length.
-p, --provide Let the user specify a password by hand.
-m, --multiline Update a multiline password.
-e, --edit Edit the password using the default editor.
-f, --force Force update.
-V, --version Show version information.
-h, --help Print this help message and exit.
Expand Down
10 changes: 9 additions & 1 deletion pass-update.1
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ generating a new one. This behavior can be changed using the provided options.
.SH COMMAND
.TP
\fBpass update\fP [ \fI--clip\fP, \fI-c\fP ] [ \fI--no-symbols\fP, \fI-n\fP ] [ \fI--provide\fP, \fI-p\fP ]
[\fI--length=<size>\fP, \fI-l <size>\fP] [ \fI--multiline\fP, \fI-m\fP ] \fIpass-names...\fP
[\fI--length=<size>\fP, \fI-l <size>\fP] [ \fI--multiline\fP, \fI-m\fP ] [ \fI--edit\fP, \fI-e\fP ]
\fIpass-names...\fP

Update the password provided: print the password and wait for the user to
generate a new one.
Expand All @@ -46,6 +47,9 @@ If \fI--multiline\fP or \fI-m\fP is specified, update a multiline password.
Beware this option will ovewrite the full password file instead of updating
the password field.

If \fI--edit\fP or \fI-e\fP is specified, edit the password using the default
editor. This editor can be specified with \fIEDITOR\fP.

If \fI--force\fP or \fI-f\fP is specified, pass update does not wait for the
user and generate a new password immediately.

Expand All @@ -71,6 +75,10 @@ Let the user specify a password by hand.
\fB\-m\fB, \-\-multiline\fR
Update a multiline password.

.TP
\fB\-e\fB, \-\-edit\fR
Edit the password using the default editor.

.TP
\fB\-f\fB, \-\-force\fR
Force to update and do not wait for user instruction.
Expand Down
2 changes: 1 addition & 1 deletion update.bash
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ cmd_update_usage() {
echo
cat <<-_EOF
Usage:
$PROGRAM update [-h] [-n] [-l <s>] [-c | -p] [-p | -m] [-f] pass-names...
$PROGRAM update [-h] [-n] [-l <s>] [-c | -p] [-p | -m] [-e] [-f] pass-names
Provide an interactive solution to update a set of passwords.
pass-names can refer either to password store path(s) or to
directory.
Expand Down

0 comments on commit 71c5b43

Please sign in to comment.