php man page for ssh2_shell

SSH2_SHELL(3)								 1							     SSH2_SHELL(3)

ssh2_shell - Request an interactive shell

SYNOPSIS
       resource  ssh2_shell  (resource	 $session,  [string  $term_type = "vanilla"], [array  $env], [int  $width = 80], [int  $height = 25], [int
       $width_height_type = SSH2_TERM_UNIT_CHARS])

DESCRIPTION
	Open a shell at the remote end and allocate a stream for it.

PARAMETERS
	      o $session
		- An SSH connection link identifier, obtained from a call to ssh2_connect(3).

	      o $term_type
		-$term_type should correspond to one of the entries in the target system's /etc/termcap file.

	      o $env
		-$env may be passed as an associative array of name/value pairs to set in the target environment.

	      o $width
		- Width of the virtual terminal.

	      o $height
		- Height of the virtual terminal.

	      o $width_height_type
		-$width_height_type should be one of SSH2_TERM_UNIT_CHARS or SSH2_TERM_UNIT_PIXELS.

RETURN VALUES
EXAMPLES
       Example #1

	      Executing a command

	      <?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);
	      ?>

SEE ALSO
       ssh2_exec(3), ssh2_tunnel(3), ssh2_fetch_stream(3).

PHP Documentation Group 													     SSH2_SHELL(3)