about summary refs log tree commit diff
path: root/pwd
diff options
context:
space:
mode:
Diffstat (limited to 'pwd')
-rw-r--r--pwd/pwd.h29
1 files changed, 15 insertions, 14 deletions
diff --git a/pwd/pwd.h b/pwd/pwd.h
index 25c6b97551..e6d20cd78b 100644
--- a/pwd/pwd.h
+++ b/pwd/pwd.h
@@ -45,11 +45,12 @@ typedef __uid_t uid_t;
 # endif
 #endif
 
-/* The passwd structure.  */
+/* A record in the user database.  */
 struct passwd
 {
   char *pw_name;		/* Username.  */
-  char *pw_passwd;		/* Password.  */
+  char *pw_passwd;		/* Hashed passphrase, if shadow database
+                                   not in use (see shadow.h).  */
   __uid_t pw_uid;		/* User ID.  */
   __gid_t pw_gid;		/* Group ID.  */
   char *pw_gecos;		/* Real name.  */
@@ -64,19 +65,19 @@ struct passwd
 
 
 #if defined __USE_MISC || defined __USE_XOPEN_EXTENDED
-/* Rewind the password-file stream.
+/* Rewind the user database stream.
 
    This function is a possible cancellation point and therefore not
    marked with __THROW.  */
 extern void setpwent (void);
 
-/* Close the password-file stream.
+/* Close the user database stream.
 
    This function is a possible cancellation point and therefore not
    marked with __THROW.  */
 extern void endpwent (void);
 
-/* Read an entry from the password-file stream, opening it if necessary.
+/* Read an entry from the user database stream, opening it if necessary.
 
    This function is a possible cancellation point and therefore not
    marked with __THROW.  */
@@ -84,7 +85,7 @@ extern struct passwd *getpwent (void);
 #endif
 
 #ifdef	__USE_MISC
-/* Read an entry from STREAM.
+/* Read a user database entry from STREAM.
 
    This function is not part of POSIX and therefore no official
    cancellation point.  But due to similarity with an POSIX interface
@@ -92,7 +93,7 @@ extern struct passwd *getpwent (void);
    therefore not marked with __THROW.  */
 extern struct passwd *fgetpwent (FILE *__stream) __nonnull ((1));
 
-/* Write the given entry onto the given stream.
+/* Write a given user database entry onto the given stream.
 
    This function is not part of POSIX and therefore no official
    cancellation point.  But due to similarity with an POSIX interface
@@ -102,13 +103,13 @@ extern int putpwent (const struct passwd *__restrict __p,
 		     FILE *__restrict __f);
 #endif
 
-/* Search for an entry with a matching user ID.
+/* Retrieve the user database entry for the given user ID.
 
    This function is a possible cancellation point and therefore not
    marked with __THROW.  */
 extern struct passwd *getpwuid (__uid_t __uid);
 
-/* Search for an entry with a matching username.
+/* Retrieve the user database entry for the given username.
 
    This function is a possible cancellation point and therefore not
    marked with __THROW.  */
@@ -155,8 +156,8 @@ extern int getpwnam_r (const char *__restrict __name,
 
 
 # ifdef	__USE_MISC
-/* Read an entry from STREAM.  This function is not standardized and
-   probably never will.
+/* Read a user database entry from STREAM.  This function is not
+   standardized and probably never will.
 
    This function is not part of POSIX and therefore no official
    cancellation point.  But due to similarity with an POSIX interface
@@ -172,9 +173,9 @@ extern int fgetpwent_r (FILE *__restrict __stream,
 #endif	/* POSIX or reentrant */
 
 #ifdef __USE_GNU
-/* Re-construct the password-file line for the given uid
-   in the given buffer.  This knows the format that the caller
-   will expect, but this need not be the format of the password file.
+/* Write a traditional /etc/passwd line, based on the user database
+   entry for the given UID, to BUFFER; space for BUFFER must be
+   allocated by the caller.
 
    This function is not part of POSIX and therefore no official
    cancellation point.  But due to similarity with an POSIX interface