-
Notifications
You must be signed in to change notification settings - Fork 70
/
ssh2-shell.xml
144 lines (137 loc) · 4.78 KB
/
ssh2-shell.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: c44f6bd5cb3076f54b1cc60e3195b0b48939b11a Maintainer: rjhdby Status: ready -->
<!-- Reviewed: no -->
<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 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>
<para>
Открывает терминал к удалённому серверу и выделяет ему поток.
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>session</parameter></term>
<listitem>
<para>
Идентификатор соединения SSH, полученный из
<function>ssh2_connect</function>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>termtype</parameter></term>
<listitem>
<para>
Тип терминала <parameter>termtype</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>
Возвращает ресурс (&resource;) потока в случае успешного выполнения&return.falseforfailure;.
</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
-->