summaryrefslogtreecommitdiff
path: root/passmenu.1
diff options
context:
space:
mode:
Diffstat (limited to 'passmenu.1')
-rw-r--r--passmenu.189
1 files changed, 89 insertions, 0 deletions
diff --git a/passmenu.1 b/passmenu.1
new file mode 100644
index 0000000..399ae3a
--- /dev/null
+++ b/passmenu.1
@@ -0,0 +1,89 @@
+.\"""
+.\" passmenu.1 - passmenu man page
+.\"
+.\" bertalanp99@ 2019-05-20
+.\"""
+.Dd 2019-05-20
+.Dt PASSMENU 1
+.Os
+.Sh NAME
+.Nm passmenu
+.Nd dmenu interface for password-store (pass)
+.Sh SYNOPSIS
+.Nm passmenu
+.Op Fl hu
+.Op dmenu options
+.Sh DESCRIPTION
+The
+.Nm
+utility provides a quick and easy interface for
+.Xr pass 1
+using
+.Xr dmenu 1
+.Ns . It reads all passwords from
+.Ev PASSWORD_STORE DIR
+(
+.Ns Pa ~/.password-store
+if unset) and displays them in dmenu. The selected password is
+copied to the clipboard.
+
+The following options are available:
+.Bl -tag -width Ds -compact
+.It Fl h
+Print usage
+.It Fl u
+Copy the username, not the password
+.It dmenu options
+.Nm
+accepts all options
+.Xr dmenu 1
+accepts and passes them to it.
+.El
+.Sh ENVIRONMENT
+.Pp
+The following environment variables affect
+.Nm
+:
+.Bl -tag -width Ds -compact
+.It Ev PASSWORD_STORE_DIR
+The location of the password-store
+.El
+.Sh EXIT STATUS
+.Nm
+returns 0 on success
+and
+1 on any error
+.Sh EXAMPLES
+Run
+.Nm
+with various options passed to dmenu:
+.Bd -literal -offset indent -compact
+passmenu -nb '#000' -nf '#FFF' -sb '#AAA' -sf '#000'
+.Be
+.Sh SEE ALSO
+.Xr pass 1
+.Xr dmenu 1
+.Sh HISTORY
+There is a popular script with the same name, however, that is a different
+implementation. As of 2019-05-20, said script is available at
+.Lk https://git.zx2c4.com/password-store/tree/contrib/dmenu/passmenu
+.Sh AUTHORS
+The
+.Nm
+script was written by
+.An Bertalan Z. P├ęter Aq Mt bertalanp99@bertalanp99.eu
+.Sh CAVEATS
+.Pp
+Beware that when copying passwords using the
+.Fl u
+option,
+.Nm
+actually just takes the second line of the password file and trims the string
+.Ql login:\
+out. Therefore passwords are expected to be stored in the form
+.Bd -literal -offset indent -compact
+my-highly-secure-password999
+login: my-username
+url: https://some-site.domain
+\&...
+.Ed