gpass.1

.\" Copyright (c) 2022 Alex Arx <aa@manpager.org>
.\"
.\" Permission to use, copy, modify, and distribute this software for any
.\" purpose with or without fee is hereby granted, provided that the above
.\" copyright notice and this permission notice appear in all copies.
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd November 17, 2024
.Dt GPASS 1
.Os
.Sh NAME
.Nm gpass
.Nd generate passphrases
.Sh SYNOPSIS
.Nm
.Op Fl a
.Op Fl d Ar dict
.Op Fl e Ar bits
.Op Fl n Ar num
.Sh DESCRIPTION
The utility
.Nm
outputs a secure passphrase by randomly choosing an appropriate number of lines
from a dictionary file, containing whitespace-separated words.
The options are as follows:
.Bl -tag -width Ds
.It Fl a
Instead of generating a passphrases from the wordlist, generate strings of
random alphanumeric characters.
.It Fl d Ar dict
Use the dictionary
.Ar dict .
.It Fl e Ar bits
Generate a passphrase with at least the specified number of
.Ar bits
of entropy.
Default is 70.
.It Fl l Ar length
Generate a passphrase of
.Ar length
words, or characters if
.Fl a
is used.
Overrides
.Fl e .
.It Fl n Ar num
Generate
.Ar num
passphrases instead of just one.
.El
.Sh ENVIRONMENT
.Bl -tag -width GPASS_DIC
.It Ev GPASS_DIC
Path to the dictionary file to use unless the option
.Fl d
is specified.
.El
.Sh FILES
.Bl -tag -width Ds -compact
.It Pa $XDG_DATA_HOME/gpass.dic
.It Pa $HOME/.gpass.dic
.It Pa /usr/share/gpass.dic
.It Pa /usr/local/share/gpass.dic
Paths searched for the default dictionary file.
Only searched if
.Ev GPASS_DIC
is not set or empty, and
.Fl d
is not used.
First to be found is used.
.Pa $HOME/.gpass.dic
is only used when
.Ev XDG_DATA_HOME
is not set.
.El
.Sh EXIT STATUS
.Ex -std
.Sh AUTHORS
.An Alex Arx Aq Mt aa@manpager.net .