cvs: phpdoc /en/reference/posix/functions posix-access.xml posix-ctermid.xml posix-get-last-error.xml posix-getcwd.xml posix-getegid.xml
posix-geteuid.xml posix-getgid.xml posix-getgrgid.xml posix-getgrnam.xml posix-getgroups.xml posix-getlogin.xml posix-getpgid.xml posix-getpgrp.xml
posix-getpid.xml posix-getppid.xml posix-getpwnam.xml posix-getpwuid.xml posix-getrlimit.xml posix-getsid.xml posix-getuid.xml posix-isatty.xml
posix-kill.xml posix-mkfifo.xml posix-mknod.xml posix-setegid.xml posix-seteuid.xml posix-setgid.xml posix-setpgid.xml posix-setsid.xml
posix-setuid.xml posix-strerror.xml posix-times.xml posix-ttyname.xml posix-uname.xml
| From: | Mehdi Achour | Date: | Sun, 04 Feb 2007 02:47:57 +0000 |
| Subject: | cvs: phpdoc /en/reference/posix/functions posix-access.xml posix-ctermid.xml posix-get-last-error.xml posix-getcwd.xml posix-getegid.xml posix-geteuid.xml posix-getgid.xml posix-getgrgid.xml posix-getgrnam.xml posix-getgroups.xml posix-getlogin.xml posix-getpgid.xml posix-getpgrp.xml posix-getpid.xml posix-getppid.xml posix-getpwnam.xml posix-getpwuid.xml posix-getrlimit.xml posix-getsid.xml posix-getuid.xml posix-isatty.xml posix-kill.xml posix-mkfifo.xml posix-mknod.xml posix-setegid.xml posix-seteuid.xml posix-setgid.xml posix-setpgid.xml posix-setsid.xml posix-setuid.xml posix-strerror.xml posix-times.xml posix-ttyname.xml posix-uname.xml |
||
| Groups: | php.doc | ||
| Request: | Send a blank email to phpdoc+get-969375234@lists.php.net to get a copy of this message | ||
didou Sun Feb 4 02:47:57 2007 UTC
Modified files:
/phpdoc/en/reference/posix/functions posix-access.xml
posix-ctermid.xml
posix-get-last-error.xml
posix-getcwd.xml
posix-getegid.xml
posix-geteuid.xml
posix-getgid.xml
posix-getgrgid.xml
posix-getgrnam.xml
posix-getgroups.xml
posix-getlogin.xml
posix-getpgid.xml
posix-getpgrp.xml
posix-getpid.xml
posix-getppid.xml
posix-getpwnam.xml
posix-getpwuid.xml
posix-getrlimit.xml
posix-getsid.xml
posix-getuid.xml
posix-isatty.xml
posix-kill.xml
posix-mkfifo.xml
posix-mknod.xml
posix-setegid.xml
posix-seteuid.xml
posix-setgid.xml
posix-setpgid.xml
posix-setsid.xml
posix-setuid.xml
posix-strerror.xml
posix-times.xml
posix-ttyname.xml
posix-uname.xml
Log:
ref.posix: switch to new style
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-access.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-access.xml diff -u phpdoc/en/reference/posix/functions/posix-access.xml:1.1 phpdoc/en/reference/posix/functions/posix-access.xml:1.2 --- phpdoc/en/reference/posix/functions/posix-access.xml:1.1 Sat Jan 8 12:04:26 2005 +++ phpdoc/en/reference/posix/functions/posix-access.xml Sun Feb 4 02:47:57 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.posix-access"> <refnamediv> <refname>posix_access</refname> @@ -14,14 +14,11 @@ <methodparam><type>string</type><parameter>file</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> - <para> <function>posix_access</function> checks the user's permission of a file. </para> - - ¬e.sm.uidcheck; - </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -94,6 +91,11 @@ </para> </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + ¬e.sm.uidcheck; + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-ctermid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-ctermid.xml diff -u phpdoc/en/reference/posix/functions/posix-ctermid.xml:1.4 phpdoc/en/reference/posix/functions/posix-ctermid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-ctermid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-ctermid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-ctermid"> <refnamediv> <refname>posix_ctermid</refname> <refpurpose>Get path name of controlling terminal</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_ctermid</methodname> <void/> @@ -16,6 +16,7 @@ &warn.undocumented.func; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-get-last-error.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-get-last-error.xml diff -u phpdoc/en/reference/posix/functions/posix-get-last-error.xml:1.3 phpdoc/en/reference/posix/functions/posix-get-last-error.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-get-last-error.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-get-last-error.xml Sun Feb 4 02:47:57 2007 @@ -1,26 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-get-last-error"> <refnamediv> <refname>posix_get_last_error</refname> <refpurpose>Retrieve the error number set by the last posix function that failed</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_get_last_error</methodname> <void /> </methodsynopsis> <para> - Returns the errno (error number) set by the last posix function that - failed. If no errors exist, 0 is returned. If you're wanting the - system error message associated with the errno, use + Retrieve the error number set by the last posix function that failed. + If you're wanting the system error message associated with the errno, use <function>posix_strerror</function>. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>posix_strerror</function>. + Returns the errno (error number) set by the last posix function that + failed. If no errors exist, 0 is returned. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_strerror</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getcwd.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getcwd.xml diff -u phpdoc/en/reference/posix/functions/posix-getcwd.xml:1.7 phpdoc/en/reference/posix/functions/posix-getcwd.xml:1.8 --- phpdoc/en/reference/posix/functions/posix-getcwd.xml:1.7 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getcwd.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.posix-getcwd"> <refnamediv> <refname>posix_getcwd</refname> <refpurpose>Pathname of current directory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_getcwd</methodname> <void/> </methodsynopsis> <para> - <function>posix_getcwd</function> returns the absolute pathname of the - script's current working directory. <function>posix_getcwd</function> - returns &false; on error. + Gets the absolute pathname of the script's current working directory. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the absolute pathname, or &false; on error. + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getegid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getegid.xml diff -u phpdoc/en/reference/posix/functions/posix-getegid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getegid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getegid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getegid.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getegid"> <refnamediv> <refname>posix_getegid</refname> <refpurpose>Return the effective group ID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getegid</methodname> <void/> </methodsynopsis> <para> - Return the numeric effective group ID of the current process. See - also <function>posix_getgrgid</function> for information on how - to convert this into a useable group name. + Return the numeric effective group ID of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the group ID. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_getgrgid</function> for information on how + to convert this into a useable group name</member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-geteuid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-geteuid.xml diff -u phpdoc/en/reference/posix/functions/posix-geteuid.xml:1.3 phpdoc/en/reference/posix/functions/posix-geteuid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-geteuid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-geteuid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-geteuid"> <refnamediv> <refname>posix_geteuid</refname> <refpurpose>Return the effective user ID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_geteuid</methodname> <void/> @@ -18,6 +18,13 @@ to convert this into a useable username. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getgid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getgid.xml diff -u phpdoc/en/reference/posix/functions/posix-getgid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getgid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getgid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getgid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getgid"> <refnamediv> <refname>posix_getgid</refname> <refpurpose>Return the real group ID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getgid</methodname> <void/> @@ -18,6 +18,13 @@ convert this into a useable group name. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getgrgid.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getgrgid.xml diff -u phpdoc/en/reference/posix/functions/posix-getgrgid.xml:1.6 phpdoc/en/reference/posix/functions/posix-getgrgid.xml:1.7 --- phpdoc/en/reference/posix/functions/posix-getgrgid.xml:1.6 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getgrgid.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,76 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.posix-getgrgid"> <refnamediv> <refname>posix_getgrgid</refname> <refpurpose>Return info about a group by group id</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getgrgid</methodname> <methodparam><type>int</type><parameter>gid</parameter></methodparam> </methodsynopsis> <para> + Gets information about a group provided its id. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>gid</parameter></term> + <listitem> + <para> + The group id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns an <type>array</type> of information about a group and &false; on failure. If <parameter>gid</parameter> isn't a number then &null; is returned and an <constant>E_WARNING</constant> level error is generated. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.2.0</entry> + <entry> + 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. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Example use of <function>posix_getgrgid</function></title> @@ -33,9 +86,7 @@ ?> ]]> </programlisting> - <para> - An example output: - </para> + &example.outputs.similar; <screen> <![CDATA[ Array @@ -53,21 +104,20 @@ </screen> </example> </para> - <note> - <para> - As of PHP 4.2.0, members is returned as an array of member - usernames in the group. Before this time it was simply an - integer (the number of members in the group) and the member - names were returned with numerical indices. - </para> - </note> - <para> - See also <function>posix_getegid</function>, - <function>filegroup</function>, - <function>stat</function>, and - <link linkend="ini.safe-mode-gid">safe_mode_gid</link>. + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_getegid</function></member> + <member><function>filegroup</function></member> + <member><function>stat</function></member> + <member><link linkend="ini.safe-mode-gid">safe_mode_gid</link></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getgrnam.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getgrnam.xml diff -u phpdoc/en/reference/posix/functions/posix-getgrnam.xml:1.4 phpdoc/en/reference/posix/functions/posix-getgrnam.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-getgrnam.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getgrnam.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-getgrnam"> <refnamediv> <refname>posix_getgrnam</refname> <refpurpose>Return info about a group by name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getgrnam</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> @@ -16,6 +16,22 @@ &warn.undocumented.func; </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getgroups.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getgroups.xml diff -u phpdoc/en/reference/posix/functions/posix-getgroups.xml:1.3 phpdoc/en/reference/posix/functions/posix-getgroups.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getgroups.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getgroups.xml Sun Feb 4 02:47:57 2007 @@ -1,24 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getgroups"> <refnamediv> <refname>posix_getgroups</refname> <refpurpose>Return the group set of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getgroups</methodname> <void/> </methodsynopsis> <para> - Returns an array of integers containing the numeric group ids of - the group set of the current process. See also - <function>posix_getgrgid</function> for information on how to - convert this into useable group names. + Gets the group set of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of integers containing the numeric group ids of the group + set of the current process. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_getgrgid</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getlogin.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getlogin.xml diff -u phpdoc/en/reference/posix/functions/posix-getlogin.xml:1.3 phpdoc/en/reference/posix/functions/posix-getlogin.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getlogin.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getlogin.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getlogin"> <refnamediv> <refname>posix_getlogin</refname> <refpurpose>Return login name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_getlogin</methodname> <void/> </methodsynopsis> <para> Returns the login name of the user owning the current process. - See <function>posix_getpwnam</function> for information how to - get more information about this user. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the login name of the user, as a string. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_getpwnam</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpgid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpgid.xml diff -u phpdoc/en/reference/posix/functions/posix-getpgid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getpgid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getpgid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpgid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getpgid"> <refnamediv> <refname>posix_getpgid</refname> <refpurpose>Get process group id for job control</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getpgid</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> @@ -16,12 +16,42 @@ Returns the process group identifier of the process <parameter>pid</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - 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;. + <variablelist> + <varlistentry> + <term><parameter>pid</parameter></term> + <listitem> + <para> + The process id. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + 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;. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpgrp.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpgrp.xml diff -u phpdoc/en/reference/posix/functions/posix-getpgrp.xml:1.3 phpdoc/en/reference/posix/functions/posix-getpgrp.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getpgrp.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpgrp.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getpgrp"> <refnamediv> <refname>posix_getpgrp</refname> <refpurpose>Return the current process group identifier</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getpgrp</methodname> <void/> </methodsynopsis> <para> - Return the process group identifier of the current process. See - POSIX.1 and the getpgrp(2) manual page on your POSIX system for - more information on process groups. + Return the process group identifier of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member>POSIX.1 and the getpgrp(2) manual page on your POSIX system for + more information on process groups.</member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpid.xml diff -u phpdoc/en/reference/posix/functions/posix-getpid.xml:1.4 phpdoc/en/reference/posix/functions/posix-getpid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-getpid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-getpid"> <refnamediv> <refname>posix_getpid</refname> <refpurpose>Return the current process identifier</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getpid</methodname> <void/> @@ -16,6 +16,13 @@ Return the process identifier of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getppid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getppid.xml diff -u phpdoc/en/reference/posix/functions/posix-getppid.xml:1.4 phpdoc/en/reference/posix/functions/posix-getppid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-getppid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getppid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-getppid"> <refnamediv> <refname>posix_getppid</refname> <refpurpose>Return the parent process identifier</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getppid</methodname> <void/> @@ -17,6 +17,13 @@ current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpwnam.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpwnam.xml diff -u phpdoc/en/reference/posix/functions/posix-getpwnam.xml:1.3 phpdoc/en/reference/posix/functions/posix-getpwnam.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getpwnam.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpwnam.xml Sun Feb 4 02:47:57 2007 @@ -1,22 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getpwnam"> <refnamediv> <refname>posix_getpwnam</refname> <refpurpose>Return info about a user by username</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getpwnam</methodname> <methodparam><type>string</type><parameter>username</parameter></methodparam> </methodsynopsis> <para> - Returns an associative array containing information about a user - referenced by an alphanumeric username, passed in the - <parameter>username</parameter> parameter. + Returns an 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> The array elements returned are: <table> @@ -92,6 +110,7 @@ </table> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpwuid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpwuid.xml diff -u phpdoc/en/reference/posix/functions/posix-getpwuid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getpwuid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getpwuid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpwuid.xml Sun Feb 4 02:47:57 2007 @@ -1,24 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <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> + + <refsect1 role="description"> + &reftitle.description; <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. + Gets information about the user referenced by the given user ID. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The array elements returned are: + <variablelist> + <varlistentry> + <term><parameter>uid</parameter></term> + <listitem> + <para> + The user identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array with the following elements: <table> <title>The user information array</title> <tgroup cols="2"> @@ -92,6 +110,7 @@ </table> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getrlimit.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getrlimit.xml diff -u phpdoc/en/reference/posix/functions/posix-getrlimit.xml:1.5 phpdoc/en/reference/posix/functions/posix-getrlimit.xml:1.6 --- phpdoc/en/reference/posix/functions/posix-getrlimit.xml:1.5 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getrlimit.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.posix-getrlimit"> <refnamediv> <refname>posix_getrlimit</refname> <refpurpose>Return info about system resource limits</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getrlimit</methodname> <void/> @@ -16,6 +16,7 @@ &warn.undocumented.func; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getsid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getsid.xml diff -u phpdoc/en/reference/posix/functions/posix-getsid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getsid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getsid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getsid.xml Sun Feb 4 02:47:57 2007 @@ -1,28 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getsid"> <refnamediv> <refname>posix_getsid</refname> <refpurpose>Get the current sid of the process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getsid</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> </methodsynopsis> <para> - Return the sid of the process <parameter>pid</parameter>. If - <parameter>pid</parameter> is 0, the sid of the current process - is returned. + Return the sid of the process <parameter>pid</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - 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;. + <variablelist> + <varlistentry> + <term><parameter>pid</parameter></term> + <listitem> + <para> + The process identifier. If set to 0, the current process is assumed. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + 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;. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getuid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getuid.xml diff -u phpdoc/en/reference/posix/functions/posix-getuid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getuid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getuid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getuid.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getuid"> <refnamediv> <refname>posix_getuid</refname> <refpurpose>Return the real user ID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getuid</methodname> <void/> </methodsynopsis> <para> - Return the numeric real user ID of the current process. See also - <function>posix_getpwuid</function> for information on how to - convert this into a useable username. + Return the numeric real user ID of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + <function>posix_getpwuid</function> for information on how to convert + this into a useable username + </member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-isatty.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-isatty.xml diff -u phpdoc/en/reference/posix/functions/posix-isatty.xml:1.4 phpdoc/en/reference/posix/functions/posix-isatty.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-isatty.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-isatty.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-isatty"> <refnamediv> <refname>posix_isatty</refname> <refpurpose>Determine if a file descriptor is an interactive terminal</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_isatty</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> @@ -16,6 +16,7 @@ &warn.undocumented.func; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-kill.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-kill.xml diff -u phpdoc/en/reference/posix/functions/posix-kill.xml:1.3 phpdoc/en/reference/posix/functions/posix-kill.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-kill.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-kill.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-kill"> <refnamediv> <refname>posix_kill</refname> <refpurpose>Send a signal to a process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_kill</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> @@ -15,16 +15,54 @@ </methodsynopsis> <para> Send the signal <parameter>sig</parameter> to the process with - the process identifier <parameter>pid</parameter>. Returns &false;, - if unable to send the signal, &true; otherwise. + the process identifier <parameter>pid</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pid</parameter></term> + <listitem> + <para> + The process identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sig</parameter></term> + <listitem> + <para> + One of the <link linkend="pcntl.constants">PCNTL signals constants</link>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also the kill(2) manual page of your POSIX system, which - contains additional information about negative process - identifiers, the special pid 0, the special pid -1, and the - signal number 0. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + The kill(2) manual page of your POSIX system, which contains additional + information about negative process identifiers, the special pid 0, the + special pid -1, and the signal number 0. + </member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-mkfifo.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-mkfifo.xml diff -u phpdoc/en/reference/posix/functions/posix-mkfifo.xml:1.5 phpdoc/en/reference/posix/functions/posix-mkfifo.xml:1.6 --- phpdoc/en/reference/posix/functions/posix-mkfifo.xml:1.5 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-mkfifo.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.posix-mkfifo"> <refnamediv> <refname>posix_mkfifo</refname> <refpurpose>Create a fifo special file (a named pipe)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_mkfifo</methodname> <methodparam><type>string</type><parameter>pathname</parameter></methodparam> @@ -18,18 +18,48 @@ <literal>FIFO</literal> file which exists in the file system and acts as a bidirectional communication endpoint for processes. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The second parameter <parameter>mode</parameter> has to be given in octal - notation (e.g. 0644). The permission of the newly created - <literal>FIFO</literal> also depends on the setting of the current - <function>umask</function>. The permissions of the created file are (mode - & ~umask). + <variablelist> + <varlistentry> + <term><parameter>pathname</parameter></term> + <listitem> + <para> + Path to the <literal>FIFO</literal> file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The second parameter <parameter>mode</parameter> has to be given in + octal notation (e.g. 0644). The permission of the newly created + <literal>FIFO</literal> also depends on the setting of the current + <function>umask</function>. The permissions of the created file are + (mode & ~umask). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - ¬e.sm.uidcheck.dir; </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + ¬e.sm.uidcheck; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-mknod.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-mknod.xml diff -u phpdoc/en/reference/posix/functions/posix-mknod.xml:1.2 phpdoc/en/reference/posix/functions/posix-mknod.xml:1.3 --- phpdoc/en/reference/posix/functions/posix-mknod.xml:1.2 Wed Nov 2 15:49:11 2005 +++ phpdoc/en/reference/posix/functions/posix-mknod.xml Sun Feb 4 02:47:57 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.posix-mknod"> <refnamediv> <refname>posix_mknod</refname> @@ -17,7 +17,7 @@ <methodparam choice="opt"><type>int</type><parameter>minor</parameter></methodparam> </methodsynopsis> <para> - <function>posix_mknod</function> creates a special or ordinary file. + Creates a special or ordinary file. </para> </refsect1> @@ -107,6 +107,7 @@ </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setegid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setegid.xml diff -u phpdoc/en/reference/posix/functions/posix-setegid.xml:1.4 phpdoc/en/reference/posix/functions/posix-setegid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-setegid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setegid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-setegid"> <refnamediv> <refname>posix_setegid</refname> <refpurpose>Set the effective GID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_setegid</methodname> <methodparam><type>int</type><parameter>gid</parameter></methodparam> @@ -17,6 +17,26 @@ privileged function and you need appropriate privileges (usually root) on your system to be able to perform this function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>gid</parameter></term> + <listitem> + <para> + The group id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-seteuid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-seteuid.xml diff -u phpdoc/en/reference/posix/functions/posix-seteuid.xml:1.4 phpdoc/en/reference/posix/functions/posix-seteuid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-seteuid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-seteuid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-seteuid"> <refnamediv> <refname>posix_seteuid</refname> <refpurpose>Set the effective UID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_seteuid</methodname> <methodparam><type>int</type><parameter>uid</parameter></methodparam> @@ -17,14 +17,40 @@ function and you need appropriate privileges (usually root) on your system to be able to perform this function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>uid</parameter></term> + <listitem> + <para> + The user id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>posix_setgid</function>. + <simplelist> + <member><function>posix_setgid</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setgid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setgid.xml diff -u phpdoc/en/reference/posix/functions/posix-setgid.xml:1.4 phpdoc/en/reference/posix/functions/posix-setgid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-setgid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setgid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.18 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-setgid"> <refnamediv> <refname>posix_setgid</refname> <refpurpose>Set the GID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_setgid</methodname> <methodparam><type>int</type><parameter>gid</parameter></methodparam> @@ -20,10 +20,31 @@ <function>posix_setgid</function> first, <function>posix_setuid</function> last. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>gid</parameter></term> + <listitem> + <para> + The group id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setpgid.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setpgid.xml diff -u phpdoc/en/reference/posix/functions/posix-setpgid.xml:1.6 phpdoc/en/reference/posix/functions/posix-setpgid.xml:1.7 --- phpdoc/en/reference/posix/functions/posix-setpgid.xml:1.6 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setpgid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.posix-setpgid"> <refnamediv> <refname>posix_setpgid</refname> <refpurpose>Set process group id for job control</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_setpgid</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> @@ -15,11 +15,53 @@ </methodsynopsis> <para> Let the process <parameter>pid</parameter> join the process group - <parameter>pgid</parameter>. See POSIX.1 and the setsid(2) manual - page on your POSIX system for more informations on process groups - and job control. &return.success; + <parameter>pgid</parameter>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pid</parameter></term> + <listitem> + <para> + The process id. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pgid</parameter></term> + <listitem> + <para> + The process group id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + See POSIX.1 and the setsid(2) manual page on your POSIX system for more + informations on process groups and job control. + </member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setsid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setsid.xml diff -u phpdoc/en/reference/posix/functions/posix-setsid.xml:1.4 phpdoc/en/reference/posix/functions/posix-setsid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-setsid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setsid.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-setsid"> <refnamediv> <refname>posix_setsid</refname> <refpurpose>Make the current process a session leader</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_setsid</methodname> <void/> </methodsynopsis> <para> - Make the current process a session leader. See POSIX.1 and the - setsid(2) manual page on your POSIX system for more information - on process groups and job control. Returns the session id. + Make the current process a session leader. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the session id, or -1 on errors. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + The POSIX.1 and the setsid(2) manual page on your POSIX system for more + information on process groups and job control. Returns the session id. + </member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setuid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setuid.xml diff -u phpdoc/en/reference/posix/functions/posix-setuid.xml:1.4 phpdoc/en/reference/posix/functions/posix-setuid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-setuid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setuid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.18 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-setuid"> <refnamediv> <refname>posix_setuid</refname> <refpurpose>Set the UID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_setuid</methodname> <methodparam><type>int</type><parameter>uid</parameter></methodparam> @@ -17,14 +17,40 @@ function and you need appropriate privileges (usually root) on your system to be able to perform this function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>uid</parameter></term> + <listitem> + <para> + The user id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>posix_setgid</function>. + <simplelist> + <member><function>posix_setgid</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-strerror.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-strerror.xml diff -u phpdoc/en/reference/posix/functions/posix-strerror.xml:1.4 phpdoc/en/reference/posix/functions/posix-strerror.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-strerror.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-strerror.xml Sun Feb 4 02:47:57 2007 @@ -1,26 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-strerror"> <refnamediv> <refname>posix_strerror</refname> <refpurpose>Retrieve the system error message associated with the given errno</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_strerror</methodname> <methodparam><type>int</type><parameter>errno</parameter></methodparam> </methodsynopsis> <para> - Returns the POSIX system error message associated with the given errno. - If <parameter>errno</parameter> is 0, then the string "Success" is - returned. The function <function>posix_get_last_error</function> is - used for retrieving the last POSIX errno. + Returns the POSIX system error message associated with the given + <parameter>errno</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>errno</parameter></term> + <listitem> + <para> + A POSIX error number, returned by + <function>posix_get_last_error</function>. If set to 0, then the + string "Success" is returned. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>posix_get_last_error</function>. + Returns the error message, as a string. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_get_last_error</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-times.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-times.xml diff -u phpdoc/en/reference/posix/functions/posix-times.xml:1.4 phpdoc/en/reference/posix/functions/posix-times.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-times.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-times.xml Sun Feb 4 02:47:57 2007 @@ -1,39 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-times"> <refnamediv> <refname>posix_times</refname> <refpurpose>Get process times</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_times</methodname> <void/> </methodsynopsis> <para> + Gets information about the current CPU usage. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns a hash of strings with information about the current - process CPU usage. The indices of the hash are + process CPU usage. The indices of the hash are: <itemizedlist> - <listitem><simpara> + <listitem> + <simpara> ticks - the number of clock ticks that have elapsed since reboot. - </simpara></listitem> - <listitem><simpara> + </simpara> + </listitem> + <listitem> + <simpara> utime - user time used by the current process. - </simpara></listitem> - <listitem><simpara> + </simpara> + </listitem> + <listitem> + <simpara> stime - system time used by the current process. - </simpara></listitem> - <listitem><simpara> + </simpara> + </listitem> + <listitem> + <simpara> cutime - user time used by current process and children. - </simpara></listitem> - <listitem><simpara> + </simpara> + </listitem> + <listitem> + <simpara> cstime - system time used by current process and children. - </simpara></listitem> + </simpara> + </listitem> </itemizedlist> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <warning> <para> This function isn't reliable to use, it may return negative values for @@ -41,6 +62,7 @@ </para> </warning> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-ttyname.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-ttyname.xml diff -u phpdoc/en/reference/posix/functions/posix-ttyname.xml:1.4 phpdoc/en/reference/posix/functions/posix-ttyname.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-ttyname.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-ttyname.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-ttyname"> <refnamediv> <refname>posix_ttyname</refname> <refpurpose>Determine terminal device name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_ttyname</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> @@ -16,6 +16,7 @@ &warn.undocumented.func; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-uname.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-uname.xml diff -u phpdoc/en/reference/posix/functions/posix-uname.xml:1.4 phpdoc/en/reference/posix/functions/posix-uname.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-uname.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-uname.xml Sun Feb 4 02:47:57 2007 @@ -1,18 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-uname"> <refnamediv> <refname>posix_uname</refname> <refpurpose>Get system name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_uname</methodname> <void/> </methodsynopsis> <para> + Gets information about the system. + </para> + <para> + Posix requires that you must not make any assumptions about the + format of the values, e.g. you cannot rely on three digit version + numbers or anything else returned by this function. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns a hash of strings with information about the system. The indices of the hash are <itemizedlist> @@ -42,12 +54,8 @@ field is only available on GNU systems or when using the GNU libc. </para> - <para> - Posix requires that you must not make any assumptions about the - format of the values, e.g. you cannot rely on three digit version - numbers or anything else returned by this function. - </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file
http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-access.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-access.xml diff -u phpdoc/en/reference/posix/functions/posix-access.xml:1.1 phpdoc/en/reference/posix/functions/posix-access.xml:1.2 --- phpdoc/en/reference/posix/functions/posix-access.xml:1.1 Sat Jan 8 12:04:26 2005 +++ phpdoc/en/reference/posix/functions/posix-access.xml Sun Feb 4 02:47:57 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.1 $ --> +<!-- $Revision: 1.2 $ --> <refentry id="function.posix-access"> <refnamediv> <refname>posix_access</refname> @@ -14,14 +14,11 @@ <methodparam><type>string</type><parameter>file</parameter></methodparam> <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> </methodsynopsis> - <para> <function>posix_access</function> checks the user's permission of a file. </para> - - ¬e.sm.uidcheck; - </refsect1> + <refsect1 role="parameters"> &reftitle.parameters; <para> @@ -94,6 +91,11 @@ </para> </refsect1> + <refsect1 role="notes"> + &reftitle.notes; + ¬e.sm.uidcheck; + </refsect1> + <refsect1 role="seealso"> &reftitle.seealso; <para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-ctermid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-ctermid.xml diff -u phpdoc/en/reference/posix/functions/posix-ctermid.xml:1.4 phpdoc/en/reference/posix/functions/posix-ctermid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-ctermid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-ctermid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-ctermid"> <refnamediv> <refname>posix_ctermid</refname> <refpurpose>Get path name of controlling terminal</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_ctermid</methodname> <void/> @@ -16,6 +16,7 @@ &warn.undocumented.func; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-get-last-error.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-get-last-error.xml diff -u phpdoc/en/reference/posix/functions/posix-get-last-error.xml:1.3 phpdoc/en/reference/posix/functions/posix-get-last-error.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-get-last-error.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-get-last-error.xml Sun Feb 4 02:47:57 2007 @@ -1,26 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-get-last-error"> <refnamediv> <refname>posix_get_last_error</refname> <refpurpose>Retrieve the error number set by the last posix function that failed</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_get_last_error</methodname> <void /> </methodsynopsis> <para> - Returns the errno (error number) set by the last posix function that - failed. If no errors exist, 0 is returned. If you're wanting the - system error message associated with the errno, use + Retrieve the error number set by the last posix function that failed. + If you're wanting the system error message associated with the errno, use <function>posix_strerror</function>. </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>posix_strerror</function>. + Returns the errno (error number) set by the last posix function that + failed. If no errors exist, 0 is returned. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_strerror</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getcwd.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getcwd.xml diff -u phpdoc/en/reference/posix/functions/posix-getcwd.xml:1.7 phpdoc/en/reference/posix/functions/posix-getcwd.xml:1.8 --- phpdoc/en/reference/posix/functions/posix-getcwd.xml:1.7 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getcwd.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.8 $ --> <refentry id="function.posix-getcwd"> <refnamediv> <refname>posix_getcwd</refname> <refpurpose>Pathname of current directory</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_getcwd</methodname> <void/> </methodsynopsis> <para> - <function>posix_getcwd</function> returns the absolute pathname of the - script's current working directory. <function>posix_getcwd</function> - returns &false; on error. + Gets the absolute pathname of the script's current working directory. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the absolute pathname, or &false; on error. + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getegid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getegid.xml diff -u phpdoc/en/reference/posix/functions/posix-getegid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getegid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getegid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getegid.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getegid"> <refnamediv> <refname>posix_getegid</refname> <refpurpose>Return the effective group ID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getegid</methodname> <void/> </methodsynopsis> <para> - Return the numeric effective group ID of the current process. See - also <function>posix_getgrgid</function> for information on how - to convert this into a useable group name. + Return the numeric effective group ID of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the group ID. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_getgrgid</function> for information on how + to convert this into a useable group name</member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-geteuid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-geteuid.xml diff -u phpdoc/en/reference/posix/functions/posix-geteuid.xml:1.3 phpdoc/en/reference/posix/functions/posix-geteuid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-geteuid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-geteuid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-geteuid"> <refnamediv> <refname>posix_geteuid</refname> <refpurpose>Return the effective user ID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_geteuid</methodname> <void/> @@ -18,6 +18,13 @@ to convert this into a useable username. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getgid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getgid.xml diff -u phpdoc/en/reference/posix/functions/posix-getgid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getgid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getgid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getgid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getgid"> <refnamediv> <refname>posix_getgid</refname> <refpurpose>Return the real group ID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getgid</methodname> <void/> @@ -18,6 +18,13 @@ convert this into a useable group name. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getgrgid.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getgrgid.xml diff -u phpdoc/en/reference/posix/functions/posix-getgrgid.xml:1.6 phpdoc/en/reference/posix/functions/posix-getgrgid.xml:1.7 --- phpdoc/en/reference/posix/functions/posix-getgrgid.xml:1.6 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getgrgid.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,76 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.posix-getgrgid"> <refnamediv> <refname>posix_getgrgid</refname> <refpurpose>Return info about a group by group id</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getgrgid</methodname> <methodparam><type>int</type><parameter>gid</parameter></methodparam> </methodsynopsis> <para> + Gets information about a group provided its id. + </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>gid</parameter></term> + <listitem> + <para> + The group id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns an <type>array</type> of information about a group and &false; on failure. If <parameter>gid</parameter> isn't a number then &null; is returned and an <constant>E_WARNING</constant> level error is generated. </para> + </refsect1> + + <refsect1 role="changelog"> + &reftitle.changelog; + <para> + <informaltable> + <tgroup cols="2"> + <thead> + <row> + <entry>&Version;</entry> + <entry>&Description;</entry> + </row> + </thead> + <tbody> + <row> + <entry>4.2.0</entry> + <entry> + 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. + </entry> + </row> + </tbody> + </tgroup> + </informaltable> + </para> + </refsect1> + + <refsect1 role="examples"> + &reftitle.examples; <para> <example> <title>Example use of <function>posix_getgrgid</function></title> @@ -33,9 +86,7 @@ ?> ]]> </programlisting> - <para> - An example output: - </para> + &example.outputs.similar; <screen> <![CDATA[ Array @@ -53,21 +104,20 @@ </screen> </example> </para> - <note> - <para> - As of PHP 4.2.0, members is returned as an array of member - usernames in the group. Before this time it was simply an - integer (the number of members in the group) and the member - names were returned with numerical indices. - </para> - </note> - <para> - See also <function>posix_getegid</function>, - <function>filegroup</function>, - <function>stat</function>, and - <link linkend="ini.safe-mode-gid">safe_mode_gid</link>. + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_getegid</function></member> + <member><function>filegroup</function></member> + <member><function>stat</function></member> + <member><link linkend="ini.safe-mode-gid">safe_mode_gid</link></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getgrnam.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getgrnam.xml diff -u phpdoc/en/reference/posix/functions/posix-getgrnam.xml:1.4 phpdoc/en/reference/posix/functions/posix-getgrnam.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-getgrnam.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getgrnam.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-getgrnam"> <refnamediv> <refname>posix_getgrnam</refname> <refpurpose>Return info about a group by name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getgrnam</methodname> <methodparam><type>string</type><parameter>name</parameter></methodparam> @@ -16,6 +16,22 @@ &warn.undocumented.func; </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>name</parameter></term> + <listitem> + <para> + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getgroups.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getgroups.xml diff -u phpdoc/en/reference/posix/functions/posix-getgroups.xml:1.3 phpdoc/en/reference/posix/functions/posix-getgroups.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getgroups.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getgroups.xml Sun Feb 4 02:47:57 2007 @@ -1,24 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getgroups"> <refnamediv> <refname>posix_getgroups</refname> <refpurpose>Return the group set of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getgroups</methodname> <void/> </methodsynopsis> <para> - Returns an array of integers containing the numeric group ids of - the group set of the current process. See also - <function>posix_getgrgid</function> for information on how to - convert this into useable group names. + Gets the group set of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an array of integers containing the numeric group ids of the group + set of the current process. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_getgrgid</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getlogin.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getlogin.xml diff -u phpdoc/en/reference/posix/functions/posix-getlogin.xml:1.3 phpdoc/en/reference/posix/functions/posix-getlogin.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getlogin.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getlogin.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,38 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getlogin"> <refnamediv> <refname>posix_getlogin</refname> <refpurpose>Return login name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_getlogin</methodname> <void/> </methodsynopsis> <para> Returns the login name of the user owning the current process. - See <function>posix_getpwnam</function> for information how to - get more information about this user. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the login name of the user, as a string. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_getpwnam</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpgid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpgid.xml diff -u phpdoc/en/reference/posix/functions/posix-getpgid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getpgid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getpgid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpgid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getpgid"> <refnamediv> <refname>posix_getpgid</refname> <refpurpose>Get process group id for job control</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getpgid</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> @@ -16,12 +16,42 @@ Returns the process group identifier of the process <parameter>pid</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - 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;. + <variablelist> + <varlistentry> + <term><parameter>pid</parameter></term> + <listitem> + <para> + The process id. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + 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;. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpgrp.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpgrp.xml diff -u phpdoc/en/reference/posix/functions/posix-getpgrp.xml:1.3 phpdoc/en/reference/posix/functions/posix-getpgrp.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getpgrp.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpgrp.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getpgrp"> <refnamediv> <refname>posix_getpgrp</refname> <refpurpose>Return the current process group identifier</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getpgrp</methodname> <void/> </methodsynopsis> <para> - Return the process group identifier of the current process. See - POSIX.1 and the getpgrp(2) manual page on your POSIX system for - more information on process groups. + Return the process group identifier of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member>POSIX.1 and the getpgrp(2) manual page on your POSIX system for + more information on process groups.</member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpid.xml diff -u phpdoc/en/reference/posix/functions/posix-getpid.xml:1.4 phpdoc/en/reference/posix/functions/posix-getpid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-getpid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-getpid"> <refnamediv> <refname>posix_getpid</refname> <refpurpose>Return the current process identifier</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getpid</methodname> <void/> @@ -16,6 +16,13 @@ Return the process identifier of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getppid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getppid.xml diff -u phpdoc/en/reference/posix/functions/posix-getppid.xml:1.4 phpdoc/en/reference/posix/functions/posix-getppid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-getppid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getppid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-getppid"> <refnamediv> <refname>posix_getppid</refname> <refpurpose>Return the parent process identifier</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getppid</methodname> <void/> @@ -17,6 +17,13 @@ current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpwnam.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpwnam.xml diff -u phpdoc/en/reference/posix/functions/posix-getpwnam.xml:1.3 phpdoc/en/reference/posix/functions/posix-getpwnam.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getpwnam.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpwnam.xml Sun Feb 4 02:47:57 2007 @@ -1,22 +1,40 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getpwnam"> <refnamediv> <refname>posix_getpwnam</refname> <refpurpose>Return info about a user by username</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getpwnam</methodname> <methodparam><type>string</type><parameter>username</parameter></methodparam> </methodsynopsis> <para> - Returns an associative array containing information about a user - referenced by an alphanumeric username, passed in the - <parameter>username</parameter> parameter. + Returns an 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> The array elements returned are: <table> @@ -92,6 +110,7 @@ </table> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getpwuid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getpwuid.xml diff -u phpdoc/en/reference/posix/functions/posix-getpwuid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getpwuid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getpwuid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getpwuid.xml Sun Feb 4 02:47:57 2007 @@ -1,24 +1,42 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <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> + + <refsect1 role="description"> + &reftitle.description; <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. + Gets information about the user referenced by the given user ID. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The array elements returned are: + <variablelist> + <varlistentry> + <term><parameter>uid</parameter></term> + <listitem> + <para> + The user identifier. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns an associative array with the following elements: <table> <title>The user information array</title> <tgroup cols="2"> @@ -92,6 +110,7 @@ </table> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getrlimit.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getrlimit.xml diff -u phpdoc/en/reference/posix/functions/posix-getrlimit.xml:1.5 phpdoc/en/reference/posix/functions/posix-getrlimit.xml:1.6 --- phpdoc/en/reference/posix/functions/posix-getrlimit.xml:1.5 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getrlimit.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.posix-getrlimit"> <refnamediv> <refname>posix_getrlimit</refname> <refpurpose>Return info about system resource limits</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_getrlimit</methodname> <void/> @@ -16,6 +16,7 @@ &warn.undocumented.func; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getsid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getsid.xml diff -u phpdoc/en/reference/posix/functions/posix-getsid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getsid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getsid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getsid.xml Sun Feb 4 02:47:57 2007 @@ -1,28 +1,56 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getsid"> <refnamediv> <refname>posix_getsid</refname> <refpurpose>Get the current sid of the process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getsid</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> </methodsynopsis> <para> - Return the sid of the process <parameter>pid</parameter>. If - <parameter>pid</parameter> is 0, the sid of the current process - is returned. + Return the sid of the process <parameter>pid</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - 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;. + <variablelist> + <varlistentry> + <term><parameter>pid</parameter></term> + <listitem> + <para> + The process identifier. If set to 0, the current process is assumed. + </para> + </listitem> + </varlistentry> + </variablelist> </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + <note> + <para> + 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;. + </para> + </note> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-getuid.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-getuid.xml diff -u phpdoc/en/reference/posix/functions/posix-getuid.xml:1.3 phpdoc/en/reference/posix/functions/posix-getuid.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-getuid.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-getuid.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-getuid"> <refnamediv> <refname>posix_getuid</refname> <refpurpose>Return the real user ID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_getuid</methodname> <void/> </methodsynopsis> <para> - Return the numeric real user ID of the current process. See also - <function>posix_getpwuid</function> for information on how to - convert this into a useable username. + Return the numeric real user ID of the current process. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the identifier, as an integer. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + <function>posix_getpwuid</function> for information on how to convert + this into a useable username + </member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-isatty.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-isatty.xml diff -u phpdoc/en/reference/posix/functions/posix-isatty.xml:1.4 phpdoc/en/reference/posix/functions/posix-isatty.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-isatty.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-isatty.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-isatty"> <refnamediv> <refname>posix_isatty</refname> <refpurpose>Determine if a file descriptor is an interactive terminal</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_isatty</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> @@ -16,6 +16,7 @@ &warn.undocumented.func; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-kill.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-kill.xml diff -u phpdoc/en/reference/posix/functions/posix-kill.xml:1.3 phpdoc/en/reference/posix/functions/posix-kill.xml:1.4 --- phpdoc/en/reference/posix/functions/posix-kill.xml:1.3 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-kill.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.4 $ --> <refentry id="function.posix-kill"> <refnamediv> <refname>posix_kill</refname> <refpurpose>Send a signal to a process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_kill</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> @@ -15,16 +15,54 @@ </methodsynopsis> <para> Send the signal <parameter>sig</parameter> to the process with - the process identifier <parameter>pid</parameter>. Returns &false;, - if unable to send the signal, &true; otherwise. + the process identifier <parameter>pid</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pid</parameter></term> + <listitem> + <para> + The process identifier. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>sig</parameter></term> + <listitem> + <para> + One of the <link linkend="pcntl.constants">PCNTL signals constants</link>. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also the kill(2) manual page of your POSIX system, which - contains additional information about negative process - identifiers, the special pid 0, the special pid -1, and the - signal number 0. + &return.success; </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + The kill(2) manual page of your POSIX system, which contains additional + information about negative process identifiers, the special pid 0, the + special pid -1, and the signal number 0. + </member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-mkfifo.xml?r1=1.5&r2=1.6&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-mkfifo.xml diff -u phpdoc/en/reference/posix/functions/posix-mkfifo.xml:1.5 phpdoc/en/reference/posix/functions/posix-mkfifo.xml:1.6 --- phpdoc/en/reference/posix/functions/posix-mkfifo.xml:1.5 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-mkfifo.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.5 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.6 $ --> <refentry id="function.posix-mkfifo"> <refnamediv> <refname>posix_mkfifo</refname> <refpurpose>Create a fifo special file (a named pipe)</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_mkfifo</methodname> <methodparam><type>string</type><parameter>pathname</parameter></methodparam> @@ -18,18 +18,48 @@ <literal>FIFO</literal> file which exists in the file system and acts as a bidirectional communication endpoint for processes. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The second parameter <parameter>mode</parameter> has to be given in octal - notation (e.g. 0644). The permission of the newly created - <literal>FIFO</literal> also depends on the setting of the current - <function>umask</function>. The permissions of the created file are (mode - & ~umask). + <variablelist> + <varlistentry> + <term><parameter>pathname</parameter></term> + <listitem> + <para> + Path to the <literal>FIFO</literal> file. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>mode</parameter></term> + <listitem> + <para> + The second parameter <parameter>mode</parameter> has to be given in + octal notation (e.g. 0644). The permission of the newly created + <literal>FIFO</literal> also depends on the setting of the current + <function>umask</function>. The permissions of the created file are + (mode & ~umask). + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> - ¬e.sm.uidcheck.dir; </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; + ¬e.sm.uidcheck; + </refsect1> + </refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-mknod.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-mknod.xml diff -u phpdoc/en/reference/posix/functions/posix-mknod.xml:1.2 phpdoc/en/reference/posix/functions/posix-mknod.xml:1.3 --- phpdoc/en/reference/posix/functions/posix-mknod.xml:1.2 Wed Nov 2 15:49:11 2005 +++ phpdoc/en/reference/posix/functions/posix-mknod.xml Sun Feb 4 02:47:57 2007 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id="function.posix-mknod"> <refnamediv> <refname>posix_mknod</refname> @@ -17,7 +17,7 @@ <methodparam choice="opt"><type>int</type><parameter>minor</parameter></methodparam> </methodsynopsis> <para> - <function>posix_mknod</function> creates a special or ordinary file. + Creates a special or ordinary file. </para> </refsect1> @@ -107,6 +107,7 @@ </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setegid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setegid.xml diff -u phpdoc/en/reference/posix/functions/posix-setegid.xml:1.4 phpdoc/en/reference/posix/functions/posix-setegid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-setegid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setegid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-setegid"> <refnamediv> <refname>posix_setegid</refname> <refpurpose>Set the effective GID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_setegid</methodname> <methodparam><type>int</type><parameter>gid</parameter></methodparam> @@ -17,6 +17,26 @@ privileged function and you need appropriate privileges (usually root) on your system to be able to perform this function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>gid</parameter></term> + <listitem> + <para> + The group id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-seteuid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-seteuid.xml diff -u phpdoc/en/reference/posix/functions/posix-seteuid.xml:1.4 phpdoc/en/reference/posix/functions/posix-seteuid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-seteuid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-seteuid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-seteuid"> <refnamediv> <refname>posix_seteuid</refname> <refpurpose>Set the effective UID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_seteuid</methodname> <methodparam><type>int</type><parameter>uid</parameter></methodparam> @@ -17,14 +17,40 @@ function and you need appropriate privileges (usually root) on your system to be able to perform this function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>uid</parameter></term> + <listitem> + <para> + The user id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>posix_setgid</function>. + <simplelist> + <member><function>posix_setgid</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setgid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setgid.xml diff -u phpdoc/en/reference/posix/functions/posix-setgid.xml:1.4 phpdoc/en/reference/posix/functions/posix-setgid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-setgid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setgid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.18 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-setgid"> <refnamediv> <refname>posix_setgid</refname> <refpurpose>Set the GID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_setgid</methodname> <methodparam><type>int</type><parameter>gid</parameter></methodparam> @@ -20,10 +20,31 @@ <function>posix_setgid</function> first, <function>posix_setuid</function> last. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>gid</parameter></term> + <listitem> + <para> + The group id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setpgid.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setpgid.xml diff -u phpdoc/en/reference/posix/functions/posix-setpgid.xml:1.6 phpdoc/en/reference/posix/functions/posix-setpgid.xml:1.7 --- phpdoc/en/reference/posix/functions/posix-setpgid.xml:1.6 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setpgid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.7 $ --> <refentry id="function.posix-setpgid"> <refnamediv> <refname>posix_setpgid</refname> <refpurpose>Set process group id for job control</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_setpgid</methodname> <methodparam><type>int</type><parameter>pid</parameter></methodparam> @@ -15,11 +15,53 @@ </methodsynopsis> <para> Let the process <parameter>pid</parameter> join the process group - <parameter>pgid</parameter>. See POSIX.1 and the setsid(2) manual - page on your POSIX system for more informations on process groups - and job control. &return.success; + <parameter>pgid</parameter>. </para> </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>pid</parameter></term> + <listitem> + <para> + The process id. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>pgid</parameter></term> + <listitem> + <para> + The process group id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + See POSIX.1 and the setsid(2) manual page on your POSIX system for more + informations on process groups and job control. + </member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setsid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setsid.xml diff -u phpdoc/en/reference/posix/functions/posix-setsid.xml:1.4 phpdoc/en/reference/posix/functions/posix-setsid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-setsid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setsid.xml Sun Feb 4 02:47:57 2007 @@ -1,23 +1,41 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-setsid"> <refnamediv> <refname>posix_setsid</refname> <refpurpose>Make the current process a session leader</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>int</type><methodname>posix_setsid</methodname> <void/> </methodsynopsis> <para> - Make the current process a session leader. See POSIX.1 and the - setsid(2) manual page on your POSIX system for more information - on process groups and job control. Returns the session id. + Make the current process a session leader. </para> </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the session id, or -1 on errors. + </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member> + The POSIX.1 and the setsid(2) manual page on your POSIX system for more + information on process groups and job control. Returns the session id. + </member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-setuid.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-setuid.xml diff -u phpdoc/en/reference/posix/functions/posix-setuid.xml:1.4 phpdoc/en/reference/posix/functions/posix-setuid.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-setuid.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-setuid.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.18 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-setuid"> <refnamediv> <refname>posix_setuid</refname> <refpurpose>Set the UID of the current process</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>posix_setuid</methodname> <methodparam><type>int</type><parameter>uid</parameter></methodparam> @@ -17,14 +17,40 @@ function and you need appropriate privileges (usually root) on your system to be able to perform this function. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>uid</parameter></term> + <listitem> + <para> + The user id. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> &return.success; </para> + </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>posix_setgid</function>. + <simplelist> + <member><function>posix_setgid</function></member> + </simplelist> </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-strerror.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-strerror.xml diff -u phpdoc/en/reference/posix/functions/posix-strerror.xml:1.4 phpdoc/en/reference/posix/functions/posix-strerror.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-strerror.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-strerror.xml Sun Feb 4 02:47:57 2007 @@ -1,26 +1,57 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-strerror"> <refnamediv> <refname>posix_strerror</refname> <refpurpose>Retrieve the system error message associated with the given errno</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_strerror</methodname> <methodparam><type>int</type><parameter>errno</parameter></methodparam> </methodsynopsis> <para> - Returns the POSIX system error message associated with the given errno. - If <parameter>errno</parameter> is 0, then the string "Success" is - returned. The function <function>posix_get_last_error</function> is - used for retrieving the last POSIX errno. + Returns the POSIX system error message associated with the given + <parameter>errno</parameter>. </para> + </refsect1> + + <refsect1 role="parameters"> + &reftitle.parameters; + <para> + <variablelist> + <varlistentry> + <term><parameter>errno</parameter></term> + <listitem> + <para> + A POSIX error number, returned by + <function>posix_get_last_error</function>. If set to 0, then the + string "Success" is returned. + </para> + </listitem> + </varlistentry> + </variablelist> + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - See also <function>posix_get_last_error</function>. + Returns the error message, as a string. </para> </refsect1> + + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>posix_get_last_error</function></member> + </simplelist> + </para> + </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-times.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-times.xml diff -u phpdoc/en/reference/posix/functions/posix-times.xml:1.4 phpdoc/en/reference/posix/functions/posix-times.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-times.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-times.xml Sun Feb 4 02:47:57 2007 @@ -1,39 +1,60 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-times"> <refnamediv> <refname>posix_times</refname> <refpurpose>Get process times</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_times</methodname> <void/> </methodsynopsis> <para> + Gets information about the current CPU usage. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns a hash of strings with information about the current - process CPU usage. The indices of the hash are + process CPU usage. The indices of the hash are: <itemizedlist> - <listitem><simpara> + <listitem> + <simpara> ticks - the number of clock ticks that have elapsed since reboot. - </simpara></listitem> - <listitem><simpara> + </simpara> + </listitem> + <listitem> + <simpara> utime - user time used by the current process. - </simpara></listitem> - <listitem><simpara> + </simpara> + </listitem> + <listitem> + <simpara> stime - system time used by the current process. - </simpara></listitem> - <listitem><simpara> + </simpara> + </listitem> + <listitem> + <simpara> cutime - user time used by current process and children. - </simpara></listitem> - <listitem><simpara> + </simpara> + </listitem> + <listitem> + <simpara> cstime - system time used by current process and children. - </simpara></listitem> + </simpara> + </listitem> </itemizedlist> </para> + </refsect1> + + <refsect1 role="notes"> + &reftitle.notes; <warning> <para> This function isn't reliable to use, it may return negative values for @@ -41,6 +62,7 @@ </para> </warning> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-ttyname.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-ttyname.xml diff -u phpdoc/en/reference/posix/functions/posix-ttyname.xml:1.4 phpdoc/en/reference/posix/functions/posix-ttyname.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-ttyname.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-ttyname.xml Sun Feb 4 02:47:57 2007 @@ -1,13 +1,13 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-ttyname"> <refnamediv> <refname>posix_ttyname</refname> <refpurpose>Determine terminal device name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>posix_ttyname</methodname> <methodparam><type>int</type><parameter>fd</parameter></methodparam> @@ -16,6 +16,7 @@ &warn.undocumented.func; </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/posix/functions/posix-uname.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/posix/functions/posix-uname.xml diff -u phpdoc/en/reference/posix/functions/posix-uname.xml:1.4 phpdoc/en/reference/posix/functions/posix-uname.xml:1.5 --- phpdoc/en/reference/posix/functions/posix-uname.xml:1.4 Sun Feb 4 02:47:39 2007 +++ phpdoc/en/reference/posix/functions/posix-uname.xml Sun Feb 4 02:47:57 2007 @@ -1,18 +1,30 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> -<!-- splitted from ./en/functions/posix.xml, last change in rev 1.2 --> +<!-- $Revision: 1.5 $ --> <refentry id="function.posix-uname"> <refnamediv> <refname>posix_uname</refname> <refpurpose>Get system name</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>posix_uname</methodname> <void/> </methodsynopsis> <para> + Gets information about the system. + </para> + <para> + Posix requires that you must not make any assumptions about the + format of the values, e.g. you cannot rely on three digit version + numbers or anything else returned by this function. + </para> + </refsect1> + + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> Returns a hash of strings with information about the system. The indices of the hash are <itemizedlist> @@ -42,12 +54,8 @@ field is only available on GNU systems or when using the GNU libc. </para> - <para> - Posix requires that you must not make any assumptions about the - format of the values, e.g. you cannot rely on three digit version - numbers or anything else returned by this function. - </para> </refsect1> + </refentry> <!-- Keep this comment at the end of the file