logo

oasis-root

Compiled tree of Oasis Linux based on own branch at <https://hacktivis.me/git/oasis/> git clone https://anongit.hacktivis.me/git/oasis-root.git

ftw.h.0p (3345B)

    

  1. '\" et
  2. .TH ftw.h "0P" 2017 "IEEE/The Open Group" "POSIX Programmer's Manual"
  3. .\"
  4. .SH PROLOG
  5. This manual page is part of the POSIX Programmer's Manual.
  6. The Linux implementation of this interface may differ (consult
  7. the corresponding Linux manual page for details of Linux behavior),
  8. or the interface may not be implemented on Linux.
  9. .\"
  10. .SH NAME
  11. ftw.h
  12. \(em file tree traversal
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <ftw.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <ftw.h> 
  21. header shall define the
  22. .BR FTW
  23. structure, which shall include at least the following members:
  24. .sp
  25. .RS 4
  26. .nf
  28. int  base
  29. int  level
  30. .fi
  31. .P
  32. .RE
  33. .P
  34. The
  35. .IR <ftw.h> 
  36. header shall define the following symbolic constants for use as values
  37. of the third argument to the application-supplied function that is
  38. passed as the second argument to
  39. \fIftw\fR()
  40. and
  41. \fInftw\fR():
  42. .IP FTW_F 14
  43. Non-directory file.
  44. .IP FTW_D 14
  45. Directory.
  46. .IP FTW_DNR 14
  47. Directory without read permission.
  48. .IP FTW_DP 14
  49. Directory with subdirectories visited.
  50. .IP FTW_NS 14
  51. Unknown type;
  52. \fIstat\fR()
  53. failed.
  54. .IP FTW_SL 14
  55. Symbolic link.
  56. .IP FTW_SLN 14
  57. Symbolic link that names a nonexistent file.
  58. .P
  59. The
  60. .IR <ftw.h> 
  61. header shall define the following symbolic constants for use as
  62. values of the fourth argument to
  63. \fInftw\fR():
  64. .IP FTW_PHYS 14
  65. Physical walk, does not follow symbolic links. Otherwise,
  66. \fInftw\fR()
  67. follows links but does not walk down any path that crosses itself.
  68. .IP FTW_MOUNT 14
  69. The walk does not cross a mount point.
  70. .IP FTW_DEPTH 14
  71. All subdirectories are visited before the directory itself.
  72. .IP FTW_CHDIR 14
  73. The walk changes to each directory before reading it.
  74. .P
  75. The following shall be declared as functions and may also be defined as
  76. macros. Function prototypes shall be provided.
  77. .sp
  78. .RS 4
  79. .nf
  81. int ftw(const char *, int (*)(const char *, const struct stat *,
  82.     int), int);
  83. int nftw(const char *, int (*)(const char *, const struct stat *,
  84.     int, struct FTW *), int, int);
  85. .fi
  86. .P
  87. .RE
  88. .P
  89. The
  90. .IR <ftw.h> 
  91. header shall define the
  92. .BR stat
  93. structure and the symbolic names for
  94. .IR st_mode
  95. and the file type test macros as described in
  96. .IR <sys/stat.h> .
  97. .P
  98. Inclusion of the
  99. .IR <ftw.h> 
  100. header may also make visible all symbols from
  101. .IR <sys/stat.h> .
  102. .LP
  103. .IR "The following sections are informative."
  104. .SH "APPLICATION USAGE"
  105. None.
  106. .SH RATIONALE
  107. None.
  108. .SH "FUTURE DIRECTIONS"
  109. None.
  110. .SH "SEE ALSO"
  111. .IR "\fB<sys_stat.h>\fP"
  112. .P
  113. The System Interfaces volume of POSIX.1\(hy2017,
  114. .IR "\fIftw\fR\^(\|)",
  115. .IR "\fInftw\fR\^(\|)"
  116. .\"
  117. .SH COPYRIGHT
  118. Portions of this text are reprinted and reproduced in electronic form
  119. from IEEE Std 1003.1-2017, Standard for Information Technology
  120. -- Portable Operating System Interface (POSIX), The Open Group Base
  121. Specifications Issue 7, 2018 Edition,
  122. Copyright (C) 2018 by the Institute of
  123. Electrical and Electronics Engineers, Inc and The Open Group.
  124. In the event of any discrepancy between this version and the original IEEE and
  125. The Open Group Standard, the original IEEE and The Open Group Standard
  126. is the referee document. The original Standard can be obtained online at
  127. http://www.opengroup.org/unix/online.html .
  128. .PP
  129. Any typographical or formatting errors that appear
  130. in this page are most likely
  131. to have been introduced during the conversion of the source files to
  132. man page format. To report such errors, see
  133. https://www.kernel.org/doc/man-pages/reporting_bugs.html .