From 7f5d64043f1d1d0ac72b6e33467b165eb2e72850 Mon Sep 17 00:00:00 2001 From: jkh Date: Thu, 8 Oct 1998 06:53:32 +0000 Subject: Add some rudimentary documentation for my new functions. --- lib/libutil/auth.3 | 61 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 61 insertions(+) create mode 100644 lib/libutil/auth.3 (limited to 'lib/libutil/auth.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 +.Fd #include +.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 . -- cgit v1.1