Files
archived-doc-pt-br/reference/ssh2/functions/ssh2-shell.xml
Leonardo Lara Rodrigues 4baf074b52 sync file lines with en rev
2026-01-27 09:14:27 -03:00

138 lines
4.3 KiB
XML

<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 12f0e72200ea9249d0fc2f118528bd24b24c44a6 Maintainer: leonardolara Status: ready --><!-- CREDITS: leonardolara -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-shell">
<refnamediv>
<refname>ssh2_shell</refname>
<refpurpose>Solicita um shell interativo</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type class="union"><type>resource</type><type>false</type></type><methodname>ssh2_shell</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam choice="opt"><type>string</type><parameter>termtype</parameter><initializer>"vanilla"</initializer></methodparam>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>env</parameter><initializer>&null;</initializer></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>
<simpara>
Abre um shell na extremidade remota e aloca um fluxo para ele.
</simpara>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<simpara>
Um identificador de conexão SSH, obtido de uma chamada a
<function>ssh2_connect</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>termtype</parameter></term>
<listitem>
<simpara>
<parameter>termtype</parameter> deve corresponder a uma das
entradas no arquivo <literal>/etc/termcap</literal> do sistema de destino.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>env</parameter></term>
<listitem>
<simpara>
<parameter>env</parameter> pode ser passado como um array associativo de
pares nome/valor para definir no ambiente de destino.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<simpara>
Largura do terminal virtual.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<simpara>
Altura do terminal virtual.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width_height_type</parameter></term>
<listitem>
<simpara>
<parameter>width_height_type</parameter> deve ser uma das constantes
<constant>SSH2_TERM_UNIT_CHARS</constant> ou
<constant>SSH2_TERM_UNIT_PIXELS</constant>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Retorna um &resource; de fluxo em caso de sucesso, &return.falseforfailure;.
</simpara>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<example>
<title>Solicitando um shell interativo</title>
<programlisting role="php">
<![CDATA[
<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'usuario', 'senha');
$stream = ssh2_shell($connection, 'vt102', null, 80, 24, SSH2_TERM_UNIT_CHARS);
?>
]]>
</programlisting>
</example>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>ssh2_exec</function></member>
<member><function>ssh2_tunnel</function></member>
<member><function>ssh2_fetch_stream</function></member>
</simplelist>
</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
-->