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 .\" 3. 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
41 .Nd group database operations
49 .Fn getgrent_r "struct group *grp" "char *buffer" "size_t bufsize" "struct group **result"
51 .Fn getgrnam "const char *name"
53 .Fn getgrnam_r "const char *name" "struct group *grp" "char *buffer" "size_t bufsize" "struct group **result"
55 .Fn getgrgid "gid_t gid"
57 .Fn getgrgid_r "gid_t gid" "struct group *grp" "char *buffer" "size_t bufsize" "struct group **result"
59 .Fn setgroupent "int stayopen"
65 These functions operate on the group database file
70 Each line of the database is defined by the structure
75 .Bd -literal -offset indent
77 char *gr_name; /* group name */
78 char *gr_passwd; /* group password */
79 gid_t gr_gid; /* group id */
80 char **gr_mem; /* group members */
88 search the group database for the given group name pointed to by
90 or the group id pointed to by
92 respectively, returning the first one encountered.
94 names or group gids may result in undefined behavior.
99 sequentially reads the group database and is intended for programs
100 that wish to step through the complete list of groups.
107 are thread-safe versions of
113 The caller must provide storage for the results of the search in
121 When these functions are successful, the
123 argument will be filled-in, and a pointer to that argument will be
126 If an entry is not found or an error occurs,
131 These functions will open the group file for reading, if necessary.
136 opens the file, or rewinds it if it is already open.
139 is non-zero, file descriptors are left open, significantly speeding
140 functions subsequent calls.
141 This functionality is unnecessary for
143 as it does not close its file descriptors by default.
145 be noted that it is dangerous for long-running programs to use this
146 functionality as the group file may be updated.
153 with an argument of zero.
158 closes any open files.
165 return a pointer to a group structure on success or
167 if the entry is not found or if an error occurs.
168 If an error does occur,
171 Note that programs must explicitly set
173 to zero before calling any of these functions if they need to
174 distinguish between a non-existent entry and an error.
180 return 0 if no error occurred, or an error number to indicate failure.
181 It is not an error if a matching entry is not found.
186 and the return value is 0, no matching entry exists.)
190 returns the value 1 if successful, otherwise the value
197 have no return value.
199 .Bl -tag -width /etc/group -compact
204 The historic function
206 which allowed the specification of alternate password databases, has
207 been deprecated and is no longer available.
211 .Xr nsswitch.conf 5 ,
226 function differs from that standard in that its return type is
261 leave their results in an internal static object and return
262 a pointer to that object.
265 will modify the same object.
274 are fairly useless in a networked environment and should be
275 avoided, if possible.
281 make no attempt to suppress duplicate information if multiple
282 sources are specified in
283 .Xr nsswitch.conf 5 .