summaryrefslogtreecommitdiff
path: root/manual.html
diff options
context:
space:
mode:
authorHisham Muhammad <hisham@gobolinux.org>2017-09-15 18:32:36 -0300
committerHisham Muhammad <hisham@gobolinux.org>2017-09-15 18:32:36 -0300
commitfbf2894a0ab3e4b28ead9e6140c57e43c6a86325 (patch)
tree8886291d8735e861dc8917e9ec2d6bb60fffac22 /manual.html
parent138bf123049627399f87c06805706bcd7e508ede (diff)
downloadluafilesystem-fbf2894a0ab3e4b28ead9e6140c57e43c6a86325.tar.gz
luafilesystem-fbf2894a0ab3e4b28ead9e6140c57e43c6a86325.tar.bz2
luafilesystem-fbf2894a0ab3e4b28ead9e6140c57e43c6a86325.zip
Update for 1.7.0
Diffstat (limited to 'manual.html')
-rw-r--r--manual.html16
1 files changed, 9 insertions, 7 deletions
diff --git a/manual.html b/manual.html
index f5fbaf6..3555e3d 100644
--- a/manual.html
+++ b/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>.
@@ -242,6 +242,8 @@ LuaFileSystem offers the following functions:
242 <dt><a name="symlinkattributes"></a><strong><code>lfs.symlinkattributes (filepath [, aname])</code></strong></dt> 242 <dt><a name="symlinkattributes"></a><strong><code>lfs.symlinkattributes (filepath [, aname])</code></strong></dt>
243 <dd>Identical to <a href="#attributes">lfs.attributes</a> except that 243 <dd>Identical to <a href="#attributes">lfs.attributes</a> except that
244 it obtains information about the link itself (not the file it refers to). 244 it obtains information about the link itself (not the file it refers to).
245 It also adds a <strong><code>target</code></strong> field, containing
246 the file name that the symlink points to.
245 On Windows this function does not yet support links, and is identical to 247 On Windows this function does not yet support links, and is identical to
246 <code>lfs.attributes</code>. 248 <code>lfs.attributes</code>.
247 </dd> 249 </dd>
@@ -255,8 +257,8 @@ LuaFileSystem offers the following functions:
255 Lua standard function <code>os.time</code>). 257 Lua standard function <code>os.time</code>).
256 If the modification time is omitted, the access time provided is used; 258 If the modification time is omitted, the access time provided is used;
257 if both times are omitted, the current time is used.<br /> 259 if both times are omitted, the current time is used.<br />
258 Returns <code>true</code> if the operation was successful; 260 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. 261 a system-dependent error code in case of error.
260 </dd> 262 </dd>
261 263
262 <dt><a name="unlock"></a><strong><code>lfs.unlock (filehandle[, start[, length]])</code></strong></dt> 264 <dt><a name="unlock"></a><strong><code>lfs.unlock (filehandle[, start[, length]])</code></strong></dt>