From 89bc5fbbae3b0fc309e894707970fcf237a38d1d Mon Sep 17 00:00:00 2001 From: Sebastiaan van Stijn Date: Mon, 21 Jan 2019 16:15:45 +0100 Subject: [PATCH] Improve `docker image rm` reference docs Copies the improved description from the man page to the online reference docs. Signed-off-by: Sebastiaan van Stijn --- docs/reference/commandline/rmi.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/reference/commandline/rmi.md b/docs/reference/commandline/rmi.md index 66f194aba7..cc4f2f4111 100644 --- a/docs/reference/commandline/rmi.md +++ b/docs/reference/commandline/rmi.md @@ -26,6 +26,17 @@ Options: --no-prune Do not delete untagged parents ``` +## Description + +Removes (and un-tags) one or more images from the host node. If an image has +multiple tags, using this command with the tag as a parameter only removes the +tag. If the tag is the only one for the image, both the image and the tag are +removed. + +This does not remove images from a registry. You cannot remove an image of a +running container unless you use the `-f` option. To see all images on a host +use the [`docker image ls`](images.md) command. + ## Examples You can remove an image using its short or long ID, its tag, or its digest. If