summaryrefslogtreecommitdiff
path: root/docs/reference/commandline/stack_ps.md
diff options
context:
space:
mode:
authorMisty Stanley-Jones <misty@apache.org>2017-04-03 16:54:34 -0700
committerGitHub <noreply@github.com>2017-04-03 16:54:34 -0700
commit473c5701cb66403b0535a5c01845cb0f27fbeb47 (patch)
tree9a40326ad4b426655abca7377dc30da003847d4d /docs/reference/commandline/stack_ps.md
parentce07fb6b0f1b8765b92022e45f96bd4349812e06 (diff)
parent71e6babfa2598669218177b5b429e873b7f35e8f (diff)
downloaddocker-1.13.x.tar.gz
Merge pull request #32332 from mstanleyjones/1.13.x1.13.x
Cherry-pick command-line ref improvements
Diffstat (limited to 'docs/reference/commandline/stack_ps.md')
-rw-r--r--docs/reference/commandline/stack_ps.md12
1 files changed, 10 insertions, 2 deletions
diff --git a/docs/reference/commandline/stack_ps.md b/docs/reference/commandline/stack_ps.md
index 101e9feb11..9f221d8da6 100644
--- a/docs/reference/commandline/stack_ps.md
+++ b/docs/reference/commandline/stack_ps.md
@@ -27,10 +27,18 @@ Options:
--no-trunc Do not truncate output
```
+## Description
+
Lists the tasks that are running as part of the specified stack. This
command has to be run targeting a manager node.
-## Filtering
+## Examples
+
+```bash
+$ docker stack ps
+```
+
+### Filtering
The filtering flag (`-f` or `--filter`) format is a `key=value` pair. If there
is more than one filter, then pass multiple flags (e.g. `--filter "foo=bar" --filter "bif=baz"`).
@@ -43,7 +51,7 @@ The currently supported filters are:
* name
* desired-state
-## Related information
+## Related commands
* [stack deploy](stack_deploy.md)
* [stack ls](stack_ls.md)