From 018e75a6e4ef955cd802267818b6a6c81a600c9a Mon Sep 17 00:00:00 2001 From: SvenDowideit Date: Mon, 18 Aug 2014 09:31:58 +1000 Subject: [PATCH] update the cli / man page docs based on what is in master right now Docker-DCO-1.1-Signed-off-by: SvenDowideit (github: SvenDowideit) --- docs/man/docker-ps.1.md | 6 ++++++ docs/man/docker-rm.1.md | 8 +++++--- docs/sources/reference/commandline/cli.md | 7 ++++--- 3 files changed, 15 insertions(+), 6 deletions(-) diff --git a/docs/man/docker-ps.1.md b/docs/man/docker-ps.1.md index 9264d53a66..bf22d87da5 100644 --- a/docs/man/docker-ps.1.md +++ b/docs/man/docker-ps.1.md @@ -8,6 +8,7 @@ docker-ps - List containers **docker ps** [**-a**|**--all**[=*false*]] [**--before**[=*BEFORE*]] +[**-f**|**--filter**[=*[]*]] [**-l**|**--latest**[=*false*]] [**-n**[=*-1*]] [**--no-trunc**[=*false*]] @@ -28,6 +29,10 @@ the running containers. **--before**="" Show only container created before Id or Name, include non-running ones. +**-f**, **--filter**=[] + Provide filter values. Valid filters: + exited= - containers with exit code of + **-l**, **--latest**=*true*|*false* Show only the latest created container, include non-running ones. The default is *false*. @@ -68,3 +73,4 @@ the running containers. April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work. June 2014, updated by Sven Dowideit +August 2014, updated by Sven Dowideit diff --git a/docs/man/docker-rm.1.md b/docs/man/docker-rm.1.md index e73231e907..bae6a7ea8c 100644 --- a/docs/man/docker-rm.1.md +++ b/docs/man/docker-rm.1.md @@ -6,8 +6,8 @@ docker-rm - Remove one or more containers # SYNOPSIS **docker rm** -[**-l**|**--link**[=*false*]] [**-f**|**--force**[=*false*]] +[**-l**|**--link**[=*false*]] [**-v**|**--volumes**[=*false*]] CONTAINER [CONTAINER...] @@ -19,11 +19,12 @@ remove a running container unless you use the \fB-f\fR option. To see all containers on a host use the **docker ps -a** command. # OPTIONS +**-f**, **--force**=*true*|*false* + Force the removal of a running container (uses SIGKILL). The default is *false*. + **-l**, **--link**=*true*|*false* Remove the specified link and not the underlying container. The default is *false*. -**-f**, **--force**=*true*|*false* - Allows removing of a running container by first killing it with SIGKILL. **-v**, **--volumes**=*true*|*false* Remove the volumes associated with the container. The default is *false*. @@ -49,3 +50,4 @@ April 2014, Originally compiled by William Henry (whenry at redhat dot com) based on docker.com source material and internal work. June 2014, updated by Sven Dowideit July 2014, updated by Sven Dowideit +August 2014, updated by Sven Dowideit diff --git a/docs/sources/reference/commandline/cli.md b/docs/sources/reference/commandline/cli.md index 9afa691b6b..8a8ef0696b 100644 --- a/docs/sources/reference/commandline/cli.md +++ b/docs/sources/reference/commandline/cli.md @@ -65,7 +65,7 @@ expect an integer, and they can only be specified once. -H, --host=[] The socket(s) to bind to in daemon mode specified using one or more tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd. --icc=true Enable inter-container communication - --ip="0.0.0.0" Default IP address to use when binding container ports + --ip=0.0.0.0 Default IP address to use when binding container ports --ip-forward=true Enable net.ipv4.ip_forward --iptables=true Enable Docker's addition of iptables rules --mtu=0 Set the containers network MTU @@ -792,7 +792,8 @@ further details. -a, --all=false Show all containers. Only running containers are shown by default. --before="" Show only container created before Id or Name, include non-running ones. - -f, --filter=[] Provide filter values (i.e. 'exited=0') + -f, --filter=[] Provide filter values. Valid filters: + exited= - containers with exit code of -l, --latest=false Show only the latest created container, include non-running ones. -n=-1 Show n last created containers, include non-running ones. --no-trunc=false Don't truncate output @@ -882,7 +883,7 @@ registry or to a self-hosted one. Remove one or more containers - -f, --force=false Force removal of a running container. Uses SIGKILL to stop the container. + -f, --force=false Force the removal of a running container (uses SIGKILL) -l, --link=false Remove the specified link and not the underlying container -v, --volumes=false Remove the volumes associated with the container