components/docker/files/man/docker-rm.1
author Jesse Butler <jesse.butler@oracle.com>
Wed, 20 Jul 2016 17:19:20 -0700
changeset 6468 af5d82385cd7
permissions -rw-r--r--
PSARC/2016/354 Docker Engine 1.10.3 23499922 Docker Engine for Solaris 23757816 Docker on Solaris could use a support utility
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
6468
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     1
.TH "DOCKER" "1" " Docker User Manuals" "Docker Community" "JUNE 2014"  ""
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     2
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     3
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     4
.SH NAME
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     5
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     6
docker\-rm \- Remove one or more containers
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     7
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     8
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
     9
.SH SYNOPSIS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    10
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    11
\fBdocker rm\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    12
[\fB\-f\fP|\fB\-\-force\fP]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    13
[\fB\-l\fP|\fB\-\-link\fP]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    14
[\fB\-v\fP|\fB\-\-volumes\fP]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    15
CONTAINER [CONTAINER...]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    16
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    17
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    18
.SH DESCRIPTION
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    19
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    20
\fBdocker rm\fP will remove one or more containers from the host node. The
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    21
container name or ID can be used. This does not remove images. You cannot
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    22
remove a running container unless you use the \fB\-f\fP option. To see all
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    23
containers on a host use the \fBdocker ps \-a\fP command.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    24
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    25
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    26
.SH OPTIONS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    27
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    28
\fB\-\-help\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    29
  Print usage statement
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    30
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    31
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    32
\fB\-f\fP, \fB\-\-force\fP=\fItrue\fP|\fIfalse\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    33
   Force the removal of a running container (uses SIGKILL). The default is \fIfalse\fP.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    34
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    35
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    36
\fB\-l\fP, \fB\-\-link\fP=\fItrue\fP|\fIfalse\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    37
   Remove the specified link and not the underlying container. The default is \fIfalse\fP.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    38
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    39
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    40
\fB\-v\fP, \fB\-\-volumes\fP=\fItrue\fP|\fIfalse\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    41
   Remove the volumes associated with the container. The default is \fIfalse\fP.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    42
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    43
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    44
.SH EXAMPLES
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    45
.SH Removing a container using its ID
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    46
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    47
To remove a container using its ID, find either from a \fBdocker ps \-a\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    48
command, or use the ID returned from the \fBdocker run\fP command, or retrieve
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    49
it from a file used to store it using the \fBdocker run \-\-cidfile\fP:
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    50
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    51
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    52
.RS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    53
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    54
.nf
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    55
docker rm abebf7571666
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    56
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    57
.fi
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    58
.RE
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    59
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    60
.SH Removing a container using the container name
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    61
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    62
The name of the container can be found using the \fBdocker ps \-a\fP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    63
command. The use that name as follows:
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    64
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    65
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    66
.RS
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    67
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    68
.nf
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    69
docker rm hopeful\_morse
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    70
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    71
.fi
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    72
.RE
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    73
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    74
.SH Removing a container and all associated volumes
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    75
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    76
$ docker rm \-v redis
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    77
  redis
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    78
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    79
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    80
This command will remove the container and any volumes associated with it.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    81
Note that if a volume was specified with a name, it will not be removed.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    82
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    83
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    84
$ docker create \-v awesome:/foo \-v /bar \-\-name hello redis
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    85
  hello
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    86
  $ docker rm \-v hello
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    87
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    88
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    89
In this example, the volume for \fB\fC/foo\fR will remain in tact, but the volume for
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    90
\fB\fC/bar\fR will be removed. The same behavior holds for volumes inherited with
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    91
\fB\fC\-\-volumes\-from\fR.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    92
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    93
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    94
.SH HISTORY
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    95
.PP
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    96
April 2014, Originally compiled by William Henry (whenry at redhat dot com)
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    97
based on docker.com source material and internal work.
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    98
June 2014, updated by Sven Dowideit 
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
    99
\[la][email protected]\[ra]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   100
July 2014, updated by Sven Dowideit 
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   101
\[la][email protected]\[ra]
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   102
August 2014, updated by Sven Dowideit 
af5d82385cd7 PSARC/2016/354 Docker Engine 1.10.3
Jesse Butler <jesse.butler@oracle.com>
parents:
diff changeset
   103
\[la][email protected]\[ra]