aboutsummaryrefslogtreecommitdiff
path: root/cmd/podman/pod_inspect.go
diff options
context:
space:
mode:
Diffstat (limited to 'cmd/podman/pod_inspect.go')
-rw-r--r--cmd/podman/pod_inspect.go8
1 files changed, 6 insertions, 2 deletions
diff --git a/cmd/podman/pod_inspect.go b/cmd/podman/pod_inspect.go
index 8b2747af0..79ffe2e6f 100644
--- a/cmd/podman/pod_inspect.go
+++ b/cmd/podman/pod_inspect.go
@@ -12,8 +12,11 @@ import (
var (
podInspectCommand cliconfig.PodInspectValues
- podInspectDescription = "Display the configuration for a pod by name or id"
- _podInspectCommand = &cobra.Command{
+ podInspectDescription = `Display the configuration for a pod 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 command returns the container JSON.`
+
+ _podInspectCommand = &cobra.Command{
Use: "inspect [flags] POD",
Short: "Displays a pod configuration",
Long: podInspectDescription,
@@ -28,6 +31,7 @@ var (
func init() {
podInspectCommand.Command = _podInspectCommand
+ podInspectCommand.SetHelpTemplate(HelpTemplate())
podInspectCommand.SetUsageTemplate(UsageTemplate())
flags := podInspectCommand.Flags()
flags.BoolVarP(&podInspectCommand.Latest, "latest", "l", false, "Act on the latest container podman is aware of")