Commit | Line | Data |
---|---|---|
15637ed4 RG |
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 | .\" @(#)pwcache.3 5.4 (Berkeley) 4/19/91 | |
33 | .\" | |
34 | .Dd April 19, 1991 | |
35 | .Dt PWCACHE 3 | |
36 | .Os | |
37 | .Sh NAME | |
38 | .Nm pwcache | |
39 | .Nd cache password and group entries | |
40 | .Sh SYNOPSIS | |
41 | .Fn user_from_uid "uid_t uid" "int nouser" | |
42 | .Fn group_from_gid "gid_t gid" "int nogroup" | |
43 | .Sh DESCRIPTION | |
44 | .Bf -symbolic | |
45 | This interface is not part of the C library. | |
46 | It has been placed in the Berkeley utility library, libutil, as it is | |
47 | used by several standard utilities. | |
48 | .Ef | |
49 | .Pp | |
50 | The | |
51 | .Fn user_from_uid | |
52 | function returns the user name associated with the argument | |
53 | .Fa uid . | |
54 | The user name is cached so that multiple calls with the same | |
55 | .Fa uid | |
56 | do not require additional calls to | |
57 | .Xr getpwuid 3 . | |
58 | If there is no user associated with the | |
59 | .Fa uid , | |
60 | a pointer is returned | |
61 | to an | |
62 | .Tn ASCII | |
63 | representation of the | |
64 | .Fa uid , | |
65 | unless the argument | |
66 | .Fa nouser | |
67 | is non-zero, in which case a | |
68 | .Dv NULL | |
69 | pointer is returned. | |
70 | .Pp | |
71 | The | |
72 | .Fn group_from_gid | |
73 | function returns the group name associated with the argument | |
74 | .Fa gid . | |
75 | The group name is cached so that multiple calls with the same | |
76 | .Fa gid | |
77 | do not require additional calls to | |
78 | .Xr getgrgid 3 . | |
79 | If there is no group associated with the | |
80 | .Fa gid , | |
81 | a pointer is returned | |
82 | to an | |
83 | .Tn ASCII | |
84 | representation of the | |
85 | .Fa gid , | |
86 | unless the argument | |
87 | .Fa nogroup | |
88 | is non-zero, in which case a | |
89 | .Dv NULL | |
90 | pointer is returned. | |
91 | .Sh SEE ALSO | |
92 | .Xr getgrgid 3 , | |
93 | .Xr getpwuid 3 | |
94 | .Sh HISTORY | |
95 | The | |
96 | .Fn user_from_id | |
97 | and | |
98 | .Fn group_from_id | |
99 | functions are | |
100 | .Ud . |