aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc_src
diff options
context:
space:
mode:
authorGravatar David Adam <zanchey@ucc.gu.uwa.edu.au>2015-09-09 17:42:00 +0800
committerGravatar David Adam <zanchey@ucc.gu.uwa.edu.au>2015-09-09 17:42:42 +0800
commit8bf1e694fe05fe918fb4f0ee64197e906b8aa009 (patch)
tree169f89e113711fce29999ee980c376628f378925 /doc_src
parentc5bc221b277a48f5ef7aff0aae96c72f492999a6 (diff)
doc_src/complete: update for new options in synopsis
Update complete documentation, hopefully to avoid another #2368. [ci skip]
Diffstat (limited to 'doc_src')
-rw-r--r--doc_src/complete.txt12
1 files changed, 10 insertions, 2 deletions
diff --git a/doc_src/complete.txt b/doc_src/complete.txt
index 825faf9a..99f7410c 100644
--- a/doc_src/complete.txt
+++ b/doc_src/complete.txt
@@ -3,11 +3,19 @@
\subsection complete-synopsis Synopsis
\fish{synopsis}
complete ( -c | --command | -p | --path ) COMMAND
+ [( -e | --erase )]
[( -s | --short-option ) SHORT_OPTION]
[( -l | --long-option | -o | --old-option ) LONG_OPTION]
+ [( -f | --no-files )]
+ [( -r | --require-parameter )]
+ [( -x | --exclusive )]
+ [( -u | --unauthoritative )]
+ [( -A | --authoritative )]
[( -a | --arguments ) OPTION_ARGUMENTS]
[( -w | --wraps ) WRAPPED_COMMAND]
+ [( -n | --condition ) CONDITION]
[( -d | --description ) DESCRIPTION]
+complete ( -C STRING | --do=complete=STRING )
\endfish
\subsection complete-description Description
@@ -22,7 +30,7 @@ the fish manual.
- `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.
+- `OPTION_ARGUMENTS` is parameter containing a space-separated list of possible option-arguments, which may contain command substitutions.
- `DESCRIPTION` is a description of what the option and/or option arguments do.
@@ -30,7 +38,7 @@ the fish manual.
- `-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.
+- `-e` or `--erase` deletes the specified completion.
- `-f` or `--no-files` specifies that the option specified by this completion may not be followed by a filename.