Merge pull request #8 from rrthomas/master

New lfs.link and other goodies

1 files changed, 12 insertions, 5 deletions

diff --git a/doc/us/manual.html b/doc/us/manual.html
index 217c249..996dc1f 100644
--- a/doc/us/manual.html
+++ b/doc/us/manual.html
@@ -174,7 +174,7 @@ LuaFileSystem offers the following functions:
 
     <dt><a name="chdir"></a><strong><code>lfs.lock_dir(path, [seconds_stale])</code></strong></dt>
     <dd>Creates a lockfile (called lockfile.lfs) in <code>path</code> if it does not
-  exist and returns the lock. If the lock already exists checks it
+  exist and returns the lock. If the lock already exists checks if
   it's stale, using the second parameter (default for the second
   parameter is <code>INT_MAX</code>, which in practice means the lock will never
   be stale. To free the the lock call <code>lock:free()</code>. <br/>
@@ -206,6 +206,13 @@ LuaFileSystem offers the following functions:
     Returns <code>true</code> if the operation was successful; in
     case of error, it returns <code>nil</code> plus an error string.
     </dd>
+
+    <dt><a name="link"></a><strong><code>lfs.link (old, new[, symlink])</code></strong></dt>
+    <dd>Creates a link. The first argument is the object to link to
+    and the second is the name of the link. If the optional third
+    argument is true, the link will by a symbolic link (by default, a
+    hard link is created).
+    </dd>
     
     <dt><a name="mkdir"></a><strong><code>lfs.mkdir (dirname)</code></strong></dt>
     <dd>Creates a new directory. The argument is the name of the new
@@ -221,15 +228,15 @@ LuaFileSystem offers the following functions:
 
     <dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt>
     <dd>Sets the writing mode for a file. The mode string can be either <code>binary</code> or <code>text</code>.
-    Returns the previous mode string for the file. This function is only available in Windows, so you may want to make sure that
-    <code>lfs.setmode</code> exists before using it.
+    Returns the previous mode string for the file. On non-Windows platforms, where the two modes are identical,
+    setting the mode has no effect, and the mode is always returned as <code>binary</code>.
     </dd>
     
     <dt><a name="symlinkattributes"></a><strong><code>lfs.symlinkattributes (filepath [, aname])</code></strong></dt>
     <dd>Identical to <a href="#attributes">lfs.attributes</a> except that
     it obtains information about the link itself (not the file it refers to).
-    This function is not available in Windows so you may want to make sure that
-    <code>lfs.symlinkattributes</code> exists before using it.
+    On Windows this function does not yet support links, and is identical to
+    <code>lfs.attributes</code>.
     </dd>
 
     <dt><a name="touch"></a><strong><code>lfs.touch (filepath [, atime [, mtime]])</code></strong></dt>