cvs: phpdoc /en/reference/ssh2/functions ssh2-auth-hostbased-file.xml ssh2-auth-none.xml ssh2-auth-password.xml ssh2-auth-pubkey-file.xml
ssh2-connect.xml ssh2-exec.xml ssh2-fetch-stream.xml ssh2-fingerprint.xml ssh2-methods-negotiated.xml ssh2-publickey-list.xml ssh2-scp-recv.xml
ssh2-scp-send.xml ssh2-sftp-lstat.xml ssh2-sftp-mkdir.xml ssh2-sftp-readlink.xml ssh2-sftp-realpath.xml ssh2-sftp-rename.xml ssh2-sftp-rmdir.xml
ssh2-sftp-stat.xml ssh2-sftp-symlink.xml ssh2-sftp-unlink.xml ssh2-sftp.xml ssh2-shell.xml ssh2-tunnel.xml

From:	Mehdi Achour	Date:	Fri, 15 Jun 2007 00:13:12 +0000
Subject:	cvs: phpdoc /en/reference/ssh2/functions ssh2-auth-hostbased-file.xml ssh2-auth-none.xml ssh2-auth-password.xml ssh2-auth-pubkey-file.xml ssh2-connect.xml ssh2-exec.xml ssh2-fetch-stream.xml ssh2-fingerprint.xml ssh2-methods-negotiated.xml ssh2-publickey-list.xml ssh2-scp-recv.xml ssh2-scp-send.xml ssh2-sftp-lstat.xml ssh2-sftp-mkdir.xml ssh2-sftp-readlink.xml ssh2-sftp-realpath.xml ssh2-sftp-rename.xml ssh2-sftp-rmdir.xml ssh2-sftp-stat.xml ssh2-sftp-symlink.xml ssh2-sftp-unlink.xml ssh2-sftp.xml ssh2-shell.xml ssh2-tunnel.xml
Groups:	php.doc
Request:	Send a blank email to phpdoc+get-969376687@lists.php.net to get a copy of this message

didou Fri Jun 15 00:13:12 2007 UTC Modified files: /phpdoc/en/reference/ssh2/functions ssh2-auth-hostbased-file.xml ssh2-auth-none.xml ssh2-auth-password.xml ssh2-auth-pubkey-file.xml ssh2-connect.xml ssh2-exec.xml ssh2-fetch-stream.xml ssh2-fingerprint.xml ssh2-methods-negotiated.xml ssh2-publickey-list.xml ssh2-scp-recv.xml ssh2-scp-send.xml ssh2-sftp-lstat.xml ssh2-sftp-mkdir.xml ssh2-sftp-readlink.xml ssh2-sftp-realpath.xml ssh2-sftp-rename.xml ssh2-sftp-rmdir.xml ssh2-sftp-stat.xml ssh2-sftp-symlink.xml ssh2-sftp-unlink.xml ssh2-sftp.xml ssh2-shell.xml ssh2-tunnel.xml Log: WS, prepare for new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml?r1=1.1&r2=1.2&diff_format=u Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml diff -u phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml:1.1 phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml:1.2 --- phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml:1.1 Tue Feb 15 00:04:09 2005 +++ phpdoc/en/reference/ssh2/functions/ssh2-auth-hostbased-file.xml Fri Jun 15 00:13:12 2007 @@ -1,35 +1,33 @@ <?xml version='1.0' encoding='iso-8859-1'?> - - <refentry id="function.ssh2-auth-hostbased-file"> - <refnamediv> - <refname>ssh2_auth_hostbased_file</refname> - <refpurpose> - Authenticate using a public hostkey - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_auth_hostbased_file</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam><type>string</type><parameter>username</parameter></methodparam> - <methodparam><type>string</type><parameter>hostname</parameter></methodparam> - <methodparam><type>string</type><parameter>pubkeyfile</parameter></methodparam> - <methodparam><type>string</type><parameter>privkeyfile</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>local_username</parameter></methodparam> - </methodsynopsis> - - <simpara> - Authenticate using a public hostkey read from a file. If <parameter>privkeyfile</parameter> - is encrypted (which it should be), the passphrase must be provided. - If <parameter>local_username</parameter> is omitted, then the value for - <parameter>username</parameter> will be used for it. - </simpara> - - <example> - <title>Authentication using a public hostkey</title> - <programlisting role="php"> + +<refentry id="function.ssh2-auth-hostbased-file"> + <refnamediv> + <refname>ssh2_auth_hostbased_file</refname> + <refpurpose>Authenticate using a public hostkey</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_auth_hostbased_file</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>hostname</parameter></methodparam> + <methodparam><type>string</type><parameter>pubkeyfile</parameter></methodparam> + <methodparam><type>string</type><parameter>privkeyfile</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>local_username</parameter></methodparam> + </methodsynopsis> + + <simpara> + Authenticate using a public hostkey read from a file. If <parameter>privkeyfile</parameter> + is encrypted (which it should be), the passphrase must be provided. + If <parameter>local_username</parameter> is omitted, then the value for + <parameter>username</parameter> will be used for it. + </simpara> + + <example> + <title>Authentication using a public hostkey</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa')); @@ -44,17 +42,17 @@ } ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <note> - <simpara> - <function>ssh2_auth_hostbased_file</function> requires libssh2 >= 0.7 and PHP/SSH2 >= 0.7 - </simpara> - </note> + <note> + <simpara> + <function>ssh2_auth_hostbased_file</function> requires libssh2 >= 0.7 and PHP/SSH2 >= 0.7 + </simpara> + </note> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-auth-none"> - <refnamediv> - <refname>ssh2_auth_none</refname> - <refpurpose> - Authenticate as "none" - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>mixed</type><methodname>ssh2_auth_none</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam><type>string</type><parameter>username</parameter></methodparam> - </methodsynopsis> - - <simpara> - Attempt "none" authentication which usually will (and should) fail. - As part of the failure, this function will return an array of accepted - authentication methods. If the server does accept "none" as an - authentication method for <parameter>username</parameter>, this function - will simply return &true;. - </simpara> - - <example> - <title>Using <function>ssh2_auth_none</function> to retreive - a list of authentication methods.</title> - <programlisting role="php"> +<refentry id="function.ssh2-auth-none"> + <refnamediv> + <refname>ssh2_auth_none</refname> + <refpurpose>Authenticate as "none"</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>mixed</type><methodname>ssh2_auth_none</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + </methodsynopsis> + + <simpara> + Attempt "none" authentication which usually will (and should) fail. + As part of the failure, this function will return an array of accepted + authentication methods. If the server does accept "none" as an + authentication method for <parameter>username</parameter>, this function + will simply return &true;. + </simpara> + + <example> + <title>Using <function>ssh2_auth_none</function> to retreive + a list of authentication methods.</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -39,11 +37,11 @@ } ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-auth-password"> - <refnamediv> - <refname>ssh2_auth_password</refname> - <refpurpose> - Authenticate over SSH using a plain password - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_auth_password</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam><type>string</type><parameter>username</parameter></methodparam> - <methodparam><type>string</type><parameter>password</parameter></methodparam> - </methodsynopsis> +<refentry id="function.ssh2-auth-password"> + <refnamediv> + <refname>ssh2_auth_password</refname> + <refpurpose>Authenticate over SSH using a plain password</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_auth_password</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>password</parameter></methodparam> + </methodsynopsis> - <simpara> - Authenticate over SSH using a plain password - </simpara> + <simpara> + Authenticate over SSH using a plain password + </simpara> - <example> - <title>Authenticating with a password</title> - <programlisting role="php"> + <example> + <title>Authenticating with a password</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -35,11 +33,11 @@ } ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-auth-pubkey-file"> - <refnamediv> - <refname>ssh2_auth_pubkey_file</refname> - <refpurpose> - Authenticate using a public key - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_auth_pubkey_file</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam><type>string</type><parameter>username</parameter></methodparam> - <methodparam><type>string</type><parameter>pubkeyfile</parameter></methodparam> - <methodparam><type>string</type><parameter>privkeyfile</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> - </methodsynopsis> +<refentry id="function.ssh2-auth-pubkey-file"> + <refnamediv> + <refname>ssh2_auth_pubkey_file</refname> + <refpurpose>Authenticate using a public key</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_auth_pubkey_file</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>username</parameter></methodparam> + <methodparam><type>string</type><parameter>pubkeyfile</parameter></methodparam> + <methodparam><type>string</type><parameter>privkeyfile</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam> + </methodsynopsis> - <simpara> - Authenticate using a public key read from a file. If <parameter>privkeyfile</parameter> - is encrypted (which it should be), the passphrase must be provided. - </simpara> + <simpara> + Authenticate using a public key read from a file. If <parameter>privkeyfile</parameter> + is encrypted (which it should be), the passphrase must be provided. + </simpara> - <example> - <title>Authentication using a public key</title> - <programlisting role="php"> + <example> + <title>Authentication using a public key</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22, array('hostkey'=>'ssh-rsa')); @@ -40,11 +38,11 @@ } ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-connect"> - <refnamediv> - <refname>ssh2_connect</refname> - <refpurpose> - Connect to an SSH server - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ssh2_connect</methodname> - <methodparam><type>string</type><parameter>host</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>methods</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter></methodparam> - </methodsynopsis> - - <simpara> - Establish a connection to a remote SSH server and return a resource on success, &false; on error. - </simpara> - - <simpara> - <parameter>methods</parameter> may be an associative array with up to four parameters - as described below. - </simpara> - - <para> - <table> - <title><parameter>methods</parameter> may be an associative array - with any or all of the following parameters.</title> - <tgroup cols="3"> - <thead> - <row> - <entry>Index</entry> - <entry>Meaning</entry> - <entry>Supported Values*</entry> - </row> - </thead> - <tbody> - <row> - <entry>kex</entry> - <entry> - List of key exchange methods to advertise, comma separated - in order of preference. - </entry> - <entry> - <literal>diffie-hellman-group1-sha1</literal>, - <literal>diffie-hellman-group14-sha1</literal>, and - <literal>diffie-hellman-group-exchange-sha1</literal> - </entry> - </row> - <row> - <entry>hostkey</entry> - <entry> - List of hostkey methods to advertise, come separated - in order of preference. - </entry> - <entry> - <literal>ssh-rsa</literal> and - <literal>ssh-dss</literal> - </entry> - </row> - <row> - <entry>client_to_server</entry> - <entry> - Associative array containing crypt, compression, and - message authentication code (MAC) method preferences - for messages sent from client to server. - </entry> - <entry/> - </row> - <row> - <entry>server_to_client</entry> - <entry> - Associative array containing crypt, compression, and - message authentication code (MAC) method preferences - for messages sent from client to server. - </entry> - <entry/> - </row> - </tbody> - </tgroup> - </table> - </para> - - <simpara> - * - Supported Values are dependent on methods supported by underlying library. - See <ulink url="&url.libssh2;">libssh2</ulink> documentation for additional - information. - </simpara> - - <para> - <table> - <title> - <parameter>client_to_server</parameter> and - <parameter>server_to_client</parameter> may be an associative array - with any or all of the following parameters. - </title> - <tgroup cols="3"> - <thead> - <row> - <entry>Index</entry> - <entry>Meaning</entry> - <entry>Supported Values*</entry> - </row> - </thead> - <tbody> - <row> - <entry>crypt</entry> - <entry>List of crypto methods to advertise, comma separated - in order of preference.</entry> - <entry> - <literal>rijndael-cbc@lysator.liu.se</literal>, - <literal>aes256-cbc</literal>, - <literal>aes192-cbc</literal>, - <literal>aes128-cbc</literal>, - <literal>3des-cbc</literal>, - <literal>blowfish-cbc</literal>, - <literal>cast128-cbc</literal>, - <literal>arcfour</literal>, and - <literal>none**</literal> - </entry> - </row> - <row> - <entry>comp</entry> - <entry>List of compression methods to advertise, comma separated - in order of preference.</entry> - <entry> - <literal>zlib</literal> and - <literal>none</literal> - </entry> - </row> - <row> - <entry>mac</entry> - <entry>List of MAC methods to advertise, come separated - in order of preference.</entry> - <entry> - <literal>hmac-sha1</literal>, - <literal>hmac-sha1-96</literal>, - <literal>hmac-ripemd160</literal>, - <literal>hmac-ripemd160@openssh.com</literal>, and - <literal>none**</literal> - </entry> - </row> - </tbody> - </tgroup> - </table> - </para> - - <note> - <title>Crypt and MAC method "<literal>none</literal>"</title> - <simpara> - For security reasons, <literal>none</literal> is disabled by the underlying - <ulink url="&url.libssh2;">libssh2</ulink> library unless explicitly enabled - during build time by using the appropriate ./configure options. See documentation - for the underlying library for more information. - </simpara> - </note> - - <para> - <table> - <title><parameter>callbackss</parameter> may be an associative array - with any or all of the following parameters.</title> - <tgroup cols="3"> - <thead> - <row> - <entry>Index</entry> - <entry>Meaning</entry> - <entry>Prototype</entry> - </row> - </thead> - <tbody> - <row> - <entry>ignore</entry> - <entry> - Name of function to call when an - <constant>SSH2_MSG_IGNORE</constant> - packet is received - </entry> - <entry>void ignore_cb($message)</entry> - </row> - <row> - <entry>debug</entry> - <entry> - Name of function to call when an - <constant>SSH2_MSG_DEBUG</constant> - packet is received - </entry> - <entry>void debug_cb($message, $language, $always_display)</entry> - </row> - <row> - <entry>macerror</entry> - <entry> - Name of function to call when a - packet is received but the message authentication - code failed. If the callback returns &true;, - the mismatch will be ignored, otherwise the - connection will be terminated. - </entry> - <entry>bool macerror_cb($packet)</entry> - </row> - <row> - <entry>disconnect</entry> - <entry> - Name of function to call when an - <constant>SSH2_MSG_DISCONNECT</constant> - packet is received - </entry> - <entry>void disconnect_cb($reason, $message, $language)</entry> - </row> - </tbody> - </tgroup> - </table> - </para> - - <example> - <title> - Open a connection forcing 3des-cbc when sending packets, - any strength aes cipher when receiving packets, - no compression in either direction, - and Group1 key exchange. - </title> - <programlisting role="php"> +<refentry id="function.ssh2-connect"> + <refnamediv> + <refname>ssh2_connect</refname> + <refpurpose>Connect to an SSH server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ssh2_connect</methodname> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>methods</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>callbacks</parameter></methodparam> + </methodsynopsis> + + <simpara> + Establish a connection to a remote SSH server and return a resource on success, &false; on error. + </simpara> + + <simpara> + <parameter>methods</parameter> may be an associative array with up to four parameters + as described below. + </simpara> + + <para> + <table> + <title><parameter>methods</parameter> may be an associative array + with any or all of the following parameters.</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Index</entry> + <entry>Meaning</entry> + <entry>Supported Values*</entry> + </row> + </thead> + <tbody> + <row> + <entry>kex</entry> + <entry> + List of key exchange methods to advertise, comma separated + in order of preference. + </entry> + <entry> + <literal>diffie-hellman-group1-sha1</literal>, + <literal>diffie-hellman-group14-sha1</literal>, and + <literal>diffie-hellman-group-exchange-sha1</literal> + </entry> + </row> + <row> + <entry>hostkey</entry> + <entry> + List of hostkey methods to advertise, come separated + in order of preference. + </entry> + <entry> + <literal>ssh-rsa</literal> and + <literal>ssh-dss</literal> + </entry> + </row> + <row> + <entry>client_to_server</entry> + <entry> + Associative array containing crypt, compression, and + message authentication code (MAC) method preferences + for messages sent from client to server. + </entry> + <entry/> + </row> + <row> + <entry>server_to_client</entry> + <entry> + Associative array containing crypt, compression, and + message authentication code (MAC) method preferences + for messages sent from client to server. + </entry> + <entry/> + </row> + </tbody> + </tgroup> + </table> + </para> + + <simpara> + * - Supported Values are dependent on methods supported by underlying library. + See <ulink url="&url.libssh2;">libssh2</ulink> documentation for additional + information. + </simpara> + + <para> + <table> + <title> + <parameter>client_to_server</parameter> and + <parameter>server_to_client</parameter> may be an associative array + with any or all of the following parameters. + </title> + <tgroup cols="3"> + <thead> + <row> + <entry>Index</entry> + <entry>Meaning</entry> + <entry>Supported Values*</entry> + </row> + </thead> + <tbody> + <row> + <entry>crypt</entry> + <entry>List of crypto methods to advertise, comma separated + in order of preference.</entry> + <entry> + <literal>rijndael-cbc@lysator.liu.se</literal>, + <literal>aes256-cbc</literal>, + <literal>aes192-cbc</literal>, + <literal>aes128-cbc</literal>, + <literal>3des-cbc</literal>, + <literal>blowfish-cbc</literal>, + <literal>cast128-cbc</literal>, + <literal>arcfour</literal>, and + <literal>none**</literal> + </entry> + </row> + <row> + <entry>comp</entry> + <entry>List of compression methods to advertise, comma separated + in order of preference.</entry> + <entry> + <literal>zlib</literal> and + <literal>none</literal> + </entry> + </row> + <row> + <entry>mac</entry> + <entry>List of MAC methods to advertise, come separated + in order of preference.</entry> + <entry> + <literal>hmac-sha1</literal>, + <literal>hmac-sha1-96</literal>, + <literal>hmac-ripemd160</literal>, + <literal>hmac-ripemd160@openssh.com</literal>, and + <literal>none**</literal> + </entry> + </row> + </tbody> + </tgroup> + </table> + </para> + + <note> + <title>Crypt and MAC method "<literal>none</literal>"</title> + <simpara> + For security reasons, <literal>none</literal> is disabled by the underlying + <ulink url="&url.libssh2;">libssh2</ulink> library unless explicitly enabled + during build time by using the appropriate ./configure options. See documentation + for the underlying library for more information. + </simpara> + </note> + + <para> + <table> + <title><parameter>callbackss</parameter> may be an associative array + with any or all of the following parameters.</title> + <tgroup cols="3"> + <thead> + <row> + <entry>Index</entry> + <entry>Meaning</entry> + <entry>Prototype</entry> + </row> + </thead> + <tbody> + <row> + <entry>ignore</entry> + <entry> + Name of function to call when an + <constant>SSH2_MSG_IGNORE</constant> + packet is received + </entry> + <entry>void ignore_cb($message)</entry> + </row> + <row> + <entry>debug</entry> + <entry> + Name of function to call when an + <constant>SSH2_MSG_DEBUG</constant> + packet is received + </entry> + <entry>void debug_cb($message, $language, $always_display)</entry> + </row> + <row> + <entry>macerror</entry> + <entry> + Name of function to call when a + packet is received but the message authentication + code failed. If the callback returns &true;, + the mismatch will be ignored, otherwise the + connection will be terminated. + </entry> + <entry>bool macerror_cb($packet)</entry> + </row> + <row> + <entry>disconnect</entry> + <entry> + Name of function to call when an + <constant>SSH2_MSG_DISCONNECT</constant> + packet is received + </entry> + <entry>void disconnect_cb($reason, $message, $language)</entry> + </row> + </tbody> + </tgroup> + </table> + </para> + + <example> + <title> + Open a connection forcing 3des-cbc when sending packets, + any strength aes cipher when receiving packets, + no compression in either direction, + and Group1 key exchange. + </title> + <programlisting role="php"> <![CDATA[ <?php /* Notify the user if the server terminates the connection */ @@ -247,25 +245,25 @@ if (!$connection) die('Connection failed'); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - Once connected, the client should verify the server's hostkey - using <function>ssh2_fingerprint</function>, then authenticate - using either password or public key. - </simpara> - - <simpara> - See Also: - <function>ssh2_fingerprint</function>, - <function>ssh2_auth_none</function>, - <function>ssh2_auth_password</function>, and - <function>ssh2_auth_pubkey_file</function> - </simpara> + <simpara> + Once connected, the client should verify the server's hostkey + using <function>ssh2_fingerprint</function>, then authenticate + using either password or public key. + </simpara> + + <simpara> + See Also: + <function>ssh2_fingerprint</function>, + <function>ssh2_auth_none</function>, + <function>ssh2_auth_password</function>, and + <function>ssh2_auth_pubkey_file</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-exec"> - <refnamediv> - <refname>ssh2_exec</refname> - <refpurpose> - Execute a command on a remote server - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ssh2_exec</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam><type>string</type><parameter>command</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>pty</parameter></methodparam> - <methodparam choice="opt"><type>array</type><parameter>env</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>height</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>width_height_type</parameter></methodparam> - </methodsynopsis> +<refentry id="function.ssh2-exec"> + <refnamediv> + <refname>ssh2_exec</refname> + <refpurpose>Execute a command on a remote server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ssh2_exec</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>command</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>pty</parameter></methodparam> + <methodparam choice="opt"><type>array</type><parameter>env</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>height</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>width_height_type</parameter></methodparam> + </methodsynopsis> - <simpara> - Execute a command at the remote end and allocate a channel for it. - Returns a stream on success or &false; on failure. - </simpara> + <simpara> + Execute a command at the remote end and allocate a channel for it. + Returns a stream on success or &false; on failure. + </simpara> - <example> - <title>Executing a command</title> - <programlisting role="php"> + <example> + <title>Executing a command</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -37,17 +35,17 @@ $stream = ssh2_exec($connection, '/usr/local/bin/php -i'); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>ssh2_connect</function>, - <function>ssh2_shell</function>, and - <function>ssh2_tunnel</function> - </simpara> - </refsect1> - </refentry> + <simpara> + See Also: + <function>ssh2_connect</function>, + <function>ssh2_shell</function>, and + <function>ssh2_tunnel</function> + </simpara> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-fetch-stream"> - <refnamediv> - <refname>ssh2_fetch_stream</refname> - <refpurpose> - Fetch an extended data stream - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ssh2_fetch_stream</methodname> - <methodparam><type>resource</type><parameter>channel</parameter></methodparam> - <methodparam><type>int</type><parameter>streamid</parameter></methodparam> - </methodsynopsis> - - <simpara> - Fetches an alternate substream associated with an SSH2 channel stream - identified by <parameter>streamid</parameter>. The SSH2 protocol - currently defines only one substream, STDERR, which has a substream ID - of <constant>SSH2_STREAM_STDERR</constant> (defined as 1). - </simpara> - - <example> - <title>Opening a shell and retrieving the stderr stream associated with it.</title> - <programlisting role="php"> +<refentry id="function.ssh2-fetch-stream"> + <refnamediv> + <refname>ssh2_fetch_stream</refname> + <refpurpose>Fetch an extended data stream</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ssh2_fetch_stream</methodname> + <methodparam><type>resource</type><parameter>channel</parameter></methodparam> + <methodparam><type>int</type><parameter>streamid</parameter></methodparam> + </methodsynopsis> + + <simpara> + Fetches an alternate substream associated with an SSH2 channel stream + identified by <parameter>streamid</parameter>. The SSH2 protocol + currently defines only one substream, STDERR, which has a substream ID + of <constant>SSH2_STREAM_STDERR</constant> (defined as 1). + </simpara> + + <example> + <title>Opening a shell and retrieving the stderr stream associated with it.</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -35,18 +33,18 @@ $stderr_stream = ssh2_fetch_stream($stdio_stream, SSH2_STREAM_STDERR); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>ssh2_shell</function>, - <function>ssh2_exec</function>, and - <function>ssh2_connect</function> - </simpara> + <simpara> + See Also: + <function>ssh2_shell</function>, + <function>ssh2_exec</function>, and + <function>ssh2_connect</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-fingerprint"> - <refnamediv> - <refname>ssh2_fingerprint</refname> - <refpurpose> - Retreive fingerprint of remote server - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ssh2_fingerprint</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> - </methodsynopsis> - - <simpara> - Returns a server hostkey hash from an active session. - Defaults to MD5 fingerprint encoded as ASCII hex values. - </simpara> - - <simpara> - <parameter>flags</parameter> may be either of - <constant>SSH2_FINGERPRINT_MD5</constant> or - <constant>SSH2_FINGERPRINT_SHA1</constant> logically ORed with - <constant>SSH2_FINGERPRINT_HEX</constant> or - <constant>SSH2_FINGERPRINT_RAW</constant>. - Defaults to <constant>SSH2_FINGERPRINT_MD5</constant> | - <constant>SSH2_FINGERPRINT_HEX</constant>. - </simpara> - - <example> - <title>Checking the fingerprint against a known value</title> - <programlisting role="php"> +<refentry id="function.ssh2-fingerprint"> + <refnamediv> + <refname>ssh2_fingerprint</refname> + <refpurpose>Retreive fingerprint of remote server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ssh2_fingerprint</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>flags</parameter></methodparam> + </methodsynopsis> + + <simpara> + Returns a server hostkey hash from an active session. + Defaults to MD5 fingerprint encoded as ASCII hex values. + </simpara> + + <simpara> + <parameter>flags</parameter> may be either of + <constant>SSH2_FINGERPRINT_MD5</constant> or + <constant>SSH2_FINGERPRINT_SHA1</constant> logically ORed with + <constant>SSH2_FINGERPRINT_HEX</constant> or + <constant>SSH2_FINGERPRINT_RAW</constant>. + Defaults to <constant>SSH2_FINGERPRINT_MD5</constant> | + <constant>SSH2_FINGERPRINT_HEX</constant>. + </simpara> + + <example> + <title>Checking the fingerprint against a known value</title> + <programlisting role="php"> <![CDATA[ <?php $known_host = '6F89C2F0A719B30CC38ABDF90755F2E4'; @@ -49,11 +47,11 @@ } ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-methods-negotiated"> - <refnamediv> - <refname>ssh2_methods_negotiated</refname> - <refpurpose> - Return list of negotiated methods - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>ssh2_methods_negotiated</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - </methodsynopsis> - - <simpara> - Returns list of negotiated methods. - </simpara> - - <example> - <title>Determining what methods were negotiated</title> - <programlisting role="php"> +<refentry id="function.ssh2-methods-negotiated"> + <refnamediv> + <refname>ssh2_methods_negotiated</refname> + <refpurpose>Return list of negotiated methods</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>ssh2_methods_negotiated</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + </methodsynopsis> + + <para> + Returns list of negotiated methods. + </para> + + <para> + <example> + <title>Determining what methods were negotiated</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -43,16 +42,18 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + + <para> + See Also: + <function>ssh2_connect</function> + </para> - <simpara> - See Also: - <function>ssh2_connect</function> - </simpara> + </refsect1> - </refsect1> - </refentry> +</refentry>  +  <refentry id="function.ssh2-publickey-list"> <refnamediv> @@ -57,7 +57,7 @@ <row> <entry>name</entry> <entry>Name of algorithm used by this publickey, for example: - <literal>ssh-dss</literal> or <literal>ssh-rsa</literal>.</entry> + <literal>ssh-dss</literal> or <literal>ssh-rsa</literal>.</entry> </row> <row> <entry>blob</entry> @@ -65,10 +65,10 @@ </row> <row> <entry>attrs</entry> - <entry>Attributes assigned to this publickey. - The most common attribute, and the only one supported by - publickey version 1 servers, is <literal>comment</literal>, - which may be any freeform string.</entry> + <entry>Attributes assigned to this publickey. The most common + attribute, and the only one supported by publickey version 1 + servers, is <literal>comment</literal>, which may be any freeform + string.</entry> </row> </tbody> </tgroup> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml diff -u phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.2 phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.3 --- phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.2 Thu Dec 30 19:49:57 2004 +++ phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml Fri Jun 15 00:13:12 2007 @@ -1,29 +1,26 @@ <?xml version='1.0' encoding='iso-8859-1'?> - +  - <refentry id="function.ssh2-scp-recv"> - <refnamediv> - <refname>ssh2_scp_recv</refname> - <refpurpose> - Request a file via SCP - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_scp_recv</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> - <methodparam><type>string</type><parameter>local_file</parameter></methodparam> - </methodsynopsis> - - <simpara> - Copy a file from the remote server to the local filesystem using the SCP protocol. - </simpara> - - <example> - <title>Downloading a file via SCP</title> - <programlisting role="php"> +<refentry id="function.ssh2-scp-recv"> + <refnamediv> + <refname>ssh2_scp_recv</refname> + <refpurpose>Request a file via SCP</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_scp_recv</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> + <methodparam><type>string</type><parameter>local_file</parameter></methodparam> + </methodsynopsis> + <para> + Copy a file from the remote server to the local filesystem using the SCP protocol. + </para> + <para> + <example> + <title>Downloading a file via SCP</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -32,17 +29,16 @@ ssh2_scp_recv($connection, '/remote/filename', '/local/filename'); ?> ]]> - </programlisting> - </example> - - <simpara> - See Also: - <function>ssh2_scp_send</function>, and - <function>copy</function> - </simpara> - - </refsect1> - </refentry> + </programlisting> + </example> + </para> + <para> + See Also: + <function>ssh2_scp_send</function>, and + <function>copy</function> + </para> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-scp-send"> - <refnamediv> - <refname>ssh2_scp_send</refname> - <refpurpose> - Send a file via SCP - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_scp_send</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam><type>string</type><parameter>local_file</parameter></methodparam> - <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>create_mode</parameter></methodparam> - </methodsynopsis> - - <simpara> - Copy a file from the local filesystem to the remote server using the SCP protocol. - The file will be created with the mode specified by <parameter>create_mode</parameter>. - </simpara> - - <example> - <title>Uploading a file via SCP</title> - <programlisting role="php"> +<refentry id="function.ssh2-scp-send"> + <refnamediv> + <refname>ssh2_scp_send</refname> + <refpurpose>Send a file via SCP</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_scp_send</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>local_file</parameter></methodparam> + <methodparam><type>string</type><parameter>remote_file</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>create_mode</parameter></methodparam> + </methodsynopsis> + + <simpara> + Copy a file from the local filesystem to the remote server using the SCP protocol. + The file will be created with the mode specified by <parameter>create_mode</parameter>. + </simpara> + + <example> + <title>Uploading a file via SCP</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -34,17 +32,17 @@ ssh2_scp_send($connection, '/local/filename', '/remote/filename', 0644); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>ssh2_scp_recv</function>, and - <function>copy</function> - </simpara> + <simpara> + See Also: + <function>ssh2_scp_recv</function>, and + <function>copy</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-lstat"> - <refnamediv> - <refname>ssh2_sftp_lstat</refname> - <refpurpose> - Stat a symbolic link - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>ssh2_sftp_lstat</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>path</parameter></methodparam> - </methodsynopsis> - - <simpara> - Stats a symbolic link on the remote filesystem <emphasis>without</emphasis> - following the link. This function is similar to using the - <function>lstat</function> function with the - <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper in PHP5 - and returns the same values. See the documentation for - <function>stat</function> for details on the values which may be returned. - </simpara> - - <example> - <title>Stating a symbolic link via SFTP</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-lstat"> + <refnamediv> + <refname>ssh2_sftp_lstat</refname> + <refpurpose>Stat a symbolic link</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>ssh2_sftp_lstat</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> + + <simpara> + Stats a symbolic link on the remote filesystem <emphasis>without</emphasis> + following the link. This function is similar to using the + <function>lstat</function> function with the + <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper in PHP5 + and returns the same values. See the documentation for + <function>stat</function> for details on the values which may be returned. + </simpara> + + <example> + <title>Stating a symbolic link via SFTP</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -44,18 +42,18 @@ $mode = $statinfo['mode']; ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>ssh2_sftp_stat</function>, - <function>lstat</function>, and - <function>stat</function> - </simpara> + <simpara> + See Also: + <function>ssh2_sftp_stat</function>, + <function>lstat</function>, and + <function>stat</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-mkdir"> - <refnamediv> - <refname>ssh2_sftp_mkdir</refname> - <refpurpose> - Create a directory - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_sftp_mkdir</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>dirname</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> - <methodparam choice="opt"><type>bool</type><parameter>recursive</parameter></methodparam> - </methodsynopsis> - - <simpara> - Creates a directory on the remote file server with permissions set to - <parameter>mode</parameter>. If <parameter>recursive</parameter> is &true; - any parent directories required for <parameter>dirname</parameter> will - be automatically created as well. - This function is similar to using <function>mkdir</function> with the - <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper. - </simpara> - - <example> - <title>Creating a directory on a remote server</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-mkdir"> + <refnamediv> + <refname>ssh2_sftp_mkdir</refname> + <refpurpose>Create a directory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_sftp_mkdir</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>dirname</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>mode</parameter></methodparam> + <methodparam choice="opt"><type>bool</type><parameter>recursive</parameter></methodparam> + </methodsynopsis> + + <simpara> + Creates a directory on the remote file server with permissions set to + <parameter>mode</parameter>. If <parameter>recursive</parameter> is &true; + any parent directories required for <parameter>dirname</parameter> will + be automatically created as well. + This function is similar to using <function>mkdir</function> with the + <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper. + </simpara> + + <example> + <title>Creating a directory on a remote server</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -40,17 +38,17 @@ /* Or: mkdir("ssh2.sftp://$sftp/home/username/newdir"); */ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>mkdir</function>, and - <function>ssh2_sftp_rmdir</function> - </simpara> + <simpara> + See Also: + <function>mkdir</function>, and + <function>ssh2_sftp_rmdir</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-readlink"> - <refnamediv> - <refname>ssh2_sftp_readlink</refname> - <refpurpose> - Return the target of a symbolic link - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ssh2_sftp_readlink</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>link</parameter></methodparam> - </methodsynopsis> - - <simpara> - Returns the target of a symbolic link. - </simpara> - - <example> - <title>Reading a symbolic link</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-readlink"> + <refnamediv> + <refname>ssh2_sftp_readlink</refname> + <refpurpose>Return the target of a symbolic link</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ssh2_sftp_readlink</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>link</parameter></methodparam> + </methodsynopsis> + + <simpara> + Returns the target of a symbolic link. + </simpara> + + <example> + <title>Reading a symbolic link</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -33,17 +31,17 @@ /* $target is now (e.g.): '/var/run/mysql.sock' */ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>readlink</function>, and - <function>ssh2_sftp_symlink</function> - </simpara> + <simpara> + See Also: + <function>readlink</function>, and + <function>ssh2_sftp_symlink</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-realpath"> - <refnamediv> - <refname>ssh2_sftp_realpath</refname> - <refpurpose> - Resolve the realpath of a provided path string - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>string</type><methodname>ssh2_sftp_realpath</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - </methodsynopsis> - - <simpara> - Translates <parameter>filename</parameter> into the effective real path - on the remote filesystem. - </simpara> - - <example> - <title>Resolving a pathname</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-realpath"> + <refnamediv> + <refname>ssh2_sftp_realpath</refname> + <refpurpose>Resolve the realpath of a provided path string</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>string</type><methodname>ssh2_sftp_realpath</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + + <simpara> + Translates <parameter>filename</parameter> into the effective real path + on the remote filesystem. + </simpara> + + <example> + <title>Resolving a pathname</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -34,18 +32,18 @@ /* $realpath is now: '/etc/passwd' */ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>realpath</function>, and - <function>ssh2_sftp_symlink</function> - <function>ssh2_sftp_readlink</function> - </simpara> + <simpara> + See Also: + <function>realpath</function>, and + <function>ssh2_sftp_symlink</function> + <function>ssh2_sftp_readlink</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-rename"> - <refnamediv> - <refname>ssh2_sftp_rename</refname> - <refpurpose> - Rename a remote file - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_sftp_rename</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>from</parameter></methodparam> - <methodparam><type>string</type><parameter>to</parameter></methodparam> - </methodsynopsis> - - <simpara> - Renames a file on the remote filesystem. - </simpara> - - <example> - <title>Renaming a file via sftp</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-rename"> + <refnamediv> + <refname>ssh2_sftp_rename</refname> + <refpurpose>Rename a remote file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_sftp_rename</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>from</parameter></methodparam> + <methodparam><type>string</type><parameter>to</parameter></methodparam> + </methodsynopsis> + + <simpara> + Renames a file on the remote filesystem. + </simpara> + + <example> + <title>Renaming a file via sftp</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -33,16 +31,16 @@ ssh2_sftp_rename($sftp, '/home/username/oldname', '/home/username/newname'); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>rename</function> - </simpara> + <simpara> + See Also: + <function>rename</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-rmdir"> - <refnamediv> - <refname>ssh2_sftp_rmdir</refname> - <refpurpose> - Remove a directory - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_sftp_rmdir</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>dirname</parameter></methodparam> - </methodsynopsis> - - <simpara> - Removes a directory from the remote file server. - This function is similar to using <function>rmdir</function> with the - <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper. - </simpara> - - <example> - <title>Removing a directory on a remote server</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-rmdir"> + <refnamediv> + <refname>ssh2_sftp_rmdir</refname> + <refpurpose>Remove a directory</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_sftp_rmdir</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>dirname</parameter></methodparam> + </methodsynopsis> + + <simpara> + Removes a directory from the remote file server. + This function is similar to using <function>rmdir</function> with the + <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper. + </simpara> + + <example> + <title>Removing a directory on a remote server</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -35,18 +33,18 @@ /* Or: rmdir("ssh2.sftp://$sftp/home/username/dirtodel"); */ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>rmdir</function>, and - <function>ssh2_sftp_mkdir</function> - </simpara> + <simpara> + See Also: + <function>rmdir</function>, and + <function>ssh2_sftp_mkdir</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-stat"> - <refnamediv> - <refname>ssh2_sftp_stat</refname> - <refpurpose> - Stat a file on a remote filesystem - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>ssh2_sftp_stat</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>path</parameter></methodparam> - </methodsynopsis> - - <simpara> - Stats a file on the remote filesystem following any symbolic links. - This function is similar to using the <function>stat</function> function - with the <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper in PHP5 - and returns the same values. See the documentation for - <function>stat</function> for details on the values which may be returned. - </simpara> - - <example> - <title>Stating a file via SFTP</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-stat"> + <refnamediv> + <refname>ssh2_sftp_stat</refname> + <refpurpose>Stat a file on a remote filesystem</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>ssh2_sftp_stat</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>path</parameter></methodparam> + </methodsynopsis> + + <simpara> + Stats a file on the remote filesystem following any symbolic links. + This function is similar to using the <function>stat</function> function + with the <link linkend="wrappers.ssh2">ssh2.sftp://</link> wrapper in PHP5 + and returns the same values. See the documentation for + <function>stat</function> for details on the values which may be returned. + </simpara> + + <example> + <title>Stating a file via SFTP</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -43,18 +41,18 @@ $mode = $statinfo['mode']; ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>ssh2_sftp_lstat</function>, - <function>lstat</function>, and - <function>stat</function> - </simpara> + <simpara> + See Also: + <function>ssh2_sftp_lstat</function>, + <function>lstat</function>, and + <function>stat</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-symlink"> - <refnamediv> - <refname>ssh2_sftp_symlink</refname> - <refpurpose> - Create a symlink - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_sftp_symlink</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>target</parameter></methodparam> - <methodparam><type>string</type><parameter>link</parameter></methodparam> - </methodsynopsis> - - <simpara> - Creates a symbolic link named <parameter>link</parameter> on the remote filesystem - pointing to <parameter>target</parameter>. - </simpara> - - <example> - <title>Creating a symbolic link</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-symlink"> + <refnamediv> + <refname>ssh2_sftp_symlink</refname> + <refpurpose>Create a symlink</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_sftp_symlink</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>target</parameter></methodparam> + <methodparam><type>string</type><parameter>link</parameter></methodparam> + </methodsynopsis> + + <simpara> + Creates a symbolic link named <parameter>link</parameter> on the remote filesystem + pointing to <parameter>target</parameter>. + </simpara> + + <example> + <title>Creating a symbolic link</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -34,17 +32,17 @@ ssh2_sftp_symlink($sftp, '/var/run/mysql.sock', '/tmp/mysql.sock'); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>symlink</function>, and - <function>ssh2_sftp_readlink</function> - </simpara> + <simpara> + See Also: + <function>symlink</function>, and + <function>ssh2_sftp_readlink</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp-unlink"> - <refnamediv> - <refname>ssh2_sftp_unlink</refname> - <refpurpose> - Delete a file - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>bool</type><methodname>ssh2_sftp_unlink</methodname> - <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> - <methodparam><type>string</type><parameter>filename</parameter></methodparam> - </methodsynopsis> - - <simpara> - Deletes a file on the remote filesystem - </simpara> - - <example> - <title>Deleting a file</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp-unlink"> + <refnamediv> + <refname>ssh2_sftp_unlink</refname> + <refpurpose>Delete a file</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>bool</type><methodname>ssh2_sftp_unlink</methodname> + <methodparam><type>resource</type><parameter>sftp</parameter></methodparam> + <methodparam><type>string</type><parameter>filename</parameter></methodparam> + </methodsynopsis> + + <simpara> + Deletes a file on the remote filesystem + </simpara> + + <example> + <title>Deleting a file</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -32,16 +30,16 @@ ssh2_sftp_unlink($sftp, '/home/username/stale_file'); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>unlink</function> - </simpara> + <simpara> + See Also: + <function>unlink</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-sftp"> - <refnamediv> - <refname>ssh2_sftp</refname> - <refpurpose> - Initialize SFTP subsystem - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ssh2_sftp</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - </methodsynopsis> - - <simpara> - Request the SFTP subsystem from an already connected SSH2 server. - </simpara> - - <simpara> - This method returns an <literal>SSH2 SFTP</literal> resource for use with - all other ssh2_sftp_*() methods and the - <link linkend="wrappers.ssh2">ssh2.sftp://</link> fopen wrapper. - </simpara> - - <example> - <title>Opening a file via SFTP</title> - <programlisting role="php"> +<refentry id="function.ssh2-sftp"> + <refnamediv> + <refname>ssh2_sftp</refname> + <refpurpose>Initialize SFTP subsystem</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ssh2_sftp</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + </methodsynopsis> + + <simpara> + Request the SFTP subsystem from an already connected SSH2 server. + </simpara> + + <simpara> + This method returns an <literal>SSH2 SFTP</literal> resource for use with + all other ssh2_sftp_*() methods and the + <link linkend="wrappers.ssh2">ssh2.sftp://</link> fopen wrapper. + </simpara> + + <example> + <title>Opening a file via SFTP</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -38,17 +36,17 @@ $stream = fopen("ssh2.sftp://$sftp/path/to/file", 'r'); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>ssh2_scp_send</function>, and - <function>ssh2_scp_recv</function> - </simpara> + <simpara> + See Also: + <function>ssh2_scp_send</function>, and + <function>ssh2_scp_recv</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-shell"> - <refnamediv> - <refname>ssh2_shell</refname> - <refpurpose> - Request an interactive shell - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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></methodparam> - <methodparam choice="opt"><type>array</type><parameter>env</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>height</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>width_height_type</parameter></methodparam> - </methodsynopsis> - - <simpara> - Open a shell at the remote end and allocate a stream for it. - <parameter>term_type</parameter> should correspond to one of the entries - in the target system's <literal>/etc/termcap</literal> file and defaults to <literal>vanilla</literal>. - <parameter>env</parameter> may be passed as an associative array of name/value pairs - to set in the target environment. - </simpara> - - <simpara> - <parameter>width</parameter>, and <parameter>height</parameter> - define the width and height of the virtual terminal allocated for the shell process. - <parameter>width_height_type</parameter> should be one of - <constant>SSH2_TERM_UNIT_CHARS</constant> or - <constant>SSH2_TERM_UNIT_PIXELS</constant>. - </simpara> - - <example> - <title>Executing a command</title> - <programlisting role="php"> +<refentry id="function.ssh2-shell"> + <refnamediv> + <refname>ssh2_shell</refname> + <refpurpose>Request an interactive shell</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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></methodparam> + <methodparam choice="opt"><type>array</type><parameter>env</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>width</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>height</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>width_height_type</parameter></methodparam> + </methodsynopsis> + + <simpara> + Open a shell at the remote end and allocate a stream for it. + <parameter>term_type</parameter> should correspond to one of the entries + in the target system's <literal>/etc/termcap</literal> file and defaults to <literal>vanilla</literal>. + <parameter>env</parameter> may be passed as an associative array of name/value pairs + to set in the target environment. + </simpara> + + <simpara> + <parameter>width</parameter>, and <parameter>height</parameter> + define the width and height of the virtual terminal allocated for the shell process. + <parameter>width_height_type</parameter> should be one of + <constant>SSH2_TERM_UNIT_CHARS</constant> or + <constant>SSH2_TERM_UNIT_PIXELS</constant>. + </simpara> + + <example> + <title>Executing a command</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -47,18 +45,18 @@ $stream = ssh2_shell($connection, 'vt102', null, 80, 24, SSH2_TERM_UNIT_CHARS); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>ssh2_exec</function>, - <function>ssh2_tunnel</function>, and - <function>ssh2_fetch_stream</function> - </simpara> + <simpara> + See Also: + <function>ssh2_exec</function>, + <function>ssh2_tunnel</function>, and + <function>ssh2_fetch_stream</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry>  +  - <refentry id="function.ssh2-tunnel"> - <refnamediv> - <refname>ssh2_tunnel</refname> - <refpurpose> - Open a tunnel through a remote server - </refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>resource</type><methodname>ssh2_tunnel</methodname> - <methodparam><type>resource</type><parameter>session</parameter></methodparam> - <methodparam><type>string</type><parameter>host</parameter></methodparam> - <methodparam><type>int</type><parameter>port</parameter></methodparam> - </methodsynopsis> - - <simpara> - Open a socket stream to an arbitrary host/port by way of the - currently connected SSH server. - </simpara> - - <example> - <title>Opening a tunnel to an arbitrary host</title> - <programlisting role="php"> +<refentry id="function.ssh2-tunnel"> + <refnamediv> + <refname>ssh2_tunnel</refname> + <refpurpose>Open a tunnel through a remote server</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>resource</type><methodname>ssh2_tunnel</methodname> + <methodparam><type>resource</type><parameter>session</parameter></methodparam> + <methodparam><type>string</type><parameter>host</parameter></methodparam> + <methodparam><type>int</type><parameter>port</parameter></methodparam> + </methodsynopsis> + + <simpara> + Open a socket stream to an arbitrary host/port by way of the + currently connected SSH server. + </simpara> + + <example> + <title>Opening a tunnel to an arbitrary host</title> + <programlisting role="php"> <![CDATA[ <?php $connection = ssh2_connect('shell.example.com', 22); @@ -33,17 +31,17 @@ $tunnel = ssh2_tunnel($connection, '10.0.0.101', 12345); ?> ]]> - </programlisting> - </example> + </programlisting> + </example> - <simpara> - See Also: - <function>ssh2_connect</function>, and - <function>fsockopen</function> - </simpara> + <simpara> + See Also: + <function>ssh2_connect</function>, and + <function>fsockopen</function> + </simpara> - </refsect1> - </refentry> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: