From 1a1217698ce64e4301ba3888cf1bee50f3d3c87a Mon Sep 17 00:00:00 2001
From: Kenneth Schwartz <irchtml@php.net>
Date: Thu, 26 Feb 2004 10:45:36 +0000
Subject: [PATCH] more pcntl docs

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@152421 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/pcntl/functions/pcntl-exec.xml | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/reference/pcntl/functions/pcntl-exec.xml b/reference/pcntl/functions/pcntl-exec.xml
index 620d5e0865..cf15ef15ab 100644
--- a/reference/pcntl/functions/pcntl-exec.xml
+++ b/reference/pcntl/functions/pcntl-exec.xml
@@ -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>