cvs: phpdoc /en/reference/exec/functions proc-get-status.xml proc-nice.xml proc-terminate.xml

wez Sun Jun 22 08:20:11 2003 EDT Modified files: /phpdoc/en/reference/exec/functions proc-get-status.xml proc-nice.xml proc-terminate.xml Log: document proc_terminate and clarify that proc_nice() is not related to the other proc_XXX functions. Index: phpdoc/en/reference/exec/functions/proc-get-status.xml diff -u phpdoc/en/reference/exec/functions/proc-get-status.xml:1.3 phpdoc/en/reference/exec/functions/proc-get-status.xml:1.4 --- phpdoc/en/reference/exec/functions/proc-get-status.xml:1.3 Mon Jun 16 15:43:40 2003 +++ phpdoc/en/reference/exec/functions/proc-get-status.xml Sun Jun 22 08:20:10 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id='function.proc-get-status'> <refnamediv> <refname>proc_get_status</refname> @@ -28,7 +28,8 @@ <row> <entry>command</entry> <entry><type>string</type></entry> - <entry></entry> + <entry>The command string that was passed to + <function>proc_open</function></entry> </row> <row> <entry>pid</entry> Index: phpdoc/en/reference/exec/functions/proc-nice.xml diff -u phpdoc/en/reference/exec/functions/proc-nice.xml:1.2 phpdoc/en/reference/exec/functions/proc-nice.xml:1.3 --- phpdoc/en/reference/exec/functions/proc-nice.xml:1.2 Mon Jun 16 15:43:14 2003 +++ phpdoc/en/reference/exec/functions/proc-nice.xml Sun Jun 22 08:20:10 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id='function.proc-nice'> <refnamediv> <refname>proc_nice</refname> @@ -28,8 +28,8 @@ </para> </note> <para> - See also <function>proc_open</function> and - <function>proc_terminate</function>. + <function>proc_nice</function> is not related to + <function>proc_open</function> and its associated functions in any way. </para> </refsect1> </refentry> Index: phpdoc/en/reference/exec/functions/proc-terminate.xml diff -u phpdoc/en/reference/exec/functions/proc-terminate.xml:1.2 phpdoc/en/reference/exec/functions/proc-terminate.xml:1.3 --- phpdoc/en/reference/exec/functions/proc-terminate.xml:1.2 Mon Jun 16 15:43:41 2003 +++ phpdoc/en/reference/exec/functions/proc-terminate.xml Sun Jun 22 08:20:10 2003 @@ -1,5 +1,5 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> +<!-- $Revision: 1.3 $ --> <refentry id='function.proc-terminate'> <refnamediv> <refname>proc_terminate</refname> @@ -9,17 +9,35 @@ </refnamediv> <refsect1> <title>Description</title> - <methodsynopsis> - <type>int</type><methodname>proc_terminate</methodname> - <methodparam><type>resource</type><parameter>process</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>signal</parameter></methodparam> - </methodsynopsis> - - &warn.undocumented.func; + <methodsynopsis> + <type>int</type><methodname>proc_terminate</methodname> + <methodparam><type>resource</type><parameter>process</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>signal</parameter></methodparam> + </methodsynopsis> + + <para> + Signals a <parameter>process</parameter> (created using + <function>proc_open</function>) that it should terminate. + <function>proc_terminate</function> returns immediately and does not wait + for the process to terminate. + </para> + <para> + The optional + <parameter>signal</parameter> is only useful on <acronym>POSIX</acronym> + operating systems; you may specify a signal to send to the process using + the <literal>kill(2)</literal> system call. The default is + <literal>SIGTERM</literal>. + </para> + + <para> + <function>proc_terminate</function> allows you terminate the process and + continue with other tasks. You may poll the process (to see if it has + stopped yet) by using the <function>proc_get_status</function> function. + </para> <para> See also <function>proc_open</function>, <function>proc_close</function>, - and <function>proc_nice</function>. + and <function>proc_get_status</function>. </para> </refsect1> </refentry>