pollita Fri Dec 24 20:03:18 2004 EDT
Added files:
/phpdoc/en/reference/ssh2 reference.xml constants.xml
/phpdoc/en/reference/ssh2/functions 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-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
Modified files:
/phpdoc/entities global.ent
Log:
Initial documentation of ssh2 extension
http://cvs.php.net/diff.php/phpdoc/entities/global.ent?r1=1.210&r2=1.211&ty=u
Index: phpdoc/entities/global.ent
diff -u phpdoc/entities/global.ent:1.210 phpdoc/entities/global.ent:1.211
--- phpdoc/entities/global.ent:1.210 Wed Dec 22 11:55:55 2004
+++ phpdoc/entities/global.ent Fri Dec 24 20:03:17 2004
@@ -1,6 +1,6 @@
<!-- -*- SGML -*-
- $Id: global.ent,v 1.210 2004/12/22 16:55:55 sean Exp $
+ $Id: global.ent,v 1.211 2004/12/25 01:03:17 pollita Exp $
Contains global "macros" for all the XML documents.
@@ -144,6 +144,7 @@
<!ENTITY url.libedit "http://sourceforge.net/projects/libedit/";>
<!ENTITY url.libiconv "http://www.gnu.org/software/libiconv/";>
<!ENTITY url.libxslt "http://xmlsoft.org/XSLT/";>
+<!ENTITY url.libssh2 "http://www.sourceforge.net/projects/libssh2/";>
<!ENTITY url.libpng "http://www.libpng.org/pub/png/libpng.html";>
<!ENTITY url.libxpm "ftp://metalab.unc.edu/pub/Linux/libs/X/!INDEX.html";>
<!ENTITY url.macosx "http://www.entropy.ch/software/macosx/";>
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/reference.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/reference.xml
+++ phpdoc/en/reference/ssh2/reference.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<reference id="ref.ssh2">
<title>ssh2 Functions</title>
<titleabbrev>ssh2</titleabbrev>
<partintro>
<section id="ssh2.intro">
&reftitle.intro;
<para>
Bindings to the <ulink url="&url.libssh2;">libssh2</ulink> library which
provide access to resources (shell, remote exec, tunneling, file transfer)
on a remote machine using a secure cryptographic transport.
</para>
</section>
<section id="ssh2.installation">
&reftitle.install;
<para>
&pecl.info;
<ulink url="&url.pecl.package;ssh2">&url.pecl.package;ssh2</ulink>.
</para>
<para>
You will also need version 0.4 or greater of the libssh2 library
(possibly higher, see release notes).
</para>
</section>
</partintro>
&reference.ssh2.functions;
</reference>
<!-- 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:"../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/constants.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/constants.xml
+++ phpdoc/en/reference/ssh2/constants.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<section id="ssh2.constants">
&reftitle.constants;
&extension.constants;
<variablelist>
<varlistentry>
<term>
<constant>SSH2_FINGERPRINT_MD5</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Flag to <function>ssh2_fingerprint</function> requesting hostkey
fingerprint as an MD5 hash.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_FINGERPRINT_SHA1</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Flag to <function>ssh2_fingerprint</function> requesting hostkey
fingerprint as an SHA1 hash.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_FINGERPRINT_HEX</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Flag to <function>ssh2_fingerprint</function> requesting hostkey
fingerprint as a string of hexits.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_FINGERPRINT_RAW</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Flag to <function>ssh2_fingerprint</function> requesting hostkey
fingerprint as a raw string of 8-bit characters.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_TERM_UNIT_CHARS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Flag to <function>ssh2_shell</function> specifying that
<parameter>width</paramter> and <parameter>height</paramter>
are provided as character sizes.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_TERM_UNIT_PIXELS</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Flag to <function>ssh2_shell</function> specifying that
<parameter>width</paramter> and <parameter>height</paramter>
are provided in pixel units.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_DEFAULT_TERM_WIDTH</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Default terminal width requested by <function>ssh2_shell</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_DEFAULT_TERM_HEIGHT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Default terminal height requested by <function>ssh2_shell</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_DEFAULT_TERM_UNIT</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Default terminal units requested by <function>ssh2_shell</function>.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_STREAM_STDIO</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Flag to <function>ssh2_fetch_stream</function> requesting STDIO subchannel.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_STREAM_STDERR</constant>
(<type>integer</type>)
</term>
<listitem>
<simpara>
Flag to <function>ssh2_fetch_stream</function> requesting STDERR
subchannel.
</simpara>
</listitem>
</varlistentry>
<varlistentry>
<term>
<constant>SSH2_DEFAULT_TERMINAL</constant>
(<type>string</type>)
</term>
<listitem>
<simpara>
Default terminal type (e.g. vt102, ansi, xterm, vanilla) requested
by <function>ssh2_shell</function>.
</simpara>
</listitem>
</varlistentry>
</variablelist>
</section>
<!-- 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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-none.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.ssh2-auth-none">
<refnamediv>
<refname>ssh2_auth_none</refname>
<refpurpose>
Authenticate as "none"
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>array</type><methodname>ssh2_auth_none</methodname>
<methodparam><type>resource</type><parameter>session</parameter></methodparam>
<methodparam><type>string</type><parameter>username</parameter></methodparam>
</methodsynopsis>
<para>
Attempt "none" authentication, returns a list of allowed methods on failed
authentication,
false on utter failure, or true on success
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-password.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Authenticate over SSH using a plain password
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-auth-pubkey-file.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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
choice="opt"><type>string</type><parameter>privkeyfile</parameter></methodparam>
<methodparam
choice="opt"><type>string</type><parameter>passphrase</parameter></methodparam>
</methodsynopsis>
<para>
Authenticate using a public key read from a file.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-connect.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-connect.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-connect.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Establish a connection to a remote SSH server and return a resource on
success, false on error
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-exec.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-exec.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-exec.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>stream</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>array</type><parameter>env</parameter></methodparam>
</methodsynopsis>
<para>
Execute a command at the remote end and allocate a channel for it.
Returns a stream on success or false on failure.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-fetch-stream.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>stream</type><methodname>ssh2_fetch_stream</methodname>
<methodparam><type>stream</type><parameter>channel</parameter></methodparam>
<methodparam><type>int</type><parameter>streamid</parameter></methodparam>
</methodsynopsis>
<para>
Fetch an alternate substream associated with an SSH2 channel stream.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-fingerprint.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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
choice="opt"><type>resource</type><parameter>session</parameter></methodparam>
<methodparam
choice="opt"><type>int</type><parameter>flags</parameter></methodparam>
</methodsynopsis>
<para>
Returns a server hostkey hash from an active session
Defaults to MD5 fingerprint encoded as ASCII hex values
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-methods-negotiated.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.ssh2-methods-negotiated">
<refnamediv>
<refname>ssh2_methods_negotiated</refname>
<refpurpose>
Return list of negotiaed 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>
Return list of negotiaed methods
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
Copies a file from the remote server to the local filesystem.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>stream</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>
<para>
Copy a file from the local filesystem to the remote server.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-lstat.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Stats a symbolic link on the remote filesystem <emphasis>without</emphasis>
following the link.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-mkdir.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>int</type><parameter>recursive</parameter></methodparam>
</methodsynopsis>
<para>
Creates a directory on the remote file server
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-readlink.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Returns the target of a symbolic link.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-realpath.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Translates <parameter>filename</parameter> into the effective real path
on the remote filesystem.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Renames a file on the remote filesystem
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-rmdir.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>filename</parameter></methodparam>
</methodsynopsis>
<para>
Removes a directory from the remote server's filesystem
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-stat.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Stats a remote file. If the file is a symbolic link, it follows the link
and stats its target.
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-symlink.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Creates a symbolic link on the remote filesystem
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Deletes a file on the remote filesystem
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>
<para>
Request the SFTP subsystem from an already connected SSH2 server
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-shell.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-shell.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-shell.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<refentry id="function.ssh2-shell">
<refnamediv>
<refname>ssh2_shell</refname>
<refpurpose>
Request an interactive shell
</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<methodsynopsis>
<type>stream</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>
<para>
Open a shell at the remote end and allocate a stream for it
</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:"../../../../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
-->
http://cvs.php.net/co.php/phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml?r=1.1&p=1
Index: phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml
+++ phpdoc/en/reference/ssh2/functions/ssh2-tunnel.xml
<?xml version='1.0' encoding='iso-8859-1'?>
<!-- $Revision: 1.1 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc. -->
<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>stream</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>
<para>
Open a socket stream to an arbitrary host/port by way of the
currently connected SSH server.
</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:"../../../../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
-->
