mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-21 03:18:55 +00:00
c030e2adf7
- All id attributes are now xml:id - Add docbook namespace to all root elements - Replace <ulink /> with <link xlink:href /> - Minor markup fixes here and there git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@238160 c90b9560-bf6c-de11-be94-00142212c4b1
138 lines
4 KiB
XML
138 lines
4 KiB
XML
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.20 $ -->
|
|
<!-- splitted from ./en/functions/exec.xml, last change in rev 1.2 -->
|
|
<refentry xml:id="function.exec" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>exec</refname>
|
|
<refpurpose>Execute an external program</refpurpose>
|
|
</refnamediv>
|
|
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>exec</methodname>
|
|
<methodparam><type>string</type><parameter>command</parameter></methodparam>
|
|
<methodparam choice="opt"><type>array</type><parameter role="reference">output</parameter></methodparam>
|
|
<methodparam choice="opt"><type>int</type><parameter role="reference">return_var</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
<function>exec</function> executes the given
|
|
<parameter>command</parameter>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<para>
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>command</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
The command that will be executed.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>output</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If the <parameter>output</parameter> argument is present, then the
|
|
specified array will be filled with every line of output from the
|
|
command. Trailing whitespace, such as <literal>\n</literal>, is not
|
|
included in this array. Note that if the array already contains some
|
|
elements, <function>exec</function> will append to the end of the array.
|
|
If you do not want the function to append elements, call
|
|
<function>unset</function> on the array before passing it to
|
|
<function>exec</function>.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>return_var</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
If the <parameter>return_var</parameter> argument is present
|
|
along with the <parameter>output</parameter> argument, then the
|
|
return status of the executed command will be written to this
|
|
variable.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
The last line from the result of the command. If you need to execute a
|
|
command and have all the data from the command passed directly back without
|
|
any interference, use the <function>passthru</function> function.
|
|
</para>
|
|
<para>
|
|
To get the output of the executed command, be sure to set and use the
|
|
<parameter>output</parameter> parameter.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title>An <function>exec</function> example</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
// outputs the username that owns the running php/httpd process
|
|
// (on a system with the "whoami" executable in the path)
|
|
echo exec('whoami');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="notes">
|
|
&reftitle.notes;
|
|
&warn.escapeshell;
|
|
¬e.exec-bg;
|
|
¬e.exec-path;
|
|
&warn.sm.exec;
|
|
</refsect1>
|
|
|
|
<refsect1 role="seealso">
|
|
&reftitle.seealso;
|
|
<para>
|
|
<simplelist>
|
|
<member><function>system</function></member>
|
|
<member><function>passthru</function></member>
|
|
<member><function>escapeshellcmd</function></member>
|
|
<member><function>pcntl_exec</function></member>
|
|
<member><link linkend="language.operators.execution">backtick operator</link></member>
|
|
</simplelist>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- Keep this comment at the end of the file
|
|
Local variables:
|
|
mode: sgml
|
|
sgml-omittag:t
|
|
sgml-shorttag:t
|
|
sgml-minimize-attributes:nil
|
|
sgml-always-quote-attributes:t
|
|
sgml-indent-step:1
|
|
sgml-indent-data:t
|
|
indent-tabs-mode:nil
|
|
sgml-parent-document:nil
|
|
sgml-default-dtd-file:"../../../../manual.ced"
|
|
sgml-exposed-tags:nil
|
|
sgml-local-catalogs:nil
|
|
sgml-local-ecat-files:nil
|
|
End:
|
|
vim600: syn=xml fen fdm=syntax fdl=2 si
|
|
vim: et tw=78 syn=sgml
|
|
vi: ts=1 sw=1
|
|
-->
|