podman/podman-image-exists.1.md at 526f01cdf59b966b6ec0d35f10cdd95ad1aa2611

mirror of https://github.com/containers/podman.git synced 2025-05-21 17:16:22 +08:00

Files

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

949 B

Raw Blame History

% podman-image-exists(1)

NAME

podman-image-exists - Check if an image exists in local storage

SYNOPSIS

podman image exists image

DESCRIPTION

podman image exists checks if an image exists in local storage. The ID or Name of the image may be used as input. Podman will return an exit code of 0 when the image is found. A 1 will be returned otherwise. An exit code of 125 indicates there was an issue accessing the local storage.

OPTIONS

--help, -h

Print usage statement

Examples

Check if an image called webclient exists in local storage (the image does actually exist).

$ podman image exists webclient
$ echo $?
0
$

Check if an image called webbackend exists in local storage (the image does not actually exist).

$ podman image exists webbackend
$ echo $?
1
$

HISTORY

November 2018, Originally compiled by Brent Baude (bbaude at redhat dot com)

949 B Raw Blame History