diff --git a/doc/us/manual.html b/doc/us/manual.html
index 5ca685d..3afde68 100644
--- a/doc/us/manual.html
+++ b/doc/us/manual.html
@@ -56,24 +56,41 @@ LuaFileSystem offers the following functions:
- lfs.attributes (filepath)
- Returns a table with file attributes.
+ Obtains the file attributes.
+ The attributes are:
+
+ dev, device inode resides on;
+ ino, inode's number;
+ mode, inode protection mode (values could be
+ file, directory, link, socket, named pipe, char device, block device or other);
+ nlink, number of hard links to the file;
+ uid, user-id of owner;
+ gid, group-id of owner;
+ rdev, device type, for special file inode;
+ access, time of last access;
+ modification, time of last data modification;
+ change, time of last file status change;
+ size, file size, in bytes;
+ blocks, block allocated for file;
+ blksize, optimal file system I/O blocksize;
+
+ Returns a table with file attributes described above.
- lfs.chdir (path)
- Changes the current
- working directory to the given path.
+ Changes the current working directory to the given path.
Returns true in case of success or nil plus an error
string.
- lfs.currentdir ()
- Returns the current
- working directory or nil plus an error string.
+ Returns a string with the current working directory or
+ nil plus an error string.
- lfs.dir (path)
- Lua iterator over the entries
- of a given directory.
+ Lua iterator over the entries of a given directory.
+ Raises an error if path is not a directory.
- lfs.lock (filehandle, mode[, start[, length]])
@@ -84,15 +101,16 @@ LuaFileSystem offers the following functions:
read/shared lock) or w (for a write/exclusive lock).
The optional arguments start and length can be
used to specify a starting point and its length;
- both should be numbers.
+ both should be numbers.
Returns a boolean indicating if the operation was successful;
in case of error, it returns false plus an error string.
- lfs.mkdir (dirname)
Creates a new directory.
- The argument is the name of the new directory.
- Returns a boolean indicating whether the operation succeeds or not.
+ The argument is the name of the new directory.
+ Returns a boolean indicating whether the operation succeeds or not
+ (in this case, an error string is returned too).
- lfs.unlock (filehandle[, start[, length]])
@@ -101,8 +119,8 @@ LuaFileSystem offers the following functions:
the file handle should be specified as the first argument.
The optional arguments start and length can be
used to specify a starting point and its length;
- both should be numbers.
- This function returns a boolean indicating if the operation was successful;
+ both should be numbers.
+ Returns a boolean indicating if the operation was successful;
in case of error, it returns false plus a string describing the
error.
@@ -167,7 +185,7 @@ attrdir (".")
-$Id: manual.html,v 1.5 2004/11/01 15:27:13 tomas Exp $
+$Id: manual.html,v 1.6 2004/11/05 10:37:29 tomas Exp $