lib/libutil/auth.3

   1 .\"
   2 .\" Copyright (c) 1998 Jordan Hubbard
   3 .\"
   4 .\" All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\"
  15 .\" THIS SOFTWARE IS PROVIDED BY THE DEVELOPERS ``AS IS'' AND ANY EXPRESS OR
  16 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  17 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  18 .\" IN NO EVENT SHALL THE DEVELOPERS BE LIABLE FOR ANY DIRECT, INDIRECT,
  19 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  20 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  21 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  22 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  23 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  24 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  25 .\"
  26 .\" $FreeBSD: src/lib/libutil/auth.3,v 1.4.2.5 2002/12/29 16:35:36 schweikh Exp $
  27 .\" $DragonFly: src/lib/libutil/auth.3,v 1.3 2006/02/17 19:35:07 swildner Exp $
  28 .\" "
  29 .Dd October 7, 1998
  30 .Os
  31 .Dt AUTH_GETVAL 3
  32 .Sh NAME
  33 .Nm auth_getval
  34 .Nd functions for reading values from
  35 .Pa /etc/auth.conf
  36 .Sh LIBRARY
  37 .Lb libutil
  38 .Sh SYNOPSIS
  39 .In sys/types.h
  40 .In libutil.h
  41 .Ft char *
  42 .Fn auth_getval "const char *name"
  43 .Sh DESCRIPTION
  44 The function
  45 .Fn auth_getval
  46 returns the value associated with the field called
  47 .Fa name
  48 or NULL if no such field is found or the auth file cannot be opened.
  49 .Sh FILES
  50 .Pa /etc/auth.conf
  51 contains the name=value pairs looked up by
  52 .Fn auth_getval .
  53 .Sh SEE ALSO
  54 .Xr properties_free 3 ,
  55 .Xr properties_read 3 ,
  56 .Xr property_find 3 ,
  57 .Xr auth.conf 5