2019-05-31 19:21:47 +00:00
|
|
|
% podman-rmi(1)
|
2017-11-01 15:24:59 +00:00
|
|
|
|
|
|
|
|
## NAME
|
2019-08-30 14:09:50 +00:00
|
|
|
podman\-rmi - Removes one or more locally stored images
|
2017-11-01 15:24:59 +00:00
|
|
|
|
|
|
|
|
## SYNOPSIS
|
Docs: consistency between man / --help
New functionality in hack/man-page-checker: start cross-
referencing the man page 'Synopsis' line against the
output of 'podman foo --help'. This is part 1, flag/option
consistency. Part 2 (arg consistency) is too big and will
have to wait for later.
flag/option consistency means: if 'podman foo --help'
includes the string '[flags]' in the Usage message,
make sure the man page includes '[*options*]' in its
Synopsis line, and vice-versa. This found several
inconsistencies, which I've fixed.
While doing this I realized that Cobra automatically
includes a 'Flags:' subsection in its --help output
for all subcommands that have defined flags. This
is great - it lets us cross-check against the
usage synopsis, and make sure that '[flags]' is
present or absent as needed, without fear of
human screwups. If a flag-less subcommand ever
gets extended with flags, but the developer forgets
to add '[flags]' and remove DisableFlagsInUseLine,
we now have a test that will catch that. (This,
too, caught two instances which I fixed).
I don't actually know if the new man-page-checker
functionality will work in CI: I vaguely recall that
it might run before 'make podman' does; and also
vaguely recall that some steps were taken to remedy
that.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-06-24 16:16:59 +00:00
|
|
|
**podman rmi** [*options*] *image* [...]
|
2017-11-01 15:24:59 +00:00
|
|
|
|
Docs: consistency between man / --help
New functionality in hack/man-page-checker: start cross-
referencing the man page 'Synopsis' line against the
output of 'podman foo --help'. This is part 1, flag/option
consistency. Part 2 (arg consistency) is too big and will
have to wait for later.
flag/option consistency means: if 'podman foo --help'
includes the string '[flags]' in the Usage message,
make sure the man page includes '[*options*]' in its
Synopsis line, and vice-versa. This found several
inconsistencies, which I've fixed.
While doing this I realized that Cobra automatically
includes a 'Flags:' subsection in its --help output
for all subcommands that have defined flags. This
is great - it lets us cross-check against the
usage synopsis, and make sure that '[flags]' is
present or absent as needed, without fear of
human screwups. If a flag-less subcommand ever
gets extended with flags, but the developer forgets
to add '[flags]' and remove DisableFlagsInUseLine,
we now have a test that will catch that. (This,
too, caught two instances which I fixed).
I don't actually know if the new man-page-checker
functionality will work in CI: I vaguely recall that
it might run before 'make podman' does; and also
vaguely recall that some steps were taken to remedy
that.
Signed-off-by: Ed Santiago <santiago@redhat.com>
2020-06-24 16:16:59 +00:00
|
|
|
**podman image rm** [*options*] *image* [...]
|
2019-08-30 14:09:50 +00:00
|
|
|
|
2017-11-01 15:24:59 +00:00
|
|
|
## DESCRIPTION
|
|
|
|
|
Removes one or more locally stored images.
|
|
|
|
|
|
|
|
|
|
## OPTIONS
|
|
|
|
|
|
2020-11-10 13:59:34 +00:00
|
|
|
#### **--all**, **-a**
|
2017-11-13 22:16:47 +00:00
|
|
|
|
2018-01-06 22:46:10 +00:00
|
|
|
Remove all images in the local storage.
|
2017-11-01 15:24:59 +00:00
|
|
|
|
2020-11-10 13:59:34 +00:00
|
|
|
#### **--force**, **-f**
|
2018-01-06 22:46:10 +00:00
|
|
|
|
|
|
|
|
This option will cause podman to remove all containers that are using the image before removing the image from the system.
|
2017-11-01 15:24:59 +00:00
|
|
|
|
|
|
|
|
|
2018-12-01 15:49:46 +00:00
|
|
|
Remove an image by its short ID
|
|
|
|
|
```
|
2020-01-26 12:16:16 +00:00
|
|
|
$ podman rmi c0ed59d05ff7
|
2018-12-01 15:49:46 +00:00
|
|
|
```
|
|
|
|
|
Remove an image and its associated containers.
|
|
|
|
|
```
|
2020-01-26 12:16:16 +00:00
|
|
|
$ podman rmi --force imageID
|
2020-01-22 12:50:48 +00:00
|
|
|
```
|
2017-11-01 15:24:59 +00:00
|
|
|
|
2018-12-01 15:49:46 +00:00
|
|
|
Remove multiple images by their shortened IDs.
|
|
|
|
|
```
|
2020-01-26 12:16:16 +00:00
|
|
|
$ podman rmi c4dfb1609ee2 93fd78260bd1 c0ed59d05ff7
|
2018-12-01 15:49:46 +00:00
|
|
|
```
|
2017-11-01 15:24:59 +00:00
|
|
|
|
2018-12-01 15:49:46 +00:00
|
|
|
Remove all images and containers.
|
|
|
|
|
```
|
2020-01-26 12:16:16 +00:00
|
|
|
$ podman rmi -a -f
|
2018-12-01 15:49:46 +00:00
|
|
|
```
|
2019-02-24 12:36:27 +00:00
|
|
|
## Exit Status
|
2020-01-26 07:53:23 +00:00
|
|
|
**0** All specified images removed
|
|
|
|
|
|
|
|
|
|
**1** One of the specified images did not exist, and no other failures
|
|
|
|
|
|
|
|
|
|
**2** One of the specified images has child images or is being used by a container
|
|
|
|
|
|
2020-09-29 14:05:53 +00:00
|
|
|
**125** The command fails for any other reason
|
2017-11-13 22:16:47 +00:00
|
|
|
|
2017-11-01 15:24:59 +00:00
|
|
|
## SEE ALSO
|
2017-12-15 21:58:36 +00:00
|
|
|
podman(1)
|
2017-11-01 15:24:59 +00:00
|
|
|
|
|
|
|
|
## HISTORY
|
|
|
|
|
March 2017, Originally compiled by Dan Walsh <dwalsh@redhat.com>
|