h/fish-shell
1
Fork 0
mirror of https://github.com/fish-shell/fish-shell.git synced 2026-05-09 08:51:14 -03:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'master' into documentation-update

Browse Source 
Conflicts (FIXED):
	.gitignore
	doc_src/complete.txt
	doc_src/function.txt
This commit is contained in:
Mark Griffiths
2014-08-19 11:42:21 +01:00
parent 3ea956a0b4 ec903ce625
commit fed4bb5c07
16 changed files with 382 additions and 65 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
doc_src/complete.txt
View File

@@ -2,11 +2,12 @@
\subsection complete-synopsis Synopsis
\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]
[( -d | --description) DESCRIPTION]
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
@@ -16,21 +17,23 @@ For an introduction to specifying completions, see <a
href='index.html#completion-own'>Writing your own completions</a> in
the fish manual.
- `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
- `-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
<<<<<<< HEAD
- `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`
- `-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
@@ -48,6 +51,14 @@ switches may all be used multiple times to specify multiple commands
which have the same completion or multiple switches accepted by a
command.
The \c -w or \c --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 \c -e or \c --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
@@ -84,3 +95,10 @@ This can be written as:
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:
`complete -c hub -w git`
Now hub inherits all of the completions from git. Note this can
also be specified in a function declaration.

4
doc_src/function.txt
View File

@@ -16,6 +16,7 @@ The following options are available:
- `-a NAMES` or `--argument-names NAMES` assigns the value of successive command-line arguments to the names given in NAMES.
- `-d DESCRIPTION` or `--description=DESCRIPTION` is a description of what the function does, suitable as a completion description.
- `-w WRAPPED_COMMAND` or `--wraps=WRAPPED_COMMAND` causes the function to inherit completions from the given wrapped command. See the documentation for <a href="#complete">`complete`</a> for more information.
- `-e` or `--on-event EVENT_NAME` tells fish to run this function when the specified named event is emitted. Fish internally generates named events e.g. when showing the prompt.
- `-j PID` or `--on-job-exit PID` tells fish to run this function when the job with group ID PID exits. Instead of PID, the string 'caller' can be specified. This is only legal when in a command substitution, and will result in the handler being triggered by the exit of the job which created this command substitution.
- `-p PID` or `--on-process-exit PID` tells fish to run this function when the fish child process with process ID PID exits.
@@ -58,6 +59,5 @@ function mkdir -d "Create a directory and set CWD"
end
\endfish
will run the mkdir command, and if it is successful, change the
current working directory to the one just created.
This will run the `mkdir` command, and if it is successful, change the current working directory to the one just created.