xref: /netbsd-src/lib/libc/gen/pwcache.3 (revision ce0bb6e8d2e560ecacbe865a848624f94498063b)
1.\"	$NetBSD: pwcache.3,v 1.4 1995/02/27 04:35:44 cgd Exp $
2.\"
3.\" Copyright (c) 1989, 1991, 1993
4.\"	The Regents of the University of California.  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.\" 3. All advertising materials mentioning features or use of this software
15.\"    must display the following acknowledgement:
16.\"	This product includes software developed by the University of
17.\"	California, Berkeley and its contributors.
18.\" 4. Neither the name of the University nor the names of its contributors
19.\"    may be used to endorse or promote products derived from this software
20.\"    without specific prior written permission.
21.\"
22.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
23.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
24.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
25.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
26.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
27.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
28.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
29.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
30.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
31.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32.\" SUCH DAMAGE.
33.\"
34.\"     @(#)pwcache.3	8.1 (Berkeley) 6/9/93
35.\"
36.Dd June 9, 1993
37.Dt PWCACHE 3
38.Os
39.Sh NAME
40.Nm pwcache
41.Nd cache password and group entries
42.Sh SYNOPSIS
43.Fn user_from_uid "uid_t uid" "int nouser"
44.Fn group_from_gid "gid_t gid" "int nogroup"
45.Sh DESCRIPTION
46The
47.Fn user_from_uid
48function returns the user name associated with the argument
49.Fa uid .
50The user name is cached so that multiple calls with the same
51.Fa uid
52do not require additional calls to
53.Xr getpwuid 3 .
54If there is no user associated with the
55.Fa uid ,
56a pointer is returned
57to a string representation of the
58.Fa uid ,
59unless the argument
60.Fa nouser
61is non-zero, in which case a
62.Dv NULL
63pointer is returned.
64.Pp
65The
66.Fn group_from_gid
67function returns the group name associated with the argument
68.Fa gid .
69The group name is cached so that multiple calls with the same
70.Fa gid
71do not require additional calls to
72.Xr getgrgid 3 .
73If there is no group associated with the
74.Fa gid ,
75a pointer is returned
76to a string representation of the
77.Fa gid ,
78unless the argument
79.Fa nogroup
80is non-zero, in which case a
81.Dv NULL
82pointer is returned.
83.Sh SEE ALSO
84.Xr getgrgid 3 ,
85.Xr getpwuid 3
86.Sh HISTORY
87The
88.Fn user_from_id
89and
90.Fn group_from_id
91functions first appeared in 4.4BSD.
92