diff options
| author | Mark Stosberg <mark@rideamigos.com> | 2020-06-25 09:54:04 -0400 |
|---|---|---|
| committer | Mark Stosberg <mark@rideamigos.com> | 2020-06-30 10:50:33 -0400 |
| commit | 8d69f5178b0b06b45986044d28f91a2ed16a7532 (patch) | |
| tree | 3b38bd4f468a56876bf761a4a4bc6cea58f99fae /docs | |
| parent | e0b93af70f1f1a183c99a350c6e588898b45c717 (diff) | |
| download | podman-8d69f5178b0b06b45986044d28f91a2ed16a7532.tar.gz podman-8d69f5178b0b06b45986044d28f91a2ed16a7532.tar.bz2 podman-8d69f5178b0b06b45986044d28f91a2ed16a7532.zip | |
docs: recommend alternatives to podman inspect
podman inspect is problematic because there can be naming clashes. Also,
it only inspects a couple of types of objects and the docs for it didn't
help discover that several more types could be inspected as well.
To address both concerns, we deprecate `podman inspect` and update the
docs to point to to the recommend alternatives.
Issue: #6756
Signed-off-by: Mark Stosberg <mark@rideamigos.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/source/markdown/podman-inspect.1.md | 14 |
1 files changed, 10 insertions, 4 deletions
diff --git a/docs/source/markdown/podman-inspect.1.md b/docs/source/markdown/podman-inspect.1.md index 4998772c3..a1dcd1a0e 100644 --- a/docs/source/markdown/podman-inspect.1.md +++ b/docs/source/markdown/podman-inspect.1.md @@ -6,15 +6,21 @@ podman\-inspect - Display a container or image's configuration ## SYNOPSIS **podman inspect** [*options*] *name* [...] -**podman image inspect** [*options*] *image* - -**podman container inspect** [*options*] *container* - ## DESCRIPTION + This displays the low-level information on containers and images identified by name or ID. By default, this will render all results in a JSON array. If the container and image have the same name, this will return container JSON for unspecified type. If a format is specified, the given template will be executed for each result. +For more inspection options, see: + + podman container inspect + podman image inspect + podman network inspect + podman pod inspect + podman volume inspect + + ## OPTIONS **--type**, **-t**=*type* |