pollita Thu Dec 30 14:42:21 2004 EDT
Modified files:
/phpdoc/en/reference/ssh2/functions ssh2-sftp-rename.xml
ssh2-sftp-unlink.xml
Log:
Additional documentation for: ssh2_sftp_rename() and ssh2_sftp_unlink()
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml:1.1
phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml:1.1 Fri Dec 24
20:03:17 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-rename.xml Thu Dec 30
14:42:20 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-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>
http://cvs.php.net/diff.php/phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml?r1=1.1&r2=1.2&ty=u
Index: phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml
diff -u phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml:1.1
phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml:1.2
--- phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml:1.1 Fri Dec 24
20:03:18 2004
+++ phpdoc/en/reference/ssh2/functions/ssh2-sftp-unlink.xml Thu Dec 30
14:42:20 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-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>
