From 64853710e87ba124561653cb5d62ca3a653b4170 Mon Sep 17 00:00:00 2001
From: TomSweeneyRedHat <tsweeney@redhat.com>
Date: Mon, 18 Feb 2019 15:00:07 -0500
Subject: [PATCH] Add 4th chunk of Cobra Examples
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
Adds the 4th chunk of Cobra Examples to the CLI help.
One more chunk of 10 to complete.
Signed-off-by: TomSweeneyRedHat <tsweeney@redhat.com>
---
cmd/podman/cleanup.go | 4 +++-
cmd/podman/restart.go | 4 +++-
cmd/podman/restore.go | 4 +++-
cmd/podman/runlabel.go | 6 ++++--
cmd/podman/save.go | 4 +++-
cmd/podman/search.go | 4 +++-
cmd/podman/stats.go | 4 +++-
cmd/podman/tag.go | 4 +++-
cmd/podman/top.go | 4 +++-
cmd/podman/varlink.go | 3 ++-
10 files changed, 30 insertions(+), 11 deletions(-)
diff --git a/cmd/podman/cleanup.go b/cmd/podman/cleanup.go
index e465a30e68..89a4ba050d 100644
--- a/cmd/podman/cleanup.go
+++ b/cmd/podman/cleanup.go
@@ -26,7 +26,9 @@ var (
cleanupCommand.GlobalFlags = MainGlobalOpts
return cleanupCmd(&cleanupCommand)
},
- Example: "CONTAINER-NAME [CONTAINER-NAME ...]",
+ Example: `podman container cleanup --latest
+ podman container cleanup ctrID1 ctrID2 ctrID3
+ podman container cleanup --all`,
}
)
diff --git a/cmd/podman/restart.go b/cmd/podman/restart.go
index 235107b5cc..97b689c024 100644
--- a/cmd/podman/restart.go
+++ b/cmd/podman/restart.go
@@ -26,7 +26,9 @@ var (
restartCommand.GlobalFlags = MainGlobalOpts
return restartCmd(&restartCommand)
},
- Example: "CONTAINER [CONTAINER ...]",
+ Example: `podman restart ctrID
+ podman restart --latest
+ podman restart ctrID1 ctrID2`,
}
)
diff --git a/cmd/podman/restore.go b/cmd/podman/restore.go
index 556cdb7742..2911bbdd63 100644
--- a/cmd/podman/restore.go
+++ b/cmd/podman/restore.go
@@ -29,7 +29,9 @@ var (
restoreCommand.GlobalFlags = MainGlobalOpts
return restoreCmd(&restoreCommand)
},
- Example: "CONTAINER-NAME [CONTAINER-NAME ...]",
+ Example: `podman container restore ctrID
+ podman container restore --latest
+ podman container restore --all`,
}
)
diff --git a/cmd/podman/runlabel.go b/cmd/podman/runlabel.go
index f1c61ebda3..54f210e622 100644
--- a/cmd/podman/runlabel.go
+++ b/cmd/podman/runlabel.go
@@ -31,7 +31,9 @@ Executes a command as described by a container image label.
runlabelCommand.GlobalFlags = MainGlobalOpts
return runlabelCmd(&runlabelCommand)
},
- Example: "",
+ Example: `podman container runlabel run imageID
+ podman container runlabel --pull install imageID arg1 arg2
+ podman container runlabel --display run myImage`,
}
)
@@ -49,7 +51,7 @@ func init() {
flags.StringVar(&runlabelCommand.Opt2, "opt2", "", "Optional parameter to pass for install")
flags.StringVar(&runlabelCommand.Opt3, "opt3", "", "Optional parameter to pass for install")
flags.MarkHidden("opt1")
- flags.MarkHidden("opt3")
+ flags.MarkHidden("opt2")
flags.MarkHidden("opt3")
flags.BoolVarP(&runlabelCommand.Pull, "pull", "p", false, "Pull the image if it does not exist locally prior to executing the label contents")
diff --git a/cmd/podman/save.go b/cmd/podman/save.go
index 1ae1bc8724..ff4a22453e 100644
--- a/cmd/podman/save.go
+++ b/cmd/podman/save.go
@@ -41,7 +41,9 @@ var (
saveCommand.GlobalFlags = MainGlobalOpts
return saveCmd(&saveCommand)
},
- Example: "",
+ Example: `podman save --quiet -o myimage.tar imageID
+ podman save --format docker-dir -o ubuntu-dir ubuntu
+ podman save > alpine-all.tar alpine:latest`,
}
)
diff --git a/cmd/podman/search.go b/cmd/podman/search.go
index 858addff62..c8b64039a7 100644
--- a/cmd/podman/search.go
+++ b/cmd/podman/search.go
@@ -36,7 +36,9 @@ var (
searchCommand.GlobalFlags = MainGlobalOpts
return searchCmd(&searchCommand)
},
- Example: "TERM",
+ Example: `podman search --filter=is-official --limit 3 alpine
+ podman search registry.fedoraproject.org/ # only works with v2 registries
+ podman search --format "table {{.Index}} {{.Name}}" registry.fedoraproject.org/fedora`,
}
)
diff --git a/cmd/podman/stats.go b/cmd/podman/stats.go
index af9bbad0e1..642e54f49f 100644
--- a/cmd/podman/stats.go
+++ b/cmd/podman/stats.go
@@ -41,7 +41,9 @@ var (
statsCommand.GlobalFlags = MainGlobalOpts
return statsCmd(&statsCommand)
},
- Example: "",
+ Example: `podman stats --all --no-stream
+ podman stats ctrID
+ podman stats --no-stream --format "table {{.ID}} {{.Name}} {{.MemUsage}}" ctrID`,
}
)
diff --git a/cmd/podman/tag.go b/cmd/podman/tag.go
index 135c2f7a0b..422e9dbf61 100644
--- a/cmd/podman/tag.go
+++ b/cmd/podman/tag.go
@@ -20,7 +20,9 @@ var (
tagCommand.GlobalFlags = MainGlobalOpts
return tagCmd(&tagCommand)
},
- Example: "IMAGE-NAME [IMAGE-NAME ...]",
+ Example: `podman tag 0e3bbc2 fedora:latest
+ podman tag imageID:latest myNewImage:newTag
+ podman tag httpd myregistryhost:5000/fedora/httpd:v2`,
}
)
diff --git a/cmd/podman/top.go b/cmd/podman/top.go
index 51b813e5a6..d85e1be53c 100644
--- a/cmd/podman/top.go
+++ b/cmd/podman/top.go
@@ -42,7 +42,9 @@ the latest container.
topCommand.GlobalFlags = MainGlobalOpts
return topCmd(&topCommand)
},
- Example: "CONTAINER-NAME [format descriptors]",
+ Example: `podman top ctrID
+ podman top --latest
+ podman top ctrID pid seccomp args %C`,
}
)
diff --git a/cmd/podman/varlink.go b/cmd/podman/varlink.go
index ce54cfa85b..d9c6cdb47f 100644
--- a/cmd/podman/varlink.go
+++ b/cmd/podman/varlink.go
@@ -32,7 +32,8 @@ var (
varlinkCommand.GlobalFlags = MainGlobalOpts
return varlinkCmd(&varlinkCommand)
},
- Example: "VARLINK_URI",
+ Example: `podman varlink unix:/run/podman/io.podman
+ podman varlink --timeout 5000 unix:/run/podman/io.podman`,
}
)