cvs: /phpdoc/functions posix.sgml

eschmid Sun Sep 12 15:39:10 1999 EDT Modified files: /phpdoc/functions posix.sgml Log: Documentation is like sex, if it is free it is better then nothing. Index: phpdoc/functions/posix.sgml diff -u phpdoc/functions/posix.sgml:1.1 phpdoc/functions/posix.sgml:1.2 --- phpdoc/functions/posix.sgml:1.1 Sun Sep 12 14:26:15 1999 +++ phpdoc/functions/posix.sgml Sun Sep 12 15:39:08 1999 @@ -2,17 +2,24 @@ <title>POSIX functions</title> <titleabbrev>POSIX</titleabbrev> + <partintro> + <para> + Needs to be written ASAP. + </para> + </partintro> + + <refentry id="function.posix-kill"> <refnamediv> <refname>posix_kill</refname> - <refpurpose>send a signal to a process</refpurpose> + <refpurpose>Send a signal to a process</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>bool <function>posix_kill</function></funcdef> - <paramdef>int <parameter>pid</parameter> - int <parameter>sig</paramdef> + <paramdef>int <parameter>pid</parameter></paramdef> + <paramdef>int <parameter>sig</parameter</paramdef> </funcsynopsis> <para> Send the signal <parameter>sig</parameter> to the process @@ -20,20 +27,22 @@ Returns FALSE, if unable to send the signal, TRUE otherwise. <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. + contains additional information about negative process + identifiers, the special pid 0, the special pid -1, and the + signal number 0. </refsect1> </refentry> <refentry id="function.posix-getpid"> <refnamediv> <refname>posix_getpid</refname> - <refpurpose>return the current process identifier</refpurpose> + <refpurpose>Return the current process identifier</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_getpid</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Return the process identifier of the current process. @@ -43,27 +52,32 @@ <refentry id="function.posix-getppid"> <refnamediv> <refname>posix_getppid</refname> - <refpurpose>return the parent process identifier</refpurpose> + <refpurpose>Return the parent process identifier</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_getppid</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - Return the process identifier of parent process of the current process. + Return the process identifier of parent process of the current + process. </refsect1> </refentry> <refentry id="function.posix-getuid"> <refnamediv> <refname>posix_getuid</refname> - <refpurpose>return the real user ID of the current process</refpurpose> + <refpurpose> + Return the real user ID of the current process + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_getuid</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Return the numeric real user ID of the current process. See also @@ -75,29 +89,35 @@ <refentry id="function.posix-geteuid"> <refnamediv> <refname>posix_geteuid</refname> - <refpurpose>return the effective user ID of the current process</refpurpose> + <refpurpose> + Return the effective user ID of the current process + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_geteuid</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - Return the numeric effective 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 effective user ID of the current process. See + also <function>posix_getpwuid</function> for information on how + to convert this into a useable username. </refsect1> </refentry> <refentry id="function.posix-getgid"> <refnamediv> <refname>posix_getgid</refname> - <refpurpose>return the real group ID of the current process</refpurpose> + <refpurpose> + Return the real group ID of the current process + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_getgid</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Return the numeric real group ID of the current process. See also @@ -109,24 +129,29 @@ <refentry id="function.posix-getegid"> <refnamediv> <refname>posix_getegid</refname> - <refpurpose>return the effective group ID of the current process</refpurpose> + <refpurpose> + Return the effective group ID of the current process + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_getegid</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <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. See + also <function>posix_getgrgid</function> for information on how + to convert this into a useable group name. </refsect1> </refentry> <refentry id="function.posix-setuid"> <refnamediv> - <refname>posix_setuid</refname> - <refpurpose>Set the effective UID of the current process</refpurpose> + <refname>posix_setuid</refname> + <refpurpose> + Set the effective UID of the current process + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -146,8 +171,10 @@ <refentry id="function.posix-setgid"> <refnamediv> - <refname>posix_setgid</refname> - <refpurpose>Set the effective GID of the current process</refpurpose> + <refname>posix_setgid</refname> + <refpurpose> + Set the effective GID of the current process + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -156,10 +183,11 @@ <paramdef>int <parameter>gid</parameter></paramdef> </funcsynopsis> <para> - Set the real group ID of the current process. This is a privileged - function and you need appropriate privileges (usually root) on - your system to be able to perform this function. The appropriate - order of function calls is <function>posix_setgid</function> first, + Set the real group ID of the current process. This is a + privileged function and you need appropriate privileges (usually + root) on your system to be able to perform this function. The + appropriate order of function calls is + <function>posix_setgid</function> first, <function>posix_setuid</function> last. <para> Returns TRUE on success, FALSE otherwise. @@ -169,30 +197,34 @@ <refentry id="function.posix-getgroups"> <refnamediv> <refname>posix_getgroups</refname> - <refpurpose>return the group set of the current process</refpurpose> + <refpurpose> + Return the group set of the current process + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>array <function>posix_getgroups</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <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. + 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. </refsect1> </refentry> <refentry id="function.posix-getlogin"> <refnamediv> <refname>posix_getlogin</refname> - <refpurpose>return login name</refpurpose> + <refpurpose>Return login name</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>string <function>posix_getlogin</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Returns the login name of the user owning the current process. @@ -204,12 +236,15 @@ <refentry id="function.posix-getpgrp"> <refnamediv> <refname>posix_getpgrp</refname> - <refpurpose>return the current process group identifier</refpurpose> + <refpurpose> + Return the current process group identifier + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_getpgrp</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Return the process group identifier of the current process. See @@ -221,12 +256,13 @@ <refentry id="function.posix-setsid"> <refnamediv> <refname>posix_setsid</refname> - <refpurpose>make the current process a session leader</refpurpose> + <refpurpose>Make the current process a session leader</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_setsid</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Make the current process a session leader. See POSIX.1 and @@ -245,8 +281,8 @@ <title>Description</title> <funcsynopsis> <funcdef>int <function>posix_setpgid</function></funcdef> - <paramdef>int <parameter>pid</parameter> - int <parameter>pgid</paramdef> + <paramdef>int <parameter>pid</parameter></paramdef> + <paramdef>int <parameter>pgid</parameter></paramdef> </funcsynopsis> <para> Let the process <parameter>pid</parameter> join the process @@ -260,7 +296,7 @@ <refentry id="function.posix-getpgid"> <refnamediv> <refname>posix_getpgid</refname> - <refpurpose>get process group id for job control</refpurpose> + <refpurpose>Get process group id for job control</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -273,15 +309,15 @@ <parameter>pid</parameter>. <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. + systems. If your system does not support this function at system + level, this PHP function will always return FALSE. </refsect1> </refentry> <refentry id="function.posix-getsid"> <refnamediv> <refname>posix_setsid</refname> - <refpurpose>get the current sid of the process</refpurpose> + <refpurpose>Get the current sid of the process</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -295,20 +331,21 @@ current process is returned. <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. + systems. If your system does not support this function at system + level, this PHP function will always return FALSE. </refsect1> </refentry> <refentry id="function.posix-uname"> <refnamediv> <refname>posix_uname</refname> - <refpurpose>get system name</refpurpose> + <refpurpose>Get system name</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>array <function>posix_uname</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Returns a hash of strings with information about the @@ -324,35 +361,38 @@ release - operating system release (e.g. 2.2.10) </simpara></listitem> <listitem><simpara> - version - operating system version (e.g. #4 Tue Jul 20 17:01:36 MEST 1999) + version - operating system version (e.g. #4 Tue Jul 20 + 17:01:36 MEST 1999) </simpara></listitem> <listitem><simpara> machine - system architecture (e.g. i586) </simpara></listitem> </itemizedlist> - - 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> + 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. </refsect1> </refentry> <refentry id="function.posix-times"> <refnamediv> <refname>posix_times</refname> - <refpurpose>get process times</refpurpose> + <refpurpose>Get process times</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>array <function>posix_times</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Returns a hash of strings with information about the current process CPU usage. The indices of the hash are <itemizedlist> <listitem><simpara> - ticks - the number of clock ticks that have elapsed since reboot. + ticks - the number of clock ticks that have elapsed since + reboot. </simpara></listitem> <listitem><simpara> utime - user time used by the current process. @@ -373,12 +413,13 @@ <refentry id="function.posix-ctermid"> <refnamediv> <refname>posix_ctermid</refname> - <refpurpose>get path name of controlling terminal</refpurpose> + <refpurpose>Get path name of controlling terminal</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>string <function>posix_ctermid</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> Needs to be written. @@ -388,7 +429,7 @@ <refentry id="function.posix-ttyname"> <refnamediv> <refname>posix_ttyname</refname> - <refpurpose>determine terminal device name</refpurpose> + <refpurpose>Determine terminal device name</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -404,7 +445,9 @@ <refentry id="function.posix-isatty"> <refnamediv> <refname>posix_isatty</refname> - <refpurpose>determine if a file descriptor is an interactive terminal</refpurpose> + <refpurpose> + Determine if a file descriptor is an interactive terminal + </refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -420,39 +463,42 @@ <refentry id="function.posix-getcwd"> <refnamediv> <refname>posix_getcwd</refname> - <refpurpose>pathname of current directory</refpurpose> + <refpurpose>Pathname of current directory</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>string <function>posix_getcwd</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written ASAP. </refsect1> </refentry> <refentry id="function.posix-mkfifo"> <refnamediv> <refname>posix_mkfifo</refname> - <refpurpose>create a fifo special file (a named pipe)</refpurpose> + <refpurpose> + Create a fifo special file (a named pipe) + </refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>bool <function>posix_getcwd</function></funcdef> - <paramdef>string <parameter>pathname</parameter> - int <parameter>mode</parameter></paramdef> + <paramdef>string <parameter>pathname</parameter></paramdef> + <paramdef>int <parameter>mode</parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written ASAP.. </refsect1> </refentry> <refentry id="function.posix-getgrnam"> <refnamediv> <refname>posix_getgrnam</refname> - <refpurpose>return info about a group by name</refpurpose> + <refpurpose>Return info about a group by name</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -468,7 +514,7 @@ <refentry id="function.posix-getgrgid"> <refnamediv> <refname>posix_getgrgid</refname> - <refpurpose>return info about a group by group id</refpurpose> + <refpurpose>Return info about a group by group id</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -484,7 +530,7 @@ <refentry id="function.posix-getpwnam"> <refnamediv> <refname>posix_getpwnam</refname> - <refpurpose>return info about a user by name</refpurpose> + <refpurpose>Return info about a user by name</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -493,14 +539,14 @@ <paramdef>string <parameter>name</parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written ASAP. </refsect1> </refentry> <refentry id="function.posix-getpwuid"> <refnamediv> <refname>posix_getpwuid</refname> - <refpurpose>return info about a user by user id</refpurpose> + <refpurpose>Return info about a user by user id</refpurpose> </refnamediv> <refsect1> <title>Description</title> @@ -509,22 +555,23 @@ <paramdef>int <parameter>uid</parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written ASAP. </refsect1> </refentry> <refentry id="function.posix-getrlimit"> <refnamediv> <refname>posix_getrlimit</refname> - <refpurpose>return info about system ressource limits</refpurpose> + <refpurpose>Return info about system ressource limits</refpurpose> </refnamediv> <refsect1> <title>Description</title> <funcsynopsis> <funcdef>array <function>posix_getrlimit</function></funcdef> + <paramdef>void <parameter></parameter></paramdef> </funcsynopsis> <para> - Needs to be written. + Needs to be written ASAP. </refsect1> </refentry>