summaryrefslogtreecommitdiff
path: root/docs/source/man/podman-rmi.1.md
diff options
context:
space:
mode:
authorbaude <bbaude@redhat.com>2019-10-24 14:54:57 -0500
committerbaude <bbaude@redhat.com>2019-10-31 12:31:39 -0500
commit52b92023edeba3a5e2c466d92d742e54b14a85cb (patch)
tree44e6193d49afd1277b7d07b0df41fc80d31b3adb /docs/source/man/podman-rmi.1.md
parent5af166ff513265b17aee92a9ce3a1522090d7dec (diff)
downloadpodman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.gz
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.tar.bz2
podman-52b92023edeba3a5e2c466d92d742e54b14a85cb.zip
Restructure documentation dir
Restructuring the docs dir to make integration with sphinx easier. man pages now exist in docs/source/man and the sphinx make files exists in docs. Signed-off-by: baude <bbaude@redhat.com>
Diffstat (limited to 'docs/source/man/podman-rmi.1.md')
-rw-r--r--docs/source/man/podman-rmi.1.md53
1 files changed, 53 insertions, 0 deletions
diff --git a/docs/source/man/podman-rmi.1.md b/docs/source/man/podman-rmi.1.md
new file mode 100644
index 000000000..d911ee6cb
--- /dev/null
+++ b/docs/source/man/podman-rmi.1.md
@@ -0,0 +1,53 @@
+% podman-rmi(1)
+
+## NAME
+podman\-rmi - Removes one or more locally stored images
+
+## SYNOPSIS
+**podman rmi** *image* [...]
+
+**podman image rm** *image* [...]
+
+## DESCRIPTION
+Removes one or more locally stored images.
+
+## OPTIONS
+
+**-all**, **-a**
+
+Remove all images in the local storage.
+
+**--force**, **-f**
+
+This option will cause podman to remove all containers that are using the image before removing the image from the system.
+
+
+Remove an image by its short ID
+```
+podman rmi c0ed59d05ff7
+```
+Remove an image and its associated containers.
+```
+podman rmi --force imageID
+````
+
+Remove multiple images by their shortened IDs.
+```
+podman rmi c4dfb1609ee2 93fd78260bd1 c0ed59d05ff7
+```
+
+Remove all images and containers.
+```
+podman rmi -a -f
+```
+## Exit Status
+**_0_** if all specified images removed
+**_1_** if one of the specified images did not exist, and no other failures
+**_2_** if one of the specified images has child images or is being used by a container
+**_125_** if the command fails for a reason other than an image did not exist or is in use
+
+## SEE ALSO
+podman(1)
+
+## HISTORY
+March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>