mirror of
https://github.com/lunarmodules/luafilesystem.git
synced 2026-07-22 11:03:07 +00:00
203 lines
8.2 KiB
HTML
203 lines
8.2 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
|
<html>
|
|
<head>
|
|
<title>LuaFileSystem</title>
|
|
<link rel="stylesheet" href="http://www.keplerproject.org/doc.css" type="text/css"/>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<div id="container">
|
|
|
|
<div id="product">
|
|
<div id="product_logo"><a href="http://www.keplerproject.org">
|
|
<img alt="LuaFileSystem" src="luafilesystem.png"/>
|
|
</a></div>
|
|
<div id="product_name"><big><strong>LuaFileSystem</strong></big></div>
|
|
<div id="product_description">File System Library for the Lua Programming Language</div>
|
|
</div> <!-- id="product" -->
|
|
|
|
<div id="main">
|
|
|
|
<div id="navigation">
|
|
<h1>LuaFileSystem</h1>
|
|
<ul>
|
|
<li><a href="index.html">Home</a>
|
|
<ul>
|
|
<li><a href="index.html#overview">Overview</a></li>
|
|
<li><a href="index.html#status">Status</a></li>
|
|
<li><a href="index.html#download">Download</a></li>
|
|
<li><a href="index.html#history">History</a></li>
|
|
<li><a href="index.html#credits">Credits</a></li>
|
|
<li><a href="index.html#contact">Contact us</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><strong>Manual</strong>
|
|
<ul>
|
|
<li><a href="manual.html#introduction">Introduction</a></li>
|
|
<li><a href="manual.html#installation">Installation</a></li>
|
|
<li><a href="manual.html#reference">Reference</a></li>
|
|
</ul>
|
|
</li>
|
|
<li><a href="examples.html">Examples</a></li>
|
|
<li><a href="license.html">License</a></li>
|
|
</ul>
|
|
</div> <!-- id="navigation" -->
|
|
|
|
<div id="content">
|
|
|
|
<h2><a name="introduction"></a>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>
|
|
|
|
<p>LuaFileSystem offers a portable way to access
|
|
the underlying directory structure and file attributes.</p>
|
|
|
|
<p>LuaFileSystem source is distributed as a pair of C source and header
|
|
files. The distribution provides a <code>Makefile</code> prepared to
|
|
compile the library and install it. The file <code>config</code> should
|
|
be edited to suit the needs of the aimed platform.</p>
|
|
|
|
<h2><a name="installation"></a>Installation</h2>
|
|
|
|
<p>LuaFileSystem follows the
|
|
<a href="http://www.keplerproject.org/compat">package model</a>
|
|
for Lua 5.1, therefore it should be "installed". Refer to
|
|
<a href="http://www.keplerproject.org/compat/manual.html#configuration">
|
|
Compat-5.1 configuration</a> section about how to install the compiled
|
|
binary properly</p>
|
|
|
|
<p>Windows users can use the pre-compiled version of LuaFileSystem
|
|
(<code>lfs.dll</code>) available at
|
|
<a href="http://luaforge.net/projects/luafilesystem/files">LuaForge</a>.</p>
|
|
|
|
<h2><a name="reference"></a>Reference</h2>
|
|
|
|
<p>LuaFileSystem offers the following functions:</p>
|
|
|
|
<dl class="reference">
|
|
<dt><a name="attributes"></a><strong><code>lfs.attributes (filepath)</code></strong></dt>
|
|
<dd>Returns a table with the file attributes corresponding to <code>filepath</code>.
|
|
The attributes are:
|
|
<dl>
|
|
<dt><strong><code>dev</code></strong></dt>
|
|
<dd>on Unix systems, represents the device that the inode resides on. On Windows systems,
|
|
represents the drive number of the disk containing the file</dd>
|
|
|
|
<dt><strong><code>ino</code></strong></dt>
|
|
<dd>on Unix systems, represents the inode number. On Windows systems this has no meaning</dd>
|
|
|
|
<dt><strong><code>mode</code></strong></dt>
|
|
<dd>string representing the associated protection mode (the values could be
|
|
<code>file</code>, <code>directory</code>, <code>link</code>, <code>socket</code>,
|
|
<code>named pipe</code>, <code>char device</code>, <code>block device</code> or
|
|
<code>other</code>)</dd>
|
|
|
|
<dt><strong><code>nlink</code></strong></dt>
|
|
<dd>number of hard links to the file</dd>
|
|
|
|
<dt><strong><code>uid</code></strong></dt>
|
|
<dd>user-id of owner (Unix only, always 0 on Windows)</dd>
|
|
|
|
<dt><strong><code>gid</code></strong></dt>
|
|
<dd>group-id of owner (Unix only, always 0 on Windows)</dd>
|
|
|
|
<dt><strong><code>rdev</code></strong></dt>
|
|
<dd>on Unix systems, represents the device type, for special file inode.
|
|
On Windows systems represents the same as <code>dev</code></dd>
|
|
|
|
<dt><strong><code>access</code></strong></dt>
|
|
<dd>time of last access</dd>
|
|
|
|
<dt><strong><code>modification</code></strong></dt>
|
|
<dd>time of last data modification</dd>
|
|
|
|
<dt><strong><code>change</code></strong></dt>
|
|
<dd>time of last file status change</dd>
|
|
|
|
<dt><strong><code>size</code></strong></dt>
|
|
<dd>file size, in bytes</dd>
|
|
|
|
<dt><strong><code>blocks</code></strong></dt>
|
|
<dd>block allocated for file; (Unix only)</dd>
|
|
|
|
<dt><strong><code>blksize</code></strong></dt>
|
|
<dd>optimal file system I/O blocksize; (Unix only)</dd>
|
|
</dl>
|
|
</dd>
|
|
|
|
<dt><a name="chdir"></a><strong><code>lfs.chdir (path)</code></strong></dt>
|
|
<dd>Changes the current working directory to the given
|
|
<code>path</code>.<br />
|
|
Returns <code>true</code> in case of success or <code>nil</code> plus an
|
|
error string.</dd>
|
|
|
|
<dt><a name="getcwd"></a><strong><code>lfs.currentdir ()</code></strong></dt>
|
|
<dd>Returns a string with the current working directory or <code>nil</code>
|
|
plus an error string.</dd>
|
|
|
|
<dt><a name="dir"></a><strong><code>lfs.dir (path)</code></strong></dt>
|
|
<dd>Lua iterator over the entries of a given directory. Raises an
|
|
error if <code>path</code> is not a directory.</dd>
|
|
|
|
<dt><a name="lock"></a><strong><code>lfs.lock (filehandle, mode[, start[, length]])</code></strong></dt>
|
|
<dd>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.<br />
|
|
Returns a boolean indicating if the operation was successful; in
|
|
case of error, it returns <code>false</code> plus an error string.
|
|
</dd>
|
|
|
|
<dt><a name="mkdir"></a><strong><code>lfs.mkdir (dirname)</code></strong></dt>
|
|
<dd>Creates a new directory. The argument is the name of the new
|
|
directory.<br />
|
|
Returns a boolean indicating whether the operation succeeds or not
|
|
(in this case, an error string is returned too).</dd>
|
|
|
|
<dt><a name="touch"></a><strong><code>lfs.touch (filepath [, atime [, mtime]])</code></strong></dt>
|
|
<dd>Set access and modification times of a file. This function is
|
|
a bind to <code>utime</code> function. The first argument is the
|
|
filename, the second argument (<code>atime</code>) is the access time,
|
|
and the third argument (<code>mtime</code>) is the modification time.
|
|
Both times are provided in seconds (which should be generated with
|
|
Lua standard function <code>os.date</code>).
|
|
If the modifition time is omitted, the access time provided is used;
|
|
if both times are omitted, the current time is used.<br />
|
|
Returns a boolean indicating whether the operation succeeded or not
|
|
(followed by an error string when it fails).</dd>
|
|
|
|
<dt><a name="unlock"></a><strong><code>lfs.unlock (filehandle[, start[, length]])</code></strong></dt>
|
|
<dd>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.<br />
|
|
Returns a boolean indicating if the operation was successful; in
|
|
case of error, it returns <code>false</code> plus a string
|
|
describing the error.</dd>
|
|
</dl>
|
|
|
|
</div> <!-- id="content" -->
|
|
|
|
</div> <!-- id="main" -->
|
|
|
|
<div id="about">
|
|
<p><a href="http://validator.w3.org/check?uri=referer"><img src="http://www.w3.org/Icons/valid-xhtml10" alt="Valid XHTML 1.0!" height="31" width="88" /></a></p>
|
|
<p><small>
|
|
$Id: manual.html,v 1.22 2005/06/02 21:02:44 carregal Exp $
|
|
</small></p>
|
|
</div> <!-- id="about" -->
|
|
|
|
</div> <!-- id="container" -->
|
|
|
|
</body>
|
|
</html>
|