axf-os161 / man / bin / ls.html
ls.html
Raw
<!--
Copyright (c) 2000, 2001, 2002, 2003, 2004, 2005, 2008, 2009, 2013
	The President and Fellows of Harvard College.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
   notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
   notice, this list of conditions and the following disclaimer in the
   documentation and/or other materials provided with the distribution.
3. Neither the name of the University nor the names of its contributors
   may be used to endorse or promote products derived from this software
   without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE UNIVERSITY AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED.  IN NO EVENT SHALL THE UNIVERSITY OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
-->
<html>
<head>
<title>ls</title>
<body bgcolor=#ffffff>
<h2 align=center>ls</h2>
<h4 align=center>OS/161 Reference Manual</h4>

<h3>Name</h3>
<p>
ls - list files or directory contents
</p>

<h3>Synopsis</h3>
<p>
<tt>/bin/ls</tt> [<tt>-adlRs</tt>] [<em>path</em>...]
</p>

<h3>Description</h3>
<p>
<tt>ls</tt> lists the filesystem objects specified on the command
line. If they are directories, the contents of the directories are
listed (unless the <tt>-d</tt> option is used).
</p>

<p>
If the <tt>-a</tt> option is given, filenames beginning with dot (.)
will be listed. Ordinarily, they are skipped.
</p>

<p>
If the <tt>-d</tt> option is given, directory contents will not be
listed; the directories themselves will be.
</p>

<p>
If the <tt>-l</tt> option is given, a long format listing showing the
file size, type, and link count will be displayed instead of just the
filenames.
</p>

<p>
If the <tt>-R</tt> option is given, subdirectories encountered will be
listed recursively.
</p>

<p>
If the <tt>-s</tt> option is given, the number of filesystem blocks
used by each object will be displayed in addition to other
information.
</p>

<p>
If no <em>paths</em> are specified, the current directory is assumed.
</p>

<h3>Requirements</h3>
<p>
<tt>ls</tt> uses the following syscalls:
<ul>
<li> <A HREF=../syscall/open.html>open</A>
<li> <A HREF=../syscall/write.html>write</A>
<li> <A HREF=../syscall/fstat.html>fstat</A>
<li> <A HREF=../syscall/getdirentry.html>getdirentry</A>
<li> <A HREF=../syscall/close.html>close</A>
<li> <A HREF=../syscall/_exit.html>_exit</A>
</ul>
</p>

<p>
As fstat and getdirentry are generally not part of the basic system
calls assignment, <tt>ls</tt> will usually still not function after
the basic system calls assignment is complete.
These calls are typically part of a later assignment, usually the file
system assignment. You may also need to implement the getdirentry
functionality at the file system level.
Consult your course materials for specific information.
</p>

</body>
</html>