diff options
Diffstat (limited to 'doc_src/complete.txt')
| -rw-r--r-- | doc_src/complete.txt | 138 |
1 files changed, 82 insertions, 56 deletions
diff --git a/doc_src/complete.txt b/doc_src/complete.txt index c2085ccb..825faf9a 100644 --- a/doc_src/complete.txt +++ b/doc_src/complete.txt @@ -1,7 +1,14 @@ \section complete complete - edit command specific tab-completions \subsection complete-synopsis Synopsis -<tt>complete (-c|--command|-p|--path) COMMAND [(-s|--short-option) SHORT_OPTION] [(-l|--long-option|-o|--old-option) LONG_OPTION [(-a||--arguments) OPTION_ARGUMENTS] [(-d|--description) DESCRIPTION] </tt> +\fish{synopsis} +complete ( -c | --command | -p | --path ) COMMAND + [( -s | --short-option ) SHORT_OPTION] + [( -l | --long-option | -o | --old-option ) LONG_OPTION] + [( -a | --arguments ) OPTION_ARGUMENTS] + [( -w | --wraps ) WRAPPED_COMMAND] + [( -d | --description ) DESCRIPTION] +\endfish \subsection complete-description Description @@ -9,69 +16,88 @@ For an introduction to specifying completions, see <a href='index.html#completion-own'>Writing your own completions</a> in the fish manual. -- <tt>COMMAND</tt> is the name of the command for which to add a completion -- <tt>SHORT_OPTION</tt> is a one character option for the command -- <tt>LONG_OPTION</tt> is a multi character option for the command -- <tt>OPTION_ARGUMENTS</tt> is parameter containing a space-separated list of possible option-arguments, which may contain subshells -- <tt>DESCRIPTION</tt> is a description of what the option and/or option arguments do -- <tt>-C STRING</tt> or <tt>--do-complete=STRING</tt> makes complete try to find all possible completions for the specified string -- <tt>-e</tt> or <tt>--erase</tt> implies that the specified completion should be deleted -- <tt>-f</tt> or <tt>--no-files</tt> specifies that the option specified by this completion may not be followed by a filename -- <tt>-n</tt> or <tt>--condition</tt> 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. -- <tt>-o</tt> or <tt>--old-option</tt> implies that the command uses old long style options with only one dash -- <tt>-p</tt> or <tt>--path</tt> implies that the string COMMAND is the full path of the command -- <tt>-r</tt> or <tt>--require-parameter</tt> specifies that the option specified by this completion always must have an option argument, i.e. may not be followed by another option -- <tt>-u</tt> or <tt>--unauthoritative</tt> implies that there may be more options than the ones specified, and that fish should not assume that options not listed are spelling errors -- <tt>-A</tt> or <tt>--authoritative</tt> implies that there may be no more options than the ones specified, and that fish should assume that options not listed are spelling errors -- <tt>-x</tt> or <tt>--exclusive</tt> implies both <tt>-r</tt> and <tt>-f</tt> - -Command specific tab-completions in \c 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: - -- 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'). -- 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'). -- 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, command path, or command -switches may all be used multiple times to specify multiple commands -which have the same completion or multiple switches accepted by a -command. - -When erasing completions, it is possible to either erase all -completions for a specific command by specifying <tt>complete -e -c -COMMAND</tt>, or by specifying a specific completion option to delete -by specifying either a long, short or old style option. +- `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. + +- `OPTION_ARGUMENTS` is parameter containing a space-separated list of possible option-arguments, which may contain subshells. + +- `DESCRIPTION` is a description of what the option and/or option arguments do. + +- `-C STRING` or `--do-complete=STRING` makes complete try to find all possible completions for the specified string. + +- `-w WRAPPED_COMMAND` or `--wraps=WRAPPED_COMMAND` causes the specified command to inherit completions from the wrapped command. + +- `-e` or `--erase` implies that the specified completion should be deleted. + +- `-f` or `--no-files` specifies that the option specified by this completion may not be followed by a filename. + +- `-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. + +- `-o` or `--old-option` implies that the command uses old long style options with only one dash. + +- `-p` or `--path` implies that the string `COMMAND` is the full path of the command. + +- `-r` or `--require-parameter` specifies that the option specified by this completion always must have an option argument, i.e. may not be followed by another option. + +- `-u` or `--unauthoritative` implies that there may be more options than the ones specified, and that fish should not assume that options not listed are spelling errors. + +- `-A` or `--authoritative` implies that there may be no more options than the ones specified, and that fish should assume that options not listed are spelling errors. + +- `-x` or `--exclusive` implies both `-r` and `-f`. + +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: + +- 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`'). + +- 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`'). + +- 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`') 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, command path, or command switches may all be used multiple times to specify multiple commands which have the same completion or multiple switches accepted by a command. + +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. + +When erasing completions, it is possible to either erase all completions for a specific command by specifying `complete -e -c COMMAND`, or by specifying a specific completion option to delete by specifying either a long, short or old style option. + \subsection complete-example Example -The short style option <tt>-o</tt> for the \c gcc command requires -that a file follows it. This can be done using writing <tt>complete --c gcc -s o -r</tt>. +The short style option `-o` for the `gcc` command requires that a file follows it. This can be done using writing: + +\fish +complete -c gcc -s o -r +\endfish + +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: + +\fish +complete -c grep -s d -x -a "read skip recurse" +\endfish -The short style option <tt>-d</tt> for the \c grep command requires -that one of the strings 'read', 'skip' or 'recurse' is used. This can -be specified writing <tt>complete -c grep -s d -x -a "read skip -recurse"</tt>. +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: -The \c 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: <tt>complete -x -c su -d "Username" -a "(cat -/etc/passwd|cut -d : -f 1)" </tt>. +\fish +complete -x -c su -d "Username" -a "(cat /etc/passwd | cut -d : -f 1)" +\endfish -The \c rpm command has several different modes. If the \c -e or \c ---erase flag has been specified, \c rpm should delete one or more -packages, in which case several switches related to deleting packages -are valid, like the \c nodeps switch. +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. This can be written as: -<tt>complete -c rpm -n "__fish_contains_opt -s e erase" -l nodeps -d -"Don't check dependencies"</tt> +\fish +complete -c rpm -n "__fish_contains_opt -s e erase" -l nodeps -d "Don't check dependencies" +\endfish + +where `__fish_contains_opt` is a function that checks the commandline buffer for the presence of a specified set of options. + +To implement an alias, use the `-w` or `--wraps` option: + +\fish +complete -c hub -w git +\endfish -where \c __fish_contains_opt is a function that checks the commandline -buffer for the presence of a specified set of options. +Now hub inherits all of the completions from git. Note this can also be specified in a function declaration. |