Mirrors/fish-shell
2
0
Fork 0
mirror of https://github.com/fish-shell/fish-shell synced 2024-11-14 08:58:01 +00:00
Code Issues Projects Releases Packages Wiki Activity
fish-shell/doc_src/complete.txt

132 lines
8.1 KiB
Text
Raw Normal View History

Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
\section complete complete - edit command specific tab-completions
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
\subsection complete-synopsis Synopsis
Rebase documentation changes
2014-09-03 14:10:53 +00:00
\fish{synopsis}
complete ( -c | --command | -p | --path ) COMMAND
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
[( -c | --command | -p | --path ) COMMAND]...
doc_src/complete: update for new options in synopsis Update complete documentation, hopefully to avoid another #2368. [ci skip]
2015-09-09 09:42:00 +00:00
[( -e | --erase )]
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
[( -s | --short-option ) SHORT_OPTION]...
[( -l | --long-option | -o | --old-option ) LONG_OPTION]...
[( -a | --arguments ) OPTION_ARGUMENTS]
Added option to use completion source order without re-sorting Introduce a -k/--keep-order switch to `complete` that can be used to prevent fish from sorting/re-ordering the results provided by a completion source. In addition, this patch does so without doing away with deduplication of completions by introducing a new unique_unsorted(..) helper function that removes duplicates in-place without affecting the general order of the vector/container. Note that the code now uses a stable sort for completions, since the behavior of is_naturally_less_than as of this patch now means that the results are not necessarily _actually_ identical just because that function repeatedly returns false for any ordering of any given two elements. Fixes #361
2017-07-24 22:54:54 +00:00
[( -k | --keep-order )]
doc_src/complete: update for new options in synopsis Update complete documentation, hopefully to avoid another #2368. [ci skip]
2015-09-09 09:42:00 +00:00
[( -f | --no-files )]
[( -r | --require-parameter )]
[( -x | --exclusive )]
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
[( -w | --wraps ) WRAPPED_COMMAND]...
doc_src/complete: update for new options in synopsis Update complete documentation, hopefully to avoid another #2368. [ci skip]
2015-09-09 09:42:00 +00:00
[( -n | --condition ) CONDITION]
Rebase documentation changes
2014-09-03 14:10:53 +00:00
[( -d | --description ) DESCRIPTION]
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
complete ( -C[STRING] | --do-complete[=STRING] )
Rebase documentation changes
2014-09-03 14:10:53 +00:00
\endfish
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
\subsection complete-description Description
More documentation tweaks darcs-hash:20051204023353-ac50b-196f21f186237d5e7074667fc86f2172a7ac40e2.gz
2005-12-04 02:33:53 +00:00
Help cleanup Large list of changes, including formatting and typos for most commands. More substantive changes have been made to alias, bind, block, break, builtin, case, cd, commandline, count, else, emit, fish_config, funced, function, functions, history, math, mimedb, nextd, not, popd, prevd, pushd, pwd, random, read, set, set_color, switch, test, trap, type, ulimit, umask, and while.
2013-05-12 07:56:01 +00:00
For an introduction to specifying completions, see <a
href='index.html#completion-own'>Writing your own completions</a> in
More documentation tweaks darcs-hash:20051204023353-ac50b-196f21f186237d5e7074667fc86f2172a7ac40e2.gz
2005-12-04 02:33:53 +00:00
the fish manual.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
- `COMMAND` is the name of the command for which to add a completion.
- `SHORT_OPTION` is a one character option for the command.
- `LONG_OPTION` is a multi character option for the command.
doc_src/complete: update for new options in synopsis Update complete documentation, hopefully to avoid another #2368. [ci skip]
2015-09-09 09:42:00 +00:00
- `OPTION_ARGUMENTS` is parameter containing a space-separated list of possible option-arguments, which may contain command substitutions.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
- `DESCRIPTION` is a description of what the option and/or option arguments do.
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-c COMMAND` or `--command COMMAND` specifies that `COMMAND` is the name of the command.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-p COMMAND` or `--path COMMAND` specifies that `COMMAND` is the absolute path of the program (optionally containing wildcards).
Rebase documentation changes
2014-09-03 14:10:53 +00:00
doc_src/complete: update for new options in synopsis Update complete documentation, hopefully to avoid another #2368. [ci skip]
2015-09-09 09:42:00 +00:00
- `-e` or `--erase` deletes the specified completion.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-s SHORT_OPTION` or `--short-option=SHORT_OPTION` adds a short option to the completions list.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-l LONG_OPTION` or `--long-option=LONG_OPTION` adds a GNU style long option to the completions list.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-o LONG_OPTION` or `--old-option=LONG_OPTION` adds an old style long option to the completions list (See below for details).
Rebase documentation changes
2014-09-03 14:10:53 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-a OPTION_ARGUMENTS` or `--arguments=OPTION_ARGUMENTS` adds the specified option arguments to the completions list.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
Added option to use completion source order without re-sorting Introduce a -k/--keep-order switch to `complete` that can be used to prevent fish from sorting/re-ordering the results provided by a completion source. In addition, this patch does so without doing away with deduplication of completions by introducing a new unique_unsorted(..) helper function that removes duplicates in-place without affecting the general order of the vector/container. Note that the code now uses a stable sort for completions, since the behavior of is_naturally_less_than as of this patch now means that the results are not necessarily _actually_ identical just because that function repeatedly returns false for any ordering of any given two elements. Fixes #361
2017-07-24 22:54:54 +00:00
- `-k` or `--keep-order` preserves the order of the `OPTION_ARGUMENTS` specified via `-a` or `--arguments` instead of sorting alphabetically.
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-f` or `--no-files` specifies that the options specified by this completion may not be followed by a filename.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-r` or `--require-parameter` specifies that the options specified by this completion always must have an option argument, i.e. may not be followed by another option.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
- `-x` or `--exclusive` implies both `-r` and `-f`.
Fix typo
2016-06-23 16:23:10 +00:00
- `-w WRAPPED_COMMAND` or `--wraps=WRAPPED_COMMAND` causes the specified command to inherit completions from the wrapped command (See below for details).
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- `-n` or `--condition` specifies a shell command that must return 0 if the completion is to be used. This makes it possible to specify completions that should only be used in some cases.
- `-CSTRING` or `--do-complete=STRING` makes complete try to find all possible completions for the specified string.
- `-C` or `--do-complete` with no argument makes complete try to find all possible completions for the current command line buffer. If the shell is not in interactive mode, an error is returned.
don't warn about using obsolete complete options Fixes #3640
2017-01-09 19:21:34 +00:00
- `-A` and `--authoritative` no longer do anything and are silently ignored.
- `-u` and `--unauthoritative` no longer do anything and are silently ignored.
Rebase documentation changes
2014-09-03 14:10:53 +00:00
Command specific tab-completions in `fish` are based on the notion of options and arguments. An option is a parameter which begins with a hyphen, such as '`-h`', '`-help`' or '`--help`'. Arguments are parameters that do not begin with a hyphen. Fish recognizes three styles of options, the same styles as the GNU version of the getopt library. These styles are:
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
2014-08-01 02:37:32 +00:00
- Short options, like '`-a`'. Short options are a single character long, are preceded by a single hyphen and may be grouped together (like '`-la`', which is equivalent to '`-l -a`'). Option arguments may be specified in the following parameter ('`-w 32`') or by appending the option with the value ('`-w32`').
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
2014-08-01 02:37:32 +00:00
- Old style long options, like '`-Wall`'. Old style long options can be more than one character long, are preceded by a single hyphen and may not be grouped together. Option arguments are specified in the following parameter ('`-ao null`').
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
- GNU style long options, like '`--colors`'. GNU style long options can be more than one character long, are preceded by two hyphens, and may not be grouped together. Option arguments may be specified in the following parameter ('`--quoting-style shell`') or by appending the option with a '`=`' and the value ('`--quoting-style=shell`'). GNU style long options may be abbreviated so long as the abbreviation is unique ('`--h`') is equivalent to '`--help`' if help is the only long option beginning with an 'h').
The options for specifying command name and command path may be used multiple times to define the same completions for multiple commands.
The options for specifying command switches and wrapped commands may be used multiple times to define multiple completions for the command(s) in a single call.
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
Invoking `complete` multiple times for the same command adds the new definitions on top of any existing completions defined for the command.
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
Tweak `complete` docs again * Add a note to the `--wrap` docs saying that wrapping only works when specifying completions for commands, not for paths. * Add more info about how `--arguments` is handled.
2016-01-02 02:29:39 +00:00
When `-a` or `--arguments` is specified in conjunction with long, short, or old style options, the specified arguments are only used as completions when attempting to complete an argument for any of the specified options. If `-a` or `--arguments` is specified without any long, short, or old style options, the specified arguments are used when completing any argument to the command (except when completing an option argument that was specified with `-r` or `--require-parameter`).
Command substitutions found in `OPTION_ARGUMENTS` are not expected to return a space-separated list of arguments. Instead they must return a newline-separated list of arguments, and each argument may optionally have a tab character followed by the argument description. Any description provided in this way overrides a description given with `-d` or `--description`.
The `-w` or `--wraps` options causes the specified command to inherit completions from another command. The inheriting command is said to "wrap" the inherited command. The wrapping command may have its own completions in addition to inherited ones. A command may wrap multiple commands, and wrapping is transitive: if A wraps B, and B wraps C, then A automatically inherits all of C's completions. Wrapping can be removed using the `-e` or `--erase` options. Note that wrapping only works for completions specified with `-c` or `--command` and are ignored when specifying completions with `-p` or `--path`.
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
When erasing completions, it is possible to either erase all completions for a specific command by specifying `complete -c COMMAND -e`, or by specifying a specific completion option to delete by specifying either a long, short or old style option.
Support for command wrapping ("aliases") Add the --wraps option to 'complete' and 'function'. This allows a command to (recursively) inherit the completions of a wrapped command. Fixes #393. When evaluating a completion, we inspect the entire "wrap chain" for a command, i.e. we follow the sequence of wrapping until we either hit a loop (which we silently ignore) or the end of the chain. We then evaluate completions as if the wrapping command were substituted with the wrapped command. Currently this only works for commands, i.e. 'complete --command gco --wraps git\ checkout' won't work (that would seem to encroaching on abbreviations anyways). It might be useful to show an error message for that case. The commandline builtin reflects the commandline with the wrapped command substituted in, so e.g. git completions (which inspect the command line) will just work. This sort of command line munging is also performed by 'complete -C' so it's not totally without precedent. 'alias will also now mark its generated function as wrapping the 'target.
2014-08-16 01:14:36 +00:00
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
\subsection complete-example Example
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
The short style option `-o` for the `gcc` command requires that a file follows it. This can be done using writing:
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
Consistency fixes
2014-08-26 18:19:24 +00:00
\fish
complete -c gcc -s o -r
\endfish
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
The short style option `-d` for the `grep` command requires that one of the strings '`read`', '`skip`' or '`recurse`' is used. This can be specified writing:
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
2014-08-01 02:37:32 +00:00
Consistency fixes
2014-08-26 18:19:24 +00:00
\fish
complete -c grep -s d -x -a "read skip recurse"
\endfish
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
2014-08-01 02:37:32 +00:00
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
The `su` command takes any username as an argument. Usernames are given as the first colon-separated field in the file /etc/passwd. This can be specified as:
Documentation update Rework for Doxygen >1.8. Moved large parts of the documentation to a simplified format, making use of Markdown enhancements and fixing bad long options.
2014-08-01 02:37:32 +00:00
Consistency fixes
2014-08-26 18:19:24 +00:00
\fish
complete -x -c su -d "Username" -a "(cat /etc/passwd | cut -d : -f 1)"
\endfish
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
The `rpm` command has several different modes. If the `-e` or `--erase` flag has been specified, `rpm` should delete one or more packages, in which case several switches related to deleting packages are valid, like the `nodeps` switch.
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
This can be written as:
Consistency fixes
2014-08-26 18:19:24 +00:00
\fish
complete -c rpm -n "__fish_contains_opt -s e erase" -l nodeps -d "Don't check dependencies"
\endfish
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
Update the docs for `complete` * Indicate which options can be repeated in the usage lines. * Reorder the options in usage slightly to group better. * Reorder the option descriptions to match the order as seen in usage. * Update some of the option descriptions. * Fix the documentation for -C to show that it must be `-CSTRING` instead of `-C STRING`. * Document the behavior of `-C` with no argument. * Tweak some of the explanatory text after the option list. * Delete `--authoritative` and `--unauthoritative` from the documentation entirely. Those options appear to not actually do anything in the new parser.
2016-01-02 02:06:51 +00:00
where `__fish_contains_opt` is a function that checks the command line buffer for the presence of a specified set of options.
Add subdirectories darcs-hash:20050920133155-ac50b-9a14c6c664dd03afbe8e15e7c7998fcfb5c3c750.gz
2005-09-20 13:31:55 +00:00
Rebase documentation changes
2014-09-03 14:10:53 +00:00
To implement an alias, use the `-w` or `--wraps` option:
Support for command wrapping ("aliases") Add the --wraps option to 'complete' and 'function'. This allows a command to (recursively) inherit the completions of a wrapped command. Fixes #393. When evaluating a completion, we inspect the entire "wrap chain" for a command, i.e. we follow the sequence of wrapping until we either hit a loop (which we silently ignore) or the end of the chain. We then evaluate completions as if the wrapping command were substituted with the wrapped command. Currently this only works for commands, i.e. 'complete --command gco --wraps git\ checkout' won't work (that would seem to encroaching on abbreviations anyways). It might be useful to show an error message for that case. The commandline builtin reflects the commandline with the wrapped command substituted in, so e.g. git completions (which inspect the command line) will just work. This sort of command line munging is also performed by 'complete -C' so it's not totally without precedent. 'alias will also now mark its generated function as wrapping the 'target.
2014-08-16 01:14:36 +00:00
Rebase documentation changes
2014-09-03 14:10:53 +00:00
\fish
complete -c hub -w git
\endfish
Support for command wrapping ("aliases") Add the --wraps option to 'complete' and 'function'. This allows a command to (recursively) inherit the completions of a wrapped command. Fixes #393. When evaluating a completion, we inspect the entire "wrap chain" for a command, i.e. we follow the sequence of wrapping until we either hit a loop (which we silently ignore) or the end of the chain. We then evaluate completions as if the wrapping command were substituted with the wrapped command. Currently this only works for commands, i.e. 'complete --command gco --wraps git\ checkout' won't work (that would seem to encroaching on abbreviations anyways). It might be useful to show an error message for that case. The commandline builtin reflects the commandline with the wrapped command substituted in, so e.g. git completions (which inspect the command line) will just work. This sort of command line munging is also performed by 'complete -C' so it's not totally without precedent. 'alias will also now mark its generated function as wrapping the 'target.
2014-08-16 01:14:36 +00:00
Make line length, wrapping and spacing consistent
2014-08-19 12:41:23 +00:00
Now hub inherits all of the completions from git. Note this can also be specified in a function declaration.
Support for command wrapping ("aliases") Add the --wraps option to 'complete' and 'function'. This allows a command to (recursively) inherit the completions of a wrapped command. Fixes #393. When evaluating a completion, we inspect the entire "wrap chain" for a command, i.e. we follow the sequence of wrapping until we either hit a loop (which we silently ignore) or the end of the chain. We then evaluate completions as if the wrapping command were substituted with the wrapped command. Currently this only works for commands, i.e. 'complete --command gco --wraps git\ checkout' won't work (that would seem to encroaching on abbreviations anyways). It might be useful to show an error message for that case. The commandline builtin reflects the commandline with the wrapped command substituted in, so e.g. git completions (which inspect the command line) will just work. This sort of command line munging is also performed by 'complete -C' so it's not totally without precedent. 'alias will also now mark its generated function as wrapping the 'target.
2014-08-16 01:14:36 +00:00
Reference in a new issue Copy permalink