<?xml version="1.0" encoding="utf-8" ?> <!-- for emacs: -*- coding: utf-8 -*- -->
<!-- Apache may like this line in the file .htaccess: AddCharset utf-8 .html -->
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1 plus MathML 2.0 plus SVG 1.1//EN" "http://www.w3.org/2002/04/xhtml-math-svg/xhtml-math-svg-flat.dtd" >
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head><title>readDirectory -- read the contents of a directory</title>
<link rel="stylesheet" type="text/css" href="../../../../Macaulay2/Style/doc.css"/>
</head>
<body>
<table class="buttons">
<tr>
<td><div><a href="_realpath.html">next</a> | <a href="_symlink__Directory_lp__String_cm__String_rp.html">previous</a> | <a href="_realpath.html">forward</a> | <a href="_symlink__Directory_lp__String_cm__String_rp.html">backward</a> | <a href="_file_spmanipulation.html">up</a> | <a href="index.html">top</a> | <a href="master.html">index</a> | <a href="toc.html">toc</a> | <a href="http://www.math.uiuc.edu/Macaulay2/">Macaulay2 web site</a></div>
</td>
</tr>
</table>
<div><a href="index.html" title="">Macaulay2Doc</a> > <a href="___The_sp__Macaulay2_splanguage.html" title="">The Macaulay2 language</a> > <a href="_file_spmanipulation.html" title="Unix file manipulation functions">file manipulation</a> > <a href="_read__Directory.html" title="read the contents of a directory">readDirectory</a></div>
<hr/>
<div><h1>readDirectory -- read the contents of a directory</h1>
<div class="single"><h2>Synopsis</h2>
<ul><li><div class="list"><dl class="element"><dt class="heading">Usage: </dt><dd class="value"><div><tt>readDirectory dir</tt></div>
</dd></dl>
</div>
</li>
<li><div class="single">Inputs:<ul><li><span><tt>dir</tt>, <span>a <a href="___String.html">string</a></span>, a filename or path to a directory</span></li>
</ul>
</div>
</li>
<li><div class="single">Outputs:<ul><li><span><span>a <a href="___List.html">list</a></span>, the list of filenames stored in the directory</span></li>
</ul>
</div>
</li>
</ul>
</div>
<div class="single"><h2>Description</h2>
<div><table class="examples"><tr><td><pre>i1 : dir = temporaryFileName()
o1 = /tmp/M2-21934-1</pre>
</td></tr>
<tr><td><pre>i2 : makeDirectory dir</pre>
</td></tr>
<tr><td><pre>i3 : (fn = dir | "/" | "foo") << "hi there" << close
o3 = /tmp/M2-21934-1/foo
o3 : File</pre>
</td></tr>
<tr><td><pre>i4 : readDirectory dir
o4 = {foo, ., ..}
o4 : List</pre>
</td></tr>
<tr><td><pre>i5 : removeFile fn</pre>
</td></tr>
<tr><td><pre>i6 : removeDirectory dir</pre>
</td></tr>
</table>
</div>
</div>
<div class="single"><h2>See also</h2>
<ul><li><span><a href="_remove__Directory.html" title="remove a directory">removeDirectory</a> -- remove a directory</span></li>
<li><span><a href="_remove__File.html" title="remove a file">removeFile</a> -- remove a file</span></li>
<li><span><a href="_make__Directory_lp__String_rp.html" title="make a directory">makeDirectory</a> -- make a directory</span></li>
</ul>
</div>
</div>
</body>
</html>
