Add some rudimentary documentation for my new functions.

1 files changed, 84 insertions, 0 deletions

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.