1 .\" Copyright (c) 1989, 1991, 1993
2 .\" The Regents of the University of California. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
28 .\" From: @(#)getgrent.3 8.2 (Berkeley) 4/19/94
44 .Nd group database operations
52 .Fn getgrent_r "struct group *grp" "char *buffer" "size_t bufsize" "struct group **result"
54 .Fn getgrnam "const char *name"
56 .Fn getgrnam_r "const char *name" "struct group *grp" "char *buffer" "size_t bufsize" "struct group **result"
58 .Fn getgrgid "gid_t gid"
60 .Fn getgrgid_r "gid_t gid" "struct group *grp" "char *buffer" "size_t bufsize" "struct group **result"
62 .Fn setgroupent "int stayopen"
68 These functions operate on the group database file
73 Each line of the database is defined by the structure
78 .Bd -literal -offset indent
80 char *gr_name; /* group name */
81 char *gr_passwd; /* group password */
82 gid_t gr_gid; /* group id */
83 char **gr_mem; /* group members */
91 search the group database for the given group name pointed to by
93 or the group id pointed to by
95 respectively, returning the first one encountered.
97 names or group gids may result in undefined behavior.
102 sequentially reads the group database and is intended for programs
103 that wish to step through the complete list of groups.
110 are thread-safe versions of
116 The caller must provide storage for the results of the search in
124 When these functions are successful, the
126 argument will be filled-in, and a pointer to that argument will be
129 If an entry is not found or an error occurs,
134 These functions will open the group file for reading, if necessary.
139 opens the file, or rewinds it if it is already open.
142 is non-zero, file descriptors are left open, significantly speeding
143 functions subsequent calls.
144 This functionality is unnecessary for
146 as it does not close its file descriptors by default.
148 be noted that it is dangerous for long-running programs to use this
149 functionality as the group file may be updated.
156 with an argument of zero.
161 closes any open files.
168 return a pointer to a group structure on success or
170 if the entry is not found or if an error occurs.
171 If an error does occur,
174 Note that programs must explicitly set
176 to zero before calling any of these functions if they need to
177 distinguish between a non-existent entry and an error.
183 return 0 if no error occurred, or an error number to indicate failure.
184 It is not an error if a matching entry is not found.
189 and the return value is 0, no matching entry exists.)
195 return the value 1 if successful, otherwise the value
201 have no return value.
203 .Bl -tag -width /etc/group -compact
208 The historic function
210 which allowed the specification of alternate password databases, has
211 been deprecated and is no longer available.
215 .Xr nsswitch.conf 5 ,
230 function differs from that standard in that its return type is
265 leave their results in an internal static object and return
266 a pointer to that object.
269 will modify the same object.
278 are fairly useless in a networked environment and should be
279 avoided, if possible.
285 make no attempt to suppress duplicate information if multiple
286 sources are specified in
287 .Xr nsswitch.conf 5 .