From f220c5df07a5b562070644d4adf4e523a6317676 Mon Sep 17 00:00:00 2001 From: Marko Karppinen Date: Tue, 11 Jan 2000 04:54:17 +0000 Subject: [PATCH] Added documentation for posix_getpwnam() and posix_getpwuid() git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@18529 c90b9560-bf6c-de11-be94-00142212c4b1 --- functions/posix.xml | 163 ++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 157 insertions(+), 6 deletions(-) diff --git a/functions/posix.xml b/functions/posix.xml index 0416df84ee..211df10728 100644 --- a/functions/posix.xml +++ b/functions/posix.xml @@ -323,7 +323,7 @@ - posix_setsid + posix_getsid Get the current sid of the process @@ -537,19 +537,95 @@ posix_getpwnam - Return info about a user by name + Return info about a user by username Description array posix_getpwnam - string name + string username - Needs to be written ASAP. + Returns an associative array containing information about a + user referenced by an alphanumeric username, passed in the + username parameter. + + + The array elements returned are: + + The user information array + + + + Element + Description + + + + + name + + The name element contains the username of the user. This is + a short, usually less than 16 character "handle" of the user, + not her real, full name. This should be the same as the + username parameter used when calling the + function, and hence redundant. + + + + passwd + + The passwd element contains the user's password in an encrypted + format. Often, for example on a system employing "shadow" + passwords, an asterisk is returned instead. + + + + uid + + User ID of the user in numeric form. + + + + gid + + The group ID of the user. Use the function + posix_getgrgid to resolve the + group name and a list of its members. + + + + gecos + + GECOS is an obsolete term that refers to the finger information + field on a Honeywell batch processing system. The field, however, + lives on, and its contents have been formalized by POSIX. The + field contains a comma separated list containing the user's full + name, office phone, office number, and home phone number. On most + systems, only the user's full name is available. + + + + dir + + This element contains the absolute path to the + home directory of the user. + + + + shell + + The shell element contains the absolute path to the executable of + the user's default shell. + + + + +
+ - + posix_getpwuid @@ -562,7 +638,82 @@ int uid - Needs to be written ASAP. + Returns an associative array containing information about a + user referenced by a numeric user ID, passed in the + uid parameter. + + + The array elements returned are: + + The user information array + + + + Element + Description + + + + + name + + The name element contains the username of the user. This is + a short, usually less than 16 character "handle" of the user, + not her real, full name. + + + + passwd + + The passwd element contains the user's password in an encrypted + format. Often, for example on a system employing "shadow" + passwords, an asterisk is returned instead. + + + + uid + + User ID, should be the same as the uid + parameter used when calling the function, and hence redundant. + + + + gid + + The group ID of the user. Use the function + posix_getgrgid to resolve the + group name and a list of its members. + + + + gecos + + GECOS is an obsolete term that refers to the finger information + field on a Honeywell batch processing system. The field, however, + lives on, and its contents have been formalized by POSIX. The + field contains a comma separated list containing the user's full + name, office phone, office number, and home phone number. On most + systems, only the user's full name is available. + + + + dir + + This element contains the absolute path to the + home directory of the user. + + + + shell + + The shell element contains the absolute path to the executable of + the user's default shell. + + + + +
+