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