diff --git a/man/pam_biometrics.8 b/man/pam_biometrics.8 new file mode 100644 index 0000000..83672fd --- /dev/null +++ b/man/pam_biometrics.8 @@ -0,0 +1,47 @@ +.\" +.\" Copyright (c) 2023 Procursus Team +.\" SPDX-License-Identifier: BSD-2-Clause +.\" +.Dd February 27, 2023 +.Dt PAM_BIOMETRICS 8 +.Os +.Sh NAME +.Nm pam_biometrics +.Nd PAM module for FaceID/TouchID authentication +.Sh SYNOPSIS +.Op Ar service-name +.Ar function-class +.Ar control-flag +pam_biometrics +.Op Ar options +.Sh DESCRIPTION +.Nm pam_biometrics +is a PAM module that allows users to authenticate with FaceID or TouchID. +.Pp +The following options can be used to set up +.Nm pam_biometrics : +.Bl -tag -width -indent +.It Sy timeout +Set a timeout period for authentication, in seconds. +.It Sy prompt +Set the given prompt as a message when authenticating. +.It Sy disableonssh +Disable the PAM module when used over SSH. +.It Sy allowwatch +Make use of your Apple Watch for authentication instead. +.El +.Sh EXAMPLES +Setting a timeout of 10 seconds for any service +.Pp +.Dl "auth sufficient pam_biometrics.so timeout=10" +.Pp +Setting a custom message and timeout to any service, while disabling +the configuration when connecting through SSH +.Pp +.Dl "auth required pam_biometrics.so timeout=10 prompt=Find\ your\ phone disableonssh" +.Sh SEE ALSO +.Xr pam.conf 5 , +.Xr pam 8 +.Sh BUGS +Report bugs to the issue tracker: +.Lk https://github.com/ProcursusTeam/pam-biometrics/issues