diff options
author | Peter Melnichenko <mpeterval@gmail.com> | 2016-05-04 15:49:56 +0300 |
---|---|---|
committer | Peter Melnichenko <mpeterval@gmail.com> | 2016-05-05 12:39:17 +0300 |
commit | 81e5b165bf324689777b967143c751786c405ce4 (patch) | |
tree | 5ff13ffaf0f193641781f5eb3351cf1f622859d0 | |
parent | 8d5f9661e954be91a17d915f214bd14f44622e99 (diff) | |
download | luafilesystem-81e5b165bf324689777b967143c751786c405ce4.tar.gz luafilesystem-81e5b165bf324689777b967143c751786c405ce4.tar.bz2 luafilesystem-81e5b165bf324689777b967143c751786c405ce4.zip |
Update docs for new return values
-rw-r--r-- | doc/us/manual.html | 14 |
1 files changed, 7 insertions, 7 deletions
diff --git a/doc/us/manual.html b/doc/us/manual.html index 86c3406..beffe03 100644 --- a/doc/us/manual.html +++ b/doc/us/manual.html | |||
@@ -104,7 +104,7 @@ LuaFileSystem offers the following functions: | |||
104 | <dl class="reference"> | 104 | <dl class="reference"> |
105 | <dt><a name="attributes"></a><strong><code>lfs.attributes (filepath [, aname | atable])</code></strong></dt> | 105 | <dt><a name="attributes"></a><strong><code>lfs.attributes (filepath [, aname | atable])</code></strong></dt> |
106 | <dd>Returns a table with the file attributes corresponding to | 106 | <dd>Returns a table with the file attributes corresponding to |
107 | <code>filepath</code> (or <code>nil</code> followed by an error message | 107 | <code>filepath</code> (or <code>nil</code> followed by an error message and a system-dependent error code |
108 | in case of error). | 108 | in case of error). |
109 | If the second optional argument is given and is a string, then only the value of the | 109 | If the second optional argument is given and is a string, then only the value of the |
110 | named attribute is returned (this use is equivalent to | 110 | named attribute is returned (this use is equivalent to |
@@ -222,14 +222,14 @@ LuaFileSystem offers the following functions: | |||
222 | <dt><a name="mkdir"></a><strong><code>lfs.mkdir (dirname)</code></strong></dt> | 222 | <dt><a name="mkdir"></a><strong><code>lfs.mkdir (dirname)</code></strong></dt> |
223 | <dd>Creates a new directory. The argument is the name of the new | 223 | <dd>Creates a new directory. The argument is the name of the new |
224 | directory.<br /> | 224 | directory.<br /> |
225 | Returns <code>true</code> if the operation was successful; | 225 | Returns <code>true</code> in case of success or <code>nil</code>, an error message and |
226 | in case of error, it returns <code>nil</code> plus an error string. | 226 | a system-dependent error code in case of error. |
227 | </dd> | 227 | </dd> |
228 | 228 | ||
229 | <dt><a name="rmdir"></a><strong><code>lfs.rmdir (dirname)</code></strong></dt> | 229 | <dt><a name="rmdir"></a><strong><code>lfs.rmdir (dirname)</code></strong></dt> |
230 | <dd>Removes an existing directory. The argument is the name of the directory.<br /> | 230 | <dd>Removes an existing directory. The argument is the name of the directory.<br /> |
231 | Returns <code>true</code> if the operation was successful; | 231 | Returns <code>true</code> in case of success or <code>nil</code>, an error message and |
232 | in case of error, it returns <code>nil</code> plus an error string.</dd> | 232 | a system-dependent error code in case of error. |
233 | 233 | ||
234 | <dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt> | 234 | <dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt> |
235 | <dd>Sets the writing mode for a file. The mode string can be either <code>"binary"</code> or <code>"text"</code>. | 235 | <dd>Sets the writing mode for a file. The mode string can be either <code>"binary"</code> or <code>"text"</code>. |
@@ -255,8 +255,8 @@ LuaFileSystem offers the following functions: | |||
255 | Lua standard function <code>os.time</code>). | 255 | Lua standard function <code>os.time</code>). |
256 | If the modification time is omitted, the access time provided is used; | 256 | If the modification time is omitted, the access time provided is used; |
257 | if both times are omitted, the current time is used.<br /> | 257 | if both times are omitted, the current time is used.<br /> |
258 | Returns <code>true</code> if the operation was successful; | 258 | Returns <code>true</code> in case of success or <code>nil</code>, an error message and |
259 | in case of error, it returns <code>nil</code> plus an error string. | 259 | a system-dependent error code in case of error. |
260 | </dd> | 260 | </dd> |
261 | 261 | ||
262 | <dt><a name="unlock"></a><strong><code>lfs.unlock (filehandle[, start[, length]])</code></strong></dt> | 262 | <dt><a name="unlock"></a><strong><code>lfs.unlock (filehandle[, start[, length]])</code></strong></dt> |