| 1 | .\" @(#)getpwent.3 6.2 (Berkeley) %G% |
| 2 | .\" |
| 3 | .TH GETPWENT 3 "" |
| 4 | .AT 3 |
| 5 | .SH NAME |
| 6 | getpwent, getpwuid, getpwnam, setpwent, endpwent, setpwfile \- get password file entry |
| 7 | .SH SYNOPSIS |
| 8 | .nf |
| 9 | .B #include <pwd.h> |
| 10 | .PP |
| 11 | .B struct passwd *getpwent() |
| 12 | .PP |
| 13 | .B struct passwd *getpwuid(uid) |
| 14 | .B int uid; |
| 15 | .PP |
| 16 | .B struct passwd *getpwnam(name) |
| 17 | .B char *name; |
| 18 | .PP |
| 19 | .B setpwent() |
| 20 | .PP |
| 21 | .B endpwent() |
| 22 | .PP |
| 23 | .B setpwfile(name) |
| 24 | .B char *name; |
| 25 | .fi |
| 26 | .SH DESCRIPTION |
| 27 | .I Getpwent, |
| 28 | .I getpwuid |
| 29 | and |
| 30 | .I getpwnam |
| 31 | each return a pointer to an object with the |
| 32 | following structure |
| 33 | containing the broken-out |
| 34 | fields of a line in the password file. |
| 35 | .RS |
| 36 | .PP |
| 37 | .nf |
| 38 | .so /usr/include/pwd.h |
| 39 | .ft R |
| 40 | .ad |
| 41 | .fi |
| 42 | .RE |
| 43 | .PP |
| 44 | The fields |
| 45 | .I pw_quota |
| 46 | and |
| 47 | .I pw_comment |
| 48 | are unused; the others have meanings described in |
| 49 | .IR passwd (5). |
| 50 | .PP |
| 51 | .I Getpwent |
| 52 | reads the next |
| 53 | line (opening the file if necessary); |
| 54 | .I setpwent |
| 55 | rewinds the file; |
| 56 | .I endpwent |
| 57 | closes it. |
| 58 | .PP |
| 59 | .I Setpwfile |
| 60 | changes the default password file to |
| 61 | .I name |
| 62 | thus allowing alternate password files to be used. |
| 63 | Note that it does |
| 64 | .I not |
| 65 | close the previous file. |
| 66 | If this is desired, |
| 67 | .I endpwent |
| 68 | should be called prior to it. |
| 69 | .PP |
| 70 | .I Getpwuid |
| 71 | and |
| 72 | .I getpwnam |
| 73 | search from the beginning until a matching |
| 74 | .I uid |
| 75 | or |
| 76 | .I name |
| 77 | is found |
| 78 | (or until EOF is encountered). |
| 79 | .SH FILES |
| 80 | /etc/passwd |
| 81 | .SH "SEE ALSO" |
| 82 | getlogin(3), getgrent(3), passwd(5) |
| 83 | .SH DIAGNOSTICS |
| 84 | The routines |
| 85 | .IR getpwent , |
| 86 | .IR getpwuid , |
| 87 | and |
| 88 | .IR getpwnam , |
| 89 | return a null pointer (0) on EOF or error. |
| 90 | .SH BUGS |
| 91 | All information |
| 92 | is contained in a static area |
| 93 | so it must be copied if it is |
| 94 | to be saved. |