pollita Thu Dec 30 14:49:58 2004 EDT
Modified files:
/phpdoc/en/reference/ssh2/functions ssh2-scp-send.xml
ssh2-scp-recv.xml
Log:
Additional Documentation for:
ssh2_scp_send()
ssh2_scp_recv()
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml:1.1
phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml:1.1 Fri Dec 24
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-scp-send.xml Thu Dec 30
14:49:57 2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc.
-->
<refentry id="function.ssh2-scp-send">
<refnamediv>
@@ -18,9 +18,30 @@
<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>
+ <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);
+ssh2_auth_password($connection, 'username', 'password');
+
+ssh2_scp_send($connection, '/local/filename', '/remote/filename', 0644);
+?>
+]]>
+ </programlisting>
+ </example>
+
+ <simpara>
+ See Also:
+ <function>ssh2_scp_recv</function>, and
+ <function>copy</function>
+ </simpara>
</refsect1>
</refentry>
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.1
phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml:1.1 Fri Dec 24
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-scp-recv.xml Thu Dec 30
14:49:57 2004
@@ -1,5 +1,5 @@
<?xml version='1.0' encoding='iso-8859-1'?>
-<!-- $Revision: 1.1 $ -->
+<!-- $Revision: 1.2 $ -->
<!-- Generated by xml_proto.php v2.1. Found in /scripts directory of phpdoc.
-->
<refentry id="function.ssh2-scp-recv">
<refnamediv>
@@ -17,9 +17,29 @@
<methodparam><type>string</type><parameter>local_file</parameter></methodparam>
</methodsynopsis>
- <para>
- Copies a file from the remote server to the local filesystem.
- </para>
+ <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">
+<![CDATA[
+<?php
+$connection = ssh2_connect('shell.example.com', 22);
+ssh2_auth_password($connection, 'username', 'password');
+
+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>
