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

glob.h.0p (3433B)

    

  1. '\" et
  2. .TH glob.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. glob.h
  12. \(em pathname pattern-matching types
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <glob.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <glob.h> 
  21. header shall define the structures and symbolic constants used by the
  22. \fIglob\fR()
  23. function.
  24. .P
  25. The
  26. .IR <glob.h> 
  27. header shall define the
  28. .BR glob_t
  29. structure type, which shall include at least the following members:
  30. .sp
  31. .RS 4
  32. .nf
  34. size_t   gl_pathc \fRCount of paths matched by \fIpattern.\fR
  35. char   **gl_pathv \fRPointer to a list of matched pathnames.\fR
  36. size_t   gl_offs  \fRSlots to reserve at the beginning of \fIgl_pathv.\fR
  37. .fi
  38. .P
  39. .RE
  40. .P
  41. The
  42. .IR <glob.h> 
  43. header shall define the
  44. .BR size_t
  45. type as described in
  46. .IR <sys/types.h> .
  47. .P
  48. The
  49. .IR <glob.h> 
  50. header shall define the following symbolic constants as values for the
  51. .IR flags
  52. argument:
  53. .IP GLOB_APPEND 14
  54. Append generated pathnames to those previously obtained.
  55. .IP GLOB_DOOFFS 14
  56. Specify how many null pointers to add to the beginning of
  57. .IR gl_pathv .
  58. .IP GLOB_ERR 14
  59. Cause
  60. \fIglob\fR()
  61. to return on error.
  62. .IP GLOB_MARK 14
  63. Each pathname that is a directory that matches
  64. .IR pattern
  65. has a
  66. <slash>
  67. appended.
  68. .IP GLOB_NOCHECK 14
  69. If
  70. .IR pattern
  71. does not match any pathname, then return a list consisting of only
  72. .IR pattern .
  73. .IP GLOB_NOESCAPE 14
  74. Disable backslash escaping.
  75. .IP GLOB_NOSORT 14
  76. Do not sort the pathnames returned.
  77. .P
  78. The
  79. .IR <glob.h> 
  80. header shall define the following symbolic constants as error
  81. return values:
  82. .IP GLOB_ABORTED 14
  83. The scan was stopped because GLOB_ERR was set or (*\fIerrfunc\fP)(\|)
  84. returned non-zero.
  85. .IP GLOB_NOMATCH 14
  86. The pattern does not match any existing pathname, and GLOB_NOCHECK was
  87. not set in
  88. .IR flags .
  89. .IP GLOB_NOSPACE 14
  90. An attempt to allocate memory failed.
  91. .P
  92. The following shall be declared as functions and may also be defined
  93. as macros. Function prototypes shall be provided.
  94. .sp
  95. .RS 4
  96. .nf
  98. int  glob(const char *restrict, int, int(*)(const char *, int),
  99.          glob_t *restrict);
  100. void globfree(glob_t *);
  101. .fi
  102. .P
  103. .RE
  104. .LP
  105. .IR "The following sections are informative."
  106. .SH "APPLICATION USAGE"
  107. None.
  108. .SH RATIONALE
  109. None.
  110. .SH "FUTURE DIRECTIONS"
  111. None.
  112. .SH "SEE ALSO"
  113. .IR "\fB<sys_types.h>\fP"
  114. .P
  115. The System Interfaces volume of POSIX.1\(hy2017,
  116. .IR "\fIglob\fR\^(\|)"
  117. .\"
  118. .SH COPYRIGHT
  119. Portions of this text are reprinted and reproduced in electronic form
  120. from IEEE Std 1003.1-2017, Standard for Information Technology
  121. -- Portable Operating System Interface (POSIX), The Open Group Base
  122. Specifications Issue 7, 2018 Edition,
  123. Copyright (C) 2018 by the Institute of
  124. Electrical and Electronics Engineers, Inc and The Open Group.
  125. In the event of any discrepancy between this version and the original IEEE and
  126. The Open Group Standard, the original IEEE and The Open Group Standard
  127. is the referee document. The original Standard can be obtained online at
  128. http://www.opengroup.org/unix/online.html .
  129. .PP
  130. Any typographical or formatting errors that appear
  131. in this page are most likely
  132. to have been introduced during the conversion of the source files to
  133. man page format. To report such errors, see
  134. https://www.kernel.org/doc/man-pages/reporting_bugs.html .