File: posix-getpwuid.xml

package info (click to toggle)
php-doc 20061001-1
  • links: PTS
  • area: non-free
  • in suites: etch, etch-m68k
  • size: 45,764 kB
  • ctags: 1,611
  • sloc: xml: 502,485; php: 7,645; cpp: 500; makefile: 297; perl: 161; sh: 141; awk: 28
file content (116 lines) | stat: -rw-r--r-- 3,548 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
<?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
-->