h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-04-29 16:51:15 -03:00
Code Issues Packages Projects Releases Wiki Activity
Files
4db61ee117c954a441213bfdb47005fc68d257e6
fish-shell/doc_src/cmds
History
Isaac Oscar Gariano 4db61ee117 Added argparse support for arguments with multiple optional values. 
This commit fixes #8432 by adding put =* in an option spec to indicate that the
option takes an optional value, where subsequent uses of the option accumulate
the value (so the parsing behaviour is like =?, but the _flag_ variables are
appended to like =+). If the option didn't have a value, it appends an empty
string. As an example,. long=* -- --long=1 --long will execute
set -l _flag_long 1 '' (i.e. count $_flag_long is 2), whereas with =? instead,
you'd get set -l _flag_long (i.e. count $_flag_long is 0).

As a use case, I'm aware of git clone which has a
--recurse-submodules=[<pathspec>]: if you use it without a value, it operates on
all submodules, with a value, it operates on the given submodule.

The fish_opt function will generate an =* option spec when given both the
--optional-val and --multiple-vals options (previously, doing so was an error).
fish_opt now also accepts -m as an abbreviation for --multiple-vals, to go with
the pre-existing -o and -r abbreviations for --optional-val and --required-val.
2025-08-30 01:55:56 +10:00
..
_.rst
docs: Remove "just"/"simply" weasel words
2025-03-28 20:12:58 +01:00
abbr.rst
Fix formatting of abbr example
2025-02-11 22:51:06 +08:00
alias.rst
Minor doc fixes
2024-09-18 22:11:14 +02:00
and.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
argparse.rst
Added argparse support for arguments with multiple optional values.
2025-08-30 01:55:56 +10:00
begin.rst
Allow { } for command grouping, like begin / end
2025-01-15 11:18:46 +01:00
bg.rst
docs: Improve bg docs
2023-06-05 18:26:13 +02:00
bind.rst
Fix rst formatting issues
2025-05-16 00:30:34 +02:00
block.rst
Clarify block command documentation
2024-04-23 19:36:11 +02:00
break.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
breakpoint.rst
docs synopsis: add HTML highlighing and automate manpage markup
2022-01-19 22:56:41 +08:00
builtin.rst
docs: Document type/builtin exit status
2022-09-30 18:50:14 +02:00
case.rst
docs synopsis: add HTML highlighing and automate manpage markup
2022-01-19 22:56:41 +08:00
cd.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
cdh.rst
docs: use canonical key names in :kbd: tags
2024-04-20 15:36:29 +02:00
command.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
commandline.rst
commandline.rst: deprecate --tokens-raw option
2025-05-11 12:46:08 +02:00
complete.rst
docs: Make --wraps clearer
2025-03-30 19:42:00 +02:00
contains.rst
docs: omnibus cleanup
2022-03-12 00:21:13 +08:00
continue.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
count.rst
docs synopsis: make all placeholder arguments uppercase
2022-01-19 22:56:41 +08:00
dirh.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
dirs.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
disown.rst
docs: Clarify that disowned jobs won't fire on-process/job-exit
2024-03-19 16:39:37 +01:00
echo.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
else.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
emit.rst
docs: omnibus cleanup
2022-03-12 00:21:13 +08:00
end.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
eval.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
exec.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
exit.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
export.rst
docs/export: Add a bit on PATH=$PATH:...
2024-11-06 18:50:41 +01:00
false.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
fg.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
fish_add_path.rst
fish_add_path: Automatically enable verbose mode for interactive use
2024-06-06 16:47:39 +02:00
fish_breakpoint_prompt.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
fish_clipboard_copy.rst
docs: Document fish_clipboard_copy's OSC 52 support
2025-02-08 12:17:55 +01:00
fish_clipboard_paste.rst
docs: use canonical key names in :kbd: tags
2024-04-20 15:36:29 +02:00
fish_command_not_found.rst
docs synopsis: add HTML highlighing and automate manpage markup
2022-01-19 22:56:41 +08:00
fish_config.rst
docs: Turn off highlighting correctly in fish_config
2023-06-16 16:17:58 +02:00
fish_default_key_bindings.rst
Correct fish_default_key_bindings docs
2024-06-15 12:18:37 -07:00
fish_delta.rst
Add a fish_delta helper function
2022-10-19 20:06:35 +02:00
fish_git_prompt.rst
Add info on formatting fish_git_prompt output
2025-06-23 18:46:54 +02:00
fish_greeting.rst
docs: fix double space in example fish_greeting
2024-01-06 15:26:20 +01:00
fish_hg_prompt.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
fish_indent.rst
Stop reading terminfo database
2025-04-11 15:11:22 +02:00
fish_is_root_user.rst
docs synopsis: add HTML highlighing and automate manpage markup
2022-01-19 22:56:41 +08:00
fish_key_reader.rst
Add back docs for fish_key_reader --verbose
2024-08-11 14:57:04 +02:00
fish_mode_prompt.rst
Mention replace mode in fish_mode_prompt docs
2025-04-24 16:26:45 +03:00
fish_opt.rst
Added argparse support for arguments with multiple optional values.
2025-08-30 01:55:56 +10:00
fish_prompt.rst
Update docs for transient prompt
2025-04-12 12:09:08 +02:00
fish_right_prompt.rst
Update docs for transient prompt
2025-04-12 12:09:08 +02:00
fish_should_add_to_history.rst
docs: Add fish_should_add_to_history to commands list
2024-03-09 12:09:00 +01:00
fish_status_to_signal.rst
docs synopsis: add HTML highlighing and automate manpage markup
2022-01-19 22:56:41 +08:00
fish_svn_prompt.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
fish_title.rst
docs/fish_title: add example on disabling title changing
2025-03-12 14:36:40 +08:00
fish_update_completions.rst
docs synopsis: add HTML highlighing and automate manpage markup
2022-01-19 22:56:41 +08:00
fish_vcs_prompt.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
fish_vi_key_bindings.rst
docs: standardise name for vi mode
2023-12-17 17:40:45 +08:00
fish.rst
Remove --install option
2025-04-11 17:29:22 +02:00
for.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
funced.rst
docs: Point to functions/type from funced/funcsave
2024-08-13 17:44:23 +02:00
funcsave.rst
docs: Point to functions/type from funced/funcsave
2024-08-13 17:44:23 +02:00
function.rst
docs: Make --wraps clearer
2025-03-30 19:42:00 +02:00
functions.rst
functions --copy: store file and lineno (#9542)
2023-02-13 09:59:28 -06:00
help.rst
docs: More about envvars
2023-01-09 20:33:37 +01:00
history.rst
docs: Remove "just"/"simply" weasel words
2025-03-28 20:12:58 +01:00
if.rst
docs/if: Link to other builtins
2023-02-28 20:49:11 +01:00
isatty.rst
Fix formatting for isatty
2022-10-19 20:10:26 +02:00
jobs.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
math.rst
✨ feat(math): add round options (#9117)
2024-06-23 17:45:52 -05:00
nextd.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
not.rst
Document the ! (not) and . (source) aliases more
2024-04-20 13:34:08 +02:00
open.rst
docs synopsis: add HTML highlighing and automate manpage markup
2022-01-19 22:56:41 +08:00
or.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
path.rst
Add --all option to path
2025-06-05 14:10:47 +02:00
popd.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
prevd.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
printf.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
prompt_hostname.rst
docs synopsis: add HTML highlighing and automate manpage markup
2022-01-19 22:56:41 +08:00
prompt_login.rst
docs: omnibus cleanup
2022-03-12 00:21:13 +08:00
prompt_pwd.rst
Add example of string manipulation to prompt_pwd
2025-07-28 19:55:18 -07:00
psub.rst
docs: omnibus cleanup
2022-03-12 00:21:13 +08:00
pushd.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
pwd.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
random.rst
docs: omnibus cleanup
2022-03-12 00:21:13 +08:00
read.rst
docs: Remove "just"/"simply" weasel words
2025-03-28 20:12:58 +01:00
realpath.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
return.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
set_color.rst
Underline styles for double/dotted/dashed
2025-05-11 22:18:06 +02:00
set.rst
docs: Update synopsis for 'set'
2024-09-14 10:29:44 +02:00
source.rst
docs: Remove pre-2.4 caveats
2025-03-15 16:36:13 +01:00
status.rst
Document and complete status get-file/list-files
2025-04-11 17:29:22 +02:00
string-collect.rst
Fix more lost string documentation
2022-05-14 10:05:02 +02:00
string-escape.rst
Improve documentation for string escape
2024-12-29 13:48:34 -08:00
string-join0.rst
We no longer have two doc systems, move sphinx_doc_src back to doc_src
2020-02-19 17:00:35 -08:00
string-join.rst
Improve docs for string join
2025-05-28 17:09:13 +02:00
string-length.rst
string docs: format options and arguments in line with other pages
2022-03-12 22:22:02 +08:00
string-lower.rst
string docs: format options and arguments in line with other pages
2022-03-12 22:22:02 +08:00
string-match.rst
docs: Fix string-match glob examples
2025-04-08 17:13:18 +02:00
string-pad.rst
docs/string: Separate "pad" and "shorten"
2023-04-20 22:17:08 +02:00
string-repeat.rst
Fix typos in docs (#11015)
2025-01-06 19:40:30 -06:00
string-replace.rst
string-replace.rst: fix trailing whitespace
2024-07-23 11:47:58 +02:00
string-shorten.rst
Fix typos in docs (#11015)
2025-01-06 19:40:30 -06:00
string-split0.rst
We no longer have two doc systems, move sphinx_doc_src back to doc_src
2020-02-19 17:00:35 -08:00
string-split.rst
Document --allow-empty, specify -r is only useful w/ -m
2025-08-21 00:06:24 +02:00
string-sub.rst
Fix more lost string documentation
2022-05-14 10:05:02 +02:00
string-trim.rst
docs/string-trim: Double down on the set of chars vs string thing
2024-11-25 17:53:14 +01:00
string-unescape.rst
We no longer have two doc systems, move sphinx_doc_src back to doc_src
2020-02-19 17:00:35 -08:00
string-upper.rst
string docs: format options and arguments in line with other pages
2022-03-12 22:22:02 +08:00
string.rst
Improve docs for string join
2025-05-28 17:09:13 +02:00
suspend.rst
docs: omnibus cleanup
2022-03-12 00:21:13 +08:00
switch.rst
docs: More about envvars
2023-01-09 20:33:37 +01:00
test.rst
docs: Remove "just"/"simply" weasel words
2025-03-28 20:12:58 +01:00
time.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
trap.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
true.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00
type.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
ulimit.rst
docs: Fix typos
2022-09-17 21:31:06 +08:00
umask.rst
Reference more non-fish shell builtins that have relevant differences
2024-04-20 13:34:08 +02:00
vared.rst
docs: omnibus cleanup
2022-03-12 00:21:13 +08:00
wait.rst
Minor doc fixes
2024-09-18 22:11:14 +02:00
while.rst
docs: Use :doc: role when linking to commands
2022-09-24 10:56:43 +02:00