summaryrefslogtreecommitdiff
path: root/plugins/docker
diff options
context:
space:
mode:
authorTuowen Zhao <ztuowen@gmail.com>2020-09-24 15:02:36 -0600
committerTuowen Zhao <ztuowen@gmail.com>2020-09-24 15:02:36 -0600
commit2b3d602644a13aa97391f22ecfc249b6bc58dd49 (patch)
tree89bed339def1ab58d1ea1b16593752d4a29e23fa /plugins/docker
parent44cc53902935c693239611b06de02fc37ac4da62 (diff)
parent93c837fec8e9fe61509b9dff9e909e84f7ebe32d (diff)
downloadzsh-2b3d602644a13aa97391f22ecfc249b6bc58dd49.tar.gz
zsh-2b3d602644a13aa97391f22ecfc249b6bc58dd49.tar.bz2
zsh-2b3d602644a13aa97391f22ecfc249b6bc58dd49.zip
Merge remote-tracking branch 'origin/master' into master
Diffstat (limited to 'plugins/docker')
-rw-r--r--plugins/docker/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/plugins/docker/README.md b/plugins/docker/README.md
index 241a6a448..fab7aa8f1 100644
--- a/plugins/docker/README.md
+++ b/plugins/docker/README.md
@@ -10,3 +10,25 @@ plugins=(... docker)
A copy of the completion script from the docker/cli git repo:
https://github.com/docker/cli/blob/master/contrib/completion/zsh/_docker
+
+## Settings
+
+By default, the completion doesn't allow option-stacking, meaning if you try to
+complete `docker run -it <TAB>` it won't work, because you're _stacking_ the
+`-i` and `-t` options.
+
+[You can enable it](https://github.com/docker/cli/commit/b10fb43048) by **adding
+the lines below to your zshrc file**, but be aware of the side effects:
+
+> This enables Zsh to understand commands like `docker run -it
+> ubuntu`. However, by enabling this, this also makes Zsh complete
+> `docker run -u<tab>` with `docker run -uapprox` which is not valid. The
+> users have to put the space or the equal sign themselves before trying
+> to complete.
+>
+> Therefore, this behavior is disabled by default. To enable it:
+>
+> ```
+> zstyle ':completion:*:*:docker:*' option-stacking yes
+> zstyle ':completion:*:*:docker-*:*' option-stacking yes
+> ```