lib/libc/gen/pwcache.3

   1 .\" Copyright (c) 1989, 1991, 1993
   2 .\"     The Regents of the University of California.  All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 4. Neither the name of the University nor the names of its contributors
  13 .\"    may be used to endorse or promote products derived from this software
  14 .\"    without specific prior written permission.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\"     @(#)pwcache.3   8.1 (Berkeley) 6/9/93
  29 .\" $FreeBSD$
  30 .\"
  31 .Dd March 22, 2002
  32 .Dt PWCACHE 3
  33 .Os
  34 .Sh NAME
  35 .Nm pwcache
  36 .Nd cache password and group entries
  37 .Sh LIBRARY
  38 .Lb libc
  39 .Sh SYNOPSIS
  40 .In pwd.h
  41 .Ft const char *
  42 .Fn user_from_uid "uid_t uid" "int nouser"
  43 .In grp.h
  44 .Ft const char *
  45 .Fn group_from_gid "gid_t gid" "int nogroup"
  46 .Sh DESCRIPTION
  47 The
  48 .Fn user_from_uid
  49 function returns the user name associated with the argument
  50 .Fa uid .
  51 The user name is cached so that multiple calls with the same
  52 .Fa uid
  53 do not require additional calls to
  54 .Xr getpwuid 3 .
  55 If there is no user associated with the
  56 .Fa uid ,
  57 a pointer is returned
  58 to a string representation of the
  59 .Fa uid ,
  60 unless the argument
  61 .Fa nouser
  62 is non-zero, in which case a
  63 .Dv NULL
  64 pointer is returned.
  65 .Pp
  66 The
  67 .Fn group_from_gid
  68 function returns the group name associated with the argument
  69 .Fa gid .
  70 The group name is cached so that multiple calls with the same
  71 .Fa gid
  72 do not require additional calls to
  73 .Xr getgrgid 3 .
  74 If there is no group associated with the
  75 .Fa gid ,
  76 a pointer is returned
  77 to a string representation of the
  78 .Fa gid ,
  79 unless the argument
  80 .Fa nogroup
  81 is non-zero, in which case a
  82 .Dv NULL
  83 pointer is returned.
  84 .Sh SEE ALSO
  85 .Xr getgrgid 3 ,
  86 .Xr getpwuid 3
  87 .Sh HISTORY
  88 The
  89 .Fn user_from_uid
  90 and
  91 .Fn group_from_gid
  92 functions first appeared in
  93 .Bx 4.4 .