posix-getpwnam.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.posix-getpwnam" xmlns="http://docbook.org/ns/docbook">
 <refnamediv>
  <refname>posix_getpwnam</refname>
  <refpurpose>Return info about a user by username</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type class="union"><type>array</type><type>false</type></type><methodname>posix_getpwnam</methodname>
   <methodparam><type>string</type><parameter>username</parameter></methodparam>
  </methodsynopsis>
  <para>
   Returns an <type>array</type> of information about the given user.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>username</parameter></term>
     <listitem>
      <para>
       An alphanumeric username.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   On success an array with the following elements is returned, else 
   &false; is returned:
   <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 the 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>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <example>
    <title>Example use of <function>posix_getpwnam</function></title>
    <programlisting role="php">
<![CDATA[
<?php

$userinfo = posix_getpwnam("tom");

print_r($userinfo);
?>
]]>
    </programlisting>
    &example.outputs.similar;
    <screen>
<![CDATA[
Array
(
    [name]    => tom
    [passwd]  => x
    [uid]     => 10000
    [gid]     => 42
    [gecos]   => "tom,,,"
    [dir]     => "/home/tom"
    [shell]   => "/bin/bash"
)
]]>
    </screen>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>posix_getpwuid</function></member>
    <member>POSIX man page GETPWNAM(3)</member>
   </simplelist>
  </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:"~/.phpdoc/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
-->