From 675a202a1b560fdc08a489b37e6765a2b8cc4dd0 Mon Sep 17 00:00:00 2001 From: TomSweeneyRedHat Date: Mon, 18 Feb 2019 16:55:08 -0500 Subject: Fifth chunk of Cobra Examples Signed-off-by: TomSweeneyRedHat The fifth and final chunk of examples for the Cobra examples in the CLI help output. Also includes a few man page touchups. Signed-off-by: TomSweeneyRedHat --- cmd/podman/generate_kube.go | 4 +++- cmd/podman/images.go | 4 +++- cmd/podman/logs.go | 4 +++- cmd/podman/pod_kill.go | 4 +++- cmd/podman/pod_pause.go | 4 +++- cmd/podman/pod_restart.go | 4 +++- cmd/podman/pod_unpause.go | 4 +++- cmd/podman/port.go | 4 +++- cmd/podman/volume_rm.go | 4 +++- cmd/podman/wait.go | 4 +++- 10 files changed, 30 insertions(+), 10 deletions(-) (limited to 'cmd') diff --git a/cmd/podman/generate_kube.go b/cmd/podman/generate_kube.go index ddb2daa34..15f374c73 100644 --- a/cmd/podman/generate_kube.go +++ b/cmd/podman/generate_kube.go @@ -25,7 +25,9 @@ var ( containerKubeCommand.GlobalFlags = MainGlobalOpts return generateKubeYAMLCmd(&containerKubeCommand) }, - Example: "CONTAINER|POD-NAME", + Example: `podman generate kube ctrID + podman generate kube podID + podman generate kube --service podID`, } ) diff --git a/cmd/podman/images.go b/cmd/podman/images.go index b269f6440..56810eaeb 100644 --- a/cmd/podman/images.go +++ b/cmd/podman/images.go @@ -96,7 +96,9 @@ var ( imagesCommand.GlobalFlags = MainGlobalOpts return imagesCmd(&imagesCommand) }, - Example: "", + Example: `podman images --format json + podman images --sort repository --format "table {{.ID}} {{.Repository}} {{.Tag}}" + podman images --filter dangling=true`, } ) diff --git a/cmd/podman/logs.go b/cmd/podman/logs.go index 6962a1f6d..4cf3b7cb8 100644 --- a/cmd/podman/logs.go +++ b/cmd/podman/logs.go @@ -26,7 +26,9 @@ var ( logsCommand.GlobalFlags = MainGlobalOpts return logsCmd(&logsCommand) }, - Example: "CONTAINER", + Example: `podman logs ctrID + podman logs --tail 2 mywebserver + podman logs --follow=true --since 10m ctrID`, } ) diff --git a/cmd/podman/pod_kill.go b/cmd/podman/pod_kill.go index febc820cd..f6991a1c3 100644 --- a/cmd/podman/pod_kill.go +++ b/cmd/podman/pod_kill.go @@ -24,7 +24,9 @@ var ( podKillCommand.GlobalFlags = MainGlobalOpts return podKillCmd(&podKillCommand) }, - Example: "[POD_NAME_OR_ID]", + Example: `podman pod kill podID + podman pod kill --signal TERM mywebserver + podman pod kill --latest`, } ) diff --git a/cmd/podman/pod_pause.go b/cmd/podman/pod_pause.go index 2059727ae..ea2c80f7b 100644 --- a/cmd/podman/pod_pause.go +++ b/cmd/podman/pod_pause.go @@ -21,7 +21,9 @@ var ( podPauseCommand.GlobalFlags = MainGlobalOpts return podPauseCmd(&podPauseCommand) }, - Example: "POD-NAME|POD-ID [POD-NAME|POD-ID ...]", + Example: `podman pod pause podID1 podID2 + podman pod pause --latest + podman pod pause --all`, } ) diff --git a/cmd/podman/pod_restart.go b/cmd/podman/pod_restart.go index f75d84956..2815af0c6 100644 --- a/cmd/podman/pod_restart.go +++ b/cmd/podman/pod_restart.go @@ -22,7 +22,9 @@ var ( podRestartCommand.GlobalFlags = MainGlobalOpts return podRestartCmd(&podRestartCommand) }, - Example: "POD-NAME|POD-ID [POD-NAME|POD-ID ...]", + Example: `podman pod restart podID1 podID2 + podman pod restart --latest + podman pod restart --all`, } ) diff --git a/cmd/podman/pod_unpause.go b/cmd/podman/pod_unpause.go index a917919c3..6c131b92c 100644 --- a/cmd/podman/pod_unpause.go +++ b/cmd/podman/pod_unpause.go @@ -22,7 +22,9 @@ var ( podUnpauseCommand.GlobalFlags = MainGlobalOpts return podUnpauseCmd(&podUnpauseCommand) }, - Example: "POD-NAME|POD-ID [POD-NAME|POD-ID ...]", + Example: `podman pod unpause podID1 podID2 + podman pod unpause --all + podman pod unpause --latest`, } ) diff --git a/cmd/podman/port.go b/cmd/podman/port.go index be84da065..581371e4f 100644 --- a/cmd/podman/port.go +++ b/cmd/podman/port.go @@ -28,7 +28,9 @@ var ( portCommand.GlobalFlags = MainGlobalOpts return portCmd(&portCommand) }, - Example: "CONTAINER-NAME [mapping]", + Example: `podman port --all + podman port ctrID 80/tcp + podman port --latest 80`, } ) diff --git a/cmd/podman/volume_rm.go b/cmd/podman/volume_rm.go index f301749e9..14847a949 100644 --- a/cmd/podman/volume_rm.go +++ b/cmd/podman/volume_rm.go @@ -28,7 +28,9 @@ not being used by any containers. To remove the volumes anyways, use the volumeRmCommand.GlobalFlags = MainGlobalOpts return volumeRmCmd(&volumeRmCommand) }, - Example: "[VOLUME-NAME ...]", + Example: `podman volume rm myvol1 myvol2 + podman volume rm --all + podman volume rm --force myvol`, } ) diff --git a/cmd/podman/wait.go b/cmd/podman/wait.go index 616c8feb5..c6e6240f3 100644 --- a/cmd/podman/wait.go +++ b/cmd/podman/wait.go @@ -28,7 +28,9 @@ var ( waitCommand.GlobalFlags = MainGlobalOpts return waitCmd(&waitCommand) }, - Example: "CONTAINER-NAME [CONTAINER-NAME ...]", + Example: `podman wait --latest + podman wait --interval 5000 ctrID + podman wait ctrID1 ctrID2`, } ) -- cgit v1.2.3-54-g00ecf