zak Thu Jan 3 02:11:56 2002 EDT
Modified files:
/phpdoc/en/functions ftp.xml
Log:
Added documentation for ftp_close and ftp_exec. Fixed docs for ftp_quit. Minor
return value fixes.
Index: phpdoc/en/functions/ftp.xml
diff -u phpdoc/en/functions/ftp.xml:1.33 phpdoc/en/functions/ftp.xml:1.34
--- phpdoc/en/functions/ftp.xml:1.33 Wed Jan 2 22:34:31 2002
+++ phpdoc/en/functions/ftp.xml Thu Jan 3 02:11:55 2002
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.33 $ -->
+<!-- $Revision: 1.34 $ -->
<reference id="ref.ftp">
<title>FTP functions</title>
<titleabbrev>FTP</titleabbrev>
@@ -54,7 +54,7 @@
}
// close the FTP stream
-ftp_quit($conn_id);
+ftp_close($conn_id);
?>
]]>
</programlisting>
@@ -316,7 +316,7 @@
<funcsynopsis>
<funcprototype>
<funcdef>bool <function>ftp_pasv</function></funcdef>
- <paramdef>int <parameter>ftp_stream</parameter></paramdef>
+ <paramdef>resource <parameter>ftp_stream</parameter></paramdef>
<paramdef>bool <parameter>pasv</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -595,6 +595,25 @@
</refsect1>
</refentry>
+ <refentry id="function.ftp-close">
+ <refnamediv>
+ <refname>ftp_close</refname>
+ <refpurpose>Closes an FTP connection</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>void <function>ftp_close</function></funcdef>
+ <paramdef>resource <parameter>ftp_stream</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ <function>ftp_close</function> closes <parameter>ftp_stream</parameter>.
+ </para>
+ </refsect1>
+ </refentry>
+
<refentry id="function.ftp-quit">
<refnamediv>
<refname>ftp_quit</refname>
@@ -604,12 +623,13 @@
<title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef>boid <function>ftp_quit</function></funcdef>
+ <funcdef>void <function>ftp_quit</function></funcdef>
<paramdef>resource <parameter>ftp_stream</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
- <function>ftp_quit</function> closes <parameter>ftp_stream</parameter>.
+ <function>ftp_quit</function> is an alias for
+ <function>ftp_close</function>.
</para>
</refsect1>
</refentry>
@@ -631,7 +651,9 @@
</funcprototype>
</funcsynopsis>
<para>
- &warn.undocumented.func;
+ Sends a SITE EXEC <parameter>command</parameter> request to the ftp
+ server. Returns &false; if the request fails, returns the output of the
+ command otherwise.
</para>
</refsect1>
</refentry>
