From 3a0e8e2ada1f2a391b9115e01e603caf74103beb Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Thu, 18 Jan 2007 17:02:24 +0000
Subject: [PATCH] document bypass_shell option comment the pty docs, as the
 code was disabled on php sources for a loong time

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227530 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/exec/functions/proc-open.xml | 39 ++++++++++++++++++++------
 1 file changed, 31 insertions(+), 8 deletions(-)

diff --git a/reference/exec/functions/proc-open.xml b/reference/exec/functions/proc-open.xml
index 12469db246..aa3aa42f63 100644
--- a/reference/exec/functions/proc-open.xml
+++ b/reference/exec/functions/proc-open.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.14 $ -->
+<!-- $Revision: 1.15 $ -->
 <!-- splitted from ./en/functions/exec.xml, last change in rev 1.28 -->
   <refentry id='function.proc-open'>
    <refnamediv>
@@ -23,6 +23,8 @@
      <function>proc_open</function> is similar to <function>popen</function>
      but provides a much greater degree of control over the program execution.
     </para>
+
+<!-- ptys are currently disabled in the sources
     <para>
      PHP 5 introduces pty support for systems with Unix98 ptys. This allows
      your script to interact with applications that expect to be talking to a
@@ -33,6 +35,8 @@
      times.  In a future version of PHP, it might be possible to do more than
      just read and write to the pty.
     </para>
+-->
+
    </refsect1>
 
  <refsect1 role="parameters">
@@ -56,8 +60,8 @@
        process. 0 is stdin, 1 is stdout, while 2 is stderr.
       </para>
       <para>
-       The currently supported pipe types are <literal>file</literal>,
-       <literal>pipe</literal> and <literal>pty</literal>.
+       The currently supported pipe types are <literal>file</literal> and
+       <literal>pipe</literal> <!-- and <literal>pty</literal>-->.
       </para>
       <para>
        The file descriptor numbers are not limited to 0, 1 and 2 - you may
@@ -103,9 +107,18 @@
      <term><parameter>other_options</parameter></term>
      <listitem>
       <para>
-       Allows you to specify additional options. Currently only
-       <literal>suppress_errors</literal> is supported, which suppresses
-       errors generated by this function when it's set to &true;
+       Allows you to specify additional options. Currently supported options
+       include:
+       <simplelist>
+        <member>
+         <literal>suppress_errors</literal> (windows only): suppresses errors
+         generated by this function when it's set to &true;
+        </member>
+        <member>
+         <literal>bypass_shell</literal> (windows only): bypass
+         <literal>cmd.exe</literal> shell when set to &true;
+        </member>
+       </simplelist>
       </para>
      </listitem>
     </varlistentry>
@@ -134,12 +147,18 @@
       </row>
      </thead>
      <tbody>
+      <row>
+       <entry>5.2.1.</entry>
+       <entry>
+        Added the <literal>bypass_shell</literal> option to the
+        <parameter>other_options</parameter> parameter.
+       </entry>
+      </row>
       <row>
        <entry>5.0.0.</entry>
        <entry>
         Added the <parameter>cwd</parameter>, <parameter>env</parameter> and
-        <parameter>other_options</parameter> parameters. Added support for
-        Unix98 ptys.
+        <parameter>other_options</parameter> parameters.
        </entry>
       </row>
      </tbody>
@@ -203,6 +222,8 @@ command returned 0
     </screen>
    </example>
   </para>
+
+<!-- ptys are currently disabled
   <para>
    <example>
     <title>ptys usage</title>
@@ -224,6 +245,8 @@ if (is_resource($process)) {
     </programlisting>
    </example>
   </para>
+-->
+
  </refsect1>
 
  <refsect1 role="notes">