aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorHisham Muhammad <hisham@gobolinux.org>2014-01-29 20:33:43 -0200
committerHisham Muhammad <hisham@gobolinux.org>2014-01-29 20:33:43 -0200
commit3bfdafcf4cf2ac07434836d6344baf3e67fb31a2 (patch)
tree34cc0d3c3a9033e0d6e02dd409fe8c7e9e733592 /doc
parent00b17c6f1a56dded8b2560b7e28ab6b108d62733 (diff)
downloadluafilesystem-3bfdafcf4cf2ac07434836d6344baf3e67fb31a2.tar.gz
luafilesystem-3bfdafcf4cf2ac07434836d6344baf3e67fb31a2.tar.bz2
luafilesystem-3bfdafcf4cf2ac07434836d6344baf3e67fb31a2.zip
Fix documentation for setmode. Closes #32.
Diffstat (limited to 'doc')
-rw-r--r--doc/us/manual.html6
1 files changed, 4 insertions, 2 deletions
diff --git a/doc/us/manual.html b/doc/us/manual.html
index 3c5728e..80170de 100644
--- a/doc/us/manual.html
+++ b/doc/us/manual.html
@@ -227,8 +227,10 @@ LuaFileSystem offers the following functions:
227 in case of error, it returns <code>nil</code> plus an error string.</dd> 227 in case of error, it returns <code>nil</code> plus an error string.</dd>
228 228
229 <dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt> 229 <dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt>
230 <dd>Sets the writing mode for a file. The mode string can be either <code>binary</code> or <code>text</code>. 230 <dd>Sets the writing mode for a file. The mode string can be either <code>"binary"</code> or <code>"text"</code>.
231 Returns the previous mode string for the file. On non-Windows platforms, where the two modes are identical, 231 Returns <code>true</code> followed the previous mode string for the file, or
232 <code>nil</code> followed by an error string in case of errors.
233 On non-Windows platforms, where the two modes are identical,
232 setting the mode has no effect, and the mode is always returned as <code>binary</code>. 234 setting the mode has no effect, and the mode is always returned as <code>binary</code>.
233 </dd> 235 </dd>
234 236