1 .\" Copyright 1993 David Metcalfe (david@prism.demon.co.uk)
3 .\" %%%LICENSE_START(VERBATIM)
4 .\" Permission is granted to make and distribute verbatim copies of this
5 .\" manual provided the copyright notice and this permission notice are
6 .\" preserved on all copies.
8 .\" Permission is granted to copy and distribute modified versions of this
9 .\" manual under the conditions for verbatim copying, provided that the
10 .\" entire resulting derived work is distributed under the terms of a
11 .\" permission notice identical to this one.
13 .\" Since the Linux kernel and libraries are constantly changing, this
14 .\" manual page may be incorrect or out-of-date. The author(s) assume no
15 .\" responsibility for errors or omissions, or for damages resulting from
16 .\" the use of the information contained herein. The author(s) may not
17 .\" have taken the same level of care in the production of this manual,
18 .\" which is licensed free of charge, as they might when working
21 .\" Formatted or processed versions of this manual, if unaccompanied by
22 .\" the source, must acknowledge the copyright and authors of this work.
25 .\" References consulted:
26 .\" Linux libc source code
27 .\" Lewine's _POSIX Programmer's Guide_ (O'Reilly & Associates, 1991)
30 .\" Modified Sat Jul 24 19:22:14 1993 by Rik Faith (faith@cs.unc.edu)
31 .\" Modified Mon May 27 21:37:47 1996 by Martin Schulze (joey@linux.de)
33 .TH GETPWENT 3 2015-08-08 "GNU" "Linux Programmer's Manual"
35 getpwent, setpwent, endpwent \- get password file entry
38 .B #include <sys/types.h>
41 .B struct passwd *getpwent(void);
43 .B void setpwent(void);
45 .B void endpwent(void);
49 Feature Test Macro Requirements for glibc (see
50 .BR feature_test_macros (7)):
58 _BSD_SOURCE || _SVID_SOURCE || _XOPEN_SOURCE\ >=\ 500 ||
59 _XOPEN_SOURCE\ &&\ _XOPEN_SOURCE_EXTENDED
65 function returns a pointer to a structure containing
66 the broken-out fields of a record from the password database
67 (e.g., the local password file
72 is called, it returns the first entry; thereafter, it returns successive
77 function rewinds to the beginning
78 of the password database.
82 function is used to close the password database
83 after all processing has been performed.
85 The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows:
90 char *pw_name; /* username */
91 char *pw_passwd; /* user password */
92 uid_t pw_uid; /* user ID */
93 gid_t pw_gid; /* group ID */
94 char *pw_gecos; /* user information */
95 char *pw_dir; /* home directory */
96 char *pw_shell; /* shell program */
101 For more information about the fields of this structure, see
106 function returns a pointer to a
108 structure, or NULL if
109 there are no more entries or an error occurred.
112 is set appropriately.
113 If one wants to check
115 after the call, it should be set to zero before the call.
117 The return value may point to a static area, and may be overwritten
118 by subsequent calls to
123 (Do not pass the returned pointer to
136 of files was open already in the calling process.
139 The maximum number of files was open already in the system.
143 Insufficient memory to allocate
146 .\" to allocate the passwd structure, or to allocate buffers
149 Insufficient buffer space supplied.
153 local password database file
155 For an explanation of the terms used in this section, see
161 Interface Attribute Value
173 T} Thread safety MT-Unsafe race:pwent locale
180 signifies that if any of the functions
185 are used in parallel in different threads of a program,
186 then data races could occur.
188 POSIX.1-2001, POSIX.1-2008, SVr4, 4.3BSD.
191 field is not specified in POSIX, but is present on most implementations.