1
0
mirror of https://github.com/php/doc-ja.git synced 2026-03-25 23:52:16 +01:00
Files
archived-doc-ja/reference/ssh2/functions/ssh2-shell.xml
TAKAGI Masahiro 6f7fdc84bb sync with en.
git-svn-id: https://svn.php.net/repository/phpdoc/ja/trunk@315121 c90b9560-bf6c-de11-be94-00142212c4b1
2011-08-18 01:49:52 +00:00

146 lines
4.2 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: fc9e379fd822e0731859b056db368fa59f7f14b9 Maintainer: shimooka Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.ssh2-shell">
<refnamediv>
<refname>ssh2_shell</refname>
<refpurpose>対話式のシェルを要求する</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>
リモートエンド上のシェルをオープンし、そのためのストリームを割り当てます。
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<para>
<function>ssh2_connect</function> のコールによって取得した
SSH 接続リンク ID。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>term_type</parameter></term>
<listitem>
<para>
<parameter>term_type</parameter> は対象システムの
<literal>/etc/termcap</literal> に記載されたエントリの一つに相当します。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>env</parameter></term>
<listitem>
<para>
<parameter>env</parameter> には、
対象の環境に設定する名前/値の組の連想配列を渡すことができます。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width</parameter></term>
<listitem>
<para>
仮想端末の幅。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>height</parameter></term>
<listitem>
<para>
仮想端末の高さ。
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>width_height_type</parameter></term>
<listitem>
<para>
<parameter>width_height_type</parameter>
<constant>SSH2_TERM_UNIT_CHARS</constant> あるいは
<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>コマンドの実行</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
-->