diff options
Diffstat (limited to 'man3/fgetpwent.3')
| -rw-r--r-- | man3/fgetpwent.3 | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/man3/fgetpwent.3 b/man3/fgetpwent.3 new file mode 100644 index 000000000..07db54c6a --- /dev/null +++ b/man3/fgetpwent.3 @@ -0,0 +1,88 @@ +.\" 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. +.\" +.\" 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. +.\" +.\" 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:37:37 1993 by Rik Faith (faith@cs.unc.edu) +.\" Modified Mon May 27 22:40:48 1996 by Martin Schulze (joey@linux.de) +.\" +.TH FGETPWENT 3 1996-05-17 "GNU" "Linux Programmer's Manual" +.SH NAME +fgetpwent \- get password file entry +.SH SYNOPSIS +.nf +.B #include <stdio.h> +.B #include <sys/types.h> +.B #include <pwd.h> +.sp +.BI "struct passwd *fgetpwent(FILE *" stream ); +.fi +.SH DESCRIPTION +The \fBfgetpwent()\fP function returns a pointer to a structure containing +the broken out fields of a line in the file \fIstream\fP. The first time +it is called it returns the first entry; thereafter, it returns successive +entries. The file \fIstream\fP must have the same format as +\fI/etc/passwd\fP. +.PP +The \fIpasswd\fP structure is defined in \fI<pwd.h>\fP as follows: +.sp +.RS +.nf +.ta 8n 16n 32n +struct passwd { + char *pw_name; /* user name */ + char *pw_passwd; /* user password */ + uid_t pw_uid; /* user id */ + gid_t pw_gid; /* group id */ + char *pw_gecos; /* real name */ + char *pw_dir; /* home directory */ + char *pw_shell; /* shell program */ +}; +.ta +.fi +.RE +.SH "RETURN VALUE" +The \fBfgetpwent()\fP function returns the passwd structure, or NULL if +there are no more entries or an error occurs. +.SH ERRORS +.TP +.B ENOMEM +Insufficient memory to allocate passwd structure. +.SH FILES +.TP +.I /etc/passwd +password database file +.SH "CONFORMING TO" +SVID 3 +.SH "SEE ALSO" +.BR endpwent (3), +.BR fgetpwent_r (3), +.BR getpw (3), +.BR getpwent (3), +.BR getpwnam (3), +.BR getpwuid (3), +.BR putpwent (3), +.BR setpwent (3), +.BR passwd (5) |