summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorOpenShift Merge Robot <openshift-merge-robot@users.noreply.github.com>2020-06-30 12:35:32 -0400
committerGitHub <noreply@github.com>2020-06-30 12:35:32 -0400
commit6fbd1570f86fc2509b6842c28dc2bc2e75e696d2 (patch)
tree9747c0551c8e0ed539b55e9e8704520ec0d8a61b /docs
parentc2a0ccd39464a91b7ba5fdca3af3c2ed66f2cbca (diff)
parent8d69f5178b0b06b45986044d28f91a2ed16a7532 (diff)
downloadpodman-6fbd1570f86fc2509b6842c28dc2bc2e75e696d2.tar.gz
podman-6fbd1570f86fc2509b6842c28dc2bc2e75e696d2.tar.bz2
podman-6fbd1570f86fc2509b6842c28dc2bc2e75e696d2.zip
Merge pull request #6773 from markstos/issue-6756-improve-inspect-docs
docs: recommend alternatives to podman inspect
Diffstat (limited to 'docs')
-rw-r--r--docs/source/markdown/podman-inspect.1.md14
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*