samesch Fri Feb 23 13:03:42 2001 EDT
Modified files:
/phpdoc/en/functions posix.xml
Log:
some re-indenting
Index: phpdoc/en/functions/posix.xml
diff -u phpdoc/en/functions/posix.xml:1.7 phpdoc/en/functions/posix.xml:1.8
--- phpdoc/en/functions/posix.xml:1.7 Mon Oct 9 08:06:37 2000
+++ phpdoc/en/functions/posix.xml Fri Feb 23 13:03:42 2001
@@ -4,17 +4,17 @@
<partintro>
<para>
- This module contains an interface to those functions defined in the
- IEEE 1003.1 (POSIX.1) standards document which are not accessible
- through other means. POSIX.1 for example defined the open(), read(),
- write() and close() functions, too, which traditionally have been
- part of PHP 3 for a long time. Some more system specific functions
- have not been available before, though, and this module tries to
- remedy this by providing easy access to these functions.
+ This module contains an interface to those functions defined in
+ the IEEE 1003.1 (POSIX.1) standards document which are not
+ accessible through other means. POSIX.1 for example defined the
+ open(), read(), write() and close() functions, too, which
+ traditionally have been part of PHP 3 for a long time. Some more
+ system specific functions have not been available before, though,
+ and this module tries to remedy this by providing easy access to
+ these functions.
</para>
</partintro>
-
<refentry id="function.posix-kill">
<refnamediv>
<refname>posix_kill</refname>
@@ -30,14 +30,16 @@
</funcprototype>
</funcsynopsis>
<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.</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.
+ </para>
<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.</para>
+ signal number 0.
+ </para>
</refsect1>
</refentry>
@@ -73,9 +75,9 @@
</funcprototype>
</funcsynopsis>
<para>
- Return the process identifier of the parent process of the current
- process.
- </para>
+ Return the process identifier of the parent process of the
+ current process.
+ </para>
</refsect1>
</refentry>
@@ -97,7 +99,8 @@
<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.</para>
+ convert this into a useable username.
+ </para>
</refsect1>
</refentry>
@@ -119,7 +122,8 @@
<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.</para>
+ to convert this into a useable username.
+ </para>
</refsect1>
</refentry>
@@ -141,7 +145,8 @@
<para>
Return the numeric real group ID of the current process. See also
<function>posix_getgrgid</function> for information on how to
- convert this into a useable group name.</para>
+ convert this into a useable group name.
+ </para>
</refsect1>
</refentry>
@@ -163,7 +168,8 @@
<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.</para>
+ to convert this into a useable group name.
+ </para>
</refsect1>
</refentry>
@@ -185,10 +191,12 @@
<para>
Set the real user 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.</para>
+ your system to be able to perform this function.
+ </para>
<para>
Returns TRUE on success, FALSE otherwise. See also
- <function>posix_setgid</function>.</para>
+ <function>posix_setgid</function>.
+ </para>
</refsect1>
</refentry>
@@ -213,9 +221,11 @@
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>
+ <function>posix_setuid</function> last.
+ </para>
<para>
- Returns TRUE on success, FALSE otherwise.</para>
+ Returns TRUE on success, FALSE otherwise.
+ </para>
</refsect1>
</refentry>
@@ -238,7 +248,8 @@
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.</para>
+ convert this into useable group names.
+ </para>
</refsect1>
</refentry>
@@ -258,7 +269,8 @@
<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>
+ get more information about this user.
+ </para>
</refsect1>
</refentry>
@@ -280,7 +292,8 @@
<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.</para>
+ more information on process groups.
+ </para>
</refsect1>
</refentry>
@@ -298,10 +311,10 @@
</funcprototype>
</funcsynopsis>
<para>
- Make the current process a session leader. See POSIX.1 and
- the setsid(2) manual page on your POSIX system for more
- informations on process groups and job control. Returns
- the session id.</para>
+ Make the current process a session leader. See POSIX.1 and the
+ setsid(2) manual page on your POSIX system for more informations
+ on process groups and job control. Returns the session id.
+ </para>
</refsect1>
</refentry>
@@ -320,11 +333,11 @@
</funcprototype>
</funcsynopsis>
<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. Returns
- TRUE on success, FALSE otherwise.</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. Returns TRUE on success, FALSE otherwise.
+ </para>
</refsect1>
</refentry>
@@ -343,11 +356,13 @@
</funcsynopsis>
<para>
Returns the process group identifier of the process
- <parameter>pid</parameter>.</para>
+ <parameter>pid</parameter>.
+ </para>
<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>
+ level, this PHP function will always return FALSE.
+ </para>
</refsect1>
</refentry>
@@ -365,13 +380,15 @@
</funcprototype>
</funcsynopsis>
<para>
- Return the sid of the process <parameter>pid</parameter>.
- If <parameter>pid</parameter> is 0, the sid of the
- current process is returned.</para>
+ Return the sid of the process <parameter>pid</parameter>. If
+ <parameter>pid</parameter> is 0, the sid of the current process
+ is returned.
+ </para>
<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>
+ 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>
</refsect1>
</refentry>
@@ -415,7 +432,8 @@
</para>
<para>
domainname is a GNU extension and not part of POSIX.1, so this
- field is only available on GNU systems or when using the GNU libc.
+ 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
@@ -439,8 +457,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns a hash of strings with information about the
- current process CPU usage. The indices of the hash are
+ 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
@@ -458,7 +476,8 @@
<listitem><simpara>
cstime - system time used by current process and children.
</simpara></listitem>
- </itemizedlist></para>
+ </itemizedlist>
+ </para>
</refsect1>
</refentry>
@@ -476,7 +495,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Needs to be written.</para>
+ Needs to be written.
+ </para>
</refsect1>
</refentry>
@@ -494,7 +514,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Needs to be written.</para>
+ Needs to be written.
+ </para>
</refsect1>
</refentry>
@@ -514,7 +535,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Needs to be written.</para>
+ Needs to be written.
+ </para>
</refsect1>
</refentry>
@@ -532,7 +554,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Needs to be written ASAP.</para>
+ Needs to be written ASAP.
+ </para>
</refsect1>
</refentry>
@@ -553,7 +576,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Needs to be written ASAP..</para>
+ Needs to be written ASAP.
+ </para>
</refsect1>
</refentry>
@@ -571,7 +595,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Needs to be written.</para>
+ Needs to be written.
+ </para>
</refsect1>
</refentry>
@@ -589,7 +614,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Needs to be written.</para>
+ Needs to be written.
+ </para>
</refsect1>
</refentry>
@@ -607,8 +633,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns an associative array containing information about a
- user referenced by an alphanumeric username, passed in the
+ Returns an associative array containing information about a user
+ referenced by an alphanumeric username, passed in the
<parameter>username</parameter> parameter.
</para>
<para>
@@ -627,18 +653,18 @@
<entry>name</entry>
<entry>
The name element contains the username of the user. This is
- a short, usually less than 16 character "handle" of the user,
- not her real, full name. This should be the same as the
- <parameter>username</parameter> parameter used when calling the
- function, and hence redundant.
+ a short, usually less than 16 character "handle" of the
+ user, not her real, full name. This should be the same as
+ the <parameter>username</parameter> parameter used when
+ calling the function, and hence redundant.
</entry>
</row>
<row>
<entry>passwd</entry>
<entry>
- The passwd element contains the user's password in an encrypted
- format. Often, for example on a system employing "shadow"
- passwords, an asterisk is returned instead.
+ The passwd element contains the user's password in an
+ encrypted format. Often, for example on a system employing
+ "shadow" passwords, an asterisk is returned instead.
</entry>
</row>
<row>
@@ -651,33 +677,34 @@
<entry>gid</entry>
<entry>
The group ID of the user. Use the function
- <function>posix_getgrgid</function> to resolve the
- group name and a list of its members.
+ <function>posix_getgrgid</function> to resolve the group
+ name and a list of its members.
</entry>
</row>
<row>
<entry>gecos</entry>
<entry>
- GECOS is an obsolete term that refers to the finger information
- field on a Honeywell batch processing system. The field, however,
- lives on, and its contents have been formalized by POSIX. The
- field contains a comma separated list containing the user's full
- name, office phone, office number, and home phone number. On most
- systems, only the user's full name is available.
+ GECOS is an obsolete term that refers to the finger
+ information field on a Honeywell batch processing system.
+ The field, however, lives on, and its contents have been
+ formalized by POSIX. The field contains a comma separated
+ list containing the user's full name, office phone, office
+ number, and home phone number. On most systems, only the
+ user's full name is available.
</entry>
</row>
<row>
<entry>dir</entry>
<entry>
- This element contains the absolute path to the
- home directory of the user.
+ This element contains the absolute path to the home
+ directory of the user.
</entry>
</row>
<row>
<entry>shell</entry>
<entry>
- The shell element contains the absolute path to the executable of
- the user's default shell.
+ The shell element contains the absolute path to the
+ executable of the user's default shell.
</entry>
</row>
</tbody>
@@ -701,8 +728,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Returns an associative array containing information about a
- user referenced by a numeric user ID, passed in the
+ Returns an associative array containing information about a user
+ referenced by a numeric user ID, passed in the
<parameter>uid</parameter> parameter.
</para>
<para>
@@ -721,42 +748,44 @@
<entry>name</entry>
<entry>
The name element contains the username of the user. This is
- a short, usually less than 16 character "handle" of the user,
- not her real, full name.
+ a short, usually less than 16 character "handle" of the
+ user, not her real, full name.
</entry>
</row>
<row>
<entry>passwd</entry>
<entry>
- The passwd element contains the user's password in an encrypted
- format. Often, for example on a system employing "shadow"
- passwords, an asterisk is returned instead.
+ The passwd element contains the user's password in an
+ encrypted format. Often, for example on a system employing
+ "shadow" passwords, an asterisk is returned instead.
</entry>
</row>
<row>
<entry>uid</entry>
<entry>
- User ID, should be the same as the <parameter>uid</parameter>
- parameter used when calling the function, and hence redundant.
+ User ID, should be the same as the
+ <parameter>uid</parameter> parameter used when calling the
+ function, and hence redundant.
</entry>
</row>
<row>
<entry>gid</entry>
<entry>
The group ID of the user. Use the function
- <function>posix_getgrgid</function> to resolve the
- group name and a list of its members.
+ <function>posix_getgrgid</function> to resolve the group
+ name and a list of its members.
</entry>
</row>
<row>
<entry>gecos</entry>
<entry>
- GECOS is an obsolete term that refers to the finger information
- field on a Honeywell batch processing system. The field, however,
- lives on, and its contents have been formalized by POSIX. The
- field contains a comma separated list containing the user's full
- name, office phone, office number, and home phone number. On most
- systems, only the user's full name is available.
+ GECOS is an obsolete term that refers to the finger
+ information field on a Honeywell batch processing system.
+ The field, however, lives on, and its contents have been
+ formalized by POSIX. The field contains a comma separated
+ list containing the user's full name, office phone, office
+ number, and home phone number. On most systems, only the
+ user's full name is available.
</entry>
</row>
<row>
@@ -769,8 +798,8 @@
<row>
<entry>shell</entry>
<entry>
- The shell element contains the absolute path to the executable of
- the user's default shell.
+ The shell element contains the absolute path to the
+ executable of the user's default shell.
</entry>
</row>
</tbody>
@@ -794,7 +823,8 @@
</funcprototype>
</funcsynopsis>
<para>
- Needs to be written ASAP.</para>
+ Needs to be written ASAP.
+ </para>
</refsect1>
</refentry>
