mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
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
This commit is contained in:
Marko Karppinen
parent
930bf9ba89
commit
f220c5df07
1 changed files with 157 additions and 6 deletions
|
|
@ -323,7 +323,7 @@
|
|||
|
||||
<refentry id="function.posix-getsid">
|
||||
<refnamediv>
|
||||
<refname>posix_setsid</refname>
|
||||
<refname>posix_getsid</refname>
|
||||
<refpurpose>Get the current sid of the process</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
|
|
@ -537,19 +537,95 @@
|
|||
<refentry id="function.posix-getpwnam">
|
||||
<refnamediv>
|
||||
<refname>posix_getpwnam</refname>
|
||||
<refpurpose>Return info about a user by name</refpurpose>
|
||||
<refpurpose>Return info about a user by username</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcdef>array <function>posix_getpwnam</function></funcdef>
|
||||
<paramdef>string <parameter>name</parameter></paramdef>
|
||||
<paramdef>string <parameter>username</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Needs to be written ASAP.</para>
|
||||
Returns an associative array containing information about a
|
||||
user referenced by an alphanumeric username, passed in the
|
||||
<parameter>username</parameter> parameter.
|
||||
</para>
|
||||
<para>
|
||||
The array elements returned are:
|
||||
<table>
|
||||
<title>The user information array</title>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Element</entry>
|
||||
<entry>Description</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>name</entry>
|
||||
<entry>
|
||||
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
|
||||
<parameter>username</parameter> parameter used when calling the
|
||||
function, and hence redundant.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>passwd</entry>
|
||||
<entry>
|
||||
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.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>uid</entry>
|
||||
<entry>
|
||||
User ID of the user in numeric form.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>gid</entry>
|
||||
<entry>
|
||||
The group ID of the user. Use the function
|
||||
<function>posix_getgrgid</function> to resolve the
|
||||
group name and a list of its members.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>gecos</entry>
|
||||
<entry>
|
||||
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.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>dir</entry>
|
||||
<entry>
|
||||
This element contains the absolute path to the
|
||||
home directory of the user.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>shell</entry>
|
||||
<entry>
|
||||
The shell element contains the absolute path to the executable of
|
||||
the user's default shell.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
||||
<refentry id="function.posix-getpwuid">
|
||||
<refnamediv>
|
||||
<refname>posix_getpwuid</refname>
|
||||
|
|
@ -562,7 +638,82 @@
|
|||
<paramdef>int <parameter>uid</parameter></paramdef>
|
||||
</funcsynopsis>
|
||||
<para>
|
||||
Needs to be written ASAP.</para>
|
||||
Returns an associative array containing information about a
|
||||
user referenced by a numeric user ID, passed in the
|
||||
<parameter>uid</parameter> parameter.
|
||||
</para>
|
||||
<para>
|
||||
The array elements returned are:
|
||||
<table>
|
||||
<title>The user information array</title>
|
||||
<tgroup cols="2">
|
||||
<thead>
|
||||
<row>
|
||||
<entry>Element</entry>
|
||||
<entry>Description</entry>
|
||||
</row>
|
||||
</thead>
|
||||
<tbody>
|
||||
<row>
|
||||
<entry>name</entry>
|
||||
<entry>
|
||||
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.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>passwd</entry>
|
||||
<entry>
|
||||
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.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>uid</entry>
|
||||
<entry>
|
||||
User ID, should be the same as the <parameter>uid</parameter>
|
||||
parameter used when calling the function, and hence redundant.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>gid</entry>
|
||||
<entry>
|
||||
The group ID of the user. Use the function
|
||||
<function>posix_getgrgid</function> to resolve the
|
||||
group name and a list of its members.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>gecos</entry>
|
||||
<entry>
|
||||
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.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>dir</entry>
|
||||
<entry>
|
||||
This element contains the absolute path to the
|
||||
home directory of the user.
|
||||
</entry>
|
||||
</row>
|
||||
<row>
|
||||
<entry>shell</entry>
|
||||
<entry>
|
||||
The shell element contains the absolute path to the executable of
|
||||
the user's default shell.
|
||||
</entry>
|
||||
</row>
|
||||
</tbody>
|
||||
</tgroup>
|
||||
</table>
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue