aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authortomas <tomas>2004-07-27 14:15:24 +0000
committertomas <tomas>2004-07-27 14:15:24 +0000
commit8addf14a396466982f62503a6dfa5793a53b1b8e (patch)
tree74d9db96683d623e3e789e2e51c7434da7ef6be4 /doc
downloadluafilesystem-8addf14a396466982f62503a6dfa5793a53b1b8e.tar.gz
luafilesystem-8addf14a396466982f62503a6dfa5793a53b1b8e.tar.bz2
luafilesystem-8addf14a396466982f62503a6dfa5793a53b1b8e.zip
Initial revision
Diffstat (limited to 'doc')
-rw-r--r--doc/us/index.html114
-rw-r--r--doc/us/license.html78
-rw-r--r--doc/us/manual.html144
3 files changed, 336 insertions, 0 deletions
diff --git a/doc/us/index.html b/doc/us/index.html
new file mode 100644
index 0000000..6b81ad9
--- /dev/null
+++ b/doc/us/index.html
@@ -0,0 +1,114 @@
1<html>
2
3<head>
4<title>LuaFileSystem</title>
5<style type="text/css">
6ul { list-style-type: disc };
7</style>
8</head>
9
10<body bgcolor="#FFFFFF">
11
12<center>
13<table border=0 cellspacing=2 cellpadding=2>
14<tr><td align=center><a href="http://www.keplerproject.org">
15<img border=0 alt="LuaFileSystem" src="luafilesystem.png"></a>
16<tr><td align=center><big><b>LuaFileSystem</b></big>
17<tr><td align=center valign=top>File system library for the
18<a href="http://www.lua.org">Lua</a>
19programming language
20</table>
21</center>
22<p>
23
24<center><small>
25<a href="#over">overview</a> &middot;
26<a href="#download">download</a> &middot;
27<a href="manual.html">manual</a> &middot;
28<a href="#credits">credits</a> &middot;
29<a href="#contact">contact us</a>
30</small></center>
31<p>
32
33<hr>
34<h2>Contents</h2>
35<p>
36<ul>
37 <li> <a href="#over">Overview</a>
38 <li> <a href="#version">Current Version</a>
39 <li> <a href="#download">Download</a>
40 <li> <a href="#manual">Manual</a>
41 <li> <a href="#credits">Credits</a>
42 <li> <a href="#contact">Contact us</a>
43</ul>
44
45<a name="over"></a>
46<h2>Overview</h2>
47<p>
48LuaFileSystem is a library developed to complement the set of functions
49related to file systems offered by the standard Lua distribution.
50One of its goals is to be as portable as Lua.
51<p>
52LuaFileSystem is free software and uses the same
53<a href="license.html">license</a>
54as Lua 5.0.
55
56
57<a name="version"></a>
58<h2>Current version</h2>
59<p>
60Current version is 1.0 alpha.
61It was developed for Lua 5.0.
62</p>
63
64
65<a name="download"></a>
66<h2>Download</h2>
67<p>
68LuaFileSystem can be downloaded in source code from the following links:
69<p>
70<ul>
71 <li><a href="luafilesystem-1.0a.tar.gz">luafilesystem-1.0a.tar.gz</a>.
72 <li><a href="luafilesystem-1.0a.zip">luafilesystem-1.0a.zip</a>.
73</ul>
74
75
76<a name="new"></a>
77<h2>What's new</h2>
78<p>
79<ul>
80 <li>[2/Aug/2004] Version 1.0 alpha released
81</ul>
82
83
84<a name="credits"></a>
85<h2>Credits</h2>
86
87<p>
88LuaFileSystem was designed by Roberto Ierusalimschy,
89Andr&eacute; Carregal and Tom&aacute;s Guisasola as part of
90<a href="http://www.keplerproject.org">The Kepler Project</a>
91which holds its copyright.
92</p>
93
94
95<a name="contact"></a>
96<h2>Contact us</h2>
97
98<p>
99For more information please
100<a href="mailto:tomas-NO-SPAM-THANKS@keplerproject.org">contact us</a>.
101Comments are welcome!
102</p>
103
104
105
106<p>
107<hr>
108<small>
109$Id: index.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
110</small>
111
112</body>
113</html>
114
diff --git a/doc/us/license.html b/doc/us/license.html
new file mode 100644
index 0000000..f01eb86
--- /dev/null
+++ b/doc/us/license.html
@@ -0,0 +1,78 @@
1<! See Copyright Notice at the end of this file>
2<HTML>
3<HEAD>
4<TITLE>LuaFileSystem: license</TITLE>
5</HEAD>
6
7<BODY BGCOLOR="#FFFFFF">
8
9<HR>
10<H1>
11License
12</H1>
13
14LuaFileSystem
15is free software:
16it can be used for both academic and commercial purposes at absolutely no cost.
17There are no royalties or GNU-like "copyleft" restrictions.
18LuaFileSystem qualifies as
19<A HREF="http://www.opensource.org/docs/definition.html">Open Source</A>
20software.
21Its licenses are compatible with
22<A HREF="http://www.gnu.org/licenses/gpl.html">GPL</A>.
23LuaFileSystem is not in the public domain and
24<a href="http://www.keplerproject.org">The Kepler Project</a>
25keep its copyright.
26The legal details are below.
27<P>
28
29The spirit of the license is that
30you are free to use LuaFileSystem for any purpose at no cost without having to ask us.
31The only requirement is that
32if you do use LuaFileSystem,
33then you should give us credit by including the appropriate copyright notice
34somewhere in your product or its documentation.
35<P>
36
37The LuaFileSystem library is designed and implemented
38by
39Roberto Ierusalimschy,
40Andr&eacute; Carregal and
41Tom&aacute;s Guisasola.
42The implementation is not derived from licensed software.
43<P>
44
45<!-- ===================================================================== -->
46<HR>
47Copyright &copy; 2004 The Kepler Project.
48<P>
49
50Permission is hereby granted, free of charge, to any person obtaining a copy
51of this software and associated documentation files (the "Software"), to deal
52in the Software without restriction, including without limitation the rights
53to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
54copies of the Software, and to permit persons to whom the Software is
55furnished to do so, subject to the following conditions:
56<P>
57
58The above copyright notice and this permission notice shall be included in
59all copies or substantial portions of the Software.
60<P>
61
62THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
63IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
64FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
65AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
66LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
67OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
68THE SOFTWARE.
69<P>
70
71<!-- ===================================================================== -->
72<HR>
73<SMALL>
74$Id: license.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
75</SMALL>
76
77</BODY>
78</HTML>
diff --git a/doc/us/manual.html b/doc/us/manual.html
new file mode 100644
index 0000000..374d033
--- /dev/null
+++ b/doc/us/manual.html
@@ -0,0 +1,144 @@
1<! See Copyright Notice in license.html>
2<html>
3
4<head>
5<title>LuaFileSystem</title>
6<style type="text/css">
7ul { list-style-type: disc };
8</style>
9</head>
10
11<body bgcolor="#FFFFFF">
12
13<hr>
14
15<center>
16<table border=0 cellspacing=2 cellpadding=2>
17<tr><td align=center><a href="http://www.keplerproject.org/luafilesystem">
18<img border=0 alt="LuaFileSystem logo" src="luafilesystem.png"></a>
19<tr><td align=center><big><b>LuaFileSystem Reference Manual</b></big>
20<tr><td align=center valign=top>File system library for the
21<a href="http://www.lua.org">Lua</a>
22programming language
23</table>
24</center>
25<p>
26
27<center><small>
28<a href="index.html">home</a> &middot;
29<a href="#introduction">introduction</a> &middot;
30<a href="#reference">reference</a> &middot;
31<a href="#example">example</a>
32</small></center>
33<p>
34
35<hr>
36
37<a name="introduction"></a>
38<h2>Introduction</h2>
39
40<p>
41LuaFileSystem is a <a href="http://www.lua.org">Lua</a> library
42developed to complement the set of functions related to file systems offered
43by the standard Lua distribution.
44<p>
45LuaFileSystem is free software and uses the same
46<a href="license.html">license</a>
47as Lua 5.0.
48</p>
49
50
51<a name="reference"></a>
52<h2>Reference</h2>
53
54<p>
55LuaFileSystem offers the following functions:
56<ul>
57 <a name="chdir"></a>
58 <li> <b><tt>luafilesystem.chdir (path)</tt></b> <br>
59 Changes the current
60 working directory to the given <tt>path</tt>.
61
62 <a name="getcwd"></a>
63 <li> <b><tt>luafilesystem.currentdir ()</tt></b> <br>
64 Returns the current
65 working directory or <code>nil</code> plus an error string.
66
67 <a name="dir"></a>
68 <li> <b><tt>luafilesystem.dir (path)</tt></b> <br>
69 Lua iterator over the entries
70 of a given directory.
71
72 <a name="lock"></a>
73 <li> <b><tt>luafilesystem.lock (filehandle, mode[, start[, length]])</tt></b> <br>
74 Locks a file or a part of it.
75 This function works on <em>open files</em>;
76 the file handle should be specified as the first argument.
77 The string <code>mode</code> could be either <code>r</code> (for a
78 read/shared lock) or <code>w</code> (for a write/exclusive lock).
79 The optional arguments <code>start</code> and <code>length</code> can be
80 used to specify a starting point and its length;
81 both should be numbers.
82 This function returns a boolean indicating if the operation was successful;
83 in case of error, it returns <code>false</code> plus a string describing the
84 error.
85
86 <a name="mkdir"></a>
87 <li> <b><tt>luafilesystem.mkdir (dirname)</tt></b> <br>
88 Creates a new directory.
89 The argument is the name of the new directory.
90
91 <a name="unlock"></a>
92 <li> <b><tt>luafilesystem.unlock (filehandle[, start[, length]])</tt></b> <br>
93 Unlocks a file or a part of it.
94 This function works on <em>open files</em>;
95 the file handle should be specified as the first argument.
96 The optional arguments <code>start</code> and <code>length</code> can be
97 used to specify a starting point and its length;
98 both should be numbers.
99 This function returns a boolean indicating if the operation was successful;
100 in case of error, it returns <code>false</code> plus a string describing the
101 error.
102
103</ul>
104
105
106<a name="example"></a>
107<h2>Example</h2>
108
109
110<a name="contents"></a>
111<h2>Contents</h2>
112<p>
113<ul>
114 <li> <a href="#introduction">Introduction</a>
115 <li> <a href="#reference">Reference</a>
116 <ul>
117 <li> <a href="#chdir">chdir</a>
118 <li> <a href="#currentdir">currentdir</a>
119 <li> <a href="#dir">dir</a>
120 <li> <a href="#lock">lock</a>
121 <li> <a href="#mkdir">mkdir</a>
122 <li> <a href="#unlock">unlock</a>
123 </ul>
124 <li> <a href="#examples">Examples</a>
125</ul>
126</p>
127
128
129<p>
130<center><small>
131<a href="index.html">home</a> &middot;
132<a href="#introduction">introduction</a> &middot;
133<a href="#reference">reference</a> &middot;
134<a href="#example">example</a>
135</small></center>
136<p>
137
138<hr>
139<small>
140$Id: manual.html,v 1.1 2004/07/27 14:15:24 tomas Exp $
141</small>
142
143</body>
144</html>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-03-27 02:04:09 +0000