pw/man/man1/pw.1

92 lines
2.4 KiB
Groff
Raw Permalink Normal View History

2022-04-04 15:39:41 +02:00
.Dd April 4, 2022
2021-11-05 16:47:27 +01:00
.Dt pw 1
.Os
.Sh NAME
.Nm pw
2021-11-07 17:49:09 +01:00
.Nd Password generator
2021-11-05 16:47:27 +01:00
.\" .Sh LIBRARY
2022-04-04 15:39:41 +02:00
.\" For sections 2, 3, and 9 only.
2021-11-05 16:47:27 +01:00
.\" Not used in OpenBSD.
.Sh SYNOPSIS
.Nm
2021-11-07 18:02:46 +01:00
.Fl h
.Nm
.Fl \-version
2021-11-05 16:47:27 +01:00
.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
2022-01-13 16:23:33 +01:00
.Op Fl S Ar set-of-symbols
2021-11-07 17:52:32 +01:00
.Op Fl c Ar length
2021-11-05 16:47:27 +01:00
.Sh DESCRIPTION
The
.Nm
2021-11-07 17:49:09 +01:00
command generates a random password and prints it on the standard output.
If no flags for specifying which characters are allowed are given,
2021-11-05 16:47:27 +01:00
.Nm
acts as if all had been specified, with minimum amounts of occurrences for all
types being zero.
2021-11-05 16:47:27 +01:00
.Pp
The options are as follows:
.Bl -tag -width Ds
.It Fl h, \-help
Print help text and exit.
2021-11-07 17:49:09 +01:00
.It Fl \-version
2021-11-05 16:47:27 +01:00
Print version info and exit.
2021-11-07 17:49:09 +01:00
.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.
2021-11-07 17:49:09 +01:00
.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.
2021-11-07 17:49:09 +01:00
.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.
2021-11-07 17:49:09 +01:00
.It Fl s, \-symbol
2021-11-07 18:00:41 +01:00
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.
2022-01-13 16:23:33 +01:00
.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.
2022-04-04 15:39:41 +02:00
.It Fl c, \-count Ar length
2021-11-07 17:54:48 +01:00
Specify the password length.
Default is 24 characters.
2021-11-05 16:47:27 +01:00
.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.