LuaFileSystem

From 688efd472ce1a1ea612a3d1720a19a2f65b383a5 Mon Sep 17 00:00:00 2001 From: tuler Date: Wed, 10 Nov 2004 14:09:45 +0000 Subject: alguns atributos sao especificos de Unix. --- doc/us/manual.html | 384 ++++++++++++++++++++++++++--------------------------- 1 file changed, 192 insertions(+), 192 deletions(-) (limited to 'doc') diff --git a/doc/us/manual.html b/doc/us/manual.html index 3afde68..ec92531 100644 --- a/doc/us/manual.html +++ b/doc/us/manual.html @@ -1,192 +1,192 @@ - - - - -LuaFileSystem - - - - - -

- - - -

LuaFileSystem Reference Manual -

File system library for the -Lua -programming language -

- -

-home · -introduction · -reference · -example - -

- -

- - -

Introduction

- -

-LuaFileSystem is a Lua library -developed to complement the set of functions related to file systems offered -by the standard Lua distribution. -

-LuaFileSystem is free software and uses the same -license -as Lua 5.0. -

- - - -

Reference

- -

-LuaFileSystem offers the following functions: -

lfs.attributes (filepath)
- Obtains the file attributes. - The attributes are: -
- Returns a table with file attributes described above. - - -
lfs.chdir (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 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. - Raises an error if path is not a directory. - - -
lfs.lock (filehandle, mode[, start[, length]])
- Locks a file or a part of it. - This function works on open files; - the file handle should be specified as the first argument. - The string mode could be either r (for a - 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.
- 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 - (in this case, an error string is returned too). - - -
lfs.unlock (filehandle[, start[, length]])
- Unlocks a file or a part of it. - This function works on open files; - 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.
- Returns a boolean indicating if the operation was successful; - in case of error, it returns false plus a string describing the - error. - -

- - - -

Example

- -

-require"lfs"
-
-function attrdir (path)
-    for file in lfs.dir(path) do
-        if file ~= "." and file ~= ".." then
-            local f = path..'/'..file
-            print ("\t "..f)
-            local attr = lfs.attributes (f)
-            assert (type(attr) == "table")
-            if attr.mode == "directory" then
-                attrdir (f)
-            else
-                for name, value in pairs(attr) do
-                    print (name, value)
-                end
-            end
-        end
-    end
-end
-
-attrdir (".")
-

- - - -

Introduction -
Reference -
- chdir -
- currentdir -
- dir -
- lock -
- mkdir -
- unlock -
-
Examples -

- - -

-home · -introduction · -reference · -example - -

- -

- -$Id: manual.html,v 1.6 2004/11/05 10:37:29 tomas Exp $ - - - - + + + + +LuaFileSystem + + + + + +

+ + + +

LuaFileSystem Reference Manual +

File system library for the +Lua +programming language +

+ +

+home · +introduction · +reference · +example + +

+ +

+ + +

Introduction

+ +

+LuaFileSystem is a Lua library +developed to complement the set of functions related to file systems offered +by the standard Lua distribution. +

+LuaFileSystem is free software and uses the same +license +as Lua 5.0. +

+ + + +

Reference

+ +

+LuaFileSystem offers the following functions: +

lfs.attributes (filepath)
+ Obtains the file attributes. + The attributes are: +
+ Returns a table with file attributes described above. + + +
lfs.chdir (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 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. + Raises an error if path is not a directory. + + +
lfs.lock (filehandle, mode[, start[, length]])
+ Locks a file or a part of it. + This function works on open files; + the file handle should be specified as the first argument. + The string mode could be either r (for a + 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.
+ 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 + (in this case, an error string is returned too). + + +
lfs.unlock (filehandle[, start[, length]])
+ Unlocks a file or a part of it. + This function works on open files; + 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.
+ Returns a boolean indicating if the operation was successful; + in case of error, it returns false plus a string describing the + error. + +

+ + + +

Example

+ +

+require"lfs"
+
+function attrdir (path)
+    for file in lfs.dir(path) do
+        if file ~= "." and file ~= ".." then
+            local f = path..'/'..file
+            print ("\t "..f)
+            local attr = lfs.attributes (f)
+            assert (type(attr) == "table")
+            if attr.mode == "directory" then
+                attrdir (f)
+            else
+                for name, value in pairs(attr) do
+                    print (name, value)
+                end
+            end
+        end
+    end
+end
+
+attrdir (".")
+

+ + + +

Introduction +
Reference +
- chdir +
- currentdir +
- dir +
- lock +
- mkdir +
- unlock +
+
Examples +

+ + +

+home · +introduction · +reference · +example + +

+ +

+ +$Id: manual.html,v 1.7 2004/11/10 14:09:45 tuler Exp $ + + + + -- cgit v1.2.3-55-g6feb

Introduction

Reference

Example

Contents

Introduction

Reference

Example

Contents