jyapayne/compose
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Merge pull request #3303 from aanand/clarify-rm-and-down

Browse source 
Clarify behaviour of rm and down
(cherry picked from commit 3d3f331404)

Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
This commit is contained in:
Aanand Prasad 2016-04-12 11:31:22 +01:00 • committed by Sven Dowideit
commit 174afeb974
3 changed files with 47 additions and 25 deletions
Download patch file Download diff file Expand all files Collapse all files

26
docs/reference/down.md
View file

@ -12,17 +12,27 @@ parent = "smn_compose_cli"
# down
```
Stop containers and remove containers, networks, volumes, and images
created by `up`. Only containers and networks are removed by default.
Usage: down [options]
Options:
--rmi type Remove images, type may be one of: 'all' to remove
all images, or 'local' to remove only images that
don't have an custom name set by the `image` field
-v, --volumes Remove data volumes
--rmi type Remove images. Type must be one of:
'all': Remove all images used by any service.
'local': Remove only images that don't have a custom tag
set by the `image` field.
-v, --volumes Remove named volumes declared in the `volumes` section
of the Compose file and anonymous volumes
attached to containers.
--remove-orphans Remove containers for services not defined in the
Compose file
```
Stops containers and removes containers, networks, volumes, and images
created by `up`.
By default, the only things removed are:
- Containers for services defined in the Compose file
- Networks defined in the `networks` section of the Compose file
- The default network, if one is used
Networks and volumes defined as `external` are never removed.