.TH pass-update 1 "December 2018" "pass-update"

.SH NAME
pass-update \- A \fBpass\fP(1) extension that provides an easy flow for updating
passwords.

.SH SYNOPSIS
\fBpass update\fP [options] \fIpass-names...\fP

.SH DESCRIPTION
\fBpass update\fP extends the pass utility with an update command providing
an easy flow for updating passwords. It supports path, directory and wildcard
update. Moreover, you can select how to update your passwords by automatically
generating new passwords or manually setting your own.

\fBpass update\fP assumes that the first line of the password file is the
password and so only ever updates the first line unless the \fI--multiline\fP
option is specified.

By default \fBpass update\fP prints the old password and wait for the user before
generating a new one. This behaviour 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--include=<regex>\fP, \fI-i <regex>\fP ] [ \fI--exclude=<regex>\fP, \fI-e=<regex>\fP ] [ \fI--edit\fP, \fI-E\fP ]
     [ \fI--multiline\fP, \fI-m\fP ] \fIpass-names...\fP

Update the password provided: print the password and wait for the user to
generate a new one.

.I pass-names
can refer either to password store path(s) or directory. Both path and
directory can be given in the same command. When updating a directory, all the
passwords in this directory are updated. Wildcard update is supported by quoting
\fI'*'\fP sign.

Both old and newly generated password can optionally be written on the clipboard
using the \fI--clip\fP or \fI-c\fP option.

If \fI--no-symbols\fP or \fI-n\fP is specified, do not use any non-alphanumeric
characters in the generated password.

Specific password length can be given using \fI--length\fP or \fI-l\fP is
specified, along with a numerical argument.

If \fI--provide\fP or \fI-p\fP is specified, let the user specify a password by
hand. The user will have to confirm the password.

If \fI--multiline\fP or \fI-m\fP is specified, update a multiline password.
Beware this option will overwrite the full password file instead of updating
the password field.

If \fI--include\fP or \fI-i\fP is specified, Only update the passwords that
match a given regex.

If \fI--exclude\fP or \fI-e\fP is specified, Do not update the passwords that
match a given regex.

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.

.SH OPTIONS

.TP
\fB\-c\fB, \-\-clip\fR
Write the password in the clipboard.

.TP
\fB\-n\fB, \-\-no-symbols\fR
Do not use any non-alphanumeric characters.

.TP
\fB\-l <size>\fB, \-\-length=<size>\fR
Provide a password length.

.TP
\fB\-p\fB, \-\-provide\fR
Let the user specify a password by hand.

.TP
\fB\-m\fB, \-\-multiline\fR
Update a multiline password.

.TP
\fB\-e <regex>\fB, \-\-exclude=<regex>\fR
Do not update the passwords that macth a regex.

.TP
\fB\-i <regex>\fB, \-\-include=<regex>\fR
Only update the passwords that match a regex.

.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.

.TP
\fB\-V\fB, \-\-version\fR
Show version information

.TP
\fB\-h\fB, \-\-help\fR
Show usage message.


.SH EXAMPLES
.TP
Update Social/twitter.com
.B zx2c4@laptop ~ $ pass update Social/twitter.com
.br
Changing password for Social/twitter.com
.br
[}p&62"#"x'aF/_ix}6X3a)zq
.br
Are you ready to generate a new password? [y/N] y
.br
The generated password for Social/twitter.com is:
.br
~*>afZsB+G\,c#+g$-,{OqJ{w

.TP
Update all the Emails
.B zx2c4@laptop ~ $ pass update Email
.br
Changing password for Email/donenfeld.com
.br
b9b"k(u#m7|ST-400B5gM%[Kq
.br
Are you ready to generate a new password? [y/N] y
.br
The generated password for Email/donenfeld.com is:
.br
m6~!b5U`OhloT~R,4-OCa:h$Q
.br
Changing password for Email/zx2c4.com
.br
4Fg{1Wg;WM{JZHqAMI:j5Jo$7
.br
Are you ready to generate a new password? [y/N] y
.br
The generated password for Email/zx2c4.com is:
.br
@uLYW_X9a",?wDQN=hp/^Z!$J

.TP
Set password length
.B zx2c4@laptop ~ $ pass update France/bank -l 50
.br
Changing password for France/bank
.br
9b'I;]b)>06xug!3.ME1*E+M3
.br
login: zx2c4
.br
Are you ready to generate a new password? [y/N] y
.br
The generated password for France/bank is:
.br
|3=&{ko:#I|A,P4*=[|hk^/V4jIcRN.uBBd-~RB0_L<sS[%k%-

.TP
Provide a password by hand
.B zx2c4@laptop ~ $ pass update Business/site.com -p
.br
Changing password for Business/site.com
.br
Zk=u]HqjUAKPZ$gM_,LuZV8J2
.br
login: zx2c4
.br
Are you ready to provide a new password? [y/N] y
.br
Enter the new password for Business/site.com:
.br
Retype the new password for Business/site.com:

.TP
Do not update PIN code
.B zx2c4@laptop ~ $ pass update --exclude '^[0-9]+$' /

.TP
Update only PIN code
.B zx2c4@laptop ~ $ pass update --include '^[0-9]+$' /


.SH SEE ALSO
.BR pass(1),
.BR pass-tomb(1),
.BR pass-import(1),
.BR pass-otp(1),
.BR pass-audit(1)


.SH AUTHORS
.B pass update
was written by
.MT alexandre@pujol.io
Alexandre Pujol
.ME .


.SH COPYING
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program.  If not, see <http://www.gnu.org/licenses/>.