php-doc-en/reference/ssh2/functions/ssh2-shell.xml

<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-shell">
 <refnamediv>
  <refname>ssh2_shell</refname>
  <refpurpose>Request an interactive shell</refpurpose>
 </refnamediv>
 
 <refsect1 role="description">
  &reftitle.description;
  <methodsynopsis>
   <type>resource</type><methodname>ssh2_shell</methodname>
   <methodparam><type>resource</type><parameter>session</parameter></methodparam>
   <methodparam choice="opt"><type>string</type><parameter>term_type</parameter><initializer>"vanilla"</initializer></methodparam>
   <methodparam choice="opt"><type>array</type><parameter>env</parameter></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>width</parameter><initializer>80</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>height</parameter><initializer>25</initializer></methodparam>
   <methodparam choice="opt"><type>int</type><parameter>width_height_type</parameter><initializer>SSH2_TERM_UNIT_CHARS</initializer></methodparam>
  </methodsynopsis>
  <para>
   Open a shell at the remote end and allocate a stream for it.
  </para>
 </refsect1>

 <refsect1 role="parameters">
  &reftitle.parameters;
  <para>
   <variablelist>
    <varlistentry>
     <term><parameter>session</parameter></term>
     <listitem>
      <para>
       An SSH connection link identifier, obtained from a call to
       <function>ssh2_connect</function>.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>term_type</parameter></term>
     <listitem>
      <para>
       <parameter>term_type</parameter> should correspond to one of the
       entries in the target system's <literal>/etc/termcap</literal> file.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>env</parameter></term>
     <listitem>
      <para>
       <parameter>env</parameter> may be passed as an associative array of
       name/value pairs to set in the target environment.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width</parameter></term>
     <listitem>
      <para>
       Width of the virtual terminal.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>height</parameter></term>
     <listitem>
      <para>
       Height of the virtual terminal.
      </para>
     </listitem>
    </varlistentry>
    <varlistentry>
     <term><parameter>width_height_type</parameter></term>
     <listitem>
      <para>
       <parameter>width_height_type</parameter> should be one of
       <constant>SSH2_TERM_UNIT_CHARS</constant> or
       <constant>SSH2_TERM_UNIT_PIXELS</constant>.
      </para>
     </listitem>
    </varlistentry>
   </variablelist>
  </para>
 </refsect1>

 <refsect1 role="returnvalues">
  &reftitle.returnvalues;
  <para>
   
  </para>
 </refsect1>

 <refsect1 role="examples">
  &reftitle.examples;
  <para>
   <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_shell($connection, 'vt102', null, 80, 24, SSH2_TERM_UNIT_CHARS);
?>
]]>
    </programlisting>
   </example>
  </para>
 </refsect1>

 <refsect1 role="seealso">
  &reftitle.seealso;
  <para>
   <simplelist>
    <member><function>ssh2_exec</function></member>
    <member><function>ssh2_tunnel</function></member>
    <member><function>ssh2_fetch_stream</function></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:"~/.phpdoc/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
-->