summaryrefslogtreecommitdiff
path: root/Doc
diff options
context:
space:
mode:
authordana <dana@dana.is>2025-04-28 16:18:42 -0500
committerdana <dana@dana.is>2025-04-28 16:23:29 -0500
commit80de57d5a63870e61a3d48efa1406ac05bbd2b5b (patch)
treef3daf3e4816e6a11ad57fc7f4e3ea8b1456e78d8 /Doc
parent9b68cf38f08fdf352fb1dc6fb97438210aee48b6 (diff)
downloadzsh-80de57d5a63870e61a3d48efa1406ac05bbd2b5b.tar.gz
zsh-80de57d5a63870e61a3d48efa1406ac05bbd2b5b.zip
53527: remove zgetopt
reverts most of 84ef0c523, 0e369f37d, and 9b68cf38f feature was not ready. may be re-added after 5.10 release
Diffstat (limited to 'Doc')
-rw-r--r--Doc/Zsh/contrib.yo79
1 files changed, 0 insertions, 79 deletions
diff --git a/Doc/Zsh/contrib.yo b/Doc/Zsh/contrib.yo
index 7822460e8..c1bea6022 100644
--- a/Doc/Zsh/contrib.yo
+++ b/Doc/Zsh/contrib.yo
@@ -4672,85 +4672,6 @@ Same as tt(zmv -C) and tt(zmv -L), respectively. These functions do not
appear in the zsh distribution, but can be created by linking tt(zmv) to
the names tt(zcp) and tt(zln) in some directory in your tt(fpath).
)
-findex(zgetopt)
-item(tt(zgetopt) [ tt(-a) ] [ tt(-A) var(array) ] [ tt(-l) var(spec) ] [ tt(-n) var(name) ] [ tt(-o) var(spec) ] tt(--) [ var(args) ])(
-This is a wrapper around tt(zparseopts) (from tt(zsh/zutil)) which
-provides an interface similar to the util-linux implementation of
-tt(getopt+LPAR()1+RPAR()) (sometimes called `GNU tt(getopt)'). It
-simplifies GNU-style argument parsing (including permutation) and
-can make it easier to write functions and scripts with complex APIs,
-particularly ones where the order of options is significant.
-
-The typical usage pattern is as follows:
-
-example(zgetopt -o abc: -l aaa,bbb,ccc: -- "$@" || return
-while (( $# )); do
- case $1 in
- -a|--aaa+RPAR() ...; shift ;; # handle -a
- -b|--bbb+RPAR() ...; shift ;; # handle -b
- -c|--ccc+RPAR() ...; shift 2 ;; # handle -c and arg
- --+RPAR() ...; shift; break ;; # end of options
- esac
-done
-# handle operands)
-
-It can also be called as a stand-alone script from other shells
-using the more traditional print-and-eval pattern:
-
-example(args="$( zgetopt -n myscript -o abc: -l aaa,bbb,ccc: -- "$@" )" || return
-eval set -- "$args"
-while [ $# -ne 0 ]; do ...; done)
-
-Options:
-
-startsitem()
-sitem(tt(-A var(array)))(When called as a function, assign the parsed
-arguments to the named array var(array). Defaults to tt(argv), which
-overwrites the caller's positional parameters. Has no meaning when
-called as a script, in which case the parsed and quoted arguments are
-always printed to standard output. An empty string forces the
-printing behaviour in either mode.)
-sitem(tt(-a))(Use `alternative'-style single-hyphenated long options
-instead of GNU-style double-hyphenated ones (tt(-foo) vs tt(--foo)).
-Note that long options with optional optargs can't always be
-distinguished accurately from short options with optional optargs
-when using this option. Also, due to limitations of tt(zparseopts),
-a single-hyphenated long option whose name is only one character long
-is always treated as a short option.)
-sitem(tt(-l var(spec)))(Specify long options to recognise when
-parsing. These should be given using just the option name (no
-dashes), suffixed by `tt(:)' or `tt(::)' if it takes a mandatory or
-optional argument respectively. Multiple options can be defined
-either by separating them by commas or by supplying -l again.
-Example: tt(-l foo,bar: -l baz))
-sitem(tt(-n var(name)))(Specify the name to use in the error message
-if argument parsing fails. Defaults to the name of the nearest
-calling function or the base name of tt($ZSH_ARGZERO). Note that
-errors related to the usage of tt(zgetopt) itself are always reported
-as coming from tt(zgetopt).)
-sitem(tt(-o var(spec)))(Specify short options to recognise when
-parsing. These should be given as a single string, in the same format
-used by the tt(getopts) built-in or the tt(getopt+LPAR()3+RPAR())
-library function, again using `tt(:)' or `tt(::)' to indicate a
-mandatory or optional argument. The spec may be prefixed with `tt(+)'
-to indicate that option parsing should stop at the first non-option
-argument (equivalent to setting the environment variable
-tt(POSIXLY_CORRECT)). Example: tt(-o ab:cd::))
-endsitem()
-
-At least one of tt(-o) or tt(-l) must be given. The function's own
-options should be followed by zero or more arguments to parse. It is
-critical that these be separated explicitly by `tt(--)', as in the
-above examples, to ensure that the function can accurately
-distinguish the arguments it's meant to parse from its own.
-
-Refer to the manual for util-linux's tt(getopt+LPAR()1+RPAR()) for
-more information about the way arguments are parsed and results are
-returned. Note however that this function is not intended to be a
-complete re-implementation. In particular, it omits all
-portability/compatibility features. Also, like tt(zparseopts)
-itself, it does not support abbreviating long options.
-)
item(tt(zkbd))(
See `Keyboard Definition'
ifzman(above)\