php man page for ssh2_sftp_symlink

SSH2_SFTP_SYMLINK(3)							 1						      SSH2_SFTP_SYMLINK(3)

ssh2_sftp_symlink - Create a symlink

SYNOPSIS
       bool ssh2_sftp_symlink (resource  $sftp, string	$target, string  $link)

DESCRIPTION
	Creates a symbolic link named $link on the remote filesystem pointing to $target.

PARAMETERS
	      o $sftp
		- An SSH2 SFTP resource opened by ssh2_sftp(3).

	      o $target
		- Target of the symbolic link.

	      o $link
		-

RETURN VALUES
	Returns TRUE on success or FALSE on failure.

EXAMPLES
       Example #1

	      Creating a symbolic link

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

	      ssh2_sftp_symlink($sftp, '/var/run/mysql.sock', '/tmp/mysql.sock');
	      ?>

SEE ALSO
       ssh2_sftp_readlink(3), symlink(3).

PHP Documentation Group 												      SSH2_SFTP_SYMLINK(3)