php-doc-en/reference/ssh2/functions/ssh2-exec.xml
Sara Golemon 7f4cac2ea3 Update proto
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@186554 c90b9560-bf6c-de11-be94-00142212c4b1
2005-05-18 17:54:24 +00:00

71 lines
2.2 KiB
XML

<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.4 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.ssh2-exec">
<refnamediv>
<refname>ssh2_exec</refname>
<refpurpose>
Execute a command on a remote server
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>stream</type><methodname>ssh2_exec</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam><type>string</type><parameter>command</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>pty</parameter></methodparam>
<methodparam choice="opt"><type>array</type><parameter>env</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>height</parameter></methodparam>
<methodparam choice="opt"><type>int</type><parameter>width_height_type</parameter></methodparam>
</methodsynopsis>
<simpara>
Execute a command at the remote end and allocate a channel for it.
Returns a stream on success or &false; on failure.
</simpara>
<example>
<title>Executing a command</title>
<programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');
$stream = ssh2_exec($connection, '/usr/local/bin/php -i');
?>
]]>
</programlisting>
</example>
<simpara>
See Also:
<function>ssh2_connect</function>,
<function>ssh2_shell</function>, and
<function>ssh2_tunnel</function>
</simpara>
</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
-->