Date: Wed, 4 May 2005 02:28:51 +0000 Subject: new documentation format --- doc/us/examples.html | 91 ++++++++++++++++++++++++++ doc/us/index.html | 164 ++++++++++++++++++++++------------------------- doc/us/license.html | 77 +++++++++++++++++----- doc/us/manual.html | 178 ++++++++++++++++++++++----------------------------- 4 files changed, 306 insertions(+), 204 deletions(-) create mode 100644 doc/us/examples.html diff --git a/doc/us/examples.html b/doc/us/examples.html new file mode 100644 index 0000000..63a3f93 --- /dev/null +++ b/doc/us/examples.html @@ -0,0 +1,91 @@ + + + + LuaFileSystem + + + + + + +

+ +

LuaFileSystem

File System Library for the Lua Programming Language

+ +

+ + + +

+ +

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 (".")
+

+ +

+ $Id: examples.html,v 1.1 2005/05/04 02:28:51 tuler Exp $ +

+ +

+ + + diff --git a/doc/us/index.html b/doc/us/index.html index 90c15ee..b7e6983 100644 --- a/doc/us/index.html +++ b/doc/us/index.html @@ -1,76 +1,78 @@ - + - -LuaFileSystem - + LuaFileSystem + + - - - - - - - - - - - - - - -

LuaFileSystem

File System Library for the Lua Programming Language

- - - -overview · -download · -manual · -credits · -contact us - - -

- -

Overview
Current Version
Download
Manual
Credits
Contact us

- - -

Overview

- -

LuaFileSystem is a library developed to complement the set of + + +

+ +

LuaFileSystem

File System Library for the Lua Programming Language

+ +

+ + + +

+ +

Overview

+LuaFileSystem is a library developed to complement the set of functions related to file systems offered by the standard Lua -distribution. One of its goals is to be as portable as Lua.

+distribution. One of its goals is to be as portable as Lua. +

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

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

- -

Current version

Status

Current version is 1.1. -It was developed for Lua 5.0.

+Current version is 1.1. It was developed for Lua 5.0. +

Version 1.1 follows the +

+Version 1.1 follows the package proposal -for Lua 5.1 (see section Installation +for Lua 5.1 (see section Installation for more details).

- -

Download

+ +

Download

LuaFileSystem can be downloaded from its @@ -78,8 +80,7 @@ LuaFileSystem can be downloaded from its page.

- -

What's new

History

[?/?/2005] Version 1.1 released

lfs.touch

Installation

LuaFileSystem is distributed as a pair of C source and header -files. The distribution provides a Makefile prepared to -compile the library and install it. The file config should -be edited to suit the needs of the aimed platform.

LuaFileSystem follows the -package proposal -for Lua 5.1, therefore this package should be "installed". -In other words, -if you are using Lua 5.0, the files compat-5.1.c and -compat-5.1.h must be used in the compilation and the file -compat-5.1.lua must be installed in the LUA_PATH. -If you are using Lua 5.1, nothing should be done.

Credits

LuaFileSystem was designed by Roberto Ierusalimschy, André Carregal and Tomás Guisasola as part of the Kepler Project which holds its copyright.

Contact us

For more information please contact us. Comments are welcome!

$Id: index.html,v 1.10 2005/01/24 10:59:58 tomas Exp $

+ +

+ $Id: index.html,v 1.11 2005/05/04 02:28:51 tuler Exp $ +

+ +

+ - diff --git a/doc/us/license.html b/doc/us/license.html index 85a9df1..b889815 100644 --- a/doc/us/license.html +++ b/doc/us/license.html @@ -1,13 +1,55 @@ - + - -LuaFileSystem: license + LuaFileSystem + + - -

+ + +

+ +

LuaFileSystem

File System Library for the Lua Programming Language

+ +

+ + + +

License

LuaFileSystem is free software: it can be used for both academic and commercial purposes at absolutely no cost. There are no royalties or GNU-like "copyleft" restrictions. LuaFileSystem @@ -20,6 +62,7 @@ LuaFileSystem is not in the public domain and the Kepler Project keep its copyright. The legal details are below. +

The spirit of the license is that you are free to use LuaFileSystem for any purpose at no cost without having to ask us. @@ -31,12 +74,8 @@ somewhere in your product or its documentation.

Ierusalimschy, André Carregal and Tomás Guisasola. The implementation is not derived from licensed software.

- -

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation @@ -58,12 +97,18 @@ ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

- -

+ +

+ $Id: license.html,v 1.5 2005/05/04 02:28:51 tuler Exp $ +

+ +

-$Id: license.html,v 1.4 2005/01/19 14:30:08 tomas Exp $ - diff --git a/doc/us/manual.html b/doc/us/manual.html index 26a2192..770b913 100644 --- a/doc/us/manual.html +++ b/doc/us/manual.html @@ -1,43 +1,54 @@ - + - -LuaFileSystem - + LuaFileSystem + + - -

- - - - - - - - - - - - - -

LuaFileSystem Reference Manual -

File system library for the Lua programming language

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

- - -

Introduction

+ + + +

+ +

LuaFileSystem

File System Library for the Lua Programming Language

+ +

+ + + +

+ +

Introduction

LuaFileSystem is a Lua library developed to complement the set of functions related to file @@ -46,9 +57,26 @@ systems offered by the standard Lua distribution.

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

- +

Installation

+ +

+LuaFileSystem is distributed as a pair of C source and header +files. The distribution provides a Makefile prepared to +compile the library and install it. The file config should +be edited to suit the needs of the aimed platform. +

+ +

+LuaFileSystem follows the +package proposal +for Lua 5.1, therefore this package should be "installed". +In other words, +if you are using Lua 5.0, the files compat-5.1.c and +compat-5.1.h must be used in the compilation and the file +compat-5.1.lua must be installed in the LUA_PATH. +If you are using Lua 5.1, nothing should be done.

Reference

LuaFileSystem offers the following functions:

@@ -147,72 +175,18 @@ 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 (".")
-

- - - -

- -