Add some rudimentary documentation for my new functions.

4 files changed, 182 insertions, 2 deletions

diff --git a/lib/libutil/Makefile b/lib/libutil/Makefile
index 47b728a..7754e6e 100644
--- a/lib/libutil/Makefile
+++ b/lib/libutil/Makefile
@@ -10,8 +10,11 @@ SRCS=	login.c login_tty.c logout.c logwtmp.c pty.c setproctitle.c \
 	_secure_path.c uucplock.c property.c auth.c
 MAN3+=	login.3 login_auth.3 login_tty.3 logout.3 logwtmp.3 pty.3 \
 	setproctitle.3 login_cap.3 login_class.3 login_times.3 login_ok.3 \
-	_secure_path.3 uucplock.3
-MAN5+=	login.conf.5
+	_secure_path.3 uucplock.3 property.3 auth.3
+MAN5+=	login.conf.5 auth.conf.5
+MLINKS+= property.3 properties_read.3  property.3 properties_free.3
+MLINKS+= property.3 property_find.3
+MLINKS+= auth.3 auth_getval.3
 MLINKS+= pty.3 openpty.3  pty.3 forkpty.3
 MLINKS+=login_cap.3 login_getclassbyname.3 login_cap.3 login_close.3 \
 	login_cap.3 login_getclass.3 login_cap.3 login_getuserclass.3 \
diff --git a/lib/libutil/auth.3 b/lib/libutil/auth.3
new file mode 100644
index 0000000..a9732cf5
--- /dev/null
+++ b/lib/libutil/auth.3
@@ -0,0 +1,61 @@
+.\" 
+.\" Copyright (c) 1998 Jordan Hubbard
+.\" 
+.\" 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. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``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 DEVELOPERS 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.
+.\" 
+.\" $Id$
+.\" "
+.Dd October 7, 1998
+.Os
+.Dt auth_getval 3
+.Sh NAME
+.Nm auth_getval
+.Nd functions for reading values from
+.Pa /etc/auth.conf
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <libutil.h>
+.Ft char *
+.Fn auth_getval "char *name"
+.Pp
+Link with
+.Va -lutil
+on the
+.Xr cc 1
+command line.
+.Sh DESCRIPTION
+
+The function
+.Fn auth_getval
+returns the value assocated with the field called
+.Fa name
+or NULL if no such field is found or the auth file cannot be opened.
+.Sh SEE ALSO
+.Xr properties_read 3 ,
+.Xr properties_free 3 ,
+.Xr property_find 3 ,
+.Xr auth.conf 5
+.Sh FILES
+.Pa /etc/auth.conf
+contains the name=value pairs looked up by
+.Fn auth_getval .
diff --git a/lib/libutil/auth.conf.5 b/lib/libutil/auth.conf.5
new file mode 100644
index 0000000..08cf806
--- /dev/null
+++ b/lib/libutil/auth.conf.5
@@ -0,0 +1,32 @@
+.\" Copyright (c) 1998 Jordan Hubbard
+.\" All rights reserved.
+.\"
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, is permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice immediately at the beginning of the file, without modification,
+.\"    this list of conditions, and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" $Id$
+.\"
+.Dd October 7, 1998
+.Dt AUTH.CONF 5
+.Os FreeBSD
+.Sh NAME
+.Nm auth.conf
+.Nd authentication capability database
+.Sh SYNOPSIS
+.Pa /etc/auth.conf
+.Sh DESCRIPTION
+auth.conf contains various attributes important to the authentication
+code, most notably
+.Xr kerberos 5
+for the time being.  This documentation will be updated as the
+.Pa auth.conf
+file, which is very new, evolves.
+.Sh SEE ALSO
+.Xr auth_getval 3
diff --git a/lib/libutil/property.3 b/lib/libutil/property.3
new file mode 100644
index 0000000..9c365c7
--- /dev/null
+++ b/lib/libutil/property.3
@@ -0,0 +1,84 @@
+.\" 
+.\" Copyright (c) 1998 Jordan Hubbard
+.\" 
+.\" 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. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\"
+.\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``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 DEVELOPERS 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.
+.\" 
+.\" $Id$
+.\" "
+.Dd October 7, 1998
+.Os
+.Dt properties 3
+.Sh NAME
+.Nm properties_read , 
+.Nm propery_find ,
+.Nm properties_free
+.Nd functions to allow creating simple property lists from ascii file data.
+.Sh SYNOPSIS
+.Fd #include <sys/types.h>
+.Fd #include <libutil.h>
+.Ft properties
+.Fn properties_read "FILE *fp"
+.Ft char *
+.Fn property_find "char *name"
+.Ft void
+.Fn properties_free "properties list"
+.Pp
+Link with
+.Va -lutil
+on the
+.Xr cc 1
+command line.
+.Sh DESCRIPTION
+.nf
+typedef struct _properties {
+	struct _properties *next;
+	char *name;
+	char *value;
+} *properties;
+.fi
+
+The function
+.Fn properties_read
+reads
+.Fa name = value
+pairs from the file specified in
+.Fa fp
+and returns the head of a new property list, assuming that the
+file's contents have been parsed properly, or NULL in case
+of error.  The property list pointer should be passed to
+.Fn properties_free
+when no longer needed.
+.Pp
+.Fn property_find
+Returns the associated value string for the property named
+.Fa name
+if found, otherwise NULL.
+.Pp
+.Fn properties_free
+is used to free the structure returned by
+.Fn properties_read
+when it is no longer needed.
+.Sh SEE ALSO
+.Xr auth_getval 3
+.Sh BUGS
+Simplistic.