mirror of
https://github.com/lunarmodules/luafilesystem.git
synced 2026-07-25 05:03:07 +00:00
Initial revision
This commit is contained in:
tomas
114
doc/us/index.html
Normal file
114
doc/us/index.html
Normal file
@@ -0,0 +1,114 @@
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<title>LuaFileSystem</title>
|
||||
<style type="text/css">
|
||||
ul { list-style-type: disc };
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body bgcolor="#FFFFFF">
|
||||
|
||||
<center>
|
||||
<table border=0 cellspacing=2 cellpadding=2>
|
||||
<tr><td align=center><a href="http://www.keplerproject.org">
|
||||
<img border=0 alt="LuaFileSystem" src="luafilesystem.png"></a>
|
||||
<tr><td align=center><big><b>LuaFileSystem</b></big>
|
||||
<tr><td align=center valign=top>File system library for the
|
||||
<a href="http://www.lua.org">Lua</a>
|
||||
programming language
|
||||
</table>
|
||||
</center>
|
||||
<p>
|
||||
|
||||
<center><small>
|
||||
<a href="#over">overview</a> ·
|
||||
<a href="#download">download</a> ·
|
||||
<a href="manual.html">manual</a> ·
|
||||
<a href="#credits">credits</a> ·
|
||||
<a href="#contact">contact us</a>
|
||||
</small></center>
|
||||
<p>
|
||||
|
||||
<hr>
|
||||
<h2>Contents</h2>
|
||||
<p>
|
||||
<ul>
|
||||
<li> <a href="#over">Overview</a>
|
||||
<li> <a href="#version">Current Version</a>
|
||||
<li> <a href="#download">Download</a>
|
||||
<li> <a href="#manual">Manual</a>
|
||||
<li> <a href="#credits">Credits</a>
|
||||
<li> <a href="#contact">Contact us</a>
|
||||
</ul>
|
||||
|
||||
<a name="over"></a>
|
||||
<h2>Overview</h2>
|
||||
<p>
|
||||
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.
|
||||
<p>
|
||||
LuaFileSystem is free software and uses the same
|
||||
<a href="license.html">license</a>
|
||||
as Lua 5.0.
|
||||
|
||||
|
||||
<a name="version"></a>
|
||||
<h2>Current version</h2>
|
||||
<p>
|
||||
Current version is 1.0 alpha.
|
||||
It was developed for Lua 5.0.
|
||||
</p>
|
||||
|
||||
|
||||
<a name="download"></a>
|
||||
<h2>Download</h2>
|
||||
<p>
|
||||
LuaFileSystem can be downloaded in source code from the following links:
|
||||
<p>
|
||||
<ul>
|
||||
<li><a href="luafilesystem-1.0a.tar.gz">luafilesystem-1.0a.tar.gz</a>.
|
||||
<li><a href="luafilesystem-1.0a.zip">luafilesystem-1.0a.zip</a>.
|
||||
</ul>
|
||||
|
||||
|
||||
<a name="new"></a>
|
||||
<h2>What's new</h2>
|
||||
<p>
|
||||
<ul>
|
||||
<li>[2/Aug/2004] Version 1.0 alpha released
|
||||
</ul>
|
||||
|
||||
|
||||
<a name="credits"></a>
|
||||
<h2>Credits</h2>
|
||||
|
||||
<p>
|
||||
LuaFileSystem was designed by Roberto Ierusalimschy,
|
||||
André Carregal and Tomás Guisasola as part of
|
||||
<a href="http://www.keplerproject.org">The Kepler Project</a>
|
||||
which holds its copyright.
|
||||
</p>
|
||||
|
||||
|
||||
<a name="contact"></a>
|
||||
<h2>Contact us</h2>
|
||||
|
||||
<p>
|
||||
For more information please
|
||||
<a href="mailto:tomas-NO-SPAM-THANKS@keplerproject.org">contact us</a>.
|
||||
Comments are welcome!
|
||||
</p>
|
||||
|
||||
|
||||
|
||||
<p>
|
||||
<hr>
|
||||
<small>
|
||||
$Id: index.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
|
||||
</small>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
|
||||
78
doc/us/license.html
Normal file
78
doc/us/license.html
Normal file
@@ -0,0 +1,78 @@
|
||||
<! See Copyright Notice at the end of this file>
|
||||
<HTML>
|
||||
<HEAD>
|
||||
<TITLE>LuaFileSystem: license</TITLE>
|
||||
</HEAD>
|
||||
|
||||
<BODY BGCOLOR="#FFFFFF">
|
||||
|
||||
<HR>
|
||||
<H1>
|
||||
License
|
||||
</H1>
|
||||
|
||||
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
|
||||
<A HREF="http://www.opensource.org/docs/definition.html">Open Source</A>
|
||||
software.
|
||||
Its licenses are compatible with
|
||||
<A HREF="http://www.gnu.org/licenses/gpl.html">GPL</A>.
|
||||
LuaFileSystem is not in the public domain and
|
||||
<a href="http://www.keplerproject.org">The Kepler Project</a>
|
||||
keep its copyright.
|
||||
The legal details are below.
|
||||
<P>
|
||||
|
||||
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.
|
||||
<P>
|
||||
|
||||
The LuaFileSystem library is designed and implemented
|
||||
by
|
||||
Roberto Ierusalimschy,
|
||||
André Carregal and
|
||||
Tomás Guisasola.
|
||||
The implementation is not derived from licensed software.
|
||||
<P>
|
||||
|
||||
<!-- ===================================================================== -->
|
||||
<HR>
|
||||
Copyright © 2004 The Kepler Project.
|
||||
<P>
|
||||
|
||||
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:
|
||||
<P>
|
||||
|
||||
The above copyright notice and this permission notice shall be included in
|
||||
all copies or substantial portions of the Software.
|
||||
<P>
|
||||
|
||||
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.
|
||||
<P>
|
||||
|
||||
<!-- ===================================================================== -->
|
||||
<HR>
|
||||
<SMALL>
|
||||
$Id: license.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
|
||||
</SMALL>
|
||||
|
||||
</BODY>
|
||||
</HTML>
|
||||
144
doc/us/manual.html
Normal file
144
doc/us/manual.html
Normal file
@@ -0,0 +1,144 @@
|
||||
<! See Copyright Notice in license.html>
|
||||
<html>
|
||||
|
||||
<head>
|
||||
<title>LuaFileSystem</title>
|
||||
<style type="text/css">
|
||||
ul { list-style-type: disc };
|
||||
</style>
|
||||
</head>
|
||||
|
||||
<body bgcolor="#FFFFFF">
|
||||
|
||||
<hr>
|
||||
|
||||
<center>
|
||||
<table border=0 cellspacing=2 cellpadding=2>
|
||||
<tr><td align=center><a href="http://www.keplerproject.org/luafilesystem">
|
||||
<img border=0 alt="LuaFileSystem logo" src="luafilesystem.png"></a>
|
||||
<tr><td align=center><big><b>LuaFileSystem Reference Manual</b></big>
|
||||
<tr><td align=center valign=top>File system library for the
|
||||
<a href="http://www.lua.org">Lua</a>
|
||||
programming language
|
||||
</table>
|
||||
</center>
|
||||
<p>
|
||||
|
||||
<center><small>
|
||||
<a href="index.html">home</a> ·
|
||||
<a href="#introduction">introduction</a> ·
|
||||
<a href="#reference">reference</a> ·
|
||||
<a href="#example">example</a>
|
||||
</small></center>
|
||||
<p>
|
||||
|
||||
<hr>
|
||||
|
||||
<a name="introduction"></a>
|
||||
<h2>Introduction</h2>
|
||||
|
||||
<p>
|
||||
LuaFileSystem is a <a href="http://www.lua.org">Lua</a> library
|
||||
developed to complement the set of functions related to file systems offered
|
||||
by the standard Lua distribution.
|
||||
<p>
|
||||
LuaFileSystem is free software and uses the same
|
||||
<a href="license.html">license</a>
|
||||
as Lua 5.0.
|
||||
</p>
|
||||
|
||||
|
||||
<a name="reference"></a>
|
||||
<h2>Reference</h2>
|
||||
|
||||
<p>
|
||||
LuaFileSystem offers the following functions:
|
||||
<ul>
|
||||
<a name="chdir"></a>
|
||||
<li> <b><tt>luafilesystem.chdir (path)</tt></b> <br>
|
||||
Changes the current
|
||||
working directory to the given <tt>path</tt>.
|
||||
|
||||
<a name="getcwd"></a>
|
||||
<li> <b><tt>luafilesystem.currentdir ()</tt></b> <br>
|
||||
Returns the current
|
||||
working directory or <code>nil</code> plus an error string.
|
||||
|
||||
<a name="dir"></a>
|
||||
<li> <b><tt>luafilesystem.dir (path)</tt></b> <br>
|
||||
Lua iterator over the entries
|
||||
of a given directory.
|
||||
|
||||
<a name="lock"></a>
|
||||
<li> <b><tt>luafilesystem.lock (filehandle, mode[, start[, length]])</tt></b> <br>
|
||||
Locks a file or a part of it.
|
||||
This function works on <em>open files</em>;
|
||||
the file handle should be specified as the first argument.
|
||||
The string <code>mode</code> could be either <code>r</code> (for a
|
||||
read/shared lock) or <code>w</code> (for a write/exclusive lock).
|
||||
The optional arguments <code>start</code> and <code>length</code> 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;
|
||||
in case of error, it returns <code>false</code> plus a string describing the
|
||||
error.
|
||||
|
||||
<a name="mkdir"></a>
|
||||
<li> <b><tt>luafilesystem.mkdir (dirname)</tt></b> <br>
|
||||
Creates a new directory.
|
||||
The argument is the name of the new directory.
|
||||
|
||||
<a name="unlock"></a>
|
||||
<li> <b><tt>luafilesystem.unlock (filehandle[, start[, length]])</tt></b> <br>
|
||||
Unlocks a file or a part of it.
|
||||
This function works on <em>open files</em>;
|
||||
the file handle should be specified as the first argument.
|
||||
The optional arguments <code>start</code> and <code>length</code> 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;
|
||||
in case of error, it returns <code>false</code> plus a string describing the
|
||||
error.
|
||||
|
||||
</ul>
|
||||
|
||||
|
||||
<a name="example"></a>
|
||||
<h2>Example</h2>
|
||||
|
||||
|
||||
<a name="contents"></a>
|
||||
<h2>Contents</h2>
|
||||
<p>
|
||||
<ul>
|
||||
<li> <a href="#introduction">Introduction</a>
|
||||
<li> <a href="#reference">Reference</a>
|
||||
<ul>
|
||||
<li> <a href="#chdir">chdir</a>
|
||||
<li> <a href="#currentdir">currentdir</a>
|
||||
<li> <a href="#dir">dir</a>
|
||||
<li> <a href="#lock">lock</a>
|
||||
<li> <a href="#mkdir">mkdir</a>
|
||||
<li> <a href="#unlock">unlock</a>
|
||||
</ul>
|
||||
<li> <a href="#examples">Examples</a>
|
||||
</ul>
|
||||
</p>
|
||||
|
||||
|
||||
<p>
|
||||
<center><small>
|
||||
<a href="index.html">home</a> ·
|
||||
<a href="#introduction">introduction</a> ·
|
||||
<a href="#reference">reference</a> ·
|
||||
<a href="#example">example</a>
|
||||
</small></center>
|
||||
<p>
|
||||
|
||||
<hr>
|
||||
<small>
|
||||
$Id: manual.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
|
||||
</small>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
Reference in New Issue
Block a user