? en/reference/posix/functions/patch.patch Index: en/reference/posix/functions/posix-ctermid.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-ctermid.xml,v retrieving revision 1.5 diff -u -u -r1.5 posix-ctermid.xml --- en/reference/posix/functions/posix-ctermid.xml 4 Feb 2007 02:47:57 -0000 1.5 +++ en/reference/posix/functions/posix-ctermid.xml 28 Apr 2007 19:13:27 -0000 @@ -1,5 +1,5 @@ - + posix_ctermid @@ -12,11 +12,51 @@ stringposix_ctermid - - &warn.undocumented.func; + + Generates a string which is the pathname for the current + controlling terminal for the process. On error this will set errno, + which can be checked using posix_get_last_error + + &reftitle.examples; + + + <function>posix_ctermid</function> example + + This example will display the path to the current TTY. + + + +]]> + + + + + + + &reftitle.returnvalues; + + Upon successful completion, returns string of the pathname to + the current controlling terminal. Otherwise &false; is returned and errno + is set, which can be checked with posix_get_last_error. + + + + + &reftitle.seealso; + + + posix_ttyname + posix_get_last_error + + + + posix_get_last_error @@ -27,6 +27,27 @@ + + &reftitle.examples; + + + <function>posix_get_last_error</function> example + + This example attempt to kill a bogus process id, which will set the + last error. We will then print out the last error. + + + +]]> + + + + &reftitle.seealso; Index: en/reference/posix/functions/posix-getcwd.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getcwd.xml,v retrieving revision 1.8 diff -u -u -r1.8 posix-getcwd.xml --- en/reference/posix/functions/posix-getcwd.xml 4 Feb 2007 02:47:57 -0000 1.8 +++ en/reference/posix/functions/posix-getcwd.xml 28 Apr 2007 19:13:27 -0000 @@ -1,5 +1,5 @@ - + posix_getcwd @@ -14,13 +14,53 @@ Gets the absolute pathname of the script's current working directory. + On error, it sets errno which can be checked using + posix_get_last_error + + &reftitle.examples; + + + <function>posix_getcwd</function> example + + This example will return the absolute path of the current working + directory of the script. + + + +]]> + + + + + + + &reftitle.notes; + + This function can fail on can fail on + + + Read or Search permission was denied + + + Pathname no longer exists + + + + + &reftitle.returnvalues; - Returns the absolute pathname, or &false; on error. + Returns a string of the absolute pathname on success. + On error, returns &false; and sets errno which can be checked with + posix_get_last_error. Index: en/reference/posix/functions/posix-getegid.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getegid.xml,v retrieving revision 1.4 diff -u -u -r1.4 posix-getegid.xml --- en/reference/posix/functions/posix-getegid.xml 4 Feb 2007 02:47:57 -0000 1.4 +++ en/reference/posix/functions/posix-getegid.xml 28 Apr 2007 19:13:27 -0000 @@ -1,5 +1,5 @@ - + posix_getegid @@ -16,11 +16,42 @@ Return the numeric effective group ID of the current process. - + + &reftitle.notes; + + posix_getegid is different than + posix_getgid by you can change the effective group ID of + a calling process using the posix_setegid. + + &reftitle.returnvalues; - Returns the group ID. + Returns an integer of the effective group ID. + + + + + &reftitle.examples; + + + <function>posix_getegid</function> example + + This example will print out your effective group id, once you + change it with posix_setegid. + + + +]]> + + @@ -30,6 +61,9 @@ posix_getgrgid for information on how to convert this into a useable group name + posix_getgid get real group id. + posix_setgid change the effective group + id Index: en/reference/posix/functions/posix-geteuid.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-geteuid.xml,v retrieving revision 1.4 diff -u -u -r1.4 posix-geteuid.xml --- en/reference/posix/functions/posix-geteuid.xml 4 Feb 2007 02:47:57 -0000 1.4 +++ en/reference/posix/functions/posix-geteuid.xml 28 Apr 2007 19:13:27 -0000 @@ -1,5 +1,5 @@ - + posix_geteuid @@ -18,11 +18,50 @@ to convert this into a useable username. - + + + &reftitle.examples; + + + <function>posix_geteuid</function> example + This example will show the current user id then set the + effective user id to a separate id using + posix_seteuid, then show the difference between + the real id and the effective id. + + +]]> + + + + + &reftitle.returnvalues; - Returns the identifier, as an integer. + Returns the user id, as an integer + + + + + &reftitle.seealso; + + + posix_getpwuid for more information + about the user. + posix_getuid get real user id. + posix_setuid change the effective user + id + POSIX man page GETEUID(2) + Index: en/reference/posix/functions/posix-getgid.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getgid.xml,v retrieving revision 1.4 diff -u -u -r1.4 posix-getgid.xml --- en/reference/posix/functions/posix-getgid.xml 4 Feb 2007 02:47:57 -0000 1.4 +++ en/reference/posix/functions/posix-getgid.xml 28 Apr 2007 19:13:27 -0000 @@ -1,5 +1,5 @@ - + posix_getgid @@ -13,16 +13,54 @@ - Return the numeric real group ID of the current process. See also - posix_getgrgid for information on how to - convert this into a useable group name. + Return the numeric real group ID of the current process. + + + + + &reftitle.examples; + + + <function>posix_getgid</function> example + + This example will print out your real group id, even once you + have changed your effective group id. + + + +]]> + + + + + + + &reftitle.seealso; + + + + posix_getgrgid for information on how + to convert this into a useable group name + + posix_getegid get effective group id. + posix_setgid change the effective group + id + POSIX man page GETGID(2) + &reftitle.returnvalues; - Returns the identifier, as an integer. + Returns the real group id, as an integer. Index: en/reference/posix/functions/posix-getgrgid.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getgrgid.xml,v retrieving revision 1.7 diff -u -u -r1.7 posix-getgrgid.xml --- en/reference/posix/functions/posix-getgrgid.xml 4 Feb 2007 02:47:57 -0000 1.7 +++ en/reference/posix/functions/posix-getgrgid.xml 28 Apr 2007 19:13:27 -0000 @@ -1,5 +1,5 @@ - + posix_getgrgid @@ -36,10 +36,51 @@ &reftitle.returnvalues; - Returns an array of information about a group and - &false; on failure. If gid isn't a number - then &null; is returned and an E_WARNING - level error is generated. + The array elements returned are: + + The group information array + + + + Element + Description + + + + + name + + The name element contains the name of the group. This is + a short, usually less than 16 character "handle" of the + group, not the real, full name. + + + + passwd + + The passwd element contains the group's password in an + encrypted format. Often, for example on a system employing + "shadow" passwords, an asterisk is returned instead. + + + + gid + + Group ID, should be the same as the + gid parameter used when calling the + function, and hence redundant. + + + + members + + This consists of an array of + string's for all the members in the group. + + + + +
@@ -82,7 +123,6 @@ $groupinfo = posix_getgrgid($groupid); print_r($groupinfo); - ?> ]]> @@ -111,9 +151,11 @@ posix_getegid + posix_getgrnam filegroup stat safe_mode_gid + POSIX man page GETGRNAM(3) Index: en/reference/posix/functions/posix-getgrnam.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getgrnam.xml,v retrieving revision 1.5 diff -u -u -r1.5 posix-getgrnam.xml --- en/reference/posix/functions/posix-getgrnam.xml 4 Feb 2007 02:47:57 -0000 1.5 +++ en/reference/posix/functions/posix-getgrnam.xml 28 Apr 2007 19:13:27 -0000 @@ -1,5 +1,5 @@ - + posix_getgrnam @@ -12,8 +12,8 @@ arrayposix_getgrnam stringname - - &warn.undocumented.func; + + Gets information about a group provided its name. @@ -24,14 +24,139 @@ name - - + The name of the group + + &reftitle.returnvalues; + + The array elements returned are: + + The group information array + + + + Element + Description + + + + + name + + The name element contains the name of the group. This is + a short, usually less than 16 character "handle" of the + group, not the real, full name. This should be the same as + the name parameter used when + calling the function, and hence redundant. + + + + passwd + + The passwd element contains the group's password in an + encrypted format. Often, for example on a system employing + "shadow" passwords, an asterisk is returned instead. + + + + uid + + Group ID of the group in numeric form. + + + + members + + This consists of an array of + string's for all the members in the group. + + + + +
+
+
+ + + &reftitle.changelog; + + + + + + &Version; + &Description; + + + + + 4.2.0 + + Prior to this version, members was simply an integer representing the + number of members in the group, and the member names were returned + with numerical indices. + + + + + + + + + + &reftitle.examples; + + + Example use of <function>posix_getgrnam</function> + + +]]> + + &example.outputs.similar; + + toons + [passwd] => x + [members] => Array + ( + [0] => tom + [1] => jerry + ) + [gid] => 42 +) +]]> + + + + + + + &reftitle.seealso; + + + posix_getegid + posix_getgrgid + filegroup + stat + safe_mode_gid + POSIX man page GETGRNAM(3) + + + +
+ posix_getgroups @@ -25,6 +25,46 @@ + + &reftitle.examples; + + + Example use of <function>posix_getgroups</function> + + +]]> + + &example.outputs.similar; + + 4 + [1] => 20 + [2] => 24 + [3] => 25 + [4] => 29 + [5] => 30 + [6] => 33 + [7] => 44 + [8] => 46 + [9] => 104 + [10] => 109 + [11] => 110 + [12] => 1000 +) +]]> + + + + + &reftitle.seealso; Index: en/reference/posix/functions/posix-getlogin.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getlogin.xml,v retrieving revision 1.4 diff -u -u -r1.4 posix-getlogin.xml --- en/reference/posix/functions/posix-getlogin.xml 4 Feb 2007 02:47:57 -0000 1.4 +++ en/reference/posix/functions/posix-getlogin.xml 28 Apr 2007 19:13:27 -0000 @@ -1,5 +1,5 @@ - + posix_getlogin @@ -20,7 +20,23 @@ &reftitle.returnvalues; - Returns the login name of the user, as a string. + Returns the login name of the user, as a string. + + + + + &reftitle.examples; + + + Example use of <function>posix_getlogin</function> + + +]]> + + @@ -29,6 +45,7 @@ posix_getpwnam + POSIX man page GETLOGIN(3) Index: en/reference/posix/functions/posix-getpgid.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getpgid.xml,v retrieving revision 1.4 diff -u -u -r1.4 posix-getpgid.xml --- en/reference/posix/functions/posix-getpgid.xml 4 Feb 2007 02:47:57 -0000 1.4 +++ en/reference/posix/functions/posix-getpgid.xml 28 Apr 2007 19:13:28 -0000 @@ -1,5 +1,5 @@ - + posix_getpgid @@ -37,19 +37,44 @@ &reftitle.returnvalues; - Returns the identifier, as an integer. + Returns the identifier, as an integer. &reftitle.notes; - - - This is not a POSIX function, but is common on BSD and System V - systems. If your system does not support this function at system - level, this PHP function will always return &false;. - - + + This is a not POSIX function, but is common on BSD and System V + systems. If your system does not support this function, then it + will not be included at compile time. You may check if this + function exists with function_exists. + + + + + &reftitle.examples; + + + Example use of <function>posix_getpgid</function> + + +]]> + + + + + + + &reftitle.seealso; + + + posix_getppid + man page SETPGID(2) + + Index: en/reference/posix/functions/posix-getpgrp.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getpgrp.xml,v retrieving revision 1.4 diff -u -u -r1.4 posix-getpgrp.xml --- en/reference/posix/functions/posix-getpgrp.xml 4 Feb 2007 02:47:57 -0000 1.4 +++ en/reference/posix/functions/posix-getpgrp.xml 28 Apr 2007 19:13:28 -0000 @@ -1,5 +1,5 @@ - + posix_getpgrp @@ -20,7 +20,7 @@ &reftitle.returnvalues; - Returns the identifier, as an integer. + Returns the identifier, as an integer. Index: en/reference/posix/functions/posix-getpid.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getpid.xml,v retrieving revision 1.5 diff -u -u -r1.5 posix-getpid.xml --- en/reference/posix/functions/posix-getpid.xml 4 Feb 2007 02:47:57 -0000 1.5 +++ en/reference/posix/functions/posix-getpid.xml 28 Apr 2007 19:13:28 -0000 @@ -1,5 +1,5 @@ - + posix_getpid @@ -20,9 +20,38 @@ &reftitle.returnvalues; - Returns the identifier, as an integer. + Returns the identifier, as an integer. + + + &reftitle.examples; + + + Example use of <function>posix_getpid</function> + + +]]> + + + + + + + &reftitle.seealso; + + + + posix_kill to kill a process. + + POSIX man page GETPID(2) + + + + + posix_getppid @@ -21,9 +21,26 @@ &reftitle.returnvalues; - Returns the identifier, as an integer. + Returns the identifier, as an integer. + + + &reftitle.examples; + + + Example use of <function>posix_getppid</function> + + +]]> + + + + + + posix_getpwnam @@ -13,7 +13,7 @@ stringusername - Returns an information about the given user. + Returns an array of information about the given user. @@ -52,7 +52,7 @@ 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 + user, not the real, full name. This should be the same as the username parameter used when calling the function, and hence redundant. @@ -111,6 +111,50 @@ + + &reftitle.examples; + + + Example use of <function>posix_getpwnam</function> + + +]]> + + &example.outputs.similar; + + tom + [passwd] => x + [uid] => 10000 + [gid] => 42 + [geocs] => "tom,,," + [dir] => "/home/tom" + [shell] => "/bin/bash" +) +]]> + + + + + + + &reftitle.seealso; + + + posix_getpwuid + POSIX man page GETPWNAM(3) + + + + + posix_getpwuid @@ -13,7 +13,8 @@ intuid - Gets information about the user referenced by the given user ID. + Returns an array of information about the user + referenced by the given user ID. @@ -52,7 +53,7 @@ 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. + user, not the real, full name. @@ -111,6 +112,50 @@ + + &reftitle.examples; + + + Example use of <function>posix_getpwuid</function> + + +]]> + + &example.outputs.similar; + + tom + [passwd] => x + [uid] => 10000 + [gid] => 42 + [geocs] => "tom,,," + [dir] => "/home/tom" + [shell] => "/bin/bash" +) +]]> + + + + + + + &reftitle.seealso; + + + posix_getpwnam + POSIX man page GETPWNAM(3) + + + + + posix_getrlimit @@ -12,8 +12,172 @@ arrayposix_getrlimit - - &warn.undocumented.func; + + posix_getrlimi returns an array + of information about the current resource's soft and hard limits. + + + Each resource has an associated soft and hard limit. The soft + limit is the value that the kernel enforces for the corresponding + resrource. The hard limit acts as a cieling for the soft limit. + An unprivileged process may only set its soft limit to a value + from 0 to the hard limit, and irreversibly lowers its hard limit. + + + + + &reftitle.returnvalues; + + Returns an associative array of elements for each + limit that is defined. Each limit has a soft and a hard limit. + + List of possible limits returned + + + + Limit name + Limit description + + + + + core + + The maximum size of the core file. When 0, not core files are + created. When core files are larger than this size, they will + be truncated at this size. + + + + totalmem + + The maximum size of the memory of the process, in bytes. + + + + virtualmem + + The maximum size of the virtual memory for the process, in bytes. + + + + data + + The maximum size of the data segment for the process, in bytes. + + + + stack + + The maximum size of the process stack, in bytes. + + + + rss + + The maximum number of virtual pages resident in RAM + + + + maxproc + + The maximum number of processes that can be created for the + real user ID of the calling process. + + + + memlock + + The maximum number of bytes of memory that may be locked into RAM. + + + + cpu + + The amount of time the process is allowed to use the CPU. + + + + filesize + + The maximum size of the data segment for the process, in bytes. + + + + openfiles + + One more than the maximum number of open file descriptors. + + + + +
+
+
+ + + &reftitle.notes; + + This is a not POSIX function, but is common on BSD and System V + systems. If your system does not support this function, then it + will not be included at compile time. You may check if this + function exists with function_exists. + + + + + &reftitle.examples; + + + Example use of <function>posix_getrlimit</function> + + +]]> + + &example.outputs.similar; + + 0 + [hard core] => unlimited + [soft data] => unlimited + [hard data] => unlimited + [soft stack] => 8388608 + [hard stack] => unlimited + [soft totalmem] => unlimited + [hard totalmem] => unlimited + [soft rss] => unlimited + [hard rss] => unlimited + [soft maxproc] => unlimited + [hard maxproc] => unlimited + [soft memlock] => unlimited + [hard memlock] => unlimited + [soft cpu] => unlimited + [hard cpu] => unlimited + [soft filesize] => unlimited + [hard filesize] => unlimited + [soft openfiles] => 1024 + [hard openfiles] => 1024 +) +]]> + + + + + + + &reftitle.seealso; + + + man page GETRLIMIT(2) + Index: en/reference/posix/functions/posix-getsid.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-getsid.xml,v retrieving revision 1.4 diff -u -u -r1.4 posix-getsid.xml --- en/reference/posix/functions/posix-getsid.xml 4 Feb 2007 02:47:57 -0000 1.4 +++ en/reference/posix/functions/posix-getsid.xml 28 Apr 2007 19:13:28 -0000 @@ -1,5 +1,5 @@ - + posix_getsid @@ -13,7 +13,8 @@ intpid - Return the sid of the process pid. + Return the session id of the process pid. + The session id of a process is the process group id of the session leader. @@ -25,7 +26,10 @@ pid - The process identifier. If set to 0, the current process is assumed. + The process identifier. If set to 0, the current process is + assumed. If an invalid pid is + specified, then &false; is returned and an error is set which + can be checked with posix_get_last_error. @@ -36,21 +40,42 @@ &reftitle.returnvalues; - Returns the identifier, as an integer. + Returns the identifier, as an integer. - - &reftitle.notes; - - - This is not a POSIX function, but is common on System V systems. - If your system does not support this function at system level, - this PHP function will always return &false;. - - + + &reftitle.examples; + + + Example use of <function>posix_getsid</function> + + +]]> + + + + + &reftitle.seealso; + + + + posix_getpgid + + + posix_setsid + + POSIX man page GETSID(2) + + + + + + posix_getuid @@ -20,7 +20,23 @@ &reftitle.returnvalues; - Returns the identifier, as an integer. + Returns the user id, as an integer + + + + + &reftitle.examples; + + + Example use of <function>posix_getuid</function> + + +]]> + + @@ -32,6 +48,7 @@ posix_getpwuid for information on how to convert this into a useable username + POSIX man page GETUID(2)
Index: en/reference/posix/functions/posix-isatty.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-isatty.xml,v retrieving revision 1.5 diff -u -u -r1.5 posix-isatty.xml --- en/reference/posix/functions/posix-isatty.xml 4 Feb 2007 02:47:57 -0000 1.5 +++ en/reference/posix/functions/posix-isatty.xml 28 Apr 2007 19:13:28 -0000 @@ -1,5 +1,5 @@ - + posix_isatty @@ -13,10 +13,43 @@ intfd - &warn.undocumented.func; + Determines if the file descriptor fd refers to a valid + terminal type device. + + + + + &reftitle.parameters; + + + + fd + + + The file descriptor. + + + + + + + + + &reftitle.returnvalues; + + Returns &true; if fd is an open descriptor connected + to a terminal and &false; otherwise. + + + + + &reftitle.seealso; + + + posix_ttyname + - + posix_setegid @@ -41,6 +41,44 @@ &return.success; + + + &reftitle.examples; + + + <function>posix_setegid</function> example + + This example will print out your effective group id, once you + change it. + + + +]]> + + + + + + + &reftitle.seealso; + + + posix_getgrgid for information on how + to a group id into a useable group name + posix_getgid get real group id. + posix_setgid change the effective group + id + + + + + posix_setgid @@ -20,6 +20,12 @@ posix_setgid first, posix_setuid last. + + + If the caller is a super user, this will also set your effective + group id + + @@ -45,6 +51,41 @@ + + &reftitle.examples; + + + <function>posix_setgid</function> example + + This example will print out your effective group id, once you + change it. + + + +]]> + + + + + + + &reftitle.seealso; + + + posix_getgrgid for information on how + to convert this into a useable group name + posix_getgid get real group id. + + + + + posix_setuid @@ -42,11 +42,37 @@ + + &reftitle.examples; + + + <function>posix_setuid</function> example + This example will show the currrent user id and then set + it to a different value. + + +]]> + + + + + &reftitle.seealso; posix_setgid + posix_seteuid + posix_getuid + posix_geteuid Index: en/reference/posix/functions/posix-strerror.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-strerror.xml,v retrieving revision 1.5 diff -u -u -r1.5 posix-strerror.xml --- en/reference/posix/functions/posix-strerror.xml 4 Feb 2007 02:47:57 -0000 1.5 +++ en/reference/posix/functions/posix-strerror.xml 28 Apr 2007 19:13:28 -0000 @@ -1,5 +1,5 @@ - + posix_strerror @@ -14,7 +14,9 @@ Returns the POSIX system error message associated with the given - errno. + errno. You may get the + errno parameter by calling + posix_get_last_error. @@ -43,6 +45,32 @@ + + &reftitle.examples; + + + <function>posix_strerror</function> example + This example will attempt to kill a process which does not + exist, then will print out the corresponding error message. + + +]]> + + &example.outputs.similar; + + + + + + + &reftitle.seealso; Index: en/reference/posix/functions/posix-times.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-times.xml,v retrieving revision 1.5 diff -u -u -r1.5 posix-times.xml --- en/reference/posix/functions/posix-times.xml 4 Feb 2007 02:47:57 -0000 1.5 +++ en/reference/posix/functions/posix-times.xml 28 Apr 2007 19:13:28 -0000 @@ -1,5 +1,5 @@ - + posix_times @@ -63,6 +63,38 @@ + + &reftitle.examples; + + + Example use of <function>posix_times</function> + + +]]> + + &example.outputs.similar; + + 25814410 + [utime] => 1 + [stime] => 1 + [cutime] => 0 + [cstime] => 0 +) +]]> + + + + + + posix_ttyname @@ -12,8 +12,34 @@ stringposix_ttyname intfd - - &warn.undocumented.func; + + Returns a string for the absolute path to the current + terminal device that is open on the file descriptor + fd. + + + + + &reftitle.parameters; + + + + fd + + + The file descriptor. + + + + + + + + + &reftitle.returnvalues; + + On success, returns a string of the absolute path of the + fd. On failure, returns &false; Index: en/reference/posix/functions/posix-uname.xml =================================================================== RCS file: /repository/phpdoc/en/reference/posix/functions/posix-uname.xml,v retrieving revision 1.5 diff -u -u -r1.5 posix-uname.xml --- en/reference/posix/functions/posix-uname.xml 4 Feb 2007 02:47:57 -0000 1.5 +++ en/reference/posix/functions/posix-uname.xml 28 Apr 2007 19:13:28 -0000 @@ -1,5 +1,5 @@ - + posix_uname @@ -56,6 +56,36 @@ + + &reftitle.examples; + + + Example use of <function>posix_uname</function> + + +]]> + + &example.outputs.similar; + + Linux + [nodename] => funbox + [release] => 2.6.20-15-server + [version] => #2 SMP Sun Apr 15 07:41:34 UTC 2007 + [machine] => i686 +) +]]> + + + + +