Browse code

update the cli / man page docs based on what is in master right now

Docker-DCO-1.1-Signed-off-by: SvenDowideit <SvenDowideit@home.org.au> (github: SvenDowideit)

SvenDowideit authored on 2014/08/18 08:31:58
Showing 3 changed files
... ...
@@ -8,6 +8,7 @@ docker-ps - List containers
8 8
 **docker ps**
9 9
 [**-a**|**--all**[=*false*]]
10 10
 [**--before**[=*BEFORE*]]
11
+[**-f**|**--filter**[=*[]*]]
11 12
 [**-l**|**--latest**[=*false*]]
12 13
 [**-n**[=*-1*]]
13 14
 [**--no-trunc**[=*false*]]
... ...
@@ -28,6 +29,10 @@ the running containers.
28 28
 **--before**=""
29 29
    Show only container created before Id or Name, include non-running ones.
30 30
 
31
+**-f**, **--filter**=[]
32
+   Provide filter values. Valid filters:
33
+                          exited=<int> - containers with exit code of <int>
34
+
31 35
 **-l**, **--latest**=*true*|*false*
32 36
    Show only the latest created container, include non-running ones. The default is *false*.
33 37
 
... ...
@@ -68,3 +73,4 @@ the running containers.
68 68
 April 2014, Originally compiled by William Henry (whenry at redhat dot com)
69 69
 based on docker.com source material and internal work.
70 70
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
71
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -6,8 +6,8 @@ docker-rm - Remove one or more containers
6 6
 
7 7
 # SYNOPSIS
8 8
 **docker rm**
9
-[**-l**|**--link**[=*false*]]
10 9
 [**-f**|**--force**[=*false*]]
10
+[**-l**|**--link**[=*false*]]
11 11
 [**-v**|**--volumes**[=*false*]]
12 12
  CONTAINER [CONTAINER...]
13 13
 
... ...
@@ -19,11 +19,12 @@ remove a running container unless you use the \fB-f\fR option. To see all
19 19
 containers on a host use the **docker ps -a** command.
20 20
 
21 21
 # OPTIONS
22
+**-f**, **--force**=*true*|*false*
23
+   Force the removal of a running container (uses SIGKILL). The default is *false*.
24
+
22 25
 **-l**, **--link**=*true*|*false*
23 26
    Remove the specified link and not the underlying container. The default is *false*.
24 27
 
25
-**-f**, **--force**=*true*|*false*
26
-  Allows removing of a running container by first killing it with SIGKILL.
27 28
 **-v**, **--volumes**=*true*|*false*
28 29
    Remove the volumes associated with the container. The default is *false*.
29 30
 
... ...
@@ -49,3 +50,4 @@ April 2014, Originally compiled by William Henry (whenry at redhat dot com)
49 49
 based on docker.com source material and internal work.
50 50
 June 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
51 51
 July 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
52
+August 2014, updated by Sven Dowideit <SvenDowideit@home.org.au>
... ...
@@ -65,7 +65,7 @@ expect an integer, and they can only be specified once.
65 65
       -H, --host=[]                              The socket(s) to bind to in daemon mode
66 66
                                                    specified using one or more tcp://host:port, unix:///path/to/socket, fd://* or fd://socketfd.
67 67
       --icc=true                                 Enable inter-container communication
68
-      --ip="0.0.0.0"                             Default IP address to use when binding container ports
68
+      --ip=0.0.0.0                               Default IP address to use when binding container ports
69 69
       --ip-forward=true                          Enable net.ipv4.ip_forward
70 70
       --iptables=true                            Enable Docker's addition of iptables rules
71 71
       --mtu=0                                    Set the containers network MTU
... ...
@@ -792,7 +792,8 @@ further details.
792 792
 
793 793
       -a, --all=false       Show all containers. Only running containers are shown by default.
794 794
       --before=""           Show only container created before Id or Name, include non-running ones.
795
-      -f, --filter=[]       Provide filter values (i.e. 'exited=0')
795
+      -f, --filter=[]       Provide filter values. Valid filters:
796
+                              exited=<int> - containers with exit code of <int>
796 797
       -l, --latest=false    Show only the latest created container, include non-running ones.
797 798
       -n=-1                 Show n last created containers, include non-running ones.
798 799
       --no-trunc=false      Don't truncate output
... ...
@@ -882,7 +883,7 @@ registry or to a self-hosted one.
882 882
 
883 883
     Remove one or more containers
884 884
 
885
-      -f, --force=false      Force removal of a running container. Uses SIGKILL to stop the container.
885
+      -f, --force=false      Force the removal of a running container (uses SIGKILL)
886 886
       -l, --link=false       Remove the specified link and not the underlying container
887 887
       -v, --volumes=false    Remove the volumes associated with the container
888 888