Merge pull request #2333 from TomSweeneyRedHat/dev/tsweeney/helpexamples

Add examples for Cobra

11 files changed, 40 insertions, 12 deletions

diff --git a/cmd/podman/commit.go b/cmd/podman/commit.go
index dc53e68d1..d8ced0e36 100644
--- a/cmd/podman/commit.go
+++ b/cmd/podman/commit.go
@@ -33,7 +33,9 @@ var (
 			commitCommand.GlobalFlags = MainGlobalOpts
 			return commitCmd(&commitCommand)
 		},
-		Example: "CONTAINER [REPOSITORY[:TAG]]",
+		Example: `podman commit -q --message "committing container to image" reverent_golick image-commited
+  podman commit -q --author "firstName lastName" reverent_golick image-commited
+  podman commit -q --pause=false containerID image-commited`,
 	}
 )
 
diff --git a/cmd/podman/common.go b/cmd/podman/common.go
index 417e938b7..ec755c4a8 100644
--- a/cmd/podman/common.go
+++ b/cmd/podman/common.go
@@ -514,7 +514,7 @@ Aliases:
   {{.NameAndAliases}}{{end}}{{if .HasExample}}
 
 Examples:
-{{.Example}}{{end}}{{if .HasAvailableSubCommands}}
+  {{.Example}}{{end}}{{if .HasAvailableSubCommands}}
 
 Available Commands:{{range .Commands}}{{if (or .IsAvailableCommand (eq .Name "help"))}}
   {{rpad .Name .NamePadding }} {{.Short}}{{end}}{{end}}{{end}}{{if .HasAvailableLocalFlags}}
diff --git a/cmd/podman/create.go b/cmd/podman/create.go
index 392163424..7bfb070c7 100644
--- a/cmd/podman/create.go
+++ b/cmd/podman/create.go
@@ -49,7 +49,9 @@ var (
 			createCommand.GlobalFlags = MainGlobalOpts
 			return createCmd(&createCommand)
 		},
-		Example: "IMAGE [COMMAND [ARG...]]",
+		Example: `podman create alpine ls
+  podman create --annotation HELLO=WORLD alpine ls
+  podman create -t -i --name myctr alpine ls`,
 	}
 
 	defaultEnvVariables = map[string]string{
diff --git a/cmd/podman/exists.go b/cmd/podman/exists.go
index 15ddaec06..7645bb716 100644
--- a/cmd/podman/exists.go
+++ b/cmd/podman/exists.go
@@ -41,7 +41,7 @@ var (
 			imageExistsCommand.GlobalFlags = MainGlobalOpts
 			return imageExistsCmd(&imageExistsCommand)
 		},
-		Example: "IMAGE-NAME",
+		Example: `podman image exists imageID`,
 	}
 
 	_containerExistsCommand = &cobra.Command{
@@ -54,7 +54,7 @@ var (
 			return containerExistsCmd(&containerExistsCommand)
 
 		},
-		Example: "CONTAINER-NAME",
+		Example: `podman container exists containerID`,
 	}
 
 	_podExistsCommand = &cobra.Command{
@@ -66,7 +66,7 @@ var (
 			podExistsCommand.GlobalFlags = MainGlobalOpts
 			return podExistsCmd(&podExistsCommand)
 		},
-		Example: "POD-NAME",
+		Example: `podman pod exists podID`,
 	}
 )
 
diff --git a/cmd/podman/info.go b/cmd/podman/info.go
index d60b8f84f..06dbbd748 100644
--- a/cmd/podman/info.go
+++ b/cmd/podman/info.go
@@ -26,7 +26,7 @@ var (
 			infoCommand.GlobalFlags = MainGlobalOpts
 			return infoCmd(&infoCommand)
 		},
-		Example: "",
+		Example: `podman info`,
 	}
 )
 
diff --git a/cmd/podman/inspect.go b/cmd/podman/inspect.go
index a29eb790e..a1f3ef81f 100644
--- a/cmd/podman/inspect.go
+++ b/cmd/podman/inspect.go
@@ -34,7 +34,9 @@ var (
 			inspectCommand.GlobalFlags = MainGlobalOpts
 			return inspectCmd(&inspectCommand)
 		},
-		Example: "CONTAINER-OR-IMAGE [CONTAINER-OR-IMAGE]...",
+		Example: `podman inspect alpine
+  podman inspect --format "imageId: {{.Id}} size: {{.Size}}" alpine
+  podman inspect --format "image: {{.ImageName}} driver: {{.Driver}}" myctr`,
 	}
 )
 
diff --git a/cmd/podman/login.go b/cmd/podman/login.go
index 1fc4d5327..3eacab54a 100644
--- a/cmd/podman/login.go
+++ b/cmd/podman/login.go
@@ -29,7 +29,9 @@ var (
 			loginCommand.GlobalFlags = MainGlobalOpts
 			return loginCmd(&loginCommand)
 		},
-		Example: "REGISTRY",
+		Example: `podman login -u testuser -p testpassword localhost:5000
+  podman login --authfile authdir/myauths.json quay.io
+  podman login -u testuser -p testpassword localhost:5000`,
 	}
 )
 
diff --git a/cmd/podman/pod_inspect.go b/cmd/podman/pod_inspect.go
index a0b691642..58b15328e 100644
--- a/cmd/podman/pod_inspect.go
+++ b/cmd/podman/pod_inspect.go
@@ -23,7 +23,7 @@ var (
 			podInspectCommand.GlobalFlags = MainGlobalOpts
 			return podInspectCmd(&podInspectCommand)
 		},
-		Example: "[POD_NAME_OR_ID]",
+		Example: `podman pod inspect podID`,
 	}
 )
 
diff --git a/cmd/podman/pod_rm.go b/cmd/podman/pod_rm.go
index 389f44a20..54cee2a50 100644
--- a/cmd/podman/pod_rm.go
+++ b/cmd/podman/pod_rm.go
@@ -26,7 +26,9 @@ If --force is specified, all containers will be stopped, then removed.
 			podRmCommand.GlobalFlags = MainGlobalOpts
 			return podRmCmd(&podRmCommand)
 		},
-		Example: "[POD ...]",
+		Example: `podman pod rm mywebserverpod
+  podman pod rm -f 860a4b23
+  podman pod rm -f -a`,
 	}
 )
 
diff --git a/docs/podman-commit.1.md b/docs/podman-commit.1.md
index 79e14aba6..acde51859 100644
--- a/docs/podman-commit.1.md
+++ b/docs/podman-commit.1.md
@@ -76,7 +76,7 @@ e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8
 ```
 
 ```
-$ podman commit -q --pause=false reverent_golick image-commited
+$ podman commit -q --pause=false containerID image-commited
 e3ce4d93051ceea088d1c242624d659be32cf1667ef62f1d16d6b60193e2c7a8
 ```
 
diff --git a/docs/podman-create.1.md b/docs/podman-create.1.md
index 2dffaff3b..342ef59c3 100644
--- a/docs/podman-create.1.md
+++ b/docs/podman-create.1.md
@@ -783,6 +783,24 @@ can override the working directory by using the **-w** option.
 
 ## EXAMPLES
 
+### Create a container using a local image
+
+```
+$ podman create alpine ls
+```
+
+### Create a container using a local image and annotate it
+
+```
+$ podman create --annotation HELLO=WORLD alpine ls
+```
+
+### Create a container using a local image, allocating a pseudo-TTY, keeping stdin open and name it myctr
+
+```
+  podman create -t -i --name myctr alpine ls
+```
+
 ### Set UID/GID mapping in a new user namespace
 
 Running a container in a new user namespace requires a mapping of