From b9801a975a7a2a3b70e9e00cbcaa9c151437c562 Mon Sep 17 00:00:00 2001
From: Sara Golemon <pollita@php.net>
Date: Thu, 30 Dec 2004 19:49:57 +0000
Subject: [PATCH] Additional Documentation for: ssh2_scp_send() ssh2_scp_recv()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@176093 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/ssh2/functions/ssh2-scp-recv.xml | 28 ++++++++++++++++++---
 reference/ssh2/functions/ssh2-scp-send.xml | 29 +++++++++++++++++++---
 2 files changed, 49 insertions(+), 8 deletions(-)

diff --git a/reference/ssh2/functions/ssh2-scp-recv.xml b/reference/ssh2/functions/ssh2-scp-recv.xml
index 74cf7f4e15..d056129f75 100644
--- a/reference/ssh2/functions/ssh2-scp-recv.xml
+++ b/reference/ssh2/functions/ssh2-scp-recv.xml
@@ -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>
diff --git a/reference/ssh2/functions/ssh2-scp-send.xml b/reference/ssh2/functions/ssh2-scp-send.xml
index 8e83595979..dabffafa66 100644
--- a/reference/ssh2/functions/ssh2-scp-send.xml
+++ b/reference/ssh2/functions/ssh2-scp-send.xml
@@ -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>