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

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