From 949d9dc86c2b6aa79a94f1331437daa5ede5ddb4 Mon Sep 17 00:00:00 2001 From: carregal Date: Mon, 22 Nov 2004 17:39:39 +0000 Subject: HTML Tidying --- doc/us/index.html | 178 ++++++++++++++++------------------- doc/us/license.html | 124 +++++++++++------------- doc/us/manual.html | 267 ++++++++++++++++++++++++++-------------------------- 3 files changed, 273 insertions(+), 296 deletions(-) (limited to 'doc') diff --git a/doc/us/index.html b/doc/us/index.html index 4394051..eb95b1d 100644 --- a/doc/us/index.html +++ b/doc/us/index.html @@ -1,140 +1,122 @@ + - + LuaFileSystem - - - -

LuaFileSystem -

File System Library for the -Lua -Programming Language + + + + + + + + + + + +

LuaFileSystem

File System Library for the Lua Programming Language

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

overview · download · manual +· credits · contact us

Overview -
Current Version -
Download -
Manual -
Credits -
Contact us +
Overview
Current Version
Download
Manual
Credits
Contact us

- + +

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. -

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

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.

+ +

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

Current version

-Current version is 1.0 beta. -It was developed for Lua 5.0. -

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

Current version is 1.0 beta. It was developed for Lua 5.0.

+ +

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

Download

-LuaFileSystem can be downloaded from its -Lua Forge -page. +

LuaFileSystem can be downloaded from its Lua +Forge page.

What's new

[10/nov/2004] Version 1.0 beta released +
[10/nov/2004] Version 1.0 beta released

+ -

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. -

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.

- -

Contact us

+ -

-For more information please -contact us. -Comments are welcome! -

Credits

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

+ -

- -$Id: index.html,v 1.6 2004/11/11 15:33:20 tomas Exp $ - +

Contact us

For more information please contact us. +Comments are welcome!

+ +

+$Id: index.html,v 1.6 2004/11/11 15:33:20 tomas Exp +$ diff --git a/doc/us/license.html b/doc/us/license.html index f01eb86..f05609c 100644 --- a/doc/us/license.html +++ b/doc/us/license.html @@ -1,78 +1,68 @@ - - - -LuaFileSystem: license - + + + + +LuaFileSystem: license + + +

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 +qualifies as Open Source +software. Its licenses are compatible with GPL. LuaFileSystem is +not in the public domain and The Kepler Project keep its +copyright. The legal details are below. -

-License -

The spirit of the license is that you are free to use +LuaFileSystem for any purpose at no cost without having to ask us. +The only requirement is that if you do use LuaFileSystem, then you +should give us credit by including the appropriate copyright notice +somewhere in your product or its documentation.

-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 qualifies as -Open Source -software. -Its licenses are compatible with -GPL. -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. -The only requirement is that -if you do use LuaFileSystem, -then you should give us credit by including the appropriate copyright notice -somewhere in your product or its documentation. -

- -The LuaFileSystem library is designed and implemented -by -Roberto Ierusalimschy, -André Carregal and -Tomás Guisasola. -The implementation is not derived from licensed software. -

The LuaFileSystem library is designed and implemented by Roberto +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 files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: -

Permission is hereby granted, free of charge, to any person +obtaining a copy of this software and associated documentation +files (the "Software"), to deal in the Software without +restriction, including without limitation the rights to use, copy, +modify, merge, publish, distribute, sublicense, and/or sell copies +of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions:

-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN 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. -

The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND +NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS +BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN +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.1 2004/07/27 14:15:24 tomas Exp $ - +

+ +

+$Id: license.html,v 1.1.1.1 2004/07/27 14:15:24 tomas Exp +$ + + - - diff --git a/doc/us/manual.html b/doc/us/manual.html index ec92531..0d9ab61 100644 --- a/doc/us/manual.html +++ b/doc/us/manual.html @@ -1,133 +1,132 @@ - + - + LuaFileSystem - -

- - -

LuaFileSystem Reference Manual -

File system library for the -Lua -programming language + + + + + + + + + + + +

LuaFileSystem Reference Manual +

File system library for the Lua programming language

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

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. -

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. +
LuaFileSystem offers the following functions:
+
- lfs.attributes (filepath)
  + 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; (Unix only)
  + blksize, optimal file system I/O blocksize; (Unix only)
  +
  + +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
```
@@ -154,39 +153,45 @@ end
 attrdir (".")
 
```
+ -
Contents
-
+ +
- Introduction
- Reference +
  - Introduction -
  - Reference -
    - chdir -
    - currentdir -
    - dir -
    - lock -
    - mkdir -
    - unlock -
    -
  - Examples +
  - 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 $ - +home · introduction · reference · example +
+$Id: manual.html,v 1.7 2004/11/10 14:09:45 tuler Exp +$ - + + -- cgit v1.2.3-55-g6feb

Contents

Overview

Current version

Download

What's new

Installation

Credits

Contact us

Credits

Contact us

License

-License -

Introduction

Reference

Example

Contents