irchtml Thu Feb 26 05:45:36 2004 EDT
Modified files:
/phpdoc/en/reference/pcntl/functions pcntl-exec.xml
Log:
more pcntl docs
http://cvs.php.net/diff.php/phpdoc/en/reference/pcntl/functions/pcntl-exec.xml?r1=1.2&r2=1.3&ty=u
Index: phpdoc/en/reference/pcntl/functions/pcntl-exec.xml
diff -u phpdoc/en/reference/pcntl/functions/pcntl-exec.xml:1.2
phpdoc/en/reference/pcntl/functions/pcntl-exec.xml:1.3
--- phpdoc/en/reference/pcntl/functions/pcntl-exec.xml:1.2 Wed Apr 17 02:42:40
2002
+++ phpdoc/en/reference/pcntl/functions/pcntl-exec.xml Thu Feb 26 05:45:36 2004
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.2 $ -->
+<!-- $Revision: 1.3 $ -->
<!-- splitted from ./en/functions/pcntl.xml, last change in rev 1.9 -->
<refentry id='function.pcntl-exec'>
<refnamediv>
@@ -17,7 +17,26 @@
<methodparam
choice="opt"><type>array</type><parameter>envs</parameter></methodparam>
</methodsynopsis>
<para>
- &warn.undocumented.func;
+ <function>pcntl_exec</function> executes the program
+ <parameter>path</parameter> with arguments <parameter>args</parameter>.
+ <parameter>path</parameter> must be the path to a binary executable or a
+ script with a valid path pointing to an executable in the shebang (
+ #!/usr/local/bin/perl for example) as the first line. See your system's
+ man execve(2) page for additional information.
+ </para>
+ <para>
+ <parameter>args</parameter> is an array of argument strings passed to the
+ program.
+ </para>
+ <para>
+ <parameter>envs</parameter> is an array of strings which are passed as
+ environment to the program. The array is in the format of name => value,
+ the key being the name of the environmental variable and the value being
+ the value of that variable.
+ </para>
+ <para>
+ <function>pcntl_exec</function> returns &false; on error and does not
+ return on success.
</para>
</refsect1>
</refentry>
