opensource/podman
1
0
Fork 0
mirror of https://github.com/containers/podman.git synced 2025-08-06 11:32:07 +08:00
Code Issues Packages Projects Releases Wiki Activity

docs: recommend alternatives to podman inspect

Browse Source 
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>
This commit is contained in:
Mark Stosberg
2020-06-25 09:54:04 -04:00
parent e0b93af70f
commit 8d69f5178b
2 changed files with 24 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/markdown/podman-inspect.1.md
View File

@ -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*