wordexp.h(0P)

✨ wordexp.h ✨

okay bestie, sit down, we're doing a POSIX header today and honestly? it's giving adorable. This is the manual page for wordexp.h from the POSIX Programmer's Manual, section 0P. πŸ’–


🫢 PROLOG

So like, real talk: this manual page is part of the POSIX Programmer's Manual. But heads up β€” the Linux implementation of this interface may differ (so go check the corresponding Linux manual page for the actual Linux behavior), or honestly the interface may not be implemented on Linux at all. πŸ™ˆ No cap.


🌸 NAME

wordexp.h β€” word-expansion types. that's it. that's the whole vibe. πŸ’…


✨ SYNOPSIS

#include <wordexp.h>

πŸŽ€ DESCRIPTION

The <wordexp.h> header shall define the structures and symbolic constants used by the wordexp() and wordfree() functions. iconic behavior, honestly. πŸ‘‘

The <wordexp.h> header shall define the wordexp_t structure type, which shall include at least the following members:

size_t   we_wordc  Count of words matched by words.
char   **we_wordv  Pointer to list of expanded words.
size_t   we_offs   Slots to reserve at the beginning of we_wordv.

look at her. three whole members. main character energy fr fr.


πŸ’– the flags (symbolic constants for wordexp())

The <wordexp.h> header shall define the following symbolic constants for use as flags for the wordexp() function:

  • WRDE_APPEND β€” Append words to those previously generated. πŸ“
  • WRDE_DOOFFS β€” Number of null pointers to prepend to we_wordv.
  • WRDE_NOCMD β€” Fail if command substitution is requested. she said NO command substitution, periodt.
  • WRDE_REUSE β€” The pwordexp argument was passed to a previous successful call to wordexp(), and has not been passed to wordfree(). The result is the same as if the application had called wordfree() and then called wordexp() without WRDE_REUSE. (it's giving "reset, but make it automatic")
  • WRDE_SHOWERR β€” Do not redirect stderr to /dev/null. πŸ‘€
  • WRDE_UNDEF β€” Report error on an attempt to expand an undefined shell variable.

πŸ’€ the error return values

The <wordexp.h> header shall define the following symbolic constants as error return values:

  • WRDE_BADCHAR β€” One of the unquoted charactersβ€”<newline>, '|', '&', ';', '<', '>', '(', ')', '{', '}'β€”appears in words in an inappropriate context. 😭
  • WRDE_BADVAL β€” Reference to undefined shell variable when WRDE_UNDEF is set in flags.
  • WRDE_CMDSUB β€” Command substitution requested when WRDE_NOCMD was set in flags.
  • WRDE_NOSPACE β€” Attempt to allocate memory failed. πŸ’€ the malloc said no.
  • WRDE_SYNTAX β€” Shell syntax error, such as unbalanced parentheses or unterminated string. (unterminated string bestie... we've all been there)

🌈 the types n' prototypes

The <wordexp.h> header shall define the size_t type as described in <stddef.h>. πŸ¦‹

The following shall be declared as functions and may also be defined as macros. Function prototypes shall be provided.

int  wordexp(const char *restrict, wordexp_t *restrict, int);
void wordfree(wordexp_t *);

two functions. one pointer-to-restrict, one void, no drama. slay. ✨


the following sections are informative β€” aka, the ✨bonus content✨

πŸ™ˆ APPLICATION USAGE

None. literally none. nothing to see here bestie. πŸŽ€


🌸 RATIONALE

None. also nothing. she's mysterious like that. πŸ’…


🧚 FUTURE DIRECTIONS

None. the future is... unchanged, apparently. ⭐


πŸ‘‘ SEE ALSO

  • <stddef.h>
  • The System Interfaces volume of POSIX.1‐2017, Section 2.6, Word Expansions

Portions of this text are reprinted and reproduced in electronic form from IEEE Std 1003.1-2017, Standard for Information Technology -- Portable Operating System Interface (POSIX), The Open Group Base Specifications Issue 7, 2018 Edition, Copyright (C) 2018 by the Institute of Electrical and Electronics Engineers, Inc and The Open Group. In the event of any discrepancy between this version 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 .

Any typographical or formatting errors that appear in this page are most likely to have been introduced during the conversion of the source files to man page format. To report such errors, see https://www.kernel.org/doc/man-pages/reporting_bugs.html .


and that's the whole page, bestie!! 🌈✨ this one came to you from IEEE/The Open Group, dated 2017, and it lives at wordexp.h(0P). love her, study her, expand some words responsibly. mwah πŸ’‹πŸ«ΆπŸ’–

πŸ“¦ where this page comes from