aboutsummaryrefslogtreecommitdiff
path: root/docs/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/index.html')
-rw-r--r--docs/index.html230
1 files changed, 230 insertions, 0 deletions
diff --git a/docs/index.html b/docs/index.html
new file mode 100644
index 0000000..b4f056e
--- /dev/null
+++ b/docs/index.html
@@ -0,0 +1,230 @@
1<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
2 "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
4<head>
5 <title>LuaFileSystem</title>
6 <link rel="stylesheet" href="doc.css" type="text/css"/>
7 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
8</head>
9
10<body>
11
12<div id="container">
13
14<div id="product">
15 <div id="product_logo">
16 <a href="http://keplerproject.github.io/luafilesystem">
17 <img alt="LuaFileSystem" src="luafilesystem.png"/>
18 </a>
19 </div>
20 <div id="product_name"><big><strong>LuaFileSystem</strong></big></div>
21 <div id="product_description">File System Library for the Lua Programming Language</div>
22</div> <!-- id="product" -->
23
24<div id="main">
25
26<div id="navigation">
27<h1>LuaFileSystem</h1>
28 <ul>
29 <li><strong>Home</strong>
30 <ul>
31 <li><a href="index.html#overview">Overview</a></li>
32 <li><a href="index.html#status">Status</a></li>
33 <li><a href="index.html#download">Download</a></li>
34 <li><a href="index.html#history">History</a></li>
35 <li><a href="index.html#credits">Credits</a></li>
36 </ul>
37 </li>
38 <li><a href="manual.html">Manual</a>
39 <ul>
40 <li><a href="manual.html#introduction">Introduction</a></li>
41 <li><a href="manual.html#building">Building</a></li>
42 <li><a href="manual.html#installation">Installation</a></li>
43 <li><a href="manual.html#reference">Reference</a></li>
44 </ul>
45 </li>
46 <li><a href="examples.html">Examples</a></li>
47 <li><a href="https://github.com/keplerproject/luafilesystem">Project</a>
48 <ul>
49 <li><a href="https://github.com/keplerproject/luafilesystem/issues">Bug Tracker</a></li>
50 <li><a href="https://github.com/keplerproject/luafilesystem">Git</a></li>
51 </ul>
52 </li>
53 <li><a href="license.html">License</a></li>
54 </ul>
55</div> <!-- id="navigation" -->
56
57<div id="content">
58
59<h2><a name="overview"></a>Overview</h2>
60
61<p>LuaFileSystem is a <a href="http://www.lua.org">Lua</a> library
62developed to complement the set of functions related to file
63systems offered by the standard Lua distribution.</p>
64
65<p>LuaFileSystem offers a portable way to access
66the underlying directory structure and file attributes.</p>
67
68<p>LuaFileSystem is free software and uses the same
69<a href="license.html">license</a> as Lua 5.x (MIT).</p>
70
71<h2><a name="status"></a>Status</h2>
72
73<p>Current version is 1.8.0. It works with Lua 5.1, 5.2, 5.3 and 5.4, and it runs on various
74flavors of Unix (including Linux, BSDs, macOS) and Windows.</p>
75
76<h2><a name="download"></a>Download</h2>
77
78<p>LuaFileSystem can be installed using <a href="https://luarocks.org">LuaRocks</a>:
79
80<pre class="example">
81$ luarocks install luafilesystem
82</pre>
83
84<p>Its source can be found at its <a href="http://github.com/keplerproject/luafilesystem">GitHub</a> page.</p>
85
86<h2><a name="history"></a>History</h2>
87
88<dl class="history">
89 <dt><strong>Version 1.8.0</strong> [22/Apr/2020]</dt>
90 <dd><ul>
91 <li>Lua 5.4 support</li>
92 <li>lfs.link and lfs.symlinkattributes now work on Windows</li>
93 <li>MACOSX_DEPLOYMENT_TARGET is configurable in the Makefile</li>
94 <li>Fallback to _POSIX_PATH_MAX when MAXPATHLEN is not avaliable</li>
95 <li>Fixed memory leak in case of realloc failure</li>
96 </ul></dd>
97
98 <dt><strong>Version 1.7.0</strong> [15/Sep/2017]</dt>
99 <dd><ul>
100 <li>symlinkattributes function now provides 'target' field, containing name of the file that the symlink points to.</li>
101 <li>attributes, symlinkattributes, touch, mkdir, and rmdir functions now return system-dependent error code as the third value on error.</li>
102 <li>Fixed detection of closed files for Lua 5.2+ in setmode, lock, and unlock functions.</li>
103 <li>Fixed various compiler warnings.</li>
104 </ul></dd>
105
106 <dt><strong>Version 1.6.3</strong> [15/Jan/2015]</dt>
107 <dd><ul>
108 <li>Lua 5.3 support.</li>
109 <li>Assorted bugfixes.</li>
110 </ul></dd>
111
112 <dt><strong>Version 1.6.2</strong> [??/Oct/2012]</dt>
113 <dd><ul>
114 <li>Full Lua 5.2 compatibility (with Lua 5.1 fallbacks)</li>
115 </ul></dd>
116
117 <dt><strong>Version 1.6.1</strong> [01/Oct/2012]</dt>
118 <dd><ul>
119 <li>fix build for Lua 5.2</li>
120 </ul></dd>
121
122 <dt><strong>Version 1.6.0</strong> [26/Sep/2012]</dt>
123 <dd><ul>
124 <li>getcwd fix for Android</li>
125 <li>support for Lua 5.2</li>
126 <li>add lfs.link</li>
127 <li>other bug fixes</li>
128 </ul></dd>
129
130 <dt><strong>Version 1.5.0</strong> [20/Oct/2009]</dt>
131 <dd><ul>
132 <li>Added explicit next and close methods to second return value of lfs.dir
133(the directory object), for explicit iteration or explicit closing.</li>
134 <li>Added directory locking via lfs.lock_dir function (see the <a href="manual.html">manual</a>).</li>
135 </ul></dd>
136 <dt><strong>Version 1.4.2</strong> [03/Feb/2009]</dt>
137 <dd>
138 <ul>
139 <li>fixed bug
140 <code>lfs.attributes(filename, 'size')</code> overflow on files > 2 Gb again (bug report and patch by KUBO Takehiro).</li>
141 <li>fixed bug
142 Compile error on Solaris 10 (bug report and patch by Aaron B).</li>
143 <li>fixed compilation problems with Borland C.</li>
144 </ul>
145 </dd>
146
147 <dt><strong>Version 1.4.1</strong> [07/May/2008]</dt>
148 <dd>
149 <ul>
150 <li>documentation review</li>
151 <li>fixed Windows compilation issues</li>
152 <li>fixed bug in the Windows tests (patch by Shmuel Zeigerman)</li>
153 <li>fixed bug
154 <code>lfs.attributes(filename, 'size')</code> overflow on files > 2 Gb
155 </li>
156 </ul>
157 </dd>
158
159 <dt><strong>Version 1.4.0</strong> [13/Feb/2008]</dt>
160 <dd>
161 <ul>
162 <li>added function
163 <a href="manual.html#setmode"><code>lfs.setmode</code></a>
164 (works only in Windows systems).</li>
165 <li><a href="manual.html#attributes"><code>lfs.attributes</code></a>
166 raises an error if attribute does not exist</li>
167 </ul>
168 </dd>
169
170 <dt><strong>Version 1.3.0</strong> [26/Oct/2007]</dt>
171 <dd>
172 <ul>
173 <li>added function
174 <a href="manual.html#symlinkattributes"><code>lfs.symlinkattributes</code></a>
175 (works only in non Windows systems).</li>
176 </ul>
177 </dd>
178
179 <dt><strong>Version 1.2.1</strong> [08/May/2007]</dt>
180 <dd>
181 <ul>
182 <li>compatible only with Lua 5.1 (Lua 5.0 support was dropped)</li>
183 </ul>
184 </dd>
185
186 <dt><strong>Version 1.2</strong> [15/Mar/2006]</dt>
187 <dd>
188 <ul>
189 <li>added optional argument to
190 <a href="manual.html#attributes"><code>lfs.attributes</code></a></li>
191 <li>added function
192 <a href="manual.html#rmdir"><code>lfs.rmdir</code></a></li>
193 <li>bug correction on <a href="manual.html#dir"><code>lfs.dir</code></a></li>
194 </ul>
195 </dd>
196
197 <dt><strong>Version 1.1</strong> [30/May/2005]</dt>
198 <dd>
199 <ul>
200 <li>added function <a href="manual.html#touch"><code>lfs.touch</code></a>.</li>
201 </ul>
202 </dd>
203
204 <dt><strong>Version 1.0</strong> [21/Jan/2005]</dt>
205 <dd />
206
207 <dt><strong>Version 1.0 Beta</strong> [10/Nov/2004]</dt>
208 <dd />
209</dl>
210
211<h2><a name="credits"></a>Credits</h2>
212
213<p>The LuaFileSystem library was originally designed and
214implemented by Roberto Ierusalimschy, Andr&eacute; Carregal and
215Tom&aacute;s Guisasola. It was then maintained by F&aacute;bio
216Mascarenhas for several years and has since been maintained
217by many contributors -- see the Git history for detailed credits.</p>
218
219</div> <!-- id="content" -->
220
221</div> <!-- id="main" -->
222
223<div id="about">
224 <p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p>
225</div> <!-- id="about" -->
226
227</div> <!-- id="container" -->
228
229</body>
230</html>
generated by cgit v1.2.3-55-g6feb (git 2.39.1) at 2025-08-14 21:19:06 +0000