diff options
| -rw-r--r-- | cmd/podman/inspect.go | 18 | ||||
| -rw-r--r-- | docs/source/markdown/podman-inspect.1.md | 14 |
2 files changed, 24 insertions, 8 deletions
diff --git a/cmd/podman/inspect.go b/cmd/podman/inspect.go index 12e11d0f5..befdeb445 100644 --- a/cmd/podman/inspect.go +++ b/cmd/podman/inspect.go @@ -8,12 +8,22 @@ import ( ) var ( + inspectDescription = `Displays the low-level information on an object identified by name or ID. + For more inspection options, see: + + podman container inspect + podman image inspect + podman network inspect + podman pod inspect + podman volume inspect` + // Command: podman _inspect_ Object_ID inspectCmd = &cobra.Command{ - Use: "inspect [flags] {CONTAINER_ID | IMAGE_ID} [...]", - Short: "Display the configuration of object denoted by ID", - Long: "Displays the low-level information on an object identified by name or ID", - RunE: inspectExec, + Use: "inspect [flags] {CONTAINER_ID | IMAGE_ID} [...]", + Short: "Display the configuration of object denoted by ID", + RunE: inspectExec, + Long: inspectDescription, + TraverseChildren: true, Example: `podman inspect fedora podman inspect --type image fedora podman inspect CtrID ImgID 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* |