share/man/man3head/ftw.h.3head

   1 .\"
   2 .\" Sun Microsystems, Inc. gratefully acknowledges The Open Group for
   3 .\" permission to reproduce portions of its copyrighted documentation.
   4 .\" Original documentation from The Open Group can be obtained online at
   5 .\" http://www.opengroup.org/bookstore/.
   6 .\"
   7 .\" The Institute of Electrical and Electronics Engineers and The Open
   8 .\" Group, have given us permission to reprint portions of their
   9 .\" documentation.
  10 .\"
  11 .\" In the following statement, the phrase ``this text'' refers to portions
  12 .\" of the system documentation.
  13 .\"
  14 .\" Portions of this text are reprinted and reproduced in electronic form
  15 .\" in the SunOS Reference Manual, from IEEE Std 1003.1, 2004 Edition,
  16 .\" Standard for Information Technology -- Portable Operating System
  17 .\" Interface (POSIX), The Open Group Base Specifications Issue 6,
  18 .\" Copyright (C) 2001-2004 by the Institute of Electrical and Electronics
  19 .\" Engineers, Inc and The Open Group.  In the event of any discrepancy
  20 .\" between these versions and the original IEEE and The Open Group
  21 .\" Standard, the original IEEE and The Open Group Standard is the referee
  22 .\" document.  The original Standard can be obtained online at
  23 .\" http://www.opengroup.org/unix/online.html.
  24 .\"
  25 .\" This notice shall appear on any product containing this material.
  26 .\"
  27 .\" The contents of this file are subject to the terms of the
  28 .\" Common Development and Distribution License (the "License").
  29 .\" You may not use this file except in compliance with the License.
  30 .\"
  31 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE
  32 .\" or http://www.opensolaris.org/os/licensing.
  33 .\" See the License for the specific language governing permissions
  34 .\" and limitations under the License.
  35 .\"
  36 .\" When distributing Covered Code, include this CDDL HEADER in each
  37 .\" file and include the License file at usr/src/OPENSOLARIS.LICENSE.
  38 .\" If applicable, add the following below this CDDL HEADER, with the
  39 .\" fields enclosed by brackets "[]" replaced with your own identifying
  40 .\" information: Portions Copyright [yyyy] [name of copyright owner]
  41 .\"
  42 .\"
  43 .\" Copyright (c) 2001, The IEEE and The Open Group.  All Rights Reserved.
  44 .\" Portions Copyright (c) 2004, Sun Microsystems, Inc. All Rights Reserved.
  45 .\"
  46 .TH FTW.H 3HEAD "Sep 10, 2004"
  47 .SH NAME
  48 ftw.h, ftw \- file tree traversal
  49 .SH SYNOPSIS
  50 .LP
  51 .nf
  52 #include <\fBftw.h\fR>
  53 .fi
  54
  55 .SH DESCRIPTION
  56 .sp
  57 .LP
  58 The <\fBftw.h\fR> header defines the FTW structure that includes the following
  59 members:
  60 .sp
  61 .in +2
  62 .nf
  63 int base
  64 int level
  65 .fi
  66 .in -2
  67
  68 .sp
  69 .LP
  70 The <\fBftw.h\fR> header defines macros for use as values of  the third
  71 argument to the application-supplied function that is  passed as the second
  72 argument to \fBftw()\fR and \fBnftw()\fR (see \fBftw\fR(3C)):
  73 .sp
  74 .ne 2
  75 .na
  76 \fB\fBFTW_F\fR\fR
  77 .ad
  78 .RS 11n
  79 file
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fB\fBFTW_D\fR\fR
  86 .ad
  87 .RS 11n
  88 directory
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fB\fBFTW_DNR\fR\fR
  95 .ad
  96 .RS 11n
  97 directory without read permission
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fB\fBFTW_DP\fR\fR
 104 .ad
 105 .RS 11n
 106 directory with subdirectories visited
 107 .RE
 108
 109 .sp
 110 .ne 2
 111 .na
 112 \fB\fBFTW_NS\fR\fR
 113 .ad
 114 .RS 11n
 115 unknown type; \fBstat()\fR failed
 116 .RE
 117
 118 .sp
 119 .ne 2
 120 .na
 121 \fB\fBFTW_SL\fR\fR
 122 .ad
 123 .RS 11n
 124 symbolic link
 125 .RE
 126
 127 .sp
 128 .ne 2
 129 .na
 130 \fB\fBFTW_SLN\fR\fR
 131 .ad
 132 .RS 11n
 133 symbolic link that names a nonexistent file
 134 .RE
 135
 136 .sp
 137 .LP
 138 The <\fBftw.h\fR> header defines macros for use as values of the fourth
 139 argument to \fBnftw()\fR:
 140 .sp
 141 .ne 2
 142 .na
 143 \fB\fBFTW_PHYS\fR\fR
 144 .ad
 145 .RS 13n
 146 Physical walk, does not follow symbolic links. Otherwise, \fBnftw()\fR follows
 147 links but does not walk down any path that crosses itself.
 148 .RE
 149
 150 .sp
 151 .ne 2
 152 .na
 153 \fB\fBFTW_MOUNT\fR\fR
 154 .ad
 155 .RS 13n
 156 The walk does not cross a mount point.
 157 .RE
 158
 159 .sp
 160 .ne 2
 161 .na
 162 \fB\fBFTW_DEPTH\fR\fR
 163 .ad
 164 .RS 13n
 165 All subdirectories are visited before the directory itself.
 166 .RE
 167
 168 .sp
 169 .ne 2
 170 .na
 171 \fB\fBFTW_CHDIR\fR\fR
 172 .ad
 173 .RS 13n
 174 The walk changes to each direct ory before reading it.
 175 .RE
 176
 177 .sp
 178 .LP
 179 The <\fBftw.h\fR> header defines the \fBstat\fR structure and the symbolic
 180 names for \fBst_mode\fR and the file type test macros as described in
 181 <\fBsys/stat.h\fR>.
 182 .sp
 183 .LP
 184 Inclusion of the <\fBftw.h\fR> header might also make visible all symbols from
 185 <\fBsys/stat.h\fR>.
 186 .SH ATTRIBUTES
 187 .sp
 188 .LP
 189 See \fBattributes\fR(5) for descriptions of the following attributes:
 190 .sp
 191
 192 .sp
 193 .TS
 194 box;
 195 c | c
 196 l | l .
 197 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 198 _
 199 Interface Stability     Standard
 200 .TE
 201
 202 .SH SEE ALSO
 203 .sp
 204 .LP
 205 \fBftw\fR(3C), \fBstat.h\fR(3HEAD), \fBattributes\fR(5), \fBstandards\fR(5)