diff options
author | Peter Melnichenko <mpeterval@gmail.com> | 2016-06-30 21:21:39 +0300 |
---|---|---|
committer | Peter Melnichenko <mpeterval@gmail.com> | 2016-06-30 21:21:39 +0300 |
commit | 138bf123049627399f87c06805706bcd7e508ede (patch) | |
tree | 36efa3eedc09a11c5ca78f110696cdae47aad6fc | |
parent | 83a811bb8e1e26f8acfdb5b35784d55039472252 (diff) | |
download | luafilesystem-138bf123049627399f87c06805706bcd7e508ede.tar.gz luafilesystem-138bf123049627399f87c06805706bcd7e508ede.tar.bz2 luafilesystem-138bf123049627399f87c06805706bcd7e508ede.zip |
Sync docs with master branch
-rw-r--r-- | manual.html | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/manual.html b/manual.html index 7a92f58..f5fbaf6 100644 --- a/manual.html +++ b/manual.html | |||
@@ -102,14 +102,15 @@ LuaFileSystem offers the following functions: | |||
102 | </p> | 102 | </p> |
103 | 103 | ||
104 | <dl class="reference"> | 104 | <dl class="reference"> |
105 | <dt><a name="attributes"></a><strong><code>lfs.attributes (filepath [, aname])</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 |
108 | in case of error). | 108 | in case of error). |
109 | If the second optional argument is given, 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 |
111 | <code>lfs.attributes(filepath).aname</code>, but the table is not created | 111 | <code>lfs.attributes(filepath)[aname]</code>, but the table is not created |
112 | and only one attribute is retrieved from the O.S.). | 112 | and only one attribute is retrieved from the O.S.). |
113 | if a table is passed as the second argument, it is filled with attributes and returned instead of a new table. | ||
113 | The attributes are described as follows; | 114 | The attributes are described as follows; |
114 | attribute <code>mode</code> is a string, all the others are numbers, | 115 | attribute <code>mode</code> is a string, all the others are numbers, |
115 | and the time related attributes use the same time reference of | 116 | and the time related attributes use the same time reference of |
@@ -176,7 +177,7 @@ LuaFileSystem offers the following functions: | |||
176 | Returns <code>true</code> in case of success or <code>nil</code> plus an | 177 | Returns <code>true</code> in case of success or <code>nil</code> plus an |
177 | error string.</dd> | 178 | error string.</dd> |
178 | 179 | ||
179 | <dt><a name="chdir"></a><strong><code>lfs.lock_dir(path, [seconds_stale])</code></strong></dt> | 180 | <dt><a name="lock_dir"></a><strong><code>lfs.lock_dir(path, [seconds_stale])</code></strong></dt> |
180 | <dd>Creates a lockfile (called lockfile.lfs) in <code>path</code> if it does not | 181 | <dd>Creates a lockfile (called lockfile.lfs) in <code>path</code> if it does not |
181 | exist and returns the lock. If the lock already exists checks if | 182 | exist and returns the lock. If the lock already exists checks if |
182 | it's stale, using the second parameter (default for the second | 183 | it's stale, using the second parameter (default for the second |
@@ -186,7 +187,7 @@ LuaFileSystem offers the following functions: | |||
186 | particular, if the lock exists and is not stale it returns the | 187 | particular, if the lock exists and is not stale it returns the |
187 | "File exists" message.</dd> | 188 | "File exists" message.</dd> |
188 | 189 | ||
189 | <dt><a name="getcwd"></a><strong><code>lfs.currentdir ()</code></strong></dt> | 190 | <dt><a name="currentdir"></a><strong><code>lfs.currentdir ()</code></strong></dt> |
190 | <dd>Returns a string with the current working directory or <code>nil</code> | 191 | <dd>Returns a string with the current working directory or <code>nil</code> |
191 | plus an error string.</dd> | 192 | plus an error string.</dd> |
192 | 193 | ||