BSD 4_3 release

[unix-history] / usr / man / man3 / getpwent.3

diff --git a/usr/man/man3/getpwent.3 b/usr/man/man3/getpwent.3
index 04ca062..afd405b 100644 (file)
--- a/usr/man/man3/getpwent.3
+++ b/usr/man/man3/getpwent.3
@@ -1,21 +1,27 @@
-.TH GETPWENT 3  "19 January 1983"
+.\"    @(#)getpwent.3  6.3 (Berkeley) 5/15/86
+.\"
+.TH GETPWENT 3  "May 15, 1986"
+.AT 3

 .SH NAME
 .SH NAME

-getpwent, getpwuid, getpwnam, setpwent, endpwent \- get password file entry
+getpwent, getpwuid, getpwnam, setpwent, endpwent, setpwfile \- get password file entry

 .SH SYNOPSIS
 .nf
 .B #include <pwd.h>
 .PP
 .SH SYNOPSIS
 .nf
 .B #include <pwd.h>
 .PP

-.B struct passwd *getpwent()
-.PP

 .B struct passwd *getpwuid(uid)
 .B int uid;
 .PP
 .B struct passwd *getpwnam(name)
 .B char *name;
 .PP
 .B struct passwd *getpwuid(uid)
 .B int uid;
 .PP
 .B struct passwd *getpwnam(name)
 .B char *name;
 .PP

-.B int setpwent()
+.B struct passwd *getpwent()
+.PP
+.B setpwent()

 .PP
 .PP

-.B int endpwent()
+.B endpwent()
+.PP
+.B setpwfile(name)
+.B char *name;

 .fi
 .SH DESCRIPTION
 .I Getpwent,
 .fi
 .SH DESCRIPTION
 .I Getpwent,


@@ -42,33 +48,54 @@ and
 are unused; the others have meanings described in
 .IR passwd (5).
 .PP
 are unused; the others have meanings described in
 .IR passwd (5).
 .PP

-.I Getpwent
-reads the next
-line (opening the file if necessary);
-.I setpwent
-rewinds the file;
+Searching of the password file is done using the \fIndbm\fP
+database access routines.
+.I Setpwent
+opens the database;

 .I endpwent
 closes it.
 .I endpwent
 closes it.

-.PP

 .I Getpwuid
 and
 .I getpwnam
 .I Getpwuid
 and
 .I getpwnam

-search from the beginning until a matching
+search the database (opening it if necessary) for a matching

 .I uid
 or
 .I uid
 or

+.IR name .
+EOF is returned if there is no entry.
+.PP
+For programs wishing to read the entire database,
+.I getpwent
+reads the next
+line (opening the database if necessary).
+In addition to opening the database,
+.I setpwent
+can be used to make
+.I getpwent
+begin its search from the beginning of the database.
+.PP
+.I Setpwfile
+changes the default password file to

 .I name
 .I name

-is found
-(or until EOF is encountered).
+thus allowing alternate password files to be used.
+Note that it does
+.I not
+close the previous file.
+If this is desired,
+.I endpwent
+should be called prior to it.

 .SH FILES
 /etc/passwd
 .SH "SEE ALSO"
 getlogin(3), getgrent(3), passwd(5)
 .SH DIAGNOSTICS
 .SH FILES
 /etc/passwd
 .SH "SEE ALSO"
 getlogin(3), getgrent(3), passwd(5)
 .SH DIAGNOSTICS

-Null pointer
-(0) returned on EOF or error.
+The routines
+.IR getpwent ,
+.IR getpwuid ,
+and
+.IR getpwnam ,
+return a null pointer (0) on EOF or error.

 .SH BUGS
 All information
 is contained in a static area
 so it must be copied if it is
 to be saved.
 .SH BUGS
 All information
 is contained in a static area
 so it must be copied if it is
 to be saved.

-.br