Libc-498.tar.gz

[apple/libc.git] / gen / ftw.3

diff --git a/gen/ftw.3 b/gen/ftw.3
index ae0479eb1bff0102328e2d4f75af8a4794024781..b6cad17c984c8e5e75e121c405abcc195b60ad5b 100644 (file)
--- a/gen/ftw.3
+++ b/gen/ftw.3
@@ -29,14 +29,15 @@
 .Ft int
 .Fo ftw
 .Fa "const char *path"
 .Ft int
 .Fo ftw
 .Fa "const char *path"

-.Fa "int (*fn)(const char *, const struct stat *, int)"
-.Fa "int maxfds"
+.Fa "int (*fn)(const\ char\ *, const\ struct\ stat\ *ptr, int\ flag)"
+.Fa "int depth"

 .Fc
 .Ft int
 .Fo nftw
 .Fa "const char *path"
 .Fc
 .Ft int
 .Fo nftw
 .Fa "const char *path"

-.Fa "int (*fn)(const\ char\ *, const\ struct\ stat\ *, int, struct\ FTW\ *)"
-.Fa "int maxfds"
+.Fa "int (*fn)(const\ char\ *, const\ struct\ stat\ *ptr, \
+     int\ flag, struct\ FTW\ *)"
+.Fa "int depth"

 .Fa "int flags"
 .Fc
 .Sh DESCRIPTION
 .Fa "int flags"
 .Fc
 .Sh DESCRIPTION


@@ -109,7 +110,7 @@ function traverses the tree in pre-order.
 That is, it processes the directory before the directory's contents.
 .Pp
 The
 That is, it processes the directory before the directory's contents.
 .Pp
 The

-.Fa maxfds
+.Fa depth

 argument specifies the maximum number of file descriptors
 to keep open while traversing the tree.
 It has no effect in this implementation.
 argument specifies the maximum number of file descriptors
 to keep open while traversing the tree.
 It has no effect in this implementation.


@@ -183,7 +184,7 @@ as follows:
 .Bl -tag -width Er
 .It Bq Er EINVAL
 The
 .Bl -tag -width Er
 .It Bq Er EINVAL
 The

-.Fa maxfds
+.Fa depth

 argument is less than 1 or greater than
 .Dv OPEN_MAX .
 .El
 argument is less than 1 or greater than
 .Dv OPEN_MAX .
 .El


@@ -196,18 +197,18 @@ functions are far more tolerant of symlink cycles and are lax in reporting
 errors while accessing the initial path.  When
 .Fn nftw
 is passed
 errors while accessing the initial path.  When
 .Fn nftw
 is passed

-.Dv FTW_MOUNT
-it will pass the callback the mount point.
+.Dv FTW_MOUNT ,
+it will pass the mount point to the callback function.

 .Sh SEE ALSO
 .Xr chdir 2 ,
 .Xr close 2 ,
 .Xr open 2 ,
 .Xr stat 2 ,
 .Sh SEE ALSO
 .Xr chdir 2 ,
 .Xr close 2 ,
 .Xr open 2 ,
 .Xr stat 2 ,

-.Xr compat 5 ,

 .Xr fts 3 ,
 .Xr malloc 3 ,
 .Xr opendir 3 ,
 .Xr fts 3 ,
 .Xr malloc 3 ,
 .Xr opendir 3 ,

-.Xr readdir 3
+.Xr readdir 3 ,
+.Xr compat 5

 .Sh STANDARDS
 The
 .Fn ftw
 .Sh STANDARDS
 The
 .Fn ftw


@@ -222,5 +223,5 @@ Prior to MacOS X 10.4
 did not follow symlinks.
 .Sh BUGS
 The
 did not follow symlinks.
 .Sh BUGS
 The

-.Fa maxfds
+.Fa depth

 argument is currently ignored.
 argument is currently ignored.