From 7ec3650749b2c4baf1600bf09fdf3e41f06d87d1 Mon Sep 17 00:00:00 2001
From: Derek Jones <derek.jones@ellislab.com>
Date: Mon, 22 Mar 2010 11:11:30 -0500
Subject: added documentation for philsturgeon's submission of download() for
 the FTP library

---
 user_guide/libraries/ftp.html | 13 +++++++++++++
 1 file changed, 13 insertions(+)

(limited to 'user_guide/libraries/ftp.html')

diff --git a/user_guide/libraries/ftp.html b/user_guide/libraries/ftp.html
index 10acdcdab..b5194e8ad 100644
--- a/user_guide/libraries/ftp.html
+++ b/user_guide/libraries/ftp.html
@@ -188,6 +188,19 @@ Example:</p>
 <p>Permissions are available if you are running PHP 5 and can be passed as an <kbd>octal</kbd> value in the fourth parameter.</p>
 
 
+<h2>$this->ftp->download()</h2>
+
+<p>Downloads a file from your server.  You must supply the remote path and the local path, and you can optionally set the mode.
+Example:</p>
+
+<code>$this->ftp->download('/public_html/myfile.html', '/local/path/to/myfile.html', 'ascii');</code>
+
+<p><strong>Mode options are:</strong>&nbsp; <kbd>ascii</kbd>, <kbd>binary</kbd>, and <kbd>auto</kbd> (the default). If
+<kbd>auto</kbd> is used it will base the mode on the file extension of the source file.</p>
+
+<p>Returns FALSE if the download does not execute successfully (including if PHP does not have permission to write the local file)</p>
+
+
 <h2>$this->ftp->rename()</h2>
 <p>Permits you to rename a file.  Supply the source file name/path and the new file name/path.</p>
 
-- 
cgit v1.2.3-24-g4f1b