From feb4ffcb08db0296d29b73606046dcf312952517 Mon Sep 17 00:00:00 2001
From: mainzelm <mainzelm>
Date: Fri, 6 Sep 2002 13:54:29 +0000
Subject: [PATCH] Documentation for the directory streams operations.

---
 doc/scsh-manual/syscalls.tex | 15 +++++++++++++++
 1 file changed, 15 insertions(+)

diff --git a/doc/scsh-manual/syscalls.tex b/doc/scsh-manual/syscalls.tex
index acecc81..7dedfab 100644
--- a/doc/scsh-manual/syscalls.tex
+++ b/doc/scsh-manual/syscalls.tex
@@ -1376,6 +1376,21 @@ Returns:
     split into separate entries. Using \ex{directory-files} is reliable.
 \end{desc}
     
+\defun {open-directory-stream} {dir} {directory-stream-record}
+\defun {read-directory-stream} {directory-stream-record} {string or \sharpf}
+\defun {close-directory-stream} {directory-stream-record} {\undefined}
+
+These functions implement a direct interface to the
+\ex{\urlh{http://www.freebsd.org/cgi/man.cgi?query=opendir&apropos=0&sektion=0&manpath=FreeBSD+4.3-RELEASE&format=html}{opendir()}}/
+\ex{\urlh{http://www.freebsd.org/cgi/man.cgi?query=readdir&apropos=0&sektion=0&manpath=FreeBSD+4.3-RELEASE&format=html}{readdir()}}/
+\ex{\urlh{http://www.freebsd.org/cgi/man.cgi?query=closedir&apropos=0&sektion=0&manpath=FreeBSD+4.3-RELEASE&format=html}{closedir()}}
+family of functions for processing directory streams.
+\ex{(open-directory-stream dir)} creates a stream of files in the
+directory \ex{dir}. \ex{(read-directory-stream directory-stream)}
+returns the next file in the stream or \sharpf if no such file exists.
+Finally, \ex{(close-directory-stream directory-stream)} closes the
+stream.
+
 \defun {glob} {\vari{pat}1 \ldots} {string list}
 \begin{desc}
     Glob each pattern against the filesystem and return the sorted list.