BSD 4_4 release

[unix-history] / usr / src / lib / libc / gen / getgrent.3

diff --git a/usr/src/lib/libc/gen/getgrent.3 b/usr/src/lib/libc/gen/getgrent.3
index b43f30b..5f32de7 100644 (file)
--- a/usr/src/lib/libc/gen/getgrent.3
+++ b/usr/src/lib/libc/gen/getgrent.3
@@ -1,141 +1,192 @@
-.\" Copyright (c) 1989 The Regents of the University of California.
-.\" All rights reserved.
+.\" Copyright (c) 1989, 1991, 1993
+.\"    The Regents of the University of California.  All rights reserved.

 .\"
 .\"

-.\" Redistribution and use in source and binary forms are permitted provided
-.\" that: (1) source distributions retain this entire copyright notice and
-.\" comment, and (2) distributions including binaries display the following
-.\" acknowledgement:  ``This product includes software developed by the
-.\" University of California, Berkeley and its contributors'' in the
-.\" documentation or other materials provided with the distribution and in
-.\" all advertising materials mentioning features or use of this software.
-.\" Neither the name of the University nor the names of its contributors may
-.\" be used to endorse or promote products derived from this software without
-.\" specific prior written permission.
-.\" THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR IMPLIED
-.\" WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED WARRANTIES OF
-.\" MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 2. Redistributions in binary form must reproduce the above copyright
+.\"    notice, this list of conditions and the following disclaimer in the
+.\"    documentation and/or other materials provided with the distribution.
+.\" 3. All advertising materials mentioning features or use of this software
+.\"    must display the following acknowledgement:
+.\"    This product includes software developed by the University of
+.\"    California, Berkeley and its contributors.
+.\" 4. Neither the name of the University nor the names of its contributors
+.\"    may be used to endorse or promote products derived from this software
+.\"    without specific prior written permission.

 .\"
 .\"

-.\"    @(#)getgrent.3  6.5 (Berkeley) 6/23/90
+.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
+.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
+.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
+.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
+.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
+.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
+.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
+.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
+.\" SUCH DAMAGE.

 .\"
 .\"

-.TH GETGRENT 3  "June 23, 1990"
-.AT 3
-.SH NAME
-getgrent, getgrnam, getgrgid, setgroupent, setgrfile, setgrent,
-endgrent \- get group file entry
-.SH SYNOPSIS
-.nf
-.B #include <grp.h>
-.PP
-.B struct group *getgrent()
-.PP
-.B struct group *getgrnam(name)
-.B char *name;
-.PP
-.B struct group *getgrgid(gid)
-.B gid_t gid;
-.PP
-.B setgroupent(stayopen)
-.B int stayopen;
-.PP
-.B void setgrfile(name)
-.B char *name;
-.PP
-.B setgrent()
-.PP
-.B void endgrent()
-.fi
-.SH DESCRIPTION
-.I Getgrent,
-.I getgrgid
-and
-.I getgrnam
-each return a pointer to a structure containing the broken-out fields
-of a line in the group file.  This structure is defined by the include
+.\"     @(#)getgrent.3 8.1 (Berkeley) 6/4/93
+.\"
+.Dd June 4, 1993
+.Dt GETGRENT 3
+.Os
+.Sh NAME
+.Nm getgrent ,
+.Nm getgrnam ,
+.Nm getgrgid ,
+.Nm setgroupent ,
+.\" .Nm setgrfile ,
+.Nm setgrent ,
+.Nm endgrent
+.Nd group database operations
+.Sh SYNOPSIS
+.Fd #include <grp.h>
+.Ft struct group *
+.Fn getgrent void
+.Ft struct group *
+.Fn getgrnam "const char *name"
+.Ft struct group *
+.Fn getgrgid "gid_t gid"
+.Ft struct group *
+.Fn setgroupent "int stayopen"
+.\" .Ft void
+.\" .Fn setgrfile "const char *name"
+.Ft int
+.Fn setgrent void
+.Ft void
+.Fn endgrent void
+.Sh DESCRIPTION
+These functions operate on the group database file
+.Pa /etc/group
+which is described
+in
+.Xr group 5 .
+Each line of the database is defined by the structure
+.Ar group
+found in the include

 file
 file

-.IR < grp.h >,
-and contains the following fields:
-.PP
-.RS
-.nf
+.Aq Pa grp.h :
+.Bd -literal -offset indent

 struct group {
 struct group {

-       char            *gr_name;               /* group name */
-       char            *gr_passwd;     /* group password */
+       char    *gr_name;       /* group name */
+       char    *gr_passwd;     /* group password */

        gid_t   gr_gid;         /* group id */
        gid_t   gr_gid;         /* group id */

-       char            **gr_mem;               /* group members */
+       char    **gr_mem;       /* group members */

 };
 };

-.ft R
-.ad
-.fi
-.RE
-.PP
-These fields are more completely described in
-.IR group (5).
-.PP
-.I Getgrnam
+.Ed
+.Pp
+The functions
+.Fn getgrnam

 and
 and

-.I getgrgid
-search the group database for a matching group name or group id,
+.Fn getgrgid
+search the group database for the given group name pointed to by
+.Ar name
+or the group id pointed to by
+.Ar gid ,

 respectively, returning the first one encountered.  Identical group
 names or group gids may result in undefined behavior.
 respectively, returning the first one encountered.  Identical group
 names or group gids may result in undefined behavior.

-.PP
-.I Getgrent
+.Pp
+The
+.Fn getgrent
+function

 sequentially reads the group database and is intended for programs
 that wish to step through the complete list of groups.
 sequentially reads the group database and is intended for programs
 that wish to step through the complete list of groups.

-.PP
+.Pp

 All three routines will open the group file for reading, if necesssary.
 All three routines will open the group file for reading, if necesssary.

-.PP
-.I Setgrfile
-changes the default group file to
-.IR file ,
-thus allowing the use of alternate group files.
-.PP
-.I Setgroupent
+.Pp
+The
+.Fn setgroupent
+function

 opens the file, or rewinds it if it is already open.  If
 opens the file, or rewinds it if it is already open.  If

-.I stayopen
+.Fa stayopen

 is non-zero, file descriptors are left open, significantly speeding
 is non-zero, file descriptors are left open, significantly speeding

-up subsequent calls.  This functionality is unnecessary for
-.I getgrent
+functions subsequent calls.  This functionality is unnecessary for
+.Fn getgrent

 as it doesn't close its file descriptors by default.  It should also
 be noted that it is dangerous for long-running programs to use this
 functionality as the group file may be updated.
 as it doesn't close its file descriptors by default.  It should also
 be noted that it is dangerous for long-running programs to use this
 functionality as the group file may be updated.

-.PP
-.I Setgrent
+.Pp
+The
+.Fn setgrent
+function

 is identical to
 is identical to

-.I setgroupent
+.Fn setgroupent

 with an argument of zero.
 with an argument of zero.

-.PP
-.I Endgrent
+.Pp
+The
+.Fn endgrent
+function

 closes any open files.
 closes any open files.

-.PP
-.PP
-.SH FILES
-/etc/group
-.SH "SEE ALSO"
- getpwent(3), group(5)
-.SH DIAGNOSTICS
-The routines
-.IR getgrent ,
-.IR getgrnam ,
+.Sh RETURN VALUES
+The functions
+.Fn getgrent ,
+.Fn getgrnam ,

 and
 and

-.IR getgrgid ,
-return a null pointer on EOF or error.
-.I Setgroupent
+.Fn getgrgid ,
+return a pointer to the group entry if successful; if end-of-file
+is reached or an error occurs a null pointer is returned.
+The functions
+.Fn setgroupent

 and
 and

-.I setgrent
-return 0 on failure, 1 on success.
-.I Endgrent
+.Fn setgrent
+return the value 1 if successful, otherwise the value
+0 is returned.
+The functions
+.Fn endgrent

 and
 and

-.I setgrfile
+.Fn setgrfile

 have no return value.
 have no return value.

-.SH BUGS
-All information is contained in a static buffer which is overwritten
-by each new call.  It must be copied elsewhere to be retained.
-.PP
-The routines
-.IR getgrent ,
-.IR endgrent ,
-.IR setgroupent ,
+.Sh FILES
+.Bl -tag -width /etc/group -compact
+.It Pa /etc/group
+group database file
+.El
+.Sh SEE ALSO
+.Fn getpwent 3 ,
+.Fn group 5
+.Sh HISTORY
+The functions
+.Fn endgrent ,
+.Fn getgrent ,
+.Fn getgrnam ,
+.Fn getgrgid ,
+and
+.Fn setgrent
+appeared in
+.At v7 .
+The functions
+.Fn setgrfile
+and
+.Fn setgroupent
+appeared in
+.Bx 4.3 Reno .
+.Sh COMPATIBILITY
+The historic function
+.Fn setgrfile ,
+which allowed the specification of alternate password databases, has
+been deprecated and is no longer available.
+.Sh BUGS
+The functions
+.Fn getgrent ,
+.Fn getgrnam ,
+.Fn getgrgid ,
+.Fn setgroupent
+and
+.Fn setgrent
+leave their results in an internal static object and return
+a pointer to that object. Subsequent calls to
+the same function
+will modify the same object.
+.Pp
+The functions
+.Fn getgrent ,
+.Fn endgrent ,
+.Fn setgroupent ,

 and
 and

-.IR setgrent
+.Fn setgrent

 are fairly useless in a networked environment and should be
 avoided, if possible.
 are fairly useless in a networked environment and should be
 avoided, if possible.