diff options
Diffstat (limited to '3rdparty/luafilesystem/doc/us')
-rw-r--r-- | 3rdparty/luafilesystem/doc/us/doc.css | 212 | ||||
-rw-r--r-- | 3rdparty/luafilesystem/doc/us/examples.html | 103 | ||||
-rw-r--r-- | 3rdparty/luafilesystem/doc/us/index.html | 218 | ||||
-rw-r--r-- | 3rdparty/luafilesystem/doc/us/license.html | 122 | ||||
-rw-r--r-- | 3rdparty/luafilesystem/doc/us/luafilesystem.png | bin | 0 -> 8535 bytes | |||
-rw-r--r-- | 3rdparty/luafilesystem/doc/us/manual.html | 280 |
6 files changed, 935 insertions, 0 deletions
diff --git a/3rdparty/luafilesystem/doc/us/doc.css b/3rdparty/luafilesystem/doc/us/doc.css new file mode 100644 index 00000000000..e816a7e2c63 --- /dev/null +++ b/3rdparty/luafilesystem/doc/us/doc.css @@ -0,0 +1,212 @@ +body { + margin-left: 1em; + margin-right: 1em; + font-family: arial, helvetica, geneva, sans-serif; + background-color:#ffffff; margin:0px; +} + +code { + font-family: "Andale Mono", monospace; +} + +tt { + font-family: "Andale Mono", monospace; +} + +body, td, th { font-size: 11pt; } + +h1, h2, h3, h4 { margin-left: 0em; } + +textarea, pre, tt { font-size:10pt; } +body, td, th { color:#000000; } +small { font-size:0.85em; } +h1 { font-size:1.5em; } +h2 { font-size:1.25em; } +h3 { font-size:1.15em; } +h4 { font-size:1.06em; } + +a:link { font-weight:bold; color: #004080; text-decoration: none; } +a:visited { font-weight:bold; color: #006699; text-decoration: none; } +a:link:hover { text-decoration:underline; } +hr { color:#cccccc } +img { border-width: 0px; } + +h3 { padding-top: 1em; } + +p { margin-left: 1em; } + +p.name { + font-family: "Andale Mono", monospace; + padding-top: 1em; + margin-left: 0em; +} + +blockquote { margin-left: 3em; } + +.example { + background-color: rgb(245, 245, 245); + border-top-width: 1px; + border-right-width: 1px; + border-bottom-width: 1px; + border-left-width: 1px; + border-top-style: solid; + border-right-style: solid; + border-bottom-style: solid; + border-left-style: solid; + border-top-color: silver; + border-right-color: silver; + border-bottom-color: silver; + border-left-color: silver; + padding: 1em; + margin-left: 1em; + margin-right: 1em; + font-family: "Andale Mono", monospace; + font-size: smaller; +} + +hr { + margin-left: 0em; + background: #00007f; + border: 0px; + height: 1px; +} + +ul { list-style-type: disc; } + +table.index { border: 1px #00007f; } +table.index td { text-align: left; vertical-align: top; } +table.index ul { padding-top: 0em; margin-top: 0em; } + +table { + border: 1px solid black; + border-collapse: collapse; + margin-left: auto; + margin-right: auto; +} + +th { + border: 1px solid black; + padding: 0.5em; +} + +td { + border: 1px solid black; + padding: 0.5em; +} +div.header, div.footer { margin-left: 0em; } + +#container { + margin-left: 1em; + margin-right: 1em; + background-color: #f0f0f0; +} + +#product { + text-align: center; + border-bottom: 1px solid #cccccc; + background-color: #ffffff; +} + +#product big { + font-size: 2em; +} + +#product_logo { +} + +#product_name { +} + +#product_description { +} + +#main { + background-color: #f0f0f0; + border-left: 2px solid #cccccc; +} + +#navigation { + float: left; + width: 12em; + margin: 0; + vertical-align: top; + background-color: #f0f0f0; + overflow:visible; +} + +#navigation h1 { + background-color:#e7e7e7; + font-size:1.1em; + color:#000000; + text-align:left; + margin:0px; + padding:0.2em; + border-top:1px solid #dddddd; + border-bottom:1px solid #dddddd; +} + +#navigation ul { + font-size:1em; + list-style-type: none; + padding: 0; + margin: 1px; +} + +#navigation li { + text-indent: -1em; + margin: 0em 0em 0em 0.5em; + display: block; + padding: 3px 0px 0px 12px; +} + +#navigation li li a { + padding: 0px 3px 0px -1em; +} + +#content { + margin-left: 12em; + padding: 1em; + border-left: 2px solid #cccccc; + border-right: 2px solid #cccccc; + background-color: #ffffff; +} + +#about { + clear: both; + margin: 0; + padding: 5px; + border-top: 2px solid #cccccc; + background-color: #ffffff; +} + +@media print { + body { + font: 10pt "Times New Roman", "TimeNR", Times, serif; + } + a { + font-weight:bold; color: #004080; text-decoration: underline; + } + #main { + background-color: #ffffff; border-left: 0px; + } + #container { + margin-left: 2%; margin-right: 2%; background-color: #ffffff; + } + #content { + margin-left: 0px; padding: 1em; border-left: 0px; border-right: 0px; background-color: #ffffff; + } + #navigation { + display: none; + } + #product_logo { + display: none; + } + #about img { + display: none; + } + .example { + font-family: "Andale Mono", monospace; + font-size: 8pt; + page-break-inside: avoid; + } +} diff --git a/3rdparty/luafilesystem/doc/us/examples.html b/3rdparty/luafilesystem/doc/us/examples.html new file mode 100644 index 00000000000..2c1644cb8a0 --- /dev/null +++ b/3rdparty/luafilesystem/doc/us/examples.html @@ -0,0 +1,103 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>LuaFileSystem</title> + <link rel="stylesheet" href="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><a href="manual.html">Manual</a> + <ul> + <li><a href="manual.html#introduction">Introduction</a></li> + <li><a href="manual.html#building">Building</a></li> + <li><a href="manual.html#installation">Installation</a></li> + <li><a href="manual.html#reference">Reference</a></li> + </ul> + </li> + <li><strong>Examples</strong></li> + <li><a href="https://github.com/keplerproject/luafilesystem">Project</a> + <ul> + <li><a href="https://github.com/keplerproject/luafilesystem/issues">Bug Tracker</a></li> + <li><a href="https://github.com/keplerproject/luafilesystem">Git</a></li> + </ul> + </li> + <li><a href="license.html">License</a></li> + </ul> +</div> <!-- id="navigation" --> + +<div id="content"> + +<h2><a name="example"></a>Examples</h2> + +<h3>Directory iterator</h3> + +<p>The following example iterates over a directory and recursively lists the +attributes for each file inside it.</p> + +<pre class="example"> +local lfs = require"lfs" + +function attrdir (path) + for file in lfs.dir(path) do + if file ~= "." and file ~= ".." then + local f = path..'/'..file + print ("\t "..f) + local attr = lfs.attributes (f) + assert (type(attr) == "table") + if attr.mode == "directory" then + attrdir (f) + else + for name, value in pairs(attr) do + print (name, value) + end + end + end + end +end + +attrdir (".") +</pre> + +</div> <!-- id="content" --> + +</div> <!-- id="main" --> + +<div id="about"> + <p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p> + <p><small>$Id: examples.html,v 1.8 2007/12/14 15:28:04 carregal Exp $</small></p> +</div> <!-- id="about" --> + +</div> <!-- id="container" --> + +</body> +</html> diff --git a/3rdparty/luafilesystem/doc/us/index.html b/3rdparty/luafilesystem/doc/us/index.html new file mode 100644 index 00000000000..2bb7f5d2cbb --- /dev/null +++ b/3rdparty/luafilesystem/doc/us/index.html @@ -0,0 +1,218 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>LuaFileSystem</title> + <link rel="stylesheet" href="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><strong>Home</strong> + <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><a href="manual.html">Manual</a> + <ul> + <li><a href="manual.html#introduction">Introduction</a></li> + <li><a href="manual.html#building">Building</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="https://github.com/keplerproject/luafilesystem">Project</a> + <ul> + <li><a href="https://github.com/keplerproject/luafilesystem/issues">Bug Tracker</a></li> + <li><a href="https://github.com/keplerproject/luafilesystem">Git</a></li> + </ul> + </li> + <li><a href="license.html">License</a></li> + </ul> +</div> <!-- id="navigation" --> + +<div id="content"> + +<h2><a name="overview"></a>Overview</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 is free software and uses the same +<a href="license.html">license</a> as Lua 5.1.</p> + +<h2><a name="status"></a>Status</h2> + +<p>Current version is 1.6.3. It works with Lua 5.1, 5.2 and 5.3.</p> + +<h2><a name="download"></a>Download</h2> + +<p>LuaFileSystem source can be downloaded from its +<a href="http://github.com/keplerproject/luafilesystem">Github</a> +page.</p> + +<h2><a name="history"></a>History</h2> + +<dl class="history"> + <dt><strong>Version 1.6.3</strong> [15/Jan/2015]</dt> + <dd><ul> + <li>Lua 5.3 support.</li> + <li>Assorted bugfixes.</li> + </ul></dd> + + <dt><strong>Version 1.6.2</strong> [??/Oct/2012]</dt> + <dd><ul> + <li>Full Lua 5.2 compatibility (with Lua 5.1 fallbacks)</li> + </ul></dd> + + <dt><strong>Version 1.6.1</strong> [01/Oct/2012]</dt> + <dd><ul> + <li>fix build for Lua 5.2</li> + </ul></dd> + + <dt><strong>Version 1.6.0</strong> [26/Sep/2012]</dt> + <dd><ul> + <li>getcwd fix for Android</li> + <li>support for Lua 5.2</li> + <li>add lfs.link</li> + <li>other bug fixes</li> + </ul></dd> + + <dt><strong>Version 1.5.0</strong> [20/Oct/2009]</dt> + <dd><ul> + <li>Added explicit next and close methods to second return value of lfs.dir +(the directory object), for explicit iteration or explicit closing.</li> + <li>Added directory locking via lfs.lock_dir function (see the <a href="manual.html">manual</a>).</li> + </ul></dd> + <dt><strong>Version 1.4.2</strong> [03/Feb/2009]</dt> + <dd> + <ul> + <li>fixed bug [<a href="http://luaforge.net/tracker/?func=detail&group_id=66&aid=13198&atid=356">#13198</a>] + lfs.attributes(filename, 'size') overflow on files > 2 Gb again (bug report and patch by KUBO Takehiro).</li> + <li>fixed bug [<a href="http://luaforge.net/tracker/?group_id=66&atid=356&func=detail&aid=39794">#39794</a>] + Compile error on Solaris 10 (bug report and patch by Aaron B).</li> + <li>fixed compilation problems with Borland C.</li> + </ul> + </dd> + + <dt><strong>Version 1.4.1</strong> [07/May/2008]</dt> + <dd> + <ul> + <li>documentation review</li> + <li>fixed Windows compilation issues</li> + <li>fixed bug in the Windows tests (patch by Shmuel Zeigerman)</li> + <li>fixed bug [<a href="http://luaforge.net/tracker/?func=detail&group_id=66&aid=2185&atid=356">#2185</a>] + <code>lfs.attributes(filename, 'size')</code> overflow on files > 2 Gb + </li> + </ul> + </dd> + + <dt><strong>Version 1.4.0</strong> [13/Feb/2008]</dt> + <dd> + <ul> + <li>added function + <a href="manual.html#setmode"><code>lfs.setmode</code></a> + (works only in Windows systems).</li> + <li><a href="manual.html#attributes"><code>lfs.attributes</code></a> + raises an error if attribute does not exist</li> + </ul> + </dd> + + <dt><strong>Version 1.3.0</strong> [26/Oct/2007]</dt> + <dd> + <ul> + <li>added function + <a href="manual.html#symlinkattributes"><code>lfs.symlinkattributes</code></a> + (works only in non Windows systems).</li> + </ul> + </dd> + + <dt><strong>Version 1.2.1</strong> [08/May/2007]</dt> + <dd> + <ul> + <li>compatible only with Lua 5.1 (Lua 5.0 support was dropped)</li> + </ul> + </dd> + + <dt><strong>Version 1.2</strong> [15/Mar/2006]</dt> + <dd> + <ul> + <li>added optional argument to + <a href="manual.html#attributes"><code>lfs.attributes</code></a></li> + <li>added function + <a href="manual.html#rmdir"><code>lfs.rmdir</code></a></li> + <li>bug correction on <a href="manual.html#dir"><code>lfs.dir</code></a></li> + </ul> + </dd> + + <dt><strong>Version 1.1</strong> [30/May/2005]</dt> + <dd> + <ul> + <li>added function <a href="manual.html#touch"><code>lfs.touch</code></a>.</li> + </ul> + </dd> + + <dt><strong>Version 1.0</strong> [21/Jan/2005]</dt> + <dd /> + + <dt><strong>Version 1.0 Beta</strong> [10/Nov/2004]</dt> + <dd /> +</dl> + +<h2><a name="credits"></a>Credits</h2> + +<p>LuaFileSystem was designed by Roberto Ierusalimschy, +André Carregal and Tomás Guisasola as part of the +<a href="http://www.keplerproject.org">Kepler Project</a>, +which holds its copyright. LuaFileSystem is currently maintained by Fábio Mascarenhas.</p> + +<h2><a name="contact"></a>Contact us</h2> + +<p>For more information please +<a href="mailto:info-NO-SPAM-THANKS@keplerproject.org">contact us</a>. +Comments are welcome!</p> + +<p>You can also reach other Kepler developers and users on the Kepler Project +<a href="http://luaforge.net/mail/?group_id=104">mailing list</a>.</p> + +</div> <!-- id="content" --> + +</div> <!-- id="main" --> + +<div id="about"> + <p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p> + <p><small>$Id: index.html,v 1.44 2009/02/04 21:21:33 carregal Exp $</small></p> +</div> <!-- id="about" --> + +</div> <!-- id="container" --> + +</body> +</html> diff --git a/3rdparty/luafilesystem/doc/us/license.html b/3rdparty/luafilesystem/doc/us/license.html new file mode 100644 index 00000000000..30033817229 --- /dev/null +++ b/3rdparty/luafilesystem/doc/us/license.html @@ -0,0 +1,122 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>LuaFileSystem</title> + <link rel="stylesheet" href="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><a href="manual.html">Manual</a> + <ul> + <li><a href="manual.html#introduction">Introduction</a></li> + <li><a href="manual.html#building">Building</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="https://github.com/keplerproject/luafilesystem">Project</a> + <ul> + <li><a href="https://github.com/keplerproject/luafilesystem/issues/">Bug Tracker</a></li> + <li><a href="https://github.com/keplerproject/luafilesystem">Git</a></li> + </ul> + </li> + <li><strong>License</strong></li> + </ul> +</div> <!-- id="navigation" --> + +<div id="content"> + +<h1>License</h1> + +<p> +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 the +<a href="http://www.keplerproject.org">Kepler Project</a> +keep its copyright. +The legal details are below. +</p> + +<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> + +<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/> +<p>Copyright © 2003 Kepler Project.</p> + +<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> + +<p>The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software.</p> + +<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> + +</div> <!-- id="content" --> + +</div> <!-- id="main" --> + +<div id="about"> + <p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p> + <p><small>$Id: license.html,v 1.13 2008/02/11 22:42:21 carregal Exp $</small></p> +</div><!-- id="about" --> + +</div><!-- id="container" --> + +</body> +</html> diff --git a/3rdparty/luafilesystem/doc/us/luafilesystem.png b/3rdparty/luafilesystem/doc/us/luafilesystem.png Binary files differnew file mode 100644 index 00000000000..e1dd8c65b52 --- /dev/null +++ b/3rdparty/luafilesystem/doc/us/luafilesystem.png diff --git a/3rdparty/luafilesystem/doc/us/manual.html b/3rdparty/luafilesystem/doc/us/manual.html new file mode 100644 index 00000000000..33c1cbea573 --- /dev/null +++ b/3rdparty/luafilesystem/doc/us/manual.html @@ -0,0 +1,280 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> +<head> + <title>LuaFileSystem</title> + <link rel="stylesheet" href="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#building">Building</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="https://github.com/keplerproject/luafilesystem">Project</a> + <ul> + <li><a href="https://github.com/keplerproject/luafilesystem/issues">Bug Tracker</a></li> + <li><a href="https://github.com/keplerproject/luafilesystem">Git</a></li> + </ul> + </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> + +<h2><a name="building"></a>Building</h2> + +<p> +LuaFileSystem should be built with Lua 5.1 so the language library +and header files for the target version must be installed properly. +</p> + +<p> +LuaFileSystem offers a Makefile and a separate configuration file, +<code>config</code>, +which should be edited to suit your installation before running +<code>make</code>. +The file has some definitions like paths to the external libraries, +compiler options and the like. +</p> + +<p>On Windows, the C runtime used to compile LuaFileSystem must be the same +runtime that Lua uses, or some LuaFileSystem functions will not work.</p> + +<h2><a name="installation"></a>Installation</h2> + +<p>The easiest way to install LuaFileSystem is to use LuaRocks:</p> + +<pre class="example"> +luarocks install luafilesystem +</pre> + +<p>If you prefer to install LuaFileSystem manually, the compiled binary should be copied to a directory in your +<a href="http://www.lua.org/manual/5.1/manual.html#pdf-package.cpath">C path</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 [, aname])</code></strong></dt> + <dd>Returns a table with the file attributes corresponding to + <code>filepath</code> (or <code>nil</code> followed by an error message + in case of error). + If the second optional argument is given, then only the value of the + named attribute is returned (this use is equivalent to + <code>lfs.attributes(filepath).aname</code>, but the table is not created + and only one attribute is retrieved from the O.S.). + The attributes are described as follows; + attribute <code>mode</code> is a string, all the others are numbers, + and the time related attributes use the same time reference of + <a href="http://www.lua.org/manual/5.1/manual.html#pdf-os.time"><code>os.time</code></a>: + <dl> + <dt><strong><code>dev</code></strong></dt> + <dd>on Unix systems, this 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, this 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 inodes. + 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> + This function uses <code>stat</code> internally thus if the given + <code>filepath</code> is a symbolic link, it is followed (if it points to + another link the chain is followed recursively) and the information + is about the file it refers to. + To obtain information about the link itself, see function + <a href="#symlinkattributes">lfs.symlinkattributes</a>. + </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="chdir"></a><strong><code>lfs.lock_dir(path, [seconds_stale])</code></strong></dt> + <dd>Creates a lockfile (called lockfile.lfs) in <code>path</code> if it does not + exist and returns the lock. If the lock already exists checks if + it's stale, using the second parameter (default for the second + parameter is <code>INT_MAX</code>, which in practice means the lock will never + be stale. To free the the lock call <code>lock:free()</code>. <br/> + In case of any errors it returns nil and the error message. In + particular, if the lock exists and is not stale it returns the + "File exists" message.</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>iter, dir_obj = lfs.dir (path)</code></strong></dt> + <dd> + Lua iterator over the entries of a given directory. + Each time the iterator is called with <code>dir_obj</code> it returns a directory entry's name as a string, or + <code>nil</code> if there are no more entries. You can also iterate by calling <code>dir_obj:next()</code>, and + explicitly close the directory before the iteration finished with <code>dir_obj:close()</code>. + 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 <code>true</code> if the operation was successful; in + case of error, it returns <code>nil</code> plus an error string. + </dd> + + <dt><a name="link"></a><strong><code>lfs.link (old, new[, symlink])</code></strong></dt> + <dd>Creates a link. The first argument is the object to link to + and the second is the name of the link. If the optional third + argument is true, the link will by a symbolic link (by default, a + hard link is created). + </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 <code>true</code> if the operation was successful; + in case of error, it returns <code>nil</code> plus an error string. + </dd> + + <dt><a name="rmdir"></a><strong><code>lfs.rmdir (dirname)</code></strong></dt> + <dd>Removes an existing directory. The argument is the name of the directory.<br /> + Returns <code>true</code> if the operation was successful; + in case of error, it returns <code>nil</code> plus an error string.</dd> + + <dt><a name="setmode"></a><strong><code>lfs.setmode (file, mode)</code></strong></dt> + <dd>Sets the writing mode for a file. The mode string can be either <code>"binary"</code> or <code>"text"</code>. + Returns <code>true</code> followed the previous mode string for the file, or + <code>nil</code> followed by an error string in case of errors. + On non-Windows platforms, where the two modes are identical, + setting the mode has no effect, and the mode is always returned as <code>binary</code>. + </dd> + + <dt><a name="symlinkattributes"></a><strong><code>lfs.symlinkattributes (filepath [, aname])</code></strong></dt> + <dd>Identical to <a href="#attributes">lfs.attributes</a> except that + it obtains information about the link itself (not the file it refers to). + On Windows this function does not yet support links, and is identical to + <code>lfs.attributes</code>. + </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.time</code>). + If the modification time is omitted, the access time provided is used; + if both times are omitted, the current time is used.<br /> + Returns <code>true</code> if the operation was successful; + in case of error, it returns <code>nil</code> plus an error string. + </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 <code>true</code> if the operation was successful; + in case of error, it returns <code>nil</code> plus an error string. + </dd> +</dl> + +</div> <!-- id="content" --> + +</div> <!-- id="main" --> + +<div id="about"> + <p><a href="http://validator.w3.org/check?uri=referer">Valid XHTML 1.0!</a></p> + <p><small>$Id: manual.html,v 1.45 2009/06/03 20:53:55 mascarenhas Exp $</small></p> +</div> <!-- id="about" --> + +</div> <!-- id="container" --> + +</body> +</html> |