iank
/
libreCMC
forked from libreCMC/libreCMC


			
							12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562
							<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html>
<head>
    <title>Reference</title>
    <link rel="stylesheet" href="../luadoc.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"></div>
	<div id="product_name"><big><b></b></big></div>
	<div id="product_description"></div>
</div> <!-- id="product" -->

<div id="main">

<div id="navigation">


<h1>LuaDoc</h1>
<ul>
	
	<li><a href="../index.html">Index</a></li>
	
</ul>


<!-- Module list -->

<h1>Modules</h1>
<ul>

	<li>
		<a href="../modules/luci.dispatcher.html">luci.dispatcher</a>
	</li>

	<li>
		<a href="../modules/luci.http.html">luci.http</a>
	</li>

	<li>
		<a href="../modules/luci.http.protocol.html">luci.http.protocol</a>
	</li>

	<li>
		<a href="../modules/luci.http.protocol.conditionals.html">luci.http.protocol.conditionals</a>
	</li>

	<li>
		<a href="../modules/luci.http.protocol.date.html">luci.http.protocol.date</a>
	</li>

	<li>
		<a href="../modules/luci.http.protocol.mime.html">luci.http.protocol.mime</a>
	</li>

	<li>
		<a href="../modules/luci.i18n.html">luci.i18n</a>
	</li>

	<li>
		<a href="../modules/luci.ip.html">luci.ip</a>
	</li>

	<li>
		<a href="../modules/luci.ip.cidr.html">luci.ip.cidr</a>
	</li>

	<li>
		<a href="../modules/luci.json.html">luci.json</a>
	</li>

	<li>
		<a href="../modules/luci.jsonc.html">luci.jsonc</a>
	</li>

	<li>
		<a href="../modules/luci.jsonc.parser.html">luci.jsonc.parser</a>
	</li>

	<li>
		<a href="../modules/luci.model.ipkg.html">luci.model.ipkg</a>
	</li>

	<li>
		<a href="../modules/luci.model.uci.html">luci.model.uci</a>
	</li>

	<li>
		<a href="../modules/luci.rpcc.html">luci.rpcc</a>
	</li>

	<li>
		<a href="../modules/luci.rpcc.ruci.html">luci.rpcc.ruci</a>
	</li>

	<li>
		<a href="../modules/luci.sys.html">luci.sys</a>
	</li>

	<li>
		<a href="../modules/luci.sys.init.html">luci.sys.init</a>
	</li>

	<li>
		<a href="../modules/luci.sys.iptparser.html">luci.sys.iptparser</a>
	</li>

	<li>
		<a href="../modules/luci.sys.net.html">luci.sys.net</a>
	</li>

	<li>
		<a href="../modules/luci.sys.process.html">luci.sys.process</a>
	</li>

	<li>
		<a href="../modules/luci.sys.user.html">luci.sys.user</a>
	</li>

	<li>
		<a href="../modules/luci.sys.wifi.html">luci.sys.wifi</a>
	</li>

	<li>
		<a href="../modules/luci.util.html">luci.util</a>
	</li>

	<li>
		<a href="../modules/nixio.html">nixio</a>
	</li>

	<li>
		<a href="../modules/nixio.CHANGELOG.html">nixio.CHANGELOG</a>
	</li>

	<li>
		<a href="../modules/nixio.CryptoHash.html">nixio.CryptoHash</a>
	</li>

	<li>
		<a href="../modules/nixio.File.html">nixio.File</a>
	</li>

	<li>
		<a href="../modules/nixio.README.html">nixio.README</a>
	</li>

	<li>
		<a href="../modules/nixio.Socket.html">nixio.Socket</a>
	</li>

	<li>
		<a href="../modules/nixio.TLSContext.html">nixio.TLSContext</a>
	</li>

	<li>
		<a href="../modules/nixio.TLSSocket.html">nixio.TLSSocket</a>
	</li>

	<li>
		<a href="../modules/nixio.UnifiedIO.html">nixio.UnifiedIO</a>
	</li>

	<li>
		<a href="../modules/nixio.bin.html">nixio.bin</a>
	</li>

	<li>
		<a href="../modules/nixio.bit.html">nixio.bit</a>
	</li>

	<li>
		<a href="../modules/nixio.crypto.html">nixio.crypto</a>
	</li>

	<li><strong>nixio.fs</strong></li>
	
</ul>


<!-- File list -->


</div><!-- id="navigation" -->

<div id="content">

<h1>Class <code>nixio.fs</code></h1>

<p>
 Low-level and high-level filesystem manipulation library.</p>


<h2>Functions</h2>
<table class="function_list">

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.access">access</a>&nbsp;(path, mode1, ...)</td>
	<td class="summary">
 Check user's permission on a file.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.basename">basename</a>&nbsp;(path)</td>
	<td class="summary">
 Strip the directory part from a path.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.chmod">chmod</a>&nbsp;(path, mode)</td>
	<td class="summary">
 Change the file mode.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.chown">chown</a>&nbsp;(path, user, group)</td>
	<td class="summary">
 (POSIX) Change owner and group of a file.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.copy">copy</a>&nbsp;(src, dest)</td>
	<td class="summary">
 Copy a file, directory or symlink non-recursively preserving file mode, 
 timestamps, owner and group.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.copyr">copyr</a>&nbsp;(src, dest)</td>
	<td class="summary">
 Copy a file, directory or symlink recursively preserving file mode, 
 timestamps, owner and group.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.datacopy">datacopy</a>&nbsp;(src, dest, limit)</td>
	<td class="summary">
 Copy data between files.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.dir">dir</a>&nbsp;(path)</td>
	<td class="summary">
 Iterate over the entries of a directory.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.dirname">dirname</a>&nbsp;(path)</td>
	<td class="summary">
 Strip the base from a path.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.glob">glob</a>&nbsp;(pattern)</td>
	<td class="summary">
 (POSIX) Find pathnames matching a pattern.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.lchown">lchown</a>&nbsp;(path, user, group)</td>
	<td class="summary">
 (POSIX) Change owner and group of a file and do not resolve 
 if target is a symlink.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.link">link</a>&nbsp;(oldpath, newpath)</td>
	<td class="summary">
 Create a hard link.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.lstat">lstat</a>&nbsp;(path, field)</td>
	<td class="summary">
 Get file status and attributes and do not resolve if target is a symlink.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.mkdir">mkdir</a>&nbsp;(path, mode)</td>
	<td class="summary">
 Create a new directory.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.mkdirr">mkdirr</a>&nbsp;(dest, mode)</td>
	<td class="summary">
 Create a directory and all needed parent directories recursively.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.mkfifo">mkfifo</a>&nbsp;(path, mode)</td>
	<td class="summary">
 (POSIX) Create a FIFO (named pipe).</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.move">move</a>&nbsp;(src, dest)</td>
	<td class="summary">
 Rename a file, directory or symlink non-recursively across filesystems.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.mover">mover</a>&nbsp;(src, dest)</td>
	<td class="summary">
 Rename a file, directory or symlink recursively across filesystems.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.readfile">readfile</a>&nbsp;(path, limit)</td>
	<td class="summary">
 Read the contents of a file into a buffer.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.readlink">readlink</a>&nbsp;(path)</td>
	<td class="summary">
 (POSIX) Read the target of a symbolic link.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.realpath">realpath</a>&nbsp;(path)</td>
	<td class="summary">
 Return the cannonicalized absolute pathname.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.remove">remove</a>&nbsp;(path)</td>
	<td class="summary">
 Remove a file or directory.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.rename">rename</a>&nbsp;(src, dest)</td>
	<td class="summary">
 Renames a file or directory.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.rmdir">rmdir</a>&nbsp;(path)</td>
	<td class="summary">
 Remove an empty directory.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.stat">stat</a>&nbsp;(path, field)</td>
	<td class="summary">
 Get file status and attributes.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.statvfs">statvfs</a>&nbsp;(path)</td>
	<td class="summary">
 (POSIX) Get filesystem statistics.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.symlink">symlink</a>&nbsp;(oldpath, newpath)</td>
	<td class="summary">
 (POSIX) Create a symbolic link.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.unlink">unlink</a>&nbsp;(path)</td>
	<td class="summary">
 Delete a name and - if no links are left - the associated file.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.utimes">utimes</a>&nbsp;(path, actime, mtime)</td>
	<td class="summary">
 Change file last access and last modification time.</td>
	</tr>

	<tr>
	<td class="name" nowrap><a href="#nixio.fs.writefile">writefile</a>&nbsp;(path, data)</td>
	<td class="summary">
 Write a buffer into a file truncating the file first.</td>
	</tr>

</table>


<br/>
<br/>


<h2><a name="functions"></a>Functions</h2>
<dl class="function">


<dt><a name="nixio.fs.access"></a><strong>access</strong>&nbsp;(path, mode1, ...)</dt>
<dd>

 Check user's permission on a file.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  mode1: First Mode to check ["f", "r", "w", "x"]
	</li>
	
	<li>
	  ...: More Modes to check	[-"-]
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.basename"></a><strong>basename</strong>&nbsp;(path)</dt>
<dd>

 Strip the directory part from a path.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
</ul>


<h3>Usage:</h3>
This function cannot fail and will never return nil.


<h3>Return value:</h3>
basename


</dd>


<dt><a name="nixio.fs.chmod"></a><strong>chmod</strong>&nbsp;(path, mode)</dt>
<dd>

 Change the file mode.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  mode: File mode	 
 [decimal mode number, "[-r][-w][-xsS][-r][-w][-xsS][-r][-w][-xtT]"]
	</li>
	
</ul>


<h3>Usage</h3>
<ul>
	
	<li>Windows only supports setting the write-protection through the 
 "Writable to others" bit.
	
	<li><strong>Notice:</strong> The mode-flag for the functions 
 open, mkdir, mkfifo are affected by the umask. 
	
</ul>


<h3>Return value:</h3>
true


<h3>See also:</h3>
<ul>
	
	<li><a href="">
		umask
	</a>
	
</ul>

</dd>


<dt><a name="nixio.fs.chown"></a><strong>chown</strong>&nbsp;(path, user, group)</dt>
<dd>

 (POSIX) Change owner and group of a file.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  user: User ID or Username		(optional)
	</li>
	
	<li>
	  group: Group ID or Groupname	(optional)
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.copy"></a><strong>copy</strong>&nbsp;(src, dest)</dt>
<dd>

 Copy a file, directory or symlink non-recursively preserving file mode, 
 timestamps, owner and group.


<h3>Parameters</h3>
<ul>
	
	<li>
	  src: Source path
	</li>
	
	<li>
	  dest: Destination path
	</li>
	
</ul>


<h3>Usage:</h3>
The destination must always be a full destination path e.g. do not 
 omit the basename even if source and destination basename are equal. 


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.copyr"></a><strong>copyr</strong>&nbsp;(src, dest)</dt>
<dd>

 Copy a file, directory or symlink recursively preserving file mode, 
 timestamps, owner and group.


<h3>Parameters</h3>
<ul>
	
	<li>
	  src: Source path
	</li>
	
	<li>
	  dest: Destination path
	</li>
	
</ul>


<h3>Usage:</h3>
The destination must always be a full destination path e.g. do not 
 omit the basename even if source and destination basename are equal. 


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.datacopy"></a><strong>datacopy</strong>&nbsp;(src, dest, limit)</dt>
<dd>

 Copy data between files.


<h3>Parameters</h3>
<ul>
	
	<li>
	  src: Source file path
	</li>
	
	<li>
	  dest: Destination file path
	</li>
	
	<li>
	  limit: Maximum bytes to copy (optional)
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.dir"></a><strong>dir</strong>&nbsp;(path)</dt>
<dd>

 Iterate over the entries of a directory.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
</ul>


<h3>Usage:</h3>
The special entries "." and ".." are omitted.


<h3>Return value:</h3>
directory iterator returning one entry per call


</dd>


<dt><a name="nixio.fs.dirname"></a><strong>dirname</strong>&nbsp;(path)</dt>
<dd>

 Strip the base from a path.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
</ul>


<h3>Usage:</h3>
This function cannot fail and will never return nil.


<h3>Return value:</h3>
dirname


</dd>


<dt><a name="nixio.fs.glob"></a><strong>glob</strong>&nbsp;(pattern)</dt>
<dd>

 (POSIX) Find pathnames matching a pattern.


<h3>Parameters</h3>
<ul>
	
	<li>
	  pattern: Pattern
	</li>
	
</ul>


<h3>Return values:</h3>
<ol>
	
	<li>path iterator
	
	<li>number of matches
	
</ol>


</dd>


<dt><a name="nixio.fs.lchown"></a><strong>lchown</strong>&nbsp;(path, user, group)</dt>
<dd>

 (POSIX) Change owner and group of a file and do not resolve 
 if target is a symlink.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  user: User ID or Username		(optional)
	</li>
	
	<li>
	  group: Group ID or Groupname	(optional)
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.link"></a><strong>link</strong>&nbsp;(oldpath, newpath)</dt>
<dd>

 Create a hard link.


<h3>Parameters</h3>
<ul>
	
	<li>
	  oldpath: Path
	</li>
	
	<li>
	  newpath: Path
	</li>
	
</ul>


<h3>Usage:</h3>
This function calls link() on POSIX and CreateHardLink() on Windows.


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.lstat"></a><strong>lstat</strong>&nbsp;(path, field)</dt>
<dd>

 Get file status and attributes and do not resolve if target is a symlink.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  field: Only return a specific field, not the whole table (optional)
	</li>
	
</ul>


<h3>Return value:</h3>
Table containing attributes (see stat for a detailed description)


<h3>See also:</h3>
<ul>
	
	<li><a href="#nixio.fs.stat">
		stat
	</a>
	
</ul>

</dd>


<dt><a name="nixio.fs.mkdir"></a><strong>mkdir</strong>&nbsp;(path, mode)</dt>
<dd>

 Create a new directory.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  mode: File mode (optional, see chmod and umask)
	</li>
	
</ul>


<h3>Return value:</h3>
true


<h3>See also:</h3>
<ul>
	
	<li><a href="#nixio.fs.chmod">
		chmod
	</a>
	
	<li><a href="">
		umask
	</a>
	
</ul>

</dd>


<dt><a name="nixio.fs.mkdirr"></a><strong>mkdirr</strong>&nbsp;(dest, mode)</dt>
<dd>

 Create a directory and all needed parent directories recursively. 


<h3>Parameters</h3>
<ul>
	
	<li>
	  dest: Destination path
	</li>
	
	<li>
	  mode: File mode (optional, see chmod and umask)
	</li>
	
</ul>


<h3>Return value:</h3>
true


<h3>See also:</h3>
<ul>
	
	<li><a href="#nixio.fs.chmod">
		chmod
	</a>
	
	<li><a href="">
		umask
	</a>
	
</ul>

</dd>


<dt><a name="nixio.fs.mkfifo"></a><strong>mkfifo</strong>&nbsp;(path, mode)</dt>
<dd>

 (POSIX) Create a FIFO (named pipe).


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  mode: File mode (optional, see chmod and umask)
	</li>
	
</ul>


<h3>Return value:</h3>
true


<h3>See also:</h3>
<ul>
	
	<li><a href="#nixio.fs.chmod">
		chmod
	</a>
	
	<li><a href="">
		umask
	</a>
	
</ul>

</dd>


<dt><a name="nixio.fs.move"></a><strong>move</strong>&nbsp;(src, dest)</dt>
<dd>

 Rename a file, directory or symlink non-recursively across filesystems.


<h3>Parameters</h3>
<ul>
	
	<li>
	  src: Source path
	</li>
	
	<li>
	  dest: Destination path
	</li>
	
</ul>


<h3>Usage:</h3>
The destination must always be a full destination path e.g. do not 
 omit the basename even if source and destination basename are equal. 


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.mover"></a><strong>mover</strong>&nbsp;(src, dest)</dt>
<dd>

 Rename a file, directory or symlink recursively across filesystems.


<h3>Parameters</h3>
<ul>
	
	<li>
	  src: Source path
	</li>
	
	<li>
	  dest: Destination path
	</li>
	
</ul>


<h3>Usage:</h3>
The destination must always be a full destination path e.g. do not 
 omit the basename even if source and destination basename are equal. 


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.readfile"></a><strong>readfile</strong>&nbsp;(path, limit)</dt>
<dd>

 Read the contents of a file into a buffer.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  limit: Maximum bytes to read (optional)
	</li>
	
</ul>


<h3>Return value:</h3>
file contents


</dd>


<dt><a name="nixio.fs.readlink"></a><strong>readlink</strong>&nbsp;(path)</dt>
<dd>

 (POSIX) Read the target of a symbolic link.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
</ul>


<h3>Return value:</h3>
target path


</dd>


<dt><a name="nixio.fs.realpath"></a><strong>realpath</strong>&nbsp;(path)</dt>
<dd>

 Return the cannonicalized absolute pathname.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
</ul>


<h3>Return value:</h3>
absolute path


</dd>


<dt><a name="nixio.fs.remove"></a><strong>remove</strong>&nbsp;(path)</dt>
<dd>

 Remove a file or directory.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.rename"></a><strong>rename</strong>&nbsp;(src, dest)</dt>
<dd>

 Renames a file or directory.


<h3>Parameters</h3>
<ul>
	
	<li>
	  src: Source path
	</li>
	
	<li>
	  dest: Destination path
	</li>
	
</ul>


<h3>Usage:</h3>
It is normally not possible to rename files across fileystems.


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.rmdir"></a><strong>rmdir</strong>&nbsp;(path)</dt>
<dd>

 Remove an empty directory.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.stat"></a><strong>stat</strong>&nbsp;(path, field)</dt>
<dd>

 Get file status and attributes.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  field: Only return a specific field, not the whole table (optional)
	</li>
	
</ul>


<h3>Return value:</h3>
Table containing: <ul> 
 <li>atime = Last access timestamp</li> 
 <li>blksize = Blocksize (POSIX only)</li> 
 <li>blocks = Blocks used (POSIX only)</li> 
 <li>ctime = Creation timestamp</li> 
 <li>dev = Device ID</li> 
 <li>gid = Group ID</li> 
 <li>ino = Inode</li> 
 <li>modedec = Mode converted into a decimal number</li> 
 <li>modestr = Mode as string as returned by <code>ls -l</code></li> 
 <li>mtime = Last modification timestamp</li> 
 <li>nlink = Number of links</li> 
 <li>rdev = Device ID (if special file)</li> 
 <li>size = Size in bytes</li> 
 <li>type = ["reg", "dir", "chr", "blk", "fifo", "lnk", "sock"]</li> 
 <li>uid = User ID</li> 
 </ul>


</dd>


<dt><a name="nixio.fs.statvfs"></a><strong>statvfs</strong>&nbsp;(path)</dt>
<dd>

 (POSIX) Get filesystem statistics.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path to any file within the filesystem.
	</li>
	
</ul>


<h3>Return value:</h3>
Table containing: <ul> 
 <li>bavail = available blocks</li> 
 <li>bfree = free blocks</li> 
 <li>blocks = number of fragments</li> 
 <li>frsize = fragment size</li> 
 <li>favail = available inodes</li> 
 <li>ffree = free inodes</li> 
 <li>files = inodes</li> 
 <li>flag = flags</li> 
 <li>fsid = filesystem ID</li> 
 <li>namemax = maximum filename length</li> 
 </ul>


</dd>


<dt><a name="nixio.fs.symlink"></a><strong>symlink</strong>&nbsp;(oldpath, newpath)</dt>
<dd>

 (POSIX) Create a symbolic link.


<h3>Parameters</h3>
<ul>
	
	<li>
	  oldpath: Path
	</li>
	
	<li>
	  newpath: Path
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.unlink"></a><strong>unlink</strong>&nbsp;(path)</dt>
<dd>

 Delete a name and - if no links are left - the associated file.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.utimes"></a><strong>utimes</strong>&nbsp;(path, actime, mtime)</dt>
<dd>

 Change file last access and last modification time.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  actime: Last access timestamp	(optional, default: current time)
	</li>
	
	<li>
	  mtime: Last modification timestamp (optional, default: actime)
	</li>
	
</ul>


<h3>Return value:</h3>
true


</dd>


<dt><a name="nixio.fs.writefile"></a><strong>writefile</strong>&nbsp;(path, data)</dt>
<dd>

 Write a buffer into a file truncating the file first.


<h3>Parameters</h3>
<ul>
	
	<li>
	  path: Path
	</li>
	
	<li>
	  data: Data to write
	</li>
	
</ul>


<h3>Return value:</h3>
true


</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>
</div> <!-- id="about" -->

</div> <!-- id="container" -->
</body>
</html>