mirror of
https://github.com/fish-shell/fish-shell.git
synced 2026-05-16 07:01:14 -03:00
f780b01ac9
The intention is that if you want to parse some of your options verbatim to another command, but you want to modfy other options (e.g. change their value, convert them to other options, or delete them entirely), you mark the options you want to modify with an &, and argparse will not add them to argv_opts. You can then call the other command with argv_opts together with any new/modified options, ensuring that the other command doesn't set the pre-modified options. As with other known options, & options will be removed from $argv, and have their $_flag_ variables set. The `&` goes at the end of the option spec, or if the option spec contains a validation script, immediately before the `!`. There is also now a -d/--delete flag to fish_opt that will generate such an option spec. See the changes in doc_src/cmds/argparse.rst for more details and an example use case.
81 lines
3.2 KiB
ReStructuredText
81 lines
3.2 KiB
ReStructuredText
.. _cmd-fish_opt:
|
|
|
|
fish_opt - create an option specification for the argparse command
|
|
==================================================================
|
|
|
|
Synopsis
|
|
--------
|
|
|
|
.. synopsis::
|
|
|
|
fish_opt -s ALPHANUM [-l LONG-NAME] [-ord] [--multiple-vals] [--long-only]
|
|
fish_opt --help
|
|
|
|
Description
|
|
-----------
|
|
|
|
This command provides a way to produce option specifications suitable for use with the :doc:`argparse <argparse>` command. You can, of course, write the option specifications by hand without using this command. But you might prefer to use this for the clarity it provides.
|
|
|
|
The following ``argparse`` options are available:
|
|
|
|
**-s** or **--short** *ALPHANUM*
|
|
Takes a single letter that is used as the short flag in the option being defined. This option is mandatory.
|
|
|
|
**-l** or **--long** *LONG-NAME*
|
|
Takes a string that is used as the long flag in the option being defined. This option is optional and has no default. If no long flag is defined then only the short flag will be allowed when parsing arguments using the option specification.
|
|
|
|
**--long-only**
|
|
The option being defined will only allow the long flag name to be used. The short flag name must still be defined (i.e., **--short** must be specified) but it cannot be used when parsing arguments using this option specification.
|
|
|
|
**-o** or **--optional-val**
|
|
The option being defined can take a value, but it is optional rather than required. If the option is seen more than once when parsing arguments, only the last value seen is saved. This means the resulting flag variable created by ``argparse`` will zero elements if no value was given with the option else it will have exactly one element.
|
|
|
|
**-r** or **--required-val**
|
|
The option being defined requires a value. If the option is seen more than once when parsing arguments, only the last value seen is saved. This means the resulting flag variable created by ``argparse`` will have exactly one element.
|
|
|
|
**--multiple-vals**
|
|
The option being defined requires a value each time it is seen. Each instance is stored. This means the resulting flag variable created by ``argparse`` will have one element for each instance of this option in the arguments.
|
|
|
|
**-d** or **--delete**
|
|
The option and any values will be deleted from the ``$argv_opts`` variables set by ``argparse``
|
|
(as with other options, it will also be deleted from ``$argv``).
|
|
|
|
**-h** or **--help**
|
|
Displays help about using this command.
|
|
|
|
Examples
|
|
--------
|
|
|
|
Define a single option specification for the boolean help flag:
|
|
|
|
|
|
|
|
::
|
|
|
|
set -l options (fish_opt -s h -l help)
|
|
argparse $options -- $argv
|
|
|
|
|
|
Same as above but with a second flag that requires a value:
|
|
|
|
|
|
|
|
::
|
|
|
|
set -l options (fish_opt -s h -l help)
|
|
set options $options (fish_opt -s m -l max --required-val)
|
|
argparse $options -- $argv
|
|
|
|
|
|
Same as above but with a third flag that can be given multiple times saving the value of each instance seen and only the long flag name (``--token``) can be used:
|
|
|
|
|
|
|
|
::
|
|
|
|
set -l options (fish_opt --short=h --long=help)
|
|
set options $options (fish_opt --short=m --long=max --required-val)
|
|
set options $options (fish_opt --short=t --long=token --multiple-vals --long-only)
|
|
argparse $options -- $argv
|
|
|