Merge pull request #2463 from edsantiago/missed_some_synopses

Followup to #2456: update examples, add trust
containers · Feb 27, 2019 · 8d120ba · 8d120ba
2 parents 4e553cf + 2c0909b
commit 8d120ba
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 10 deletions.
diff --git a/cmd/podman/checkpoint.go b/cmd/podman/checkpoint.go
@@ -32,9 +32,9 @@ var (
 		Args: func(cmd *cobra.Command, args []string) error {
 			return checkAllAndLatest(cmd, args, false)
 		},
-		Example: `podman checkpoint --keep ctrID
-  podman checkpoint --all
-  podman checkpoint --leave-running --latest`,
+		Example: `podman container checkpoint --keep ctrID
+  podman container checkpoint --all
+  podman container checkpoint --leave-running --latest`,
 	}
 )
 

diff --git a/cmd/podman/exists.go b/cmd/podman/exists.go
@@ -40,7 +40,8 @@ var (
 			imageExistsCommand.GlobalFlags = MainGlobalOpts
 			return imageExistsCmd(&imageExistsCommand)
 		},
-		Example: `podman image exists imageID`,
+		Example: `podman image exists imageID
+  podman image exists alpine || podman pull alpine`,
 	}
 
 	_containerExistsCommand = &cobra.Command{
@@ -53,7 +54,8 @@ var (
 			return containerExistsCmd(&containerExistsCommand)
 
 		},
-		Example: `podman container exists containerID`,
+		Example: `podman container exists containerID
+  podman container exists myctr || podman run --name myctr [etc...]`,
 	}
 
 	_podExistsCommand = &cobra.Command{
@@ -65,7 +67,8 @@ var (
 			podExistsCommand.GlobalFlags = MainGlobalOpts
 			return podExistsCmd(&podExistsCommand)
 		},
-		Example: `podman pod exists podID`,
+		Example: `podman pod exists podID
+  podman pod exists mypod || podman pod create --name mypod`,
 	}
 )
 

diff --git a/cmd/podman/generate_kube.go b/cmd/podman/generate_kube.go
@@ -17,7 +17,7 @@ var (
 	containerKubeCommand     cliconfig.GenerateKubeValues
 	containerKubeDescription = "Generate Kubernetes Pod YAML"
 	_containerKubeCommand    = &cobra.Command{
-		Use:   "kube CONTAINER | POD",
+		Use:   "kube [flags] CONTAINER | POD",
 		Short: "Generate Kubernetes pod YAML for a container or pod",
 		Long:  containerKubeDescription,
 		RunE: func(cmd *cobra.Command, args []string) error {

diff --git a/cmd/podman/images.go b/cmd/podman/images.go
@@ -88,7 +88,7 @@ var (
 	imagesDescription = "lists locally stored images."
 
 	_imagesCommand = cobra.Command{
-		Use:   "images",
+		Use:   "images [flags] [IMAGE]",
 		Short: "List images in local storage",
 		Long:  imagesDescription,
 		RunE: func(cmd *cobra.Command, args []string) error {

diff --git a/cmd/podman/trust_set_show.go b/cmd/podman/trust_set_show.go
@@ -23,7 +23,7 @@ var (
 	showTrustCommand    cliconfig.ShowTrustValues
 	setTrustDescription = "Set default trust policy or add a new trust policy for a registry"
 	_setTrustCommand    = &cobra.Command{
-		Use:     "set",
+		Use:     "set [flags] REGISTRY",
 		Short:   "Set default trust policy or a new trust policy for a registry",
 		Long:    setTrustDescription,
 		Example: "",
@@ -36,7 +36,7 @@ var (
 
 	showTrustDescription = "Display trust policy for the system"
 	_showTrustCommand    = &cobra.Command{
-		Use:   "show",
+		Use:   "show [flags] [REGISTRY]",
 		Short: "Display trust policy for the system",
 		Long:  showTrustDescription,
 		RunE: func(cmd *cobra.Command, args []string) error {