pw/man/man1/pw.1

92 lines
2.4 KiB
Groff

.Dd April 4, 2022
.Dt pw 1
.Os
.Sh NAME
.Nm pw
.Nd Password generator
.\" .Sh LIBRARY
.\" For sections 2, 3, and 9 only.
.\" Not used in OpenBSD.
.Sh SYNOPSIS
.Nm
.Fl h
.Nm
.Fl \-version
.Nm
.Op Fl d Ar minimum-amount
.Op Fl l Ar minimum-amount
.Op Fl u Ar minimum-amount
.Op Fl s Ar minimum-amount
.Op Fl S Ar set-of-symbols
.Op Fl c Ar length
.Sh DESCRIPTION
The
.Nm
command generates a random password and prints it on the standard output.
If no flags for specifying which characters are allowed are given,
.Nm
acts as if all had been specified, with minimum amounts of occurrences for all
types being zero.
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl h, \-help
Print help text and exit.
.It Fl \-version
Print version info and exit.
.It Fl d, \-digit
Allow digits.
An integer argument is expected, which should be zero or more, and indicates the
minimum amount of digits to be included.
.It Fl l, \-lower
Allow lower case letters.
An integer argument is expected, which should be zero or more, and indicates the
minimum amount of lower case letters to be included.
.It Fl u, \-upper
Allow upper case letters.
An integer argument is expected, which should be zero or more, and indicates the
minimum amount of upper case letters to be included.
.It Fl s, \-symbol
Allow symbols and punctuation from the following list: _-=+<>,.!@#$%^&*.
An integer argument is expected, which should be zero or more, and indicates the
minimum amount of symbols to be included.
.It Fl S, \-special Ar set-of-symbols
Allow symbols from specified argument.
For example, specifying
.Fl S
.Sq :-+@
allows symbols :, -, + or @.
The minimum amount will always be one when this option is given.
.It Fl c, \-count Ar length
Specify the password length.
Default is 24 characters.
.El
.\" .Sh CONTEXT
.\" For section 9 functions only.
.\" .Sh IMPLEMENTATION NOTES
.\" Not used in OpenBSD.
.\" .Sh RETURN VALUES
.\" For sections 2, 3, and 9 function return values only.
.\" .Sh ENVIRONMENT
.\" For sections 1, 6, 7, and 8 only.
.\" .Sh FILES
.Sh EXIT STATUS
.\" For sections 1, 6, and 8 only.
.Nm
exits 0 on success, and 1 if an error occurs.
.\" .Sh EXAMPLES
.\" .Sh DIAGNOSTICS
.\" For sections 1, 4, 6, 7, 8, and 9 printf/stderr messages only.
.\" .Sh ERRORS
.\" For sections 2, 3, 4, and 9 errno settings only.
.\" .Sh SEE ALSO
.\" .Xr foobar 1
.\" .Sh STANDARDS
.\" .Sh HISTORY
.Sh AUTHORS
Bob Polis
.\" .Sh CAVEATS
.\" .Sh BUGS
.\" .Sh SECURITY CONSIDERATIONS
.\" Not used in OpenBSD.