From 8332f1ab9ef64d1c8faab97d31a026576490b510 Mon Sep 17 00:00:00 2001 From: Fabio Mascarenhas Date: Tue, 20 Oct 2009 19:03:43 -0200 Subject: [PATCH] first pages commit for luafilesystem --- examples.html | 103 ++++++++++++++++++ index.html | 192 ++++++++++++++++++++++++++++++++ license.html | 122 +++++++++++++++++++++ luafilesystem.png | Bin 0 -> 8535 bytes manual.html | 271 ++++++++++++++++++++++++++++++++++++++++++++++ 5 files changed, 688 insertions(+) create mode 100644 examples.html create mode 100644 index.html create mode 100644 license.html create mode 100644 luafilesystem.png create mode 100644 manual.html diff --git a/examples.html b/examples.html new file mode 100644 index 0000000..746df62 --- /dev/null +++ b/examples.html @@ -0,0 +1,103 @@ + + + + LuaFileSystem + + + + + + +
+ +
+ +
LuaFileSystem
+
File System Library for the Lua Programming Language
+
+ +
+ + + +
+ +

Examples

+ +

Directory iterator

+ +

The following example iterates over a directory and recursively lists the +attributes for each file inside it.

+ +
+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 (".")
+
+ +
+ +
+ +
+

Valid XHTML 1.0!

+

$Id: examples.html,v 1.8 2007/12/14 15:28:04 carregal Exp $

+
+ +
+ + + diff --git a/index.html b/index.html new file mode 100644 index 0000000..43edefc --- /dev/null +++ b/index.html @@ -0,0 +1,192 @@ + + + + LuaFileSystem + + + + + + +
+ +
+ +
LuaFileSystem
+
File System Library for the Lua Programming Language
+
+ +
+ + + +
+ +

Overview

+ +

LuaFileSystem is a Lua library +developed to complement the set of functions related to file +systems offered by the standard Lua distribution.

+ +

LuaFileSystem offers a portable way to access +the underlying directory structure and file attributes.

+ +

LuaFileSystem is free software and uses the same +license as Lua 5.1.

+ +

Status

+ +

Current version is 1.5.0. It was developed for Lua 5.1.

+ +

Download

+ +

LuaFileSystem source can be downloaded from its +Github +page.

+ +

History

+ +
+
Version 1.5.0 [20/Oct/2009]
+
  • Added explicit next and close methods to second return value of lfs.dir +(the directory object), for explicit iteration or explicit closing.
    • +
  • Added directory locking via lfs.lock_dir function (see the manual).
    • +
    Version 1.4.2 [03/Feb/2009]
    +
    +
      +
    • fixed bug [#13198] + lfs.attributes(filename, 'size') overflow on files > 2 Gb again (bug report and patch by KUBO Takehiro).
      • +
    • fixed bug [#39794] + Compile error on Solaris 10 (bug report and patch by Aaron B).
      • +
    • fixed compilation problems with Borland C.
      • +
    +
    + +
    Version 1.4.1 [07/May/2008]
    +
    +
      +
    • documentation review
      • +
    • fixed Windows compilation issues
      • +
    • fixed bug in the Windows tests (patch by Shmuel Zeigerman)
      • +
    • fixed bug [#2185] + lfs.attributes(filename, 'size') overflow on files > 2 Gb +
      • +
    +
    + +
    Version 1.4.0 [13/Feb/2008]
    +
    +
      +
    • added function + lfs.setmode + (works only in Windows systems).
      • +
    • lfs.attributes + raises an error if attribute does not exist
      • +
    +
    + +
    Version 1.3.0 [26/Oct/2007]
    +
    + +
    + +
    Version 1.2.1 [08/May/2007]
    +
    +
      +
    • compatible only with Lua 5.1 (Lua 5.0 support was dropped)
      • +
    +
    + +
    Version 1.2 [15/Mar/2006]
    +
    + +
    + +
    Version 1.1 [30/May/2005]
    +
    + +
    + +
    Version 1.0 [21/Jan/2005]
    +
    + +
    Version 1.0 Beta [10/Nov/2004]
    +
    +
    + +

    Credits

    + +

    LuaFileSystem was designed by Roberto Ierusalimschy, +André Carregal and Tomás Guisasola as part of the +Kepler Project, +which holds its copyright. LuaFileSystem is currently maintained by Fábio Mascarenhas.

    + +

    Contact us

    + +

    For more information please +contact us. +Comments are welcome!

    + +

    You can also reach other Kepler developers and users on the Kepler Project +mailing list.

    + +
    + +
    + +
    +

    Valid XHTML 1.0!

    +

    $Id: index.html,v 1.44 2009/02/04 21:21:33 carregal Exp $

    +
    + +
    + + + diff --git a/license.html b/license.html new file mode 100644 index 0000000..4ecad4b --- /dev/null +++ b/license.html @@ -0,0 +1,122 @@ + + + + LuaFileSystem + + + + + + +
    + +
    + +
    LuaFileSystem
    +
    File System Library for the Lua Programming Language
    +
    + +
    + + + +
    + +

    License

    + +

    +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 +Open Source +software. +Its licenses are compatible with +GPL. +LuaFileSystem is not in the public domain and the +Kepler Project +keep its copyright. +The legal details are below. +

    + +

    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.

    + +

    The LuaFileSystem library is designed and implemented by Roberto +Ierusalimschy, André Carregal and Tomás Guisasola. +The implementation is not derived from licensed software.

    + +
    +

    Copyright © 2003 Kepler Project.

    + +

    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:

    + +

    The above copyright notice and this permission notice shall be +included in all copies or substantial portions of the Software.

    + +

    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.

    + +
    + +
    + +
    +

    Valid XHTML 1.0!

    +

    $Id: license.html,v 1.13 2008/02/11 22:42:21 carregal Exp $

    +
    + +
    + + + diff --git a/luafilesystem.png b/luafilesystem.png new file mode 100644 index 0000000000000000000000000000000000000000..e1dd8c65b5211ba5dd37f2e86da987fdd517d6c6 GIT binary patch literal 8535 zcmX|HWjvj4AHSLIW~Ld_c9`y-9%i~tP3P1xaWFl@Oig!B593TtcMUV$lhdB-|K_vubSnPD0R77LtEJjNJ~5XFio48jap#gTF&V>n*LS$ctAksetdeg{te{@40W^;3G{ zPW2ANlX?Zeu?QGYIT#p{1{rjMi9Qe^2CuKJ{B>}ipAUZ@Jv{w~sX6PvU;oeWkb3#7 z(np35FH|Z`)K%ve<$n8yJ(zt%6GiPQ9LN0qr4FPsNUsLXRGJL*_owYt@v()K+(Dtl zSZI0oFFBGkGc(FMd5BvEz(^9@c5b^?Yz zKK}|-Q!y|xpR;_><-i9UA)(Uo?Z!~L8f%h9k&lm$n6U6*h6rhVucjByS3Y$|2oE_l zG!z~lZen7>LSnx?UU0H8gj{jO!;oVk>F(}+QKDO*{dRl&F(qYcz2gi?)Q_J(f1aLt zQba%V*ieI{9UUFj)nki_*wWO7`}&G2D)6zf**Q5w8Tw{sQion^CS5&^y@IF^j~+b= zmt};$-Dz%hJk)o=vN;gc(%L%Z;02CaCQpJzhV%I8)3Nb!62yv2$8AG%^TU!Sthw4H z*Vjs6vg`zyZ=ATdJaGtY^}9c_px_Y_rY0xXH#GclZTj+s0SP((J?|_7#bRCYs(f*Fk;nKS64SQ^sF9DPftU^@7|$^W>)Hz^;_2#6%`p)DEh&` ztl{F~LQs5fT|+}dZLO^3>X9!U9bKOh1Ub}G6Bmue#5}1q4Rl*q@sg48H(RdWXo<$< z7SCvVds4n-=Yoo&vkQBOT3l8((AW1xyM%^7=?R%>d%)YXohe*O9^De%%gal0a&n_a z=kC>`JoIYoev%xmPf1D4$to692#Z-TTfK3#x*W;MEbqH5U%h%|WMtHAOh-f{%|en` z+kPx`dX~J!*Baj@{*;oOci$LY+Jy)d0%3(n_GLa#84RSmx_x0$+$L(unufoNrx zrDhK{QBmsn-o~$Ajho$VkO+L`I7~D&hWG*N+Pk|TTU*;TGrD+8WVIXW?~{mzH_d+k zocSI4T0}eN>rP%*Yde6i4U0oKnM#9i>Bli6&1xm zN4M`Pp4ws4%n}w6VMLO1a&lsY5M7RKpB^6{gC*P7*9ZP=7IeAZ9ZgAwqX5>re)ad| zWiy^sTr^bmI55fa!)|o(z2_rQd)G@tEYfzkjPr!SU(o*V@|Sqa%YF%kH6cq5b{+L@o?Sng~>YuD*WXx_h#U zjg3t~X69nKK^+7Qr1J7|a4->JK@dTN$M5g&rlu$cfw8UaW}$leAWV7^9S`YHZ@61dg;<%NpU=q1Xm6L~Np1BzbI8yAnCj!vyj(KX zV@sB)QCYQo_}g6MZaPdzMwi2Db2t;6!Wx#=Zyi^84a(@7&mmpzS4NVkbRieXpqmSM zI3b!$izf*Y+U522_0^T0p5FQSxr5}{-<1FzcY26{V&FqkwA7t&z)b~q8uq~YF#>_O zy7Eg?!+^f8xN2xW+GJcJ@_9P*V0}lyG9Ms5^t_KvX&!q>d zId~h1jHqB{e*J`$n>)8f^j&uL;-}r$6cB6#2T%tALCV0o&%v)|&uwi>OQuYXk&zKz zUS6{%SAgTCrKJ@WPM62)pBYQEo~UVPG&DBa*3Bg)R()dUTutLF9oNoELkFe%IXxX* zi9kV9Zf@7o65YcyLPElm%K#S_7feh{)OQIVKYD_(+}nGD`VQQ-_u{z^V>ypGlF&xS$3LW`G+1`Of2^9q@G1d?9!&-;&QxAA0vw$8 zk&#VayA;vghSlbsfD&~%$YHCrq~vHa056MO!YrD~RL94e9Gu9HF69CPk<830CA!$q z7p=c!IAg=Z-~zjlp`EY!O^oddcQb5Yb!X4rn^TI_NT3L0RBUXU+bTl41P>QCl)C?lvzIC^+vu-e1~FSx-<|H(!i!E%E94xb*;oF*=Mbd zimD$?F@%NfhKuV_G!eUP!o~euQM`a07neJEK^aB&)hiES8l3R1b$4tuSw%&JF^^e| zWq5WreNzA6&!2$g(*e^$(goT_mjOaTLULwfixR&3hC@?jyf`@Xv789m90A@#8*pl7 zC7eF%0N3i>tFt?7Z2rtl`&s6rzvfh_3iG*^aUFIskTq;>vDN1hHT86b5hjF%hsQz^ z^{UDgD2^8|UOWozx6fEOm=l0p4X#~B{yH|2yBu}59uJR4UCbli+yGXZy2u0&-9EbS6qk|=91a!_zf zOA7$Q$9#NztgM9{9rxfOxVgFi10+&PN~NNS7postk~c?E>BY{Q+D(J0XFY{!HabH) z7aB*Vsw!w6z7Q6pCy&Z!ZRg<|tto%gm@+)VfD$R6>;LbdyQhaK?+joV83jcpAhq+o zIViZWuuwIX2b5x!Nh?JJlCh2tmKHNlTB^HqvY8FP+D1<6jiK2z@)(;`+@Dny{C66i zN9PA^UdPsnQM^|h=~Mpycxd2@5XyJHj1M1}QU@Acmg9=KEvSZpegaez87Ym(;x%hm zQ&l}VJylay{$4D``NVFaQNJP~q8YC{tHE7~!VDCtJeGL~AFXs~tdi82| zem>Ap%;Kh(9v<^FWqf?xb|lMbu2!LLG9rf7>CKzk+S;q@>$bKw@O$=+w}nMcLN{P~i+uQx(+SOy))p2EivzNsv+i<5I+5}>ZT?%kd@UE-MHj(P z%CwQbW3V!dsMii4hEK2imgnZ8dRIaHbl!9O&&|&}FMXREAJ@*&`Z8RUCAsgr8taIU zf18xt|H-^Ajh+2SH6@0&u0(eyEG#=#2dC}+?hkK!ooTQ4%2~L8D7ccWeDgv$Og`qV%ZADzt5tVsugR6pzxq zH`KO2Zt$^cYiB7bnNjgyu_XTOjZ={D`ziq@b)-(1hK&Bu%(Q*;cc=LzF+-swgjfOO zUtZ3I6{1&Rn4Fz`xVH8+=+-Y(fLnG&Sxs$cwU<^Wtt#&rD?Y-Us#w=S;vpZr{bYZ^ zXn&8Z$2h_QVCLq|)Musmc?ZYqur6Y(5E>dT+u^T-g#Tun+$hqAzJC(Iz>~woz^F9q zSQ;ILWJa?j{1ta$FNmWH%Jd4v1LsBhA4*V*(-}6z(9$1v_||Zy59N<3bCCa<5i&NI z^SBQ>Ss$1(v}HWm5Ls+%9qQ>Z=fsJj5+r_PLY|wOOJwqBM@PE^CVD07?7WLsfP$MY zG;+0;gk@$XW`goji(kl_Q+EI+w9rFqLZQ0QK3}~hpY~HKwzMim6ejwdc0CW z$g=P1e0Ov*>Cu_KIgEXCxWcHehfwu*r_ANuZR1E5_al$MTfh5k_)>9)*c1a9&cMLH zGsN*#rzr92$t5fe@96YsX)>+Mlpl4kx`~KXX7BwKfA+S68KFWiRA%alho}vj7pWF_;#4^bdjm=-01bFc>V3PGWv`wpg``5ASf! zBeeHXMr1~}ta7B0rDeicJZaQL5}Q@eVDrVzN~Rcp4H>(U(L!)AfJN5Hge{zbg9B&z z2aFWaU@6_)-U9sLriccpK*^>5Ww)g4m1EHD6yAn_;)&UP{p1gH3!WJf!D%-BI_J}F zKnLUF9F5MIp;x|YYIqcZe17=murvh)1^4D}B_;hsL-^Y+pi+S*^V$}BOfvWGfzROQ zY{be+r+)h{ybW#uwY2b~wtuzN~+ekkloui{p ziD?PuHZjgi{gUP;mV;#fJL@feDo5RWQ8#m!- zoAC3;lR$o+pL?4iM6S@P{mynqM@Kg{HhOw`e*H4GK5R}+edX%<_tPydb^GSE(=yb&s%&wC8>xHJoO?H5%P=t`T3SR+P)BFbWQeStoPebMYJo)jTk?0AC{))j zA)8aKATQ7kygHqvghSH)t#7IApx~^AyI%SMt<+=&EZ`za%E~6Da4cv!e!DiM@!KjY zDvsL;m~>0A6%`aHSXX{b@2a!isHsWl|M>D{Tg!pBH-WWno@PBL_-@OmwJFc&GEs|* zi$~vVjDNR=iHUjbobsBM!&Gb4fzDH`E0%V5H}rZYgJo~OWoQag1wzRS>6wh@{`3r~ z1BZ*P5pR^0TFeB~)mf8NRa895;o-72DVZ# zhu=xkMsB-h#oR@xC zz8B1GNTDZk#hH?P#za7Quyf(Q>8Pbcx`=xaPrzV`YgwU2`W169=f z7W1tHGQ`SZ2k+(Kea}wX!R1L-r;Lb0HSjqA3yx-LaHK2rm`(k@E>%=fezI&8brTQ( zBOOrqf8*_|$T8avaGjGy0{q zwV0|bo}wb`>{yp3+T$;^MxC{ssg;y^rF}1&8<$Q0u0&WE{wrk$x+iJk>h9XW#%2-G zo(p#KqK}A;jhz-4M;~) zwyZ2kla`=1DND+=-{w(Bkcx4V?aa@&U;j&=80Sz`X^DyMs3DfP1a8T&NUH-I_zVty z{v_EP22O5I(ZEwP>!*+bA(f_Mna1spQwv{xw-wp$a9nZ-a&)XsCdYOYF4X$eLX0zT zlZ{-7sacc1P=^i<4&2<_`daezxtyJx6dEcWQD^7o>|;E7`NADLdYVKOa|P_0GcA+FG8OM1nIT@3!z3lZl8bJ0LKV?+^D#R~PD3XR5qq z!}zJvkB>jC>0H=ha{|xKvuV_xw@achw8vIc#cSl8B}YjUeHl|$V+~hiepn&Y^&ucp zIn399&V#l9yQ_GRiG&ULfHwm9tJa19GWXR#T2Bpc2|-7z{>GvOLXRMW9Al& zSXeQ-e_Wtp)Y=Ka2rx^g{{H?_UR(QbV+cVH=UP9(x0|kEfm>VWH#7)}iuw(Doivp( zCbA;$i&Ing*|Oy!=;DS^0u>9-nz7Tt;ldET+IHlISxIl)uH%vRsw+{b3_iXWA->oB z^>XUoeDd2f4!wUp)-bgrxA>S>2QUirRz{Pxf6d2-S6X)2>a#5D_9yw}+=s``RJT%A&)ZW|L73XwGh+S1 z6oAV0)o5F?gVzrjewxH}a@xXb@4i)oxt;R!66qj)gT!K8wZKQ|L(=$itV#7PVG3_i zlKLlGV)!uN@KYz;iFXl%X7A-;khEKk#sun6KFPKFhOegUtPC*}+By2)|Kxmf)W}~| zP8v6B=Sks3ScP)eE`Q?hy;#c=kO3@)L?RuYy>EBz!E2)IHOyA&lNG$hod$|RjEadStEwzn1z+x8>2%YVWe&ZpD$|GcuGfuiFrjSm*Szke*&X zp`?DTztF2xlL{^2E^BJO(w^v9q`PsIt_r_Zv1a?zT1hhG&lV+x*(6BDd>{qF>-=)IJ9B+; zVF#z(IRUnJYO215c=0#^X`v|Z`{^<1nOp&hS3N(#K$y0_fmMy^T)x0F?6cW3tLzCb z)4lfvw_}8bGI1b`GBKeowS{AaEWNd5Ou>qkD+x$;)YD@zDg8+(g;&=w?c9=6W0w9D zY53}?k88EKr*d{g&Dh>z>!|1QfE%&k{PL>0O^k+m$sg+KLhrgP%ZUp{Y)PKAh zf<9bQf^BNr;ngLdtHH){aBv!i#!pipGG(If+S+4LKsTJlz0fWpx64h?TUg`P zk(1rzWaOvv(__s?rZcWP+9Yv#XsFAj{jH(yBztPv&COne6RvSh7b)}?Nm$_0){PEL zPX4tW5-o{}Q0tkQIaCrzE?3-dWSI;Jr3eV&whJN%GNA>es*o)Yi;$3`w~13DDsF zm&Yfz!{xNgFA4DaB(I)qUL3J;rH~(|9JN=~)>2zpYIodA#tqSxwGl_<18;iKmxu~- z@~Kzx9XBv-&Fi48QFpF^gyiI8A~eR{>}^ZgxS9|PVU8Wt6#O?m?~pR8sVxx^{=U9^ z$}Hm9Qa5`Kd71Ml@}iwkQ79kwV`IB{c-8l;xQb`3ZBGmXMWJYvR%NjIh;&swFVVAdlR4XgLebX25heO? ztNuU;0NHG-4{zxV42ecWO+CN3Xkrv?FSOPkSd~`$)`6OY?%=2sGrA^1D8BXc7^r2C zpRcX0nU|pXiXYru`chIp7{*N-uGZIMXWt$AgKjH;p+rec%t(gwG^_t$%kJ!CB)vy0 z>>eq@w8Cq)#OL>>G@`RpW>2E56BSs6R`30;prwsJ-IY>zP19=+ugOjpecV)2{mil1 zlU0a|5L8xzg|apJT%n!}@JrS2sb-3ngi?zadv)tkQSYc8EO)@^q2RV)4a5s>=r=Im zx+6RjNuVHad!=OgD4KxV`|#ld5cPX(mY-Rm0_~`b$xs|L88AAtD@e{eeWx)%kO5cQ zu$bm5y|OB^j)UD@$I-WatV3bErr(sA605IkA}lTj(`p-++byozo1zfX-)W`jZW}v> zgoW|esJbk+glFi-B?33o-RS2sKcA-GrF9#W&ZWj@D|0$Wa2YJ+{A_m7D2r4jS?rtm)>gkSHYYiKC$;HSI4h=c2_QWb?6YwUn^YiZlsB49Hbbs3fRofJa<*lu)74WTNn?u%Q zgA&8yjy1A(wIDwqNW1pCt6c=a``*zRp@3DzMUZ6@(tZ8(C$4Kcg_^iCF7Et&?Ag>R z%ueM~f}}J9QGP)IXpvPIH;;1>b0qIvUA6bdi-B0TwA3#>Jv=k>K}+F;JkxM@_vfM4 zgIW80wsEU~k^z+RIXB9wgG}I+G}I!(1b(vUv~$MutB3z zRykUHb2p}&7oP=gK4+1VLLrFW+*kiJ|oGHQzWT2II*d5nRj#R7>wHg;N*w|z*k zg|Dlt*8RJ8iu}*j6AUYO*x8%m_wDudXP=)r8k?A~trRFeKvt`6qwbWo0F>5FjfDlR)aFlGi^t$i>OYOcDip&ULScfZctn z;pWIwmo{mvWGdgG?y8n<=rlqa(Z1 z+_l+wXfY*)qTX=-;6PHnka^+{^VdJ1`L@5$ozxEkZeQ^wDzQU;+hHs;R3?yr6aDqQ zX%D;>KsR6@Vqs%@0D-<~XeX6b0rGYFN`fXoEYLAHXntYgF-epfEAX!>1@2?H3ZF~A z=yIT=zN@c)7A~81oJh_A*G0L3Bl8KG@2tiD{{+GPgO6mJs0j~RZoq>M;+_ino^mcu zPBzY-5W{mP3tJloTN`H^cMDG&YX-}=3`!a=8I + + + LuaFileSystem + + + + + + +
    + +
    + +
    LuaFileSystem
    +
    File System Library for the Lua Programming Language
    +
    + +
    + + + +
    + +

    Introduction

    + +

    LuaFileSystem is a Lua library +developed to complement the set of functions related to file +systems offered by the standard Lua distribution.

    + +

    LuaFileSystem offers a portable way to access +the underlying directory structure and file attributes.

    + +

    Building

    + +

    +LuaFileSystem should be built with Lua 5.1 so the language library +and header files for the target version must be installed properly. +

    + +

    +LuaFileSystem offers a Makefile and a separate configuration file, +config, +which should be edited to suit your installation before running +make. +The file has some definitions like paths to the external libraries, +compiler options and the like. +

    + +

    On Windows, the C runtime used to compile LuaFileSystem must be the same +runtime that Lua uses, or some LuaFileSystem functions will not work.

    + +

    Installation

    + +

    The easiest way to install LuaFileSystem is to use LuaRocks:

    + +
    +luarocks install luafilesystem
+
    + +

    If you prefer to install LuaFileSystem manually, the compiled binary should be copied to a directory in your +C path.

    + +

    Reference

    + +

    +LuaFileSystem offers the following functions: +

    + +
    +
    lfs.attributes (filepath [, aname])
    +
    Returns a table with the file attributes corresponding to + filepath (or nil 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 + lfs.attributes(filepath).aname, but the table is not created + and only one attribute is retrieved from the O.S.). + The attributes are described as follows; + attribute mode is a string, all the others are numbers, + and the time related attributes use the same time reference of + os.time: +
    +
    dev
    +
    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
    + +
    ino
    +
    on Unix systems, this represents the inode number. On Windows systems this has no meaning
    + +
    mode
    +
    string representing the associated protection mode (the values could be + file, directory, link, socket, + named pipe, char device, block device or + other)
    + +
    nlink
    +
    number of hard links to the file
    + +
    uid
    +
    user-id of owner (Unix only, always 0 on Windows)
    + +
    gid
    +
    group-id of owner (Unix only, always 0 on Windows)
    + +
    rdev
    +
    on Unix systems, represents the device type, for special file inodes. + On Windows systems represents the same as dev
    + +
    access
    +
    time of last access
    + +
    modification
    +
    time of last data modification
    + +
    change
    +
    time of last file status change
    + +
    size
    +
    file size, in bytes
    + +
    blocks
    +
    block allocated for file; (Unix only)
    + +
    blksize
    +
    optimal file system I/O blocksize; (Unix only)
    +
    + This function uses stat internally thus if the given + filepath 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 + lfs.symlinkattributes. +
    + +
    lfs.chdir (path)
    +
    Changes the current working directory to the given + path.
    + Returns true in case of success or nil plus an + error string.
    + +
    lfs.lock_dir(path, [seconds_stale])
    +
    Creates a lockfile (called lockfile.lfs) in path if it does not + exist and returns the lock. If the lock already exists checks it + it's stale, using the second parameter (default for the second + parameter is INT_MAX, which in practice means the lock will never + be stale. To free the the lock call lock:free().
    + 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.
    + +
    lfs.currentdir ()
    +
    Returns a string with the current working directory or nil + plus an error string.
    + +
    iter, dir_obj = lfs.dir (path)
    +
    + Lua iterator over the entries of a given directory. + Each time the iterator is called with dir_obj it returns a directory entry's name as a string, or + nil if there are no more entries. You can also iterate by calling dir_obj:next(), and + explicitly close the directory before the iteration finished with dir_obj:close(). + Raises an error if path is not a directory. +
    + +
    lfs.lock (filehandle, mode[, start[, length]])
    +
    Locks a file or a part of it. This function works on open files; the + file handle should be specified as the first argument. + The string mode could be either + r (for a read/shared lock) or w (for a + write/exclusive lock). The optional arguments start + and length can be used to specify a starting point and + its length; both should be numbers.
    + Returns true if the operation was successful; in + case of error, it returns nil plus an error string. +
    + +
    lfs.mkdir (dirname)
    +
    Creates a new directory. The argument is the name of the new + directory.
    + Returns true if the operation was successful; + in case of error, it returns nil plus an error string. +
    + +
    lfs.rmdir (dirname)
    +
    Removes an existing directory. The argument is the name of the directory.
    + Returns true if the operation was successful; + in case of error, it returns nil plus an error string.
    + +
    lfs.setmode (file, mode)
    +
    Sets the writing mode for a file. The mode string can be either binary or text. + Returns the previous mode string for the file. This function is only available in Windows, so you may want to make sure that + lfs.setmode exists before using it. +
    + +
    lfs.symlinkattributes (filepath [, aname])
    +
    Identical to lfs.attributes except that + it obtains information about the link itself (not the file it refers to). + This function is not available in Windows so you may want to make sure that + lfs.symlinkattributes exists before using it. +
    + +
    lfs.touch (filepath [, atime [, mtime]])
    +
    Set access and modification times of a file. This function is + a bind to utime function. The first argument is the + filename, the second argument (atime) is the access time, + and the third argument (mtime) is the modification time. + Both times are provided in seconds (which should be generated with + Lua standard function os.time). + If the modification time is omitted, the access time provided is used; + if both times are omitted, the current time is used.
    + Returns true if the operation was successful; + in case of error, it returns nil plus an error string. +
    + +
    lfs.unlock (filehandle[, start[, length]])
    +
    Unlocks a file or a part of it. This function works on + open files; the file handle should be specified as the first + argument. The optional arguments start and + length can be used to specify a starting point and its + length; both should be numbers.
    + Returns true if the operation was successful; + in case of error, it returns nil plus an error string. +
    +
    + +
    + +
    + +
    +

    Valid XHTML 1.0!

    +

    $Id: manual.html,v 1.45 2009/06/03 20:53:55 mascarenhas Exp $

    +
    + +
    + + +