2004-11-03 13:51:07 +00:00
|
|
|
.\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to make and distribute verbatim copies of this
|
|
|
|
.\" manual provided the copyright notice and this permission notice are
|
|
|
|
.\" preserved on all copies.
|
|
|
|
.\"
|
|
|
|
.\" Permission is granted to copy and distribute modified versions of this
|
|
|
|
.\" manual under the conditions for verbatim copying, provided that the
|
|
|
|
.\" entire resulting derived work is distributed under the terms of a
|
|
|
|
.\" permission notice identical to this one.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Since the Linux kernel and libraries are constantly changing, this
|
|
|
|
.\" manual page may be incorrect or out-of-date. The author(s) assume no
|
|
|
|
.\" responsibility for errors or omissions, or for damages resulting from
|
|
|
|
.\" the use of the information contained herein. The author(s) may not
|
|
|
|
.\" have taken the same level of care in the production of this manual,
|
|
|
|
.\" which is licensed free of charge, as they might when working
|
|
|
|
.\" professionally.
|
2007-04-12 22:42:49 +00:00
|
|
|
.\"
|
2004-11-03 13:51:07 +00:00
|
|
|
.\" Formatted or processed versions of this manual, if unaccompanied by
|
|
|
|
.\" the source, must acknowledge the copyright and authors of this work.
|
|
|
|
.\"
|
|
|
|
.\" References consulted:
|
|
|
|
.\" Linux libc source code
|
|
|
|
.\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
|
|
|
|
.\" 386BSD man pages
|
|
|
|
.\" Modified Sat Jul 24 19:29:54 1993 by Rik Faith (faith@cs.unc.edu)
|
_exit.2, brk.2, capget.2, chdir.2, chmod.2, chown.2, chroot.2, getdtablesize.2, gethostname.2, getpagesize.2, getsid.2, killpg.2, mknod.2, mknodat.2, poll.2, posix_fadvise.2, pread.2, readlink.2, setpgid.2, setreuid.2, sigaltstack.2, stat.2, symlink.2, sync.2, truncate.2, vfork.2, wait.2, wait4.2, a64l.3, abs.3, acos.3, acosh.3, asin.3, asinh.3, atan.3, atan2.3, atoi.3, cbrt.3, ceil.3, copysign.3, cosh.3, dirfd.3, div.3, ecvt.3, erf.3, erfc.3, exp.3, exp2.3, fabs.3, fdim.3, ffs.3, floor.3, fma.3, fmax.3, fmin.3, fmod.3, fpclassify.3, frexp.3, ftw.3, fwide.3, gcvt.3, getcwd.3, getdate.3, getgrent.3, gethostid.3, getpass.3, getpwent.3, getsubopt.3, getw.3, hypot.3, ilogb.3, index.3, isalpha.3, isgreater.3, iswblank.3, j0.3, ldexp.3, lockf.3, log.3, log10.3, log1p.3, logb.3, lrint.3, lround.3, mkstemp.3, mktemp.3, modf.3, mq_receive.3, mq_send.3, nan.3, nextafter.3, posix_fallocate.3, posix_memalign.3, printf.3, qecvt.3, random.3, realpath.3, remainder.3, remquo.3, rint.3, round.3, scalb.3, scalbln.3, scanf.3, siginterrupt.3, signbit.3, sigset.3, sinh.3, sqrt.3, strcasecmp.3, strcat.3, strchr.3, strcmp.3, strcoll.3, strcpy.3, strfry.3, strpbrk.3, strsep.3, strspn.3, strstr.3, strtod.3, strtok.3, strtol.3, strtoul.3, strxfrm.3, tanh.3, tgamma.3, trunc.3, ttyslot.3, ualarm.3, usleep.3, wprintf.3, armscii-8.7, cp1251.7, iso_8859-10.7, iso_8859-11.7, iso_8859-13.7, iso_8859-14.7, iso_8859-3.7, iso_8859-5.7, iso_8859-6.7, iso_8859-8.7, koi8-u.7: tstamp
Signed-off-by: Michael Kerrisk <mtk.manpages@gmail.com>
2010-09-19 17:19:13 +00:00
|
|
|
.TH GETGRENT 3 2010-09-20 "" "Linux Programmer's Manual"
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH NAME
|
|
|
|
getgrent, setgrent, endgrent \- get group file entry
|
|
|
|
.SH SYNOPSIS
|
|
|
|
.nf
|
|
|
|
.B #include <sys/types.h>
|
|
|
|
.B #include <grp.h>
|
|
|
|
.sp
|
|
|
|
.B struct group *getgrent(void);
|
|
|
|
.sp
|
|
|
|
.B void setgrent(void);
|
|
|
|
.sp
|
|
|
|
.B void endgrent(void);
|
|
|
|
.fi
|
2007-07-08 12:11:40 +00:00
|
|
|
.sp
|
|
|
|
.in -4n
|
|
|
|
Feature Test Macro Requirements for glibc (see
|
|
|
|
.BR feature_test_macros (7)):
|
|
|
|
.in
|
|
|
|
.sp
|
2010-09-19 14:39:12 +00:00
|
|
|
.PD 0
|
2007-07-08 12:11:40 +00:00
|
|
|
.ad l
|
|
|
|
.BR setgrent (),
|
2010-09-19 14:39:12 +00:00
|
|
|
.RS 4
|
|
|
|
_SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
|
|
|
|
_XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED ||
|
|
|
|
.br
|
|
|
|
/* Since glibc 2.12: */ _POSIX_C_SOURCE\ >=\ 200809L
|
|
|
|
.RE
|
|
|
|
.sp
|
|
|
|
.BR getgrent (),
|
2007-07-08 12:11:40 +00:00
|
|
|
.BR endgrent ():
|
2010-09-19 05:11:08 +00:00
|
|
|
.RS 4
|
2010-09-19 14:39:12 +00:00
|
|
|
_SVID_SOURCE || _BSD_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
|
|
|
|
_XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
|
2010-09-19 05:11:08 +00:00
|
|
|
.RE
|
2010-09-19 14:39:12 +00:00
|
|
|
.PD
|
2007-07-08 12:11:40 +00:00
|
|
|
.ad b
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH DESCRIPTION
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR getgrent ()
|
2005-07-01 16:50:33 +00:00
|
|
|
function returns a pointer to a structure containing
|
|
|
|
the broken-out fields of a record in the group database
|
2007-04-12 22:42:49 +00:00
|
|
|
(e.g., the local group file
|
2005-07-01 16:50:33 +00:00
|
|
|
.IR /etc/group ,
|
|
|
|
NIS, and LDAP).
|
2010-09-19 16:20:09 +00:00
|
|
|
The first time
|
|
|
|
.BR getgrent ()
|
|
|
|
is called,
|
2004-11-03 13:51:07 +00:00
|
|
|
it returns the first entry; thereafter, it returns successive entries.
|
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR setgrent ()
|
|
|
|
function rewinds to the beginning
|
2005-07-01 16:50:33 +00:00
|
|
|
of the group database, to allow repeated scans.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR endgrent ()
|
|
|
|
function is used to close the group database
|
2005-07-01 16:50:33 +00:00
|
|
|
after all processing has been performed.
|
2004-11-03 13:51:07 +00:00
|
|
|
.PP
|
|
|
|
The \fIgroup\fP structure is defined in \fI<grp.h>\fP as follows:
|
|
|
|
.sp
|
2007-12-23 14:14:04 +00:00
|
|
|
.in +4n
|
2004-11-03 13:51:07 +00:00
|
|
|
.nf
|
|
|
|
struct group {
|
2005-07-01 16:50:33 +00:00
|
|
|
char *gr_name; /* group name */
|
|
|
|
char *gr_passwd; /* group password */
|
2005-07-19 06:20:42 +00:00
|
|
|
gid_t gr_gid; /* group ID */
|
2005-07-01 16:50:33 +00:00
|
|
|
char **gr_mem; /* group members */
|
2004-11-03 13:51:07 +00:00
|
|
|
};
|
|
|
|
.fi
|
2007-12-23 14:14:04 +00:00
|
|
|
.in
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "RETURN VALUE"
|
2007-05-12 09:06:04 +00:00
|
|
|
The
|
|
|
|
.BR getgrent ()
|
|
|
|
function returns a pointer to a
|
2007-04-12 22:42:49 +00:00
|
|
|
.I group
|
|
|
|
structure,
|
2004-11-03 13:51:07 +00:00
|
|
|
or NULL if there are no more entries or an error occurs.
|
|
|
|
.LP
|
|
|
|
Upon error,
|
|
|
|
.I errno
|
2005-07-01 16:50:33 +00:00
|
|
|
may be set.
|
|
|
|
If one wants to check
|
|
|
|
.I errno
|
|
|
|
after the call, it should be set to zero before the call.
|
2009-03-29 23:18:56 +00:00
|
|
|
|
|
|
|
The return value may point to a static area, and may be overwritten
|
|
|
|
by subsequent calls to
|
|
|
|
.BR getgrent (),
|
|
|
|
.BR getgrgid (3),
|
|
|
|
or
|
|
|
|
.BR getgrnam (3).
|
2009-03-29 23:33:55 +00:00
|
|
|
(Do not pass the returned pointer to
|
|
|
|
.BR free (3).)
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH ERRORS
|
|
|
|
.TP
|
|
|
|
.B EINTR
|
|
|
|
A signal was caught.
|
|
|
|
.TP
|
|
|
|
.B EIO
|
|
|
|
I/O error.
|
|
|
|
.TP
|
|
|
|
.B EMFILE
|
|
|
|
The calling process already has too many open files.
|
|
|
|
.TP
|
|
|
|
.B ENFILE
|
|
|
|
Too many open files in the system.
|
|
|
|
.TP
|
|
|
|
.B ENOMEM
|
2005-07-01 16:50:33 +00:00
|
|
|
.\" not in POSIX
|
2008-07-10 10:46:47 +00:00
|
|
|
Insufficient memory to allocate
|
|
|
|
.I group
|
|
|
|
structure.
|
2005-07-01 16:50:33 +00:00
|
|
|
.TP
|
|
|
|
.B ERANGE
|
|
|
|
Insufficient buffer space supplied.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH FILES
|
|
|
|
.TP
|
|
|
|
.I /etc/group
|
2005-07-01 16:50:33 +00:00
|
|
|
local group database file
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "CONFORMING TO"
|
2006-08-03 13:57:30 +00:00
|
|
|
SVr4, 4.3BSD, POSIX.1-2001.
|
2004-11-03 13:51:07 +00:00
|
|
|
.SH "SEE ALSO"
|
|
|
|
.BR fgetgrent (3),
|
|
|
|
.BR getgrent_r (3),
|
|
|
|
.BR getgrgid (3),
|
2005-06-28 07:26:52 +00:00
|
|
|
.BR getgrnam (3),
|
2008-05-04 18:31:25 +00:00
|
|
|
.BR getgrouplist (3),
|
2005-06-28 07:26:52 +00:00
|
|
|
.BR putgrent (3)
|