From dbf53e1491994aedf9beb16d7e8fdab342e1df03 Mon Sep 17 00:00:00 2001 From: Wen Cheng Ma Date: Thu, 3 Dec 2015 15:16:53 +0800 Subject: [PATCH] Improvement for docker subcommand's help messages Signed-off-by: Wen Cheng Ma Upstream-commit: 636ffcc0281769fe5980e73519477ca4f1236413 Component: cli --- .../cli/docs/reference/commandline/ps.md | 10 +++++++++- components/cli/man/docker-ps.1.md | 19 +++++++++---------- 2 files changed, 18 insertions(+), 11 deletions(-) diff --git a/components/cli/docs/reference/commandline/ps.md b/components/cli/docs/reference/commandline/ps.md index 213648f1db..432a9a31c4 100644 --- a/components/cli/docs/reference/commandline/ps.md +++ b/components/cli/docs/reference/commandline/ps.md @@ -15,7 +15,15 @@ parent = "smn_cli" List containers -a, --all Show all containers (default shows just running) - -f, --filter=[] Filter output based on conditions provided + -f, --filter=[] Filter output based on these conditions: + - exited= an exit code of + - label= or label== + - status=(created|restarting|running|paused|exited) + - name= a container's name + - id= a container's ID + - before=(|) + - since=(|) + - ancestor=([:tag]||) - containers created from an image or a descendant. --format=[] Pretty-print containers using a Go template --help Print usage -l, --latest Show the latest created container (includes all states) diff --git a/components/cli/man/docker-ps.1.md b/components/cli/man/docker-ps.1.md index 770cd26498..0d0cae5792 100644 --- a/components/cli/man/docker-ps.1.md +++ b/components/cli/man/docker-ps.1.md @@ -26,16 +26,15 @@ the running containers. Show all containers. Only running containers are shown by default. The default is *false*. **-f**, **--filter**=[] - Provide filter values. Valid filters: - exited= - containers with exit code of - label= or label== - status=(created|restarting|running|paused|exited) - name= - container's name - id= - container's ID - before=(|) - since=(|) - ancestor=([:tag]||) - filters containers that were - created from the given image or a descendant. + Filter output based on these conditions: + - exited= an exit code of + - label= or label== + - status=(created|restarting|running|paused|exited) + - name= a container's name + - id= a container's ID + - before=(|) + - since=(|) + - ancestor=([:tag]||) - containers created from an image or a descendant. **--format**="*TEMPLATE*" Pretty-print containers using a Go template.