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

wordexp.h.0p (3811B)

    

  1. '\" et
  2. .TH wordexp.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. wordexp.h
  12. \(em word-expansion types
  13. .SH SYNOPSIS
  14. .LP
  15. .nf
  16. #include <wordexp.h>
  17. .fi
  18. .SH DESCRIPTION
  19. The
  20. .IR <wordexp.h> 
  21. header shall define the structures and symbolic constants used by the
  22. \fIwordexp\fR()
  23. and
  24. \fIwordfree\fR()
  25. functions.
  26. .P
  27. The
  28. .IR <wordexp.h> 
  29. header shall define the
  30. .BR wordexp_t
  31. structure type, which shall include at least the following members:
  32. .sp
  33. .RS 4
  34. .nf
  36. size_t   we_wordc  \fRCount of words matched by \fIwords.\fR
  37. char   **we_wordv  \fRPointer to list of expanded words.\fR
  38. size_t   we_offs   \fRSlots to reserve at the beginning of \fIwe_wordv.\fR
  39. .fi
  40. .P
  41. .RE
  42. .P
  43. The
  44. .IR <wordexp.h> 
  45. header shall define the following symbolic constants for use as flags
  46. for the
  47. \fIwordexp\fR()
  48. function:
  49. .IP WRDE_APPEND 14
  50. Append words to those previously generated.
  51. .IP WRDE_DOOFFS 14
  52. Number of null pointers to prepend to
  53. .IR we_wordv .
  54. .IP WRDE_NOCMD 14
  55. Fail if command substitution is requested.
  56. .IP WRDE_REUSE 14
  57. The
  58. .IR pwordexp
  59. argument was passed to a previous successful call to
  60. \fIwordexp\fR(),
  61. and has not been passed to
  62. \fIwordfree\fR().
  63. The result is the same as if the application had called
  64. \fIwordfree\fR()
  65. and then called
  66. \fIwordexp\fR()
  67. without WRDE_REUSE.
  68. .IP WRDE_SHOWERR 14
  69. Do not redirect
  70. .IR stderr
  71. to
  72. .BR /dev/null .
  73. .IP WRDE_UNDEF 14
  74. Report error on an attempt to expand an undefined shell variable.
  75. .P
  76. The
  77. .IR <wordexp.h> 
  78. header shall define the following symbolic constants as error
  79. return values:
  80. .IP WRDE_BADCHAR 14
  81. One of the unquoted characters\(em\c
  82. <newline>,
  83. .BR '|' ,
  84. .BR '&' ,
  85. .BR ';' ,
  86. .BR '<' ,
  87. .BR '>' ,
  88. .BR '(' ,
  89. .BR ')' ,
  90. .BR '{' ,
  91. .BR '}' \(em\c
  92. appears in
  93. .IR words
  94. in an inappropriate context.
  95. .IP WRDE_BADVAL 14
  96. Reference to undefined shell variable when WRDE_UNDEF is set in
  97. .IR flags .
  98. .IP WRDE_CMDSUB 14
  99. Command substitution requested when WRDE_NOCMD was set in
  100. .IR flags .
  101. .IP WRDE_NOSPACE 14
  102. Attempt to allocate memory failed.
  103. .IP WRDE_SYNTAX 14
  104. Shell syntax error, such as unbalanced parentheses or unterminated string.
  105. .P
  106. The
  107. .IR <wordexp.h> 
  108. header shall define the
  109. .BR size_t
  110. type as described in
  111. .IR <stddef.h> .
  112. .P
  113. The following shall be declared as functions and may also be defined as
  114. macros. Function prototypes shall be provided.
  115. .sp
  116. .RS 4
  117. .nf
  119. int  wordexp(const char *restrict, wordexp_t *restrict, int);
  120. void wordfree(wordexp_t *);
  121. .fi
  122. .P
  123. .RE
  124. .LP
  125. .IR "The following sections are informative."
  126. .SH "APPLICATION USAGE"
  127. None.
  128. .SH RATIONALE
  129. None.
  130. .SH "FUTURE DIRECTIONS"
  131. None.
  132. .SH "SEE ALSO"
  133. .IR "\fB<stddef.h>\fP"
  134. .P
  135. The System Interfaces volume of POSIX.1\(hy2017,
  136. .IR "Section 2.6" ", " "Word Expansions"
  137. .\"
  138. .SH COPYRIGHT
  139. Portions of this text are reprinted and reproduced in electronic form
  140. from IEEE Std 1003.1-2017, Standard for Information Technology
  141. -- Portable Operating System Interface (POSIX), The Open Group Base
  142. Specifications Issue 7, 2018 Edition,
  143. Copyright (C) 2018 by the Institute of
  144. Electrical and Electronics Engineers, Inc and The Open Group.
  145. In the event of any discrepancy between this version and the original IEEE and
  146. The Open Group Standard, the original IEEE and The Open Group Standard
  147. is the referee document. The original Standard can be obtained online at
  148. http://www.opengroup.org/unix/online.html .
  149. .PP
  150. Any typographical or formatting errors that appear
  151. in this page are most likely
  152. to have been introduced during the conversion of the source files to
  153. man page format. To report such errors, see
  154. https://www.kernel.org/doc/man-pages/reporting_bugs.html .