man-pages/man3/readdir.3am.html
2021-03-31 01:06:50 +01:00

166 lines
3.5 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of READDIR</TITLE>
</HEAD><BODY>
<H1>READDIR</H1>
Section: GNU Awk Extension Modules (3am)<BR>Updated: Mar 17 2019<BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
readdir - directory input parser for gawk
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
@load &quot;readdir&quot;
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
The
<I>readdir</I>
extension
adds an input parser for directories.
<P>
When this extension is in use, instead of skipping directories named
on the command line (or with
<B>getline</B>),
they are read, with each entry returned as a record.
<P>
The record consists of three fields. The first two are the inode number and the
filename, separated by a forward slash character.
On systems where the directory entry contains the file type, the record
has a third field which is a single letter indicating the type of the
file:
<B>f</B>
for file,
<B>d</B>
for directory,
<B>b</B>
for a block device,
<B>c</B>
for a character device,
<B>p</B>
for a FIFO,
<B>l</B>
for a symbolic link,
<B>s</B>
for a socket.
<P>
On systems without the file type information, the extension falls back
to calling
<I><A HREF="/cgi-bin/man/man2html?2+stat">stat</A></I>(2),
in order to provide the information.
Thus the third field should never be
<B>u</B>.
<A NAME="lbAE">&nbsp;</A>
<H2>EXAMPLE</H2>
<PRE>
@load &quot;readdir&quot;
...
BEGIN { FS = &quot;/&quot; }
{ print &quot;file name is&quot;, $2 }
</PRE>
<A NAME="lbAF">&nbsp;</A>
<H2>SEE ALSO</H2>
<I>GAWK: Effective AWK Programming</I>,
<I>filefuncs</I>(3am),
<I>fnmatch</I>(3am),
<I>fork</I>(3am),
<I>inplace</I>(3am),
<I>ordchr</I>(3am),
<I>readfile</I>(3am),
<I>revoutput</I>(3am),
<I>rwarray</I>(3am),
<I>time</I>(3am).
<P>
<I><A HREF="/cgi-bin/man/man2html?3+opendir">opendir</A></I>(3),
<I><A HREF="/cgi-bin/man/man2html?3+readdir">readdir</A></I>(3),
<I><A HREF="/cgi-bin/man/man2html?2+stat">stat</A></I>(2).
<A NAME="lbAG">&nbsp;</A>
<H2>AUTHOR</H2>
Arnold Robbins,
<B><A HREF="mailto:arnold@skeeve.com">arnold@skeeve.com</A></B>.
<A NAME="lbAH">&nbsp;</A>
<H2>COPYING PERMISSIONS</H2>
Copyright &#169; 2012, 2013, 2018, 2019
Free Software Foundation, Inc.
<P>
Permission is granted to make and distribute verbatim copies of
this manual page provided the copyright notice and this permission
notice are preserved on all copies.
<P>
Permission is granted to copy and distribute modified versions of this
manual page under the conditions for verbatim copying, provided that
the entire resulting derived work is distributed under the terms of a
permission notice identical to this one.
<P>
Permission is granted to copy and distribute translations of this
manual page into another language, under the above conditions for
modified versions, except that this permission notice may be stated in
a translation approved by the Foundation.
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="1"><A HREF="#lbAB">NAME</A><DD>
<DT id="2"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="3"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="4"><A HREF="#lbAE">EXAMPLE</A><DD>
<DT id="5"><A HREF="#lbAF">SEE ALSO</A><DD>
<DT id="6"><A HREF="#lbAG">AUTHOR</A><DD>
<DT id="7"><A HREF="#lbAH">COPYING PERMISSIONS</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:54 GMT, March 31, 2021
</BODY>
</HTML>