Home/ Manual/ ssh2 / functions/ ssh2_shell_resize

ssh2_shell_resize

PHP function Edit on GitHub ✎

(PECL ssh2 >= 1.4)

Change the dimensions of a channel's pseudo-terminal

Description

ssh2_shell_resize(resource $channel, int $width, int $height, int $width_px = 0, int $height_px = 0): bool

Requests that the pseudo-terminal (PTY) attached to the given channel be resized to the given dimensions.

Note

The extension declares only the first three parameters, under the name session for channel. As a result, width_px and height_px can only be passed positionally.

Parameters

channel: An SSH channel stream, as returned by ssh2_exec() or ssh2_shell().
width: The width of the terminal, in characters.
height: The height of the terminal, in characters.
width_px: The width of the terminal in pixels, or 0 to leave the pixel dimensions unspecified.
height_px: The height of the terminal in pixels, or 0 to leave the pixel dimensions unspecified.

Return Values

Returns true, or false when channel is not an SSH channel stream.

The outcome of the resize request itself is not reported: true is returned even when the remote end does not honour it.

Errors/Exceptions

An E_WARNING is emitted when channel is not an SSH channel stream.

Examples

Resizing the pseudo-terminal of a shell

php

<?php
$connection = ssh2_connect('shell.example.com', 22);
ssh2_auth_password($connection, 'username', 'password');

$shell = ssh2_shell($connection, 'xterm', null, 80, 24);

// Tell the remote end the terminal is now 132 columns by 43 rows
ssh2_shell_resize($shell, 132, 43);
?>