mdoc-0.5.0.0: templates/pass.1.mustache

{{>title1}}
.Sh NAME
.Nm pass
.Nd stores, retrieves, generates, and synchronizes passwords securely
.Sh SYNOPSIS
.Nm
{{{page.synopsis}}}
{{#page.commands.items}}
.Pp
.Nm
.Cm {{{name}}}
{{#synopsis}}
{{{.}}}
{{/synopsis}}
{{/page.commands.items}}
.Sh DESCRIPTION
.Nm
is a very simple password store that keeps passwords inside
.Xr gpg2 1
encrypted files inside a simple directory tree residing at
.Pa ~/.password-store .
The pass utility provides a series of commands for manipulating the password
store, allowing the user to add, remove, edit, synchronize, generate, and
manipulate passwords.
.Pp
If no COMMAND is specified, COMMAND defaults to either
.Cm show
or
.Cm ls ,
depending on the type of specifier in ARGS. Alternatively, if
.Ar PASSWORD_STORE_ENABLE_EXTENSIONS
is set to "true", and the file
.Pa .extensions/COMMAND.bash
exists inside the password store and is executable, then it is sourced into the
environment, passing any arguments and environment variables. Extensions
existing in a system- wide directory, only installable by the administrator, are
always enabled.
.Pp
Otherwise COMMAND must be one of the valid commands listed below.
.Pp
Several of the commands below rely on or provide additional functionality if the
password store directory is also a git repository. If the password store
directory is a git repository, all password store modification commands will
cause a corresponding git commit. Sub- directories may be separate nested git
repositories, and pass will use the inner-most directory relative to the current
password. See the
.Ar EXTENDED GIT EXAMPLE
section for a detailed description using init and
.Xr git 1
.Pp
The
.Cm init
command must be run before other commands in order to initialize the password
store with the correct gpg key id. Passwords are encrypted using the gpg key set
with
.Cm init .
.Pp
There is a corresponding bash completion script for use with tab completing
password names in
.Xr bash 1 .
{{#page.options}}
{{>options}}
{{/page.options}}
{{#page.commands}}
.Ss COMMANDS
{{>commands}}
{{/page.commands}}
.Sh EXIT STATUS
.Ex -std