php-doc-en/reference/posix/functions/posix-getpwuid.xml
Hartmut Holzgraefe 5b9fc29465 revision tags added
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78496 c90b9560-bf6c-de11-be94-00142212c4b1
2002-04-17 06:45:35 +00:00

116 lines
3.5 KiB
XML

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.2 $ -->
<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 -->
<refentry id="function.posix-getpwuid">
<refnamediv>
<refname>posix_getpwuid</refname>
<refpurpose>Return info about a user by user id</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>posix_getpwuid</methodname>
<methodparam><type>int</type><parameter>uid</parameter></methodparam>
</methodsynopsis>
<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>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"../../../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->