From 6e6bc33d3befd61f05b5a5f6282b899567db095f Mon Sep 17 00:00:00 2001
From: Sara Golemon <pollita@php.net>
Date: Thu, 30 Dec 2004 19:42:20 +0000
Subject: [PATCH] Additional documentation for: ssh2_sftp_rename() and
 ssh2_sftp_unlink()

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@176092 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/ssh2/functions/ssh2-sftp-rename.xml | 28 ++++++++++++++++---
 reference/ssh2/functions/ssh2-sftp-unlink.xml | 26 +++++++++++++++--
 2 files changed, 47 insertions(+), 7 deletions(-)

diff --git a/reference/ssh2/functions/ssh2-sftp-rename.xml b/reference/ssh2/functions/ssh2-sftp-rename.xml
index 3bafd23d48..95a8c8c397 100644
--- a/reference/ssh2/functions/ssh2-sftp-rename.xml
+++ b/reference/ssh2/functions/ssh2-sftp-rename.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-sftp-rename">
    <refnamediv>
@@ -17,9 +17,29 @@
      <methodparam><type>string</type><parameter>to</parameter></methodparam>
     </methodsynopsis>
 
-    <para>
-     Renames a file on the remote filesystem
-    </para>
+    <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);
+ssh2_auth_password($connection, 'username', 'password');
+$sftp = ssh2_sftp($connection);
+
+ssh2_sftp_rename($sftp, '/home/username/oldname', '/home/username/newname');
+?>
+]]>
+     </programlisting>
+    </example>
+
+    <simpara>
+     See Also:
+     <function>rename</function>
+    </simpara>
 
    </refsect1>
   </refentry>
diff --git a/reference/ssh2/functions/ssh2-sftp-unlink.xml b/reference/ssh2/functions/ssh2-sftp-unlink.xml
index b2ec862f9a..69900552a0 100644
--- a/reference/ssh2/functions/ssh2-sftp-unlink.xml
+++ b/reference/ssh2/functions/ssh2-sftp-unlink.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-sftp-unlink">
    <refnamediv>
@@ -16,9 +16,29 @@
      <methodparam><type>string</type><parameter>filename</parameter></methodparam>
     </methodsynopsis>
 
-    <para>
+    <simpara>
      Deletes a file on the remote filesystem
-    </para>
+    </simpara>
+
+    <example>
+     <title>Deleting a file</title>
+     <programlisting role="php">
+<![CDATA[
+<?php
+$connection = ssh2_connect('shell.example.com', 22);
+ssh2_auth_password($connection, 'username', 'password');
+$sftp = ssh2_sftp($connection);
+
+ssh2_sftp_unlink($sftp, '/home/username/stale_file');
+?>
+]]>
+     </programlisting>
+    </example>
+
+    <simpara>
+     See Also:
+     <function>unlink</function>
+    </simpara>
 
    </refsect1>
   </refentry>