xref: /dragonfly/lib/libc/gen/pwcache.3 (revision 984263bc)
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.\" 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.\"     @(#)pwcache.3	8.1 (Berkeley) 6/9/93
33.\" $FreeBSD: src/lib/libc/gen/pwcache.3,v 1.6.2.4 2001/12/14 18:33:51 ru Exp $
34.\"
35.Dd June 9, 1993
36.Dt PWCACHE 3
37.Os
38.Sh NAME
39.Nm pwcache
40.Nd cache password and group entries
41.Sh LIBRARY
42.Lb libc
43.Sh SYNOPSIS
44.In stdlib.h
45.Ft char *
46.Fn user_from_uid "unsigned long uid" "int nouser"
47.Ft char *
48.Fn group_from_gid "unsigned long gid" "int nogroup"
49.Sh DESCRIPTION
50The
51.Fn user_from_uid
52function returns the user name associated with the argument
53.Fa uid .
54The user name is cached so that multiple calls with the same
55.Fa uid
56do not require additional calls to
57.Xr getpwuid 3 .
58If there is no user associated with the
59.Fa uid ,
60a pointer is returned
61to a string representation of the
62.Fa uid ,
63unless the argument
64.Fa nouser
65is non-zero, in which case a
66.Dv NULL
67pointer is returned.
68.Pp
69The
70.Fn group_from_gid
71function returns the group name associated with the argument
72.Fa gid .
73The group name is cached so that multiple calls with the same
74.Fa gid
75do not require additional calls to
76.Xr getgrgid 3 .
77If there is no group associated with the
78.Fa gid ,
79a pointer is returned
80to a string representation of the
81.Fa gid ,
82unless the argument
83.Fa nogroup
84is non-zero, in which case a
85.Dv NULL
86pointer is returned.
87.Sh SEE ALSO
88.Xr getgrgid 3 ,
89.Xr getpwuid 3
90.Sh HISTORY
91The
92.Fn user_from_uid
93and
94.Fn group_from_gid
95functions first appeared in
96.Bx 4.4 .
97