first cut at a man page for login_check_expire()

2 files changed, 71 insertions, 4 deletions

diff --git a/lib/libutil/Makefile b/lib/libutil/Makefile
index 2bb0ad8ef35..a0435d9934d 100644
--- a/lib/libutil/Makefile
+++ b/lib/libutil/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.20 2000/11/26 01:27:19 millert Exp $
+#	$OpenBSD: Makefile,v 1.21 2000/11/27 05:55:47 millert Exp $
 #	$NetBSD: Makefile,v 1.8 1996/05/16 07:03:28 thorpej Exp $
 
 LIB=	util
@@ -9,9 +9,9 @@ SRCS=	check_expire.c getmaxpartitions.c getrawpartition.c login.c \
 	login_tty.c logout.c logwtmp.c opendev.c passwd.c pty.c readlabel.c \
 	scsi.c login_fbtab.c uucplock.c fparseln.c opendisk.c
 
-MAN=	getmaxpartitions.3 getrawpartition.3 login.3 opendev.3 openpty.3 \
-	pw_init.3 pw_lock.3 readlabelfs.3 scsi.3 pw_getconf.3 uucplock.3 \
-	fparseln.3 opendisk.3 login_fbtab.3
+MAN=	check_expire.3 getmaxpartitions.3 getrawpartition.3 login.3 opendev.3 \
+	openpty.3 pw_init.3 pw_lock.3 readlabelfs.3 scsi.3 pw_getconf.3 \
+	uucplock.3 fparseln.3 opendisk.3 login_fbtab.3
 
 MLINKS+=login.3 logout.3
 MLINKS+=login.3 logwtmp.3
diff --git a/lib/libutil/check_expire.3 b/lib/libutil/check_expire.3
new file mode 100644
index 00000000000..78078e0d20e
--- /dev/null
+++ b/lib/libutil/check_expire.3
@@ -0,0 +1,67 @@
+.\"	$OpenBSD: check_expire.3,v 1.1 2000/11/27 05:55:47 millert Exp $
+.\"
+.\" Copyright (c) 2000 Todd C. Miller <Todd.Miller@courtesan.com>
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. The name of the author may not be used to endorse or promote products
+.\"    derived from this software without specific prior written permission.
+.\"
+.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES,
+.\" INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
+.\" AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL
+.\" THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
+.\" EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
+.\" PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+.\" OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+.\" WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR
+.\" OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
+.\" ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+.\"
+.Dd November 26, 2000
+.Dt CHECK_EXPIRE 3
+.Os
+.Sh NAME
+.Nm check_expire
+.Nd check for password expiration
+.Sh SYNOPSIS
+.Fd #include <util.h>
+.Ft int
+.Fn login_check_expire "FILE *back" "struct passwd *pwd" "char *class" "int lastchance"
+.Sh DESCRIPTION
+The
+.Fn login_check_expire
+function is called by a BSD authentication login script to
+check whether the user's password entry, as described by
+.Fa pwd ,
+has expired.
+.Pp
+If a
+.Fa class
+is specified, it is used instead of the class specified in the user's
+password database entry.
+If the
+.Fa lastchance
+argument is non-zero, the user's password has expired, and it has not been
+expired longer than
+.Dq password-dead
+seconds (see
+.Xr login.conf 5 ) ,
+the user will be able to log in one last time to change the password.
+.Sh RETURN VALUE
+The
+.Fn login_check_expire
+function returns 0 if the user's password has not expired, and 1 if it has
+expired or if an error occurred.
+.br
+Status and error messages are passed
+back to the login script caller via the back channel,
+.Fa back .
+.Sh SEE ALSO
+.Xr authenticate 3 ,
+.Xr auth_subr 3 ,
+.Xr login.conf 5