Files
podman/docs/source/markdown/podman-rmi.1.md
Ed Santiago c6090c290e 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 10:39:10 -06:00

1.2 KiB

% podman-rmi(1)

NAME

podman-rmi - Removes one or more locally stored images

SYNOPSIS

podman rmi [options] image [...]

podman image rm [options] 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 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

125 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